public static final class CreativeTemplateVariable.ListStringCreativeTemplateVariable extends GeneratedMessage 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
Inherited Members
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)
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()
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()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder newBuilder()
newBuilder(CreativeTemplateVariable.ListStringCreativeTemplateVariable prototype)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder newBuilder(CreativeTemplateVariable.ListStringCreativeTemplateVariable prototype)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseDelimitedFrom(InputStream input)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(CodedInputStream input)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(InputStream input)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreativeTemplateVariable.ListStringCreativeTemplateVariable parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CreativeTemplateVariable.ListStringCreativeTemplateVariable> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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
|
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];
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
|
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()
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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public CreativeTemplateVariable.ListStringCreativeTemplateVariable.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
