Class CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder (0.39.0)

public static final class CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder extends GeneratedMessageV3.Builder<CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

Static Methods

getDescriptor()

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

Methods

addAllChoices(Iterable<? extends CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice> values)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder addAllChoices(Iterable<? extends CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice> values)

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
values Iterable<? extends com.google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice>
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

addChoices(CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice value)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder addChoices(CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice value)

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
value CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

addChoices(CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder builderForValue)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder addChoices(CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder builderForValue)

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
builderForValue CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

addChoices(int index, CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice value)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder addChoices(int index, CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice value)

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

Parameters
Name Description
index int
value CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

addChoices(int index, CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder builderForValue)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder addChoices(int index, CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

addChoicesBuilder()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder addChoicesBuilder()

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
CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder

addChoicesBuilder(int index)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder addChoicesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder clear()
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder
Overrides

clearAllowOtherChoice()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder clearAllowOtherChoice()

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

This builder for chaining.

clearChoices()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder clearChoices()

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

clearDefaultValue()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder clearDefaultValue()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSampleValue()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder clearSampleValue()

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

This builder for chaining.

clone()

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder clone()
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder
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

getChoicesBuilder(int index)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder getChoicesBuilder(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.Builder

getChoicesBuilderList()

public List<CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder> getChoicesBuilderList()

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

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreativeTemplateVariable.ListStringCreativeTemplateVariable other)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder mergeFrom(CreativeTemplateVariable.ListStringCreativeTemplateVariable other)
Parameter
Name Description
other CreativeTemplateVariable.ListStringCreativeTemplateVariable
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeChoices(int index)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder removeChoices(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.Builder

setAllowOtherChoice(boolean value)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder setAllowOtherChoice(boolean value)

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

Parameter
Name Description
value boolean

The allowOtherChoice to set.

Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

This builder for chaining.

setChoices(int index, CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice value)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder setChoices(int index, CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice value)

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

Parameters
Name Description
index int
value CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

setChoices(int index, CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder builderForValue)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder setChoices(int index, CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue CreativeTemplateVariable.ListStringCreativeTemplateVariable.VariableChoice.Builder
Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

setDefaultValue(String value)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder setDefaultValue(String value)

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

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

Parameter
Name Description
value String

The defaultValue to set.

Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

This builder for chaining.

setDefaultValueBytes(ByteString value)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder setDefaultValueBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for defaultValue to set.

Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSampleValue(String value)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder setSampleValue(String value)

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

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

Parameter
Name Description
value String

The sampleValue to set.

Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

This builder for chaining.

setSampleValueBytes(ByteString value)

public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder setSampleValueBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for sampleValue to set.

Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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