Class CreativeTemplateVariable (0.39.0)

Version latest

• 0.39.0 (latest)
• 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 CreativeTemplateVariable extends GeneratedMessageV3 implements CreativeTemplateVariableOrBuilder

Represents a variable defined in a creative template.

Protobuf type google.ads.admanager.v1.CreativeTemplateVariable

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CreativeTemplateVariable

Implements

CreativeTemplateVariableOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ASSET_VARIABLE_FIELD_NUMBER

public static final int ASSET_VARIABLE_FIELD_NUMBER

Field Value
Type	Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

Field Value
Type	Description
int

LIST_STRING_VARIABLE_FIELD_NUMBER

public static final int LIST_STRING_VARIABLE_FIELD_NUMBER

Field Value
Type	Description
int

LONG_VARIABLE_FIELD_NUMBER

public static final int LONG_VARIABLE_FIELD_NUMBER

Field Value
Type	Description
int

REQUIRED_FIELD_NUMBER

public static final int REQUIRED_FIELD_NUMBER

Field Value
Type	Description
int

STRING_VARIABLE_FIELD_NUMBER

public static final int STRING_VARIABLE_FIELD_NUMBER

Field Value
Type	Description
int

UNIQUE_DISPLAY_NAME_FIELD_NUMBER

public static final int UNIQUE_DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

URL_VARIABLE_FIELD_NUMBER

public static final int URL_VARIABLE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static CreativeTemplateVariable getDefaultInstance()

Returns
Type	Description
CreativeTemplateVariable

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static CreativeTemplateVariable.Builder newBuilder()

Returns
Type	Description
CreativeTemplateVariable.Builder

newBuilder(CreativeTemplateVariable prototype)

public static CreativeTemplateVariable.Builder newBuilder(CreativeTemplateVariable prototype)

Parameter
Name	Description
prototype	CreativeTemplateVariable

Returns
Type	Description
CreativeTemplateVariable.Builder

parseDelimitedFrom(InputStream input)

public static CreativeTemplateVariable parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static CreativeTemplateVariable parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreativeTemplateVariable parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreativeTemplateVariable parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static CreativeTemplateVariable parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static CreativeTemplateVariable parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativeTemplateVariable

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<CreativeTemplateVariable> parser()

Returns
Type	Description
Parser<CreativeTemplateVariable>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAssetVariable()

public CreativeTemplateVariable.AssetCreativeTemplateVariable getAssetVariable()

Optional. Represents a file asset variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.AssetCreativeTemplateVariable asset_variable = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.AssetCreativeTemplateVariable	The assetVariable.

getAssetVariableOrBuilder()

public CreativeTemplateVariable.AssetCreativeTemplateVariableOrBuilder getAssetVariableOrBuilder()

Optional. Represents a file asset variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.AssetCreativeTemplateVariable asset_variable = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.AssetCreativeTemplateVariableOrBuilder

getDefaultInstanceForType()

public CreativeTemplateVariable getDefaultInstanceForType()

Returns
Type	Description
CreativeTemplateVariable

getDescription()

public String getDescription()

Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.

optional string description = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.

optional string description = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for description.

getLabel()

public String getLabel()

Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.

optional string label = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The label.

getLabelBytes()

public ByteString getLabelBytes()

Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.

optional string label = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for label.

getListStringVariable()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable getListStringVariable()

Optional. Represents a list variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable list_string_variable = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable	The listStringVariable.

getListStringVariableOrBuilder()

public CreativeTemplateVariable.ListStringCreativeTemplateVariableOrBuilder getListStringVariableOrBuilder()

Optional. Represents a list variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable list_string_variable = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.ListStringCreativeTemplateVariableOrBuilder

getLongVariable()

public CreativeTemplateVariable.LongCreativeTemplateVariable getLongVariable()

Optional. Represents a long variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.LongCreativeTemplateVariable long_variable = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.LongCreativeTemplateVariable	The longVariable.

getLongVariableOrBuilder()

public CreativeTemplateVariable.LongCreativeTemplateVariableOrBuilder getLongVariableOrBuilder()

Optional. Represents a long variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.LongCreativeTemplateVariable long_variable = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.LongCreativeTemplateVariableOrBuilder

getParserForType()

public Parser<CreativeTemplateVariable> getParserForType()

Returns
Type	Description
Parser<CreativeTemplateVariable>

Overrides

GeneratedMessageV3.getParserForType()

getRequired()

public boolean getRequired()

Optional. True if this variable is required to be filled in by users when creating a creative from the creative template.

optional bool required = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The required.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getStringVariable()

public CreativeTemplateVariable.StringCreativeTemplateVariable getStringVariable()

Optional. Represents a string variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.StringCreativeTemplateVariable string_variable = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.StringCreativeTemplateVariable	The stringVariable.

getStringVariableOrBuilder()

public CreativeTemplateVariable.StringCreativeTemplateVariableOrBuilder getStringVariableOrBuilder()

Optional. Represents a string variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.StringCreativeTemplateVariable string_variable = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.StringCreativeTemplateVariableOrBuilder

getSubTypeCase()

public CreativeTemplateVariable.SubTypeCase getSubTypeCase()

Returns
Type	Description
CreativeTemplateVariable.SubTypeCase

getUniqueDisplayName()

public String getUniqueDisplayName()

Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.

optional string unique_display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uniqueDisplayName.

getUniqueDisplayNameBytes()

public ByteString getUniqueDisplayNameBytes()

Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.

optional string unique_display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uniqueDisplayName.

getUrlVariable()

public CreativeTemplateVariable.UrlCreativeTemplateVariable getUrlVariable()

Optional. Represents a url variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.UrlCreativeTemplateVariable url_variable = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.UrlCreativeTemplateVariable	The urlVariable.

getUrlVariableOrBuilder()

public CreativeTemplateVariable.UrlCreativeTemplateVariableOrBuilder getUrlVariableOrBuilder()

Optional. Represents a url variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.UrlCreativeTemplateVariable url_variable = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateVariable.UrlCreativeTemplateVariableOrBuilder

hasAssetVariable()

public boolean hasAssetVariable()

Optional. Represents a file asset variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.AssetCreativeTemplateVariable asset_variable = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the assetVariable field is set.

hasDescription()

public boolean hasDescription()

Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.

optional string description = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the description field is set.

hasLabel()

public boolean hasLabel()

Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.

optional string label = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the label field is set.

hasListStringVariable()

public boolean hasListStringVariable()

Optional. Represents a list variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable list_string_variable = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the listStringVariable field is set.

hasLongVariable()

public boolean hasLongVariable()

Optional. Represents a long variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.LongCreativeTemplateVariable long_variable = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the longVariable field is set.

hasRequired()

public boolean hasRequired()

Optional. True if this variable is required to be filled in by users when creating a creative from the creative template.

optional bool required = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the required field is set.

hasStringVariable()

public boolean hasStringVariable()

Optional. Represents a string variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.StringCreativeTemplateVariable string_variable = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the stringVariable field is set.

hasUniqueDisplayName()

public boolean hasUniqueDisplayName()

Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.

optional string unique_display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the uniqueDisplayName field is set.

hasUrlVariable()

public boolean hasUrlVariable()

Optional. Represents a url variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.UrlCreativeTemplateVariable url_variable = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the urlVariable field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CreativeTemplateVariable.Builder newBuilderForType()

Returns
Type	Description
CreativeTemplateVariable.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreativeTemplateVariable.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
CreativeTemplateVariable.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CreativeTemplateVariable.Builder toBuilder()

Returns
Type	Description
CreativeTemplateVariable.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException