Class CreativePlaceholder.Builder (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class CreativePlaceholder.Builder extends GeneratedMessage.Builder<CreativePlaceholder.Builder> implements CreativePlaceholderOrBuilder

Describes a slot that a creative is expected to fill. This is used in forecasting and to validate that the correct creatives are associated with the line item.

Protobuf type google.ads.admanager.v1.CreativePlaceholder

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CreativePlaceholder.Builder

Implements

CreativePlaceholderOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

public CreativePlaceholder.Builder addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

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
values	Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>

Returns
Type	Description
CreativePlaceholder.Builder

addAllCompanions(Iterable<? extends CreativePlaceholderCompanion> values)

public CreativePlaceholder.Builder addAllCompanions(Iterable<? extends CreativePlaceholderCompanion> values)

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
values	Iterable<? extends com.google.ads.admanager.v1.CreativePlaceholderCompanion>

Returns
Type	Description
CreativePlaceholder.Builder

addAppliedLabels(AppliedLabel value)

public CreativePlaceholder.Builder addAppliedLabels(AppliedLabel value)

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
value	AppliedLabel

Returns
Type	Description
CreativePlaceholder.Builder

addAppliedLabels(AppliedLabel.Builder builderForValue)

public CreativePlaceholder.Builder addAppliedLabels(AppliedLabel.Builder builderForValue)

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
builderForValue	AppliedLabel.Builder

Returns
Type	Description
CreativePlaceholder.Builder

addAppliedLabels(int index, AppliedLabel value)

public CreativePlaceholder.Builder addAppliedLabels(int index, AppliedLabel value)

Optional. Set of labels applied directly to this CreativePlaceholder.

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

Parameters
Name	Description
index	int
value	AppliedLabel

Returns
Type	Description
CreativePlaceholder.Builder

addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public CreativePlaceholder.Builder addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Optional. Set of labels applied directly to this CreativePlaceholder.

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

Parameters
Name	Description
index	int
builderForValue	AppliedLabel.Builder

Returns
Type	Description
CreativePlaceholder.Builder

addAppliedLabelsBuilder()

public AppliedLabel.Builder addAppliedLabelsBuilder()

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
AppliedLabel.Builder

addAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addAppliedLabelsBuilder(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.Builder

addCompanions(CreativePlaceholderCompanion value)

public CreativePlaceholder.Builder addCompanions(CreativePlaceholderCompanion value)

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
value	CreativePlaceholderCompanion

Returns
Type	Description
CreativePlaceholder.Builder

addCompanions(CreativePlaceholderCompanion.Builder builderForValue)

public CreativePlaceholder.Builder addCompanions(CreativePlaceholderCompanion.Builder builderForValue)

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
builderForValue	CreativePlaceholderCompanion.Builder

Returns
Type	Description
CreativePlaceholder.Builder

addCompanions(int index, CreativePlaceholderCompanion value)

public CreativePlaceholder.Builder addCompanions(int index, CreativePlaceholderCompanion value)

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];

Parameters
Name	Description
index	int
value	CreativePlaceholderCompanion

Returns
Type	Description
CreativePlaceholder.Builder

addCompanions(int index, CreativePlaceholderCompanion.Builder builderForValue)

public CreativePlaceholder.Builder addCompanions(int index, CreativePlaceholderCompanion.Builder builderForValue)

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];

Parameters
Name	Description
index	int
builderForValue	CreativePlaceholderCompanion.Builder

Returns
Type	Description
CreativePlaceholder.Builder

addCompanionsBuilder()

public CreativePlaceholderCompanion.Builder addCompanionsBuilder()

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
CreativePlaceholderCompanion.Builder

addCompanionsBuilder(int index)

public CreativePlaceholderCompanion.Builder addCompanionsBuilder(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.Builder

build()

public CreativePlaceholder build()

Returns
Type	Description
CreativePlaceholder

buildPartial()

public CreativePlaceholder buildPartial()

Returns
Type	Description
CreativePlaceholder

clear()

public CreativePlaceholder.Builder clear()

Returns
Type	Description
CreativePlaceholder.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAmpOnly()

public CreativePlaceholder.Builder clearAmpOnly()

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
CreativePlaceholder.Builder	This builder for chaining.

clearAppliedLabels()

public CreativePlaceholder.Builder clearAppliedLabels()

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
CreativePlaceholder.Builder

clearCompanions()

public CreativePlaceholder.Builder clearCompanions()

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
CreativePlaceholder.Builder

clearCreativeTargetingDisplayName()

public CreativePlaceholder.Builder clearCreativeTargetingDisplayName()

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
CreativePlaceholder.Builder	This builder for chaining.

clearExpectedCreativeCount()

public CreativePlaceholder.Builder clearExpectedCreativeCount()

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
CreativePlaceholder.Builder	This builder for chaining.

clearSize()

public CreativePlaceholder.Builder clearSize()

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
CreativePlaceholder.Builder

getAmpOnly()

public 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 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

getAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getAppliedLabelsBuilder(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.Builder

getAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getAppliedLabelsBuilderList()

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<Builder>

getAppliedLabelsCount()

public 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 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 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 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 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

getCompanionsBuilder(int index)

public CreativePlaceholderCompanion.Builder getCompanionsBuilder(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.Builder

getCompanionsBuilderList()

public List<CreativePlaceholderCompanion.Builder> getCompanionsBuilderList()

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<Builder>

getCompanionsCount()

public 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 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 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 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 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 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.

getDefaultInstanceForType()

public CreativePlaceholder getDefaultInstanceForType()

Returns
Type	Description
CreativePlaceholder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getExpectedCreativeCount()

public 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 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.

getSizeBuilder()

public Size.Builder getSizeBuilder()

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.Builder

getSizeOrBuilder()

public 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(CreativePlaceholder other)

public CreativePlaceholder.Builder mergeFrom(CreativePlaceholder other)

Parameter
Name	Description
other	CreativePlaceholder

Returns
Type	Description
CreativePlaceholder.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreativePlaceholder.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativePlaceholder.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CreativePlaceholder.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CreativePlaceholder.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSize(Size value)

public CreativePlaceholder.Builder mergeSize(Size value)

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

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

Parameter
Name	Description
value	Size

Returns
Type	Description
CreativePlaceholder.Builder

removeAppliedLabels(int index)

public CreativePlaceholder.Builder removeAppliedLabels(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
CreativePlaceholder.Builder

removeCompanions(int index)

public CreativePlaceholder.Builder removeCompanions(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
CreativePlaceholder.Builder

setAmpOnly(boolean value)

public CreativePlaceholder.Builder setAmpOnly(boolean value)

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];

Parameter
Name	Description
value	boolean The ampOnly to set.

Returns
Type	Description
CreativePlaceholder.Builder	This builder for chaining.

setAppliedLabels(int index, AppliedLabel value)

public CreativePlaceholder.Builder setAppliedLabels(int index, AppliedLabel value)

Optional. Set of labels applied directly to this CreativePlaceholder.

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

Parameters
Name	Description
index	int
value	AppliedLabel

Returns
Type	Description
CreativePlaceholder.Builder

setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public CreativePlaceholder.Builder setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Optional. Set of labels applied directly to this CreativePlaceholder.

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

Parameters
Name	Description
index	int
builderForValue	AppliedLabel.Builder

Returns
Type	Description
CreativePlaceholder.Builder

setCompanions(int index, CreativePlaceholderCompanion value)

public CreativePlaceholder.Builder setCompanions(int index, CreativePlaceholderCompanion value)

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];

Parameters
Name	Description
index	int
value	CreativePlaceholderCompanion

Returns
Type	Description
CreativePlaceholder.Builder

setCompanions(int index, CreativePlaceholderCompanion.Builder builderForValue)

public CreativePlaceholder.Builder setCompanions(int index, CreativePlaceholderCompanion.Builder builderForValue)

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];

Parameters
Name	Description
index	int
builderForValue	CreativePlaceholderCompanion.Builder

Returns
Type	Description
CreativePlaceholder.Builder

setCreativeTargetingDisplayName(String value)

public CreativePlaceholder.Builder setCreativeTargetingDisplayName(String value)

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

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

Parameter
Name	Description
value	String The creativeTargetingDisplayName to set.

Returns
Type	Description
CreativePlaceholder.Builder	This builder for chaining.

setCreativeTargetingDisplayNameBytes(ByteString value)

public CreativePlaceholder.Builder setCreativeTargetingDisplayNameBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for creativeTargetingDisplayName to set.

Returns
Type	Description
CreativePlaceholder.Builder	This builder for chaining.

setExpectedCreativeCount(int value)

public CreativePlaceholder.Builder setExpectedCreativeCount(int value)

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];

Parameter
Name	Description
value	int The expectedCreativeCount to set.

Returns
Type	Description
CreativePlaceholder.Builder	This builder for chaining.

setSize(Size value)

public CreativePlaceholder.Builder setSize(Size value)

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

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

Parameter
Name	Description
value	Size

Returns
Type	Description
CreativePlaceholder.Builder

setSize(Size.Builder builderForValue)

public CreativePlaceholder.Builder setSize(Size.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	Size.Builder

Returns
Type	Description
CreativePlaceholder.Builder