Class GrpSettings (0.54.0)

public final class GrpSettings extends GeneratedMessage 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 Fields

APPLY_TRUE_COVIEW_FIELD_NUMBER

public static final int APPLY_TRUE_COVIEW_FIELD_NUMBER
Field Value
Type Description
int

IN_TARGET_RATIO_ESTIMATE_MILLI_PERCENT_FIELD_NUMBER

public static final int IN_TARGET_RATIO_ESTIMATE_MILLI_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

MAX_TARGET_AGE_FIELD_NUMBER

public static final int MAX_TARGET_AGE_FIELD_NUMBER
Field Value
Type Description
int

MIN_TARGET_AGE_FIELD_NUMBER

public static final int MIN_TARGET_AGE_FIELD_NUMBER
Field Value
Type Description
int

NIELSEN_CTV_PACING_TYPE_FIELD_NUMBER

public static final int NIELSEN_CTV_PACING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PACING_DEVICE_CATEGORIZATION_TYPE_FIELD_NUMBER

public static final int PACING_DEVICE_CATEGORIZATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PROVIDER_FIELD_NUMBER

public static final int PROVIDER_FIELD_NUMBER
Field Value
Type Description
int

TARGET_GENDER_FIELD_NUMBER

public static final int TARGET_GENDER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GrpSettings getDefaultInstance()
Returns
Type Description
GrpSettings

getDescriptor()

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

newBuilder()

public static GrpSettings.Builder newBuilder()
Returns
Type Description
GrpSettings.Builder

newBuilder(GrpSettings prototype)

public static GrpSettings.Builder newBuilder(GrpSettings prototype)
Parameter
Name Description
prototype GrpSettings
Returns
Type Description
GrpSettings.Builder

parseDelimitedFrom(InputStream input)

public static GrpSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GrpSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GrpSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GrpSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GrpSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GrpSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GrpSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GrpSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GrpSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GrpSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GrpSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GrpSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GrpSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GrpSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GrpSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GrpSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GrpSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GrpSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GrpSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GrpSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GrpSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GrpSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GrpSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GrpSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GrpSettings> parser()
Returns
Type Description
Parser<GrpSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

getParserForType()

public Parser<GrpSettings> getParserForType()
Returns
Type Description
Parser<GrpSettings>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GrpSettings.Builder newBuilderForType()
Returns
Type Description
GrpSettings.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected GrpSettings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GrpSettings.Builder
Overrides

toBuilder()

public GrpSettings.Builder toBuilder()
Returns
Type Description
GrpSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException