Interface CreativePlaceholderOrBuilder (0.54.0)

public interface CreativePlaceholderOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAmpOnly()

public abstract boolean getAmpOnly()

Optional. Non-empty default. Indicates if the expected creative of this placeholder has an AMP only variant. This is used to improve the accuracy of forecasting and has no effect on serving. By default, the value is false.

optional bool amp_only = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

The ampOnly.

getAppliedLabels(int index)

public abstract AppliedLabel getAppliedLabels(int index)

Optional. Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getAppliedLabelsCount()

public abstract int getAppliedLabelsCount()

Optional. Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAppliedLabelsList()

public abstract List<AppliedLabel> getAppliedLabelsList()

Optional. Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AppliedLabel>

getAppliedLabelsOrBuilder(int index)

public abstract AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)

Optional. Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getAppliedLabelsOrBuilderList()

public abstract List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()

Optional. Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder>

getCompanions(int index)

public abstract CreativePlaceholderCompanion getCompanions(int index)

Optional. The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has an EnvironmentType of VIDEO_PLAYER or roadblocking_type of CREATIVE_SET.

repeated .google.ads.admanager.v1.CreativePlaceholderCompanion companions = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholderCompanion

getCompanionsCount()

public abstract int getCompanionsCount()

Optional. The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has an EnvironmentType of VIDEO_PLAYER or roadblocking_type of CREATIVE_SET.

repeated .google.ads.admanager.v1.CreativePlaceholderCompanion companions = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCompanionsList()

public abstract List<CreativePlaceholderCompanion> getCompanionsList()

Optional. The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has an EnvironmentType of VIDEO_PLAYER or roadblocking_type of CREATIVE_SET.

repeated .google.ads.admanager.v1.CreativePlaceholderCompanion companions = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<CreativePlaceholderCompanion>

getCompanionsOrBuilder(int index)

public abstract CreativePlaceholderCompanionOrBuilder getCompanionsOrBuilder(int index)

Optional. The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has an EnvironmentType of VIDEO_PLAYER or roadblocking_type of CREATIVE_SET.

repeated .google.ads.admanager.v1.CreativePlaceholderCompanion companions = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholderCompanionOrBuilder

getCompanionsOrBuilderList()

public abstract List<? extends CreativePlaceholderCompanionOrBuilder> getCompanionsOrBuilderList()

Optional. The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has an EnvironmentType of VIDEO_PLAYER or roadblocking_type of CREATIVE_SET.

repeated .google.ads.admanager.v1.CreativePlaceholderCompanion companions = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.CreativePlaceholderCompanionOrBuilder>

getCreativeTargetingDisplayName()

public abstract String getCreativeTargetingDisplayName()

Optional. The display name of the creative targeting that this CreativePlaceholder represents.

optional string creative_targeting_display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The creativeTargetingDisplayName.

getCreativeTargetingDisplayNameBytes()

public abstract ByteString getCreativeTargetingDisplayNameBytes()

Optional. The display name of the creative targeting that this CreativePlaceholder represents.

optional string creative_targeting_display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for creativeTargetingDisplayName.

getExpectedCreativeCount()

public abstract int getExpectedCreativeCount()

Optional. Non-empty default. Expected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served. By default, the expected creative count is set to 1.

optional int32 expected_creative_count = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The expectedCreativeCount.

getSize()

public abstract Size getSize()

Required. The size that the creative is expected to have.

.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Size

The size.

getSizeOrBuilder()

public abstract SizeOrBuilder getSizeOrBuilder()

Required. The size that the creative is expected to have.

.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SizeOrBuilder

hasAmpOnly()

public abstract boolean hasAmpOnly()

Optional. Non-empty default. Indicates if the expected creative of this placeholder has an AMP only variant. This is used to improve the accuracy of forecasting and has no effect on serving. By default, the value is false.

optional bool amp_only = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the ampOnly field is set.

hasCreativeTargetingDisplayName()

public abstract boolean hasCreativeTargetingDisplayName()

Optional. The display name of the creative targeting that this CreativePlaceholder represents.

optional string creative_targeting_display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the creativeTargetingDisplayName field is set.

hasExpectedCreativeCount()

public abstract boolean hasExpectedCreativeCount()

Optional. Non-empty default. Expected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served. By default, the expected creative count is set to 1.

optional int32 expected_creative_count = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the expectedCreativeCount field is set.

hasSize()

public abstract boolean hasSize()

Required. The size that the creative is expected to have.

.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the size field is set.