Class GrpSettings.Builder (0.54.0)

public static final class GrpSettings.Builder extends GeneratedMessage.Builder<GrpSettings.Builder> implements GrpSettingsOrBuilder

GrpSettings contains information for a line item that will have a target demographic when serving. This information will be used to set up tracking and enable reporting on the demographic information.

Protobuf type google.ads.admanager.v1.GrpSettings

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public GrpSettings build()
Returns
Type Description
GrpSettings

buildPartial()

public GrpSettings buildPartial()
Returns
Type Description
GrpSettings

clear()

public GrpSettings.Builder clear()
Returns
Type Description
GrpSettings.Builder
Overrides

clearApplyTrueCoview()

public GrpSettings.Builder clearApplyTrueCoview()

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if nielsen_ctv_pacing_type is not NONE.

optional bool apply_true_coview = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

clearInTargetRatioEstimateMilliPercent()

public GrpSettings.Builder clearInTargetRatioEstimateMilliPercent()

Optional. Estimate for the in-target ratio given the line item's audience targeting. This field is only applicable if provider is Nielsen, [LineItem.primary_goal.unit_type][] is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.

optional int64 in_target_ratio_estimate_milli_percent = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

clearMaxTargetAge()

public GrpSettings.Builder clearMaxTargetAge()

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if provider is not null.

optional int64 max_target_age = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

clearMinTargetAge()

public GrpSettings.Builder clearMinTargetAge()

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if provider is not null.

optional int64 min_target_age = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

clearNielsenCtvPacingType()

public GrpSettings.Builder clearNielsenCtvPacingType()

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

optional .google.ads.admanager.v1.NielsenCtvPacingEnum.NielsenCtvPacing nielsen_ctv_pacing_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

clearPacingDeviceCategorizationType()

public GrpSettings.Builder clearPacingDeviceCategorizationType()

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

optional .google.ads.admanager.v1.PacingDeviceCategorizationEnum.PacingDeviceCategorization pacing_device_categorization_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

clearProvider()

public GrpSettings.Builder clearProvider()

Optional. Specifies the GRP provider of the LineItem.

optional .google.ads.admanager.v1.GrpProviderEnum.GrpProvider provider = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

clearTargetGender()

public GrpSettings.Builder clearTargetGender()

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.

optional .google.ads.admanager.v1.GrpTargetGenderEnum.GrpTargetGender target_gender = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

getApplyTrueCoview()

public boolean getApplyTrueCoview()

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if nielsen_ctv_pacing_type is not NONE.

optional bool apply_true_coview = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The applyTrueCoview.

getDefaultInstanceForType()

public GrpSettings getDefaultInstanceForType()
Returns
Type Description
GrpSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInTargetRatioEstimateMilliPercent()

public long getInTargetRatioEstimateMilliPercent()

Optional. Estimate for the in-target ratio given the line item's audience targeting. This field is only applicable if provider is Nielsen, [LineItem.primary_goal.unit_type][] is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.

optional int64 in_target_ratio_estimate_milli_percent = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The inTargetRatioEstimateMilliPercent.

getMaxTargetAge()

public long getMaxTargetAge()

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if provider is not null.

optional int64 max_target_age = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The maxTargetAge.

getMinTargetAge()

public long getMinTargetAge()

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if provider is not null.

optional int64 min_target_age = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The minTargetAge.

getNielsenCtvPacingType()

public NielsenCtvPacingEnum.NielsenCtvPacing getNielsenCtvPacingType()

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

optional .google.ads.admanager.v1.NielsenCtvPacingEnum.NielsenCtvPacing nielsen_ctv_pacing_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NielsenCtvPacingEnum.NielsenCtvPacing

The nielsenCtvPacingType.

getNielsenCtvPacingTypeValue()

public int getNielsenCtvPacingTypeValue()

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

optional .google.ads.admanager.v1.NielsenCtvPacingEnum.NielsenCtvPacing nielsen_ctv_pacing_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for nielsenCtvPacingType.

getPacingDeviceCategorizationType()

public PacingDeviceCategorizationEnum.PacingDeviceCategorization getPacingDeviceCategorizationType()

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

optional .google.ads.admanager.v1.PacingDeviceCategorizationEnum.PacingDeviceCategorization pacing_device_categorization_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PacingDeviceCategorizationEnum.PacingDeviceCategorization

The pacingDeviceCategorizationType.

getPacingDeviceCategorizationTypeValue()

public int getPacingDeviceCategorizationTypeValue()

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

optional .google.ads.admanager.v1.PacingDeviceCategorizationEnum.PacingDeviceCategorization pacing_device_categorization_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for pacingDeviceCategorizationType.

getProvider()

public GrpProviderEnum.GrpProvider getProvider()

Optional. Specifies the GRP provider of the LineItem.

optional .google.ads.admanager.v1.GrpProviderEnum.GrpProvider provider = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpProviderEnum.GrpProvider

The provider.

getProviderValue()

public int getProviderValue()

Optional. Specifies the GRP provider of the LineItem.

optional .google.ads.admanager.v1.GrpProviderEnum.GrpProvider provider = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for provider.

getTargetGender()

public GrpTargetGenderEnum.GrpTargetGender getTargetGender()

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.

optional .google.ads.admanager.v1.GrpTargetGenderEnum.GrpTargetGender target_gender = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpTargetGenderEnum.GrpTargetGender

The targetGender.

getTargetGenderValue()

public int getTargetGenderValue()

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.

optional .google.ads.admanager.v1.GrpTargetGenderEnum.GrpTargetGender target_gender = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for targetGender.

hasApplyTrueCoview()

public boolean hasApplyTrueCoview()

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if nielsen_ctv_pacing_type is not NONE.

optional bool apply_true_coview = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the applyTrueCoview field is set.

hasInTargetRatioEstimateMilliPercent()

public boolean hasInTargetRatioEstimateMilliPercent()

Optional. Estimate for the in-target ratio given the line item's audience targeting. This field is only applicable if provider is Nielsen, [LineItem.primary_goal.unit_type][] is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.

optional int64 in_target_ratio_estimate_milli_percent = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inTargetRatioEstimateMilliPercent field is set.

hasMaxTargetAge()

public boolean hasMaxTargetAge()

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if provider is not null.

optional int64 max_target_age = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxTargetAge field is set.

hasMinTargetAge()

public boolean hasMinTargetAge()

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if provider is not null.

optional int64 min_target_age = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the minTargetAge field is set.

hasNielsenCtvPacingType()

public boolean hasNielsenCtvPacingType()

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

optional .google.ads.admanager.v1.NielsenCtvPacingEnum.NielsenCtvPacing nielsen_ctv_pacing_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the nielsenCtvPacingType field is set.

hasPacingDeviceCategorizationType()

public boolean hasPacingDeviceCategorizationType()

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

optional .google.ads.admanager.v1.PacingDeviceCategorizationEnum.PacingDeviceCategorization pacing_device_categorization_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pacingDeviceCategorizationType field is set.

hasProvider()

public boolean hasProvider()

Optional. Specifies the GRP provider of the LineItem.

optional .google.ads.admanager.v1.GrpProviderEnum.GrpProvider provider = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the provider field is set.

hasTargetGender()

public boolean hasTargetGender()

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.

optional .google.ads.admanager.v1.GrpTargetGenderEnum.GrpTargetGender target_gender = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the targetGender field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GrpSettings other)

public GrpSettings.Builder mergeFrom(GrpSettings other)
Parameter
Name Description
other GrpSettings
Returns
Type Description
GrpSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GrpSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GrpSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GrpSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GrpSettings.Builder
Overrides

setApplyTrueCoview(boolean value)

public GrpSettings.Builder setApplyTrueCoview(boolean value)

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if nielsen_ctv_pacing_type is not NONE.

optional bool apply_true_coview = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The applyTrueCoview to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setInTargetRatioEstimateMilliPercent(long value)

public GrpSettings.Builder setInTargetRatioEstimateMilliPercent(long value)

Optional. Estimate for the in-target ratio given the line item's audience targeting. This field is only applicable if provider is Nielsen, [LineItem.primary_goal.unit_type][] is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.

optional int64 in_target_ratio_estimate_milli_percent = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The inTargetRatioEstimateMilliPercent to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setMaxTargetAge(long value)

public GrpSettings.Builder setMaxTargetAge(long value)

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if provider is not null.

optional int64 max_target_age = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The maxTargetAge to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setMinTargetAge(long value)

public GrpSettings.Builder setMinTargetAge(long value)

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if provider is not null.

optional int64 min_target_age = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The minTargetAge to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setNielsenCtvPacingType(NielsenCtvPacingEnum.NielsenCtvPacing value)

public GrpSettings.Builder setNielsenCtvPacingType(NielsenCtvPacingEnum.NielsenCtvPacing value)

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

optional .google.ads.admanager.v1.NielsenCtvPacingEnum.NielsenCtvPacing nielsen_ctv_pacing_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value NielsenCtvPacingEnum.NielsenCtvPacing

The nielsenCtvPacingType to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setNielsenCtvPacingTypeValue(int value)

public GrpSettings.Builder setNielsenCtvPacingTypeValue(int value)

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.

optional .google.ads.admanager.v1.NielsenCtvPacingEnum.NielsenCtvPacing nielsen_ctv_pacing_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for nielsenCtvPacingType to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setPacingDeviceCategorizationType(PacingDeviceCategorizationEnum.PacingDeviceCategorization value)

public GrpSettings.Builder setPacingDeviceCategorizationType(PacingDeviceCategorizationEnum.PacingDeviceCategorization value)

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

optional .google.ads.admanager.v1.PacingDeviceCategorizationEnum.PacingDeviceCategorization pacing_device_categorization_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PacingDeviceCategorizationEnum.PacingDeviceCategorization

The pacingDeviceCategorizationType to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setPacingDeviceCategorizationTypeValue(int value)

public GrpSettings.Builder setPacingDeviceCategorizationTypeValue(int value)

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

optional .google.ads.admanager.v1.PacingDeviceCategorizationEnum.PacingDeviceCategorization pacing_device_categorization_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for pacingDeviceCategorizationType to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setProvider(GrpProviderEnum.GrpProvider value)

public GrpSettings.Builder setProvider(GrpProviderEnum.GrpProvider value)

Optional. Specifies the GRP provider of the LineItem.

optional .google.ads.admanager.v1.GrpProviderEnum.GrpProvider provider = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GrpProviderEnum.GrpProvider

The provider to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setProviderValue(int value)

public GrpSettings.Builder setProviderValue(int value)

Optional. Specifies the GRP provider of the LineItem.

optional .google.ads.admanager.v1.GrpProviderEnum.GrpProvider provider = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for provider to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setTargetGender(GrpTargetGenderEnum.GrpTargetGender value)

public GrpSettings.Builder setTargetGender(GrpTargetGenderEnum.GrpTargetGender value)

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.

optional .google.ads.admanager.v1.GrpTargetGenderEnum.GrpTargetGender target_gender = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GrpTargetGenderEnum.GrpTargetGender

The targetGender to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.

setTargetGenderValue(int value)

public GrpSettings.Builder setTargetGenderValue(int value)

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.

optional .google.ads.admanager.v1.GrpTargetGenderEnum.GrpTargetGender target_gender = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for targetGender to set.

Returns
Type Description
GrpSettings.Builder

This builder for chaining.