Class CreativePlaceholder (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 final class CreativePlaceholder extends GeneratedMessage 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

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > CreativePlaceholder

Implements

CreativePlaceholderOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AMP_ONLY_FIELD_NUMBER

public static final int AMP_ONLY_FIELD_NUMBER

Field Value
Type	Description
int

APPLIED_LABELS_FIELD_NUMBER

public static final int APPLIED_LABELS_FIELD_NUMBER

Field Value
Type	Description
int

COMPANIONS_FIELD_NUMBER

public static final int COMPANIONS_FIELD_NUMBER

Field Value
Type	Description
int

CREATIVE_TARGETING_DISPLAY_NAME_FIELD_NUMBER

public static final int CREATIVE_TARGETING_DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

EXPECTED_CREATIVE_COUNT_FIELD_NUMBER

public static final int EXPECTED_CREATIVE_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

SIZE_FIELD_NUMBER

public static final int SIZE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static CreativePlaceholder getDefaultInstance()

Returns
Type	Description
CreativePlaceholder

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static CreativePlaceholder.Builder newBuilder()

Returns
Type	Description
CreativePlaceholder.Builder

newBuilder(CreativePlaceholder prototype)

public static CreativePlaceholder.Builder newBuilder(CreativePlaceholder prototype)

Parameter
Name	Description
prototype	CreativePlaceholder

Returns
Type	Description
CreativePlaceholder.Builder

parseDelimitedFrom(InputStream input)

public static CreativePlaceholder parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativePlaceholder parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static CreativePlaceholder parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreativePlaceholder parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreativePlaceholder parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreativePlaceholder parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreativePlaceholder parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativePlaceholder parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static CreativePlaceholder parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativePlaceholder parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static CreativePlaceholder parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreativePlaceholder parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativePlaceholder

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<CreativePlaceholder> parser()

Returns
Type	Description
Parser<CreativePlaceholder>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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

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

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.

getParserForType()

public Parser<CreativePlaceholder> getParserForType()

Returns
Type	Description
Parser<CreativePlaceholder>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public CreativePlaceholder.Builder newBuilderForType()

Returns
Type	Description
CreativePlaceholder.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CreativePlaceholder.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
CreativePlaceholder.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public CreativePlaceholder.Builder toBuilder()

Returns
Type	Description
CreativePlaceholder.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException