Class CreativeTemplateVariable.ListStringCreativeTemplateVariable (0.39.0)

public static final class CreativeTemplateVariable.ListStringCreativeTemplateVariable extends GeneratedMessageV3 implements CreativeTemplateVariable.ListStringCreativeTemplateVariableOrBuilder

Represents a list variable defined in a creative template. This is similar to StringCreativeTemplateVariable, except that there are possible choices to choose from.

Use [StringCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a CreativeTemplate.

Protobuf type google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable

Inheritance

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

Static Fields

ALLOW_OTHER_CHOICE_FIELD_NUMBER

public static final int ALLOW_OTHER_CHOICE_FIELD_NUMBER
Field Value
Type Description
int

CHOICES_FIELD_NUMBER

public static final int CHOICES_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_VALUE_FIELD_NUMBER

public static final int SAMPLE_VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable getDefaultInstance()
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder newBuilder()
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

newBuilder(CreativeTemplateVariable.ListStringCreativeTemplateVariable prototype)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder newBuilder(CreativeTemplateVariable.ListStringCreativeTemplateVariable prototype)
Parameter
Name Description
prototype CreativeTemplateVariable.ListStringCreativeTemplateVariable
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

parseDelimitedFrom(InputStream input)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreativeTemplateVariable.ListStringCreativeTemplateVariable> parser()
Returns
Type Description
Parser<ListStringCreativeTemplateVariable>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowOtherChoice()

public boolean getAllowOtherChoice()

Optional. True if a user can specify an 'other' value. For example, if a variable called backgroundColor is defined as a list with values: red, green, blue, this boolean can be set to allow a user to enter a value not on the list such as purple.

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

Returns
Type Description
boolean

The allowOtherChoice.

getChoices(int index)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice getChoices(int index)

Optional. The selectable values that the user can choose from.

repeated .google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice choices = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice

getChoicesCount()

public int getChoicesCount()

Optional. The selectable values that the user can choose from.

repeated .google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice choices = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getChoicesList()

public List<CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice> getChoicesList()

Optional. The selectable values that the user can choose from.

repeated .google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice choices = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<VariableChoice>

getChoicesOrBuilder(int index)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoiceOrBuilder getChoicesOrBuilder(int index)

Optional. The selectable values that the user can choose from.

repeated .google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice choices = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoiceOrBuilder

getChoicesOrBuilderList()

public List<? extends CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoiceOrBuilder> getChoicesOrBuilderList()

Optional. The selectable values that the user can choose from.

repeated .google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice choices = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoiceOrBuilder>

getDefaultInstanceForType()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable getDefaultInstanceForType()
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable

getDefaultValue()

public String getDefaultValue()

Optional. Default value to be filled in when creating creatives from the creative template.

optional string default_value = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The defaultValue.

getDefaultValueBytes()

public ByteString getDefaultValueBytes()

Optional. Default value to be filled in when creating creatives from the creative template.

optional string default_value = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for defaultValue.

getParserForType()

public Parser<CreativeTemplateVariable.ListStringCreativeTemplateVariable> getParserForType()
Returns
Type Description
Parser<ListStringCreativeTemplateVariable>
Overrides

getSampleValue()

public String getSampleValue()

Optional. Sample value that is used when previewing the template in the UI.

optional string sample_value = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sampleValue.

getSampleValueBytes()

public ByteString getSampleValueBytes()

Optional. Sample value that is used when previewing the template in the UI.

optional string sample_value = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sampleValue.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAllowOtherChoice()

public boolean hasAllowOtherChoice()

Optional. True if a user can specify an 'other' value. For example, if a variable called backgroundColor is defined as a list with values: red, green, blue, this boolean can be set to allow a user to enter a value not on the list such as purple.

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

Returns
Type Description
boolean

Whether the allowOtherChoice field is set.

hasDefaultValue()

public boolean hasDefaultValue()

Optional. Default value to be filled in when creating creatives from the creative template.

optional string default_value = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the defaultValue field is set.

hasSampleValue()

public boolean hasSampleValue()

Optional. Sample value that is used when previewing the template in the UI.

optional string sample_value = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sampleValue field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder newBuilderForType()
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder toBuilder()
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException