Class CreativePlaceholder.Builder (0.4.0)

public static final class CreativePlaceholder.Builder extends GeneratedMessageV3.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

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)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
CreativePlaceholder.Builder

addAllCompanionSizes(Iterable<? extends Size> values)

public CreativePlaceholder.Builder addAllCompanionSizes(Iterable<? extends Size> values)

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.Size companion_sizes = 2;

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.Size>
Returns
Type Description
CreativePlaceholder.Builder

addAppliedLabels(AppliedLabel value)

public CreativePlaceholder.Builder addAppliedLabels(AppliedLabel value)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameter
Name Description
value AppliedLabel
Returns
Type Description
CreativePlaceholder.Builder

addAppliedLabels(AppliedLabel.Builder builderForValue)

public CreativePlaceholder.Builder addAppliedLabels(AppliedLabel.Builder builderForValue)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameter
Name Description
builderForValue AppliedLabel.Builder
Returns
Type Description
CreativePlaceholder.Builder

addAppliedLabels(int index, AppliedLabel value)

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

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

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)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
CreativePlaceholder.Builder

addAppliedLabelsBuilder()

public AppliedLabel.Builder addAppliedLabelsBuilder()

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Returns
Type Description
AppliedLabel.Builder

addAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addAppliedLabelsBuilder(int index)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

addCompanionSizes(Size value)

public CreativePlaceholder.Builder addCompanionSizes(Size value)

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.Size companion_sizes = 2;

Parameter
Name Description
value Size
Returns
Type Description
CreativePlaceholder.Builder

addCompanionSizes(Size.Builder builderForValue)

public CreativePlaceholder.Builder addCompanionSizes(Size.Builder builderForValue)

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.Size companion_sizes = 2;

Parameter
Name Description
builderForValue Size.Builder
Returns
Type Description
CreativePlaceholder.Builder

addCompanionSizes(int index, Size value)

public CreativePlaceholder.Builder addCompanionSizes(int index, Size value)

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.Size companion_sizes = 2;

Parameters
Name Description
index int
value Size
Returns
Type Description
CreativePlaceholder.Builder

addCompanionSizes(int index, Size.Builder builderForValue)

public CreativePlaceholder.Builder addCompanionSizes(int index, Size.Builder builderForValue)

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.Size companion_sizes = 2;

Parameters
Name Description
index int
builderForValue Size.Builder
Returns
Type Description
CreativePlaceholder.Builder

addCompanionSizesBuilder()

public Size.Builder addCompanionSizesBuilder()

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.Size companion_sizes = 2;

Returns
Type Description
Size.Builder

addCompanionSizesBuilder(int index)

public Size.Builder addCompanionSizesBuilder(int index)

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.Size companion_sizes = 2;

Parameter
Name Description
index int
Returns
Type Description
Size.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreativePlaceholder.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreativePlaceholder.Builder
Overrides

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

clearAmpOnly()

public CreativePlaceholder.Builder clearAmpOnly()

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.

bool amp_only = 5;

Returns
Type Description
CreativePlaceholder.Builder

This builder for chaining.

clearAppliedLabels()

public CreativePlaceholder.Builder clearAppliedLabels()

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Returns
Type Description
CreativePlaceholder.Builder

clearCompanionSizes()

public CreativePlaceholder.Builder clearCompanionSizes()

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.Size companion_sizes = 2;

Returns
Type Description
CreativePlaceholder.Builder

clearCreativeTargetingDisplayName()

public CreativePlaceholder.Builder clearCreativeTargetingDisplayName()

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

string creative_targeting_display_name = 6;

Returns
Type Description
CreativePlaceholder.Builder

This builder for chaining.

clearExpectedCreativeCount()

public CreativePlaceholder.Builder clearExpectedCreativeCount()

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.

int32 expected_creative_count = 3;

Returns
Type Description
CreativePlaceholder.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreativePlaceholder.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreativePlaceholder.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreativePlaceholder.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreativePlaceholder.Builder
Overrides

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

clone()

public CreativePlaceholder.Builder clone()
Returns
Type Description
CreativePlaceholder.Builder
Overrides

getAmpOnly()

public boolean getAmpOnly()

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.

bool amp_only = 5;

Returns
Type Description
boolean

The ampOnly.

getAppliedLabels(int index)

public AppliedLabel getAppliedLabels(int index)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getAppliedLabelsBuilder(int index)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

getAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getAppliedLabelsBuilderList()

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Returns
Type Description
List<Builder>

getAppliedLabelsCount()

public int getAppliedLabelsCount()

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Returns
Type Description
int

getAppliedLabelsList()

public List<AppliedLabel> getAppliedLabelsList()

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Returns
Type Description
List<AppliedLabel>

getAppliedLabelsOrBuilder(int index)

public AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getAppliedLabelsOrBuilderList()

public List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

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

getCompanionSizes(int index)

public Size getCompanionSizes(int index)

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.Size companion_sizes = 2;

Parameter
Name Description
index int
Returns
Type Description
Size

getCompanionSizesBuilder(int index)

public Size.Builder getCompanionSizesBuilder(int index)

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.Size companion_sizes = 2;

Parameter
Name Description
index int
Returns
Type Description
Size.Builder

getCompanionSizesBuilderList()

public List<Size.Builder> getCompanionSizesBuilderList()

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.Size companion_sizes = 2;

Returns
Type Description
List<Builder>

getCompanionSizesCount()

public int getCompanionSizesCount()

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.Size companion_sizes = 2;

Returns
Type Description
int

getCompanionSizesList()

public List<Size> getCompanionSizesList()

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.Size companion_sizes = 2;

Returns
Type Description
List<Size>

getCompanionSizesOrBuilder(int index)

public SizeOrBuilder getCompanionSizesOrBuilder(int index)

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.Size companion_sizes = 2;

Parameter
Name Description
index int
Returns
Type Description
SizeOrBuilder

getCompanionSizesOrBuilderList()

public List<? extends SizeOrBuilder> getCompanionSizesOrBuilderList()

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.Size companion_sizes = 2;

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

getCreativeTargetingDisplayName()

public String getCreativeTargetingDisplayName()

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

string creative_targeting_display_name = 6;

Returns
Type Description
String

The creativeTargetingDisplayName.

getCreativeTargetingDisplayNameBytes()

public ByteString getCreativeTargetingDisplayNameBytes()

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

string creative_targeting_display_name = 6;

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

getExpectedCreativeCount()

public int getExpectedCreativeCount()

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.

int32 expected_creative_count = 3;

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

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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreativePlaceholder.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreativePlaceholder.Builder
Overrides

removeAppliedLabels(int index)

public CreativePlaceholder.Builder removeAppliedLabels(int index)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholder.Builder

removeCompanionSizes(int index)

public CreativePlaceholder.Builder removeCompanionSizes(int index)

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.Size companion_sizes = 2;

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholder.Builder

setAmpOnly(boolean value)

public CreativePlaceholder.Builder setAmpOnly(boolean value)

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.

bool amp_only = 5;

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)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

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)

Set of labels applied directly to this CreativePlaceholder.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 4;

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
CreativePlaceholder.Builder

setCompanionSizes(int index, Size value)

public CreativePlaceholder.Builder setCompanionSizes(int index, Size value)

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.Size companion_sizes = 2;

Parameters
Name Description
index int
value Size
Returns
Type Description
CreativePlaceholder.Builder

setCompanionSizes(int index, Size.Builder builderForValue)

public CreativePlaceholder.Builder setCompanionSizes(int index, Size.Builder builderForValue)

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.Size companion_sizes = 2;

Parameters
Name Description
index int
builderForValue Size.Builder
Returns
Type Description
CreativePlaceholder.Builder

setCreativeTargetingDisplayName(String value)

public CreativePlaceholder.Builder setCreativeTargetingDisplayName(String value)

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

string creative_targeting_display_name = 6;

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)

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

string creative_targeting_display_name = 6;

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)

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.

int32 expected_creative_count = 3;

Parameter
Name Description
value int

The expectedCreativeCount to set.

Returns
Type Description
CreativePlaceholder.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreativePlaceholder.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreativePlaceholder.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreativePlaceholder.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreativePlaceholder.Builder
Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final CreativePlaceholder.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreativePlaceholder.Builder
Overrides