com.google.api.ads.dfp.axis.v201306

Class ListStringCreativeTemplateVariable

java.lang.Object

com.google.api.ads.dfp.axis.v201306.CreativeTemplateVariable

com.google.api.ads.dfp.axis.v201306.StringCreativeTemplateVariable

com.google.api.ads.dfp.axis.v201306.ListStringCreativeTemplateVariable

All Implemented Interfaces:

Serializable

public class ListStringCreativeTemplateVariable
extends StringCreativeTemplateVariable
implements Serializable

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 TemplateCreative from the TemplateCreative.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListStringCreativeTemplateVariable()
ListStringCreativeTemplateVariable(String label, String uniqueName, String description, Boolean isRequired, String creativeTemplateVariableType, String defaultValue, ListStringCreativeTemplateVariableVariableChoice[] choices, Boolean allowOtherChoice)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllowOtherChoice() Gets the allowOtherChoice value for this ListStringCreativeTemplateVariable.
ListStringCreativeTemplateVariableVariableChoice[]	getChoices() Gets the choices value for this ListStringCreativeTemplateVariable.
ListStringCreativeTemplateVariableVariableChoice	getChoices(int i)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAllowOtherChoice(Boolean allowOtherChoice) Sets the allowOtherChoice value for this ListStringCreativeTemplateVariable.
void	setChoices(int i, ListStringCreativeTemplateVariableVariableChoice _value)
void	setChoices(ListStringCreativeTemplateVariableVariableChoice[] choices) Sets the choices value for this ListStringCreativeTemplateVariable.

Methods inherited from class com.google.api.ads.dfp.axis.v201306.StringCreativeTemplateVariable

getDefaultValue, setDefaultValue

Methods inherited from class com.google.api.ads.dfp.axis.v201306.CreativeTemplateVariable

getCreativeTemplateVariableType, getDescription, getIsRequired, getLabel, getUniqueName, setCreativeTemplateVariableType, setDescription, setIsRequired, setLabel, setUniqueName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListStringCreativeTemplateVariable

public ListStringCreativeTemplateVariable()

ListStringCreativeTemplateVariable

public ListStringCreativeTemplateVariable(String label,
                                  String uniqueName,
                                  String description,
                                  Boolean isRequired,
                                  String creativeTemplateVariableType,
                                  String defaultValue,
                                  ListStringCreativeTemplateVariableVariableChoice[] choices,
                                  Boolean allowOtherChoice)

Method Detail

getChoices

public ListStringCreativeTemplateVariableVariableChoice[] getChoices()

Gets the choices value for this ListStringCreativeTemplateVariable.

Returns:

choices * The values within the list users need to select from.

setChoices

public void setChoices(ListStringCreativeTemplateVariableVariableChoice[] choices)

Sets the choices value for this ListStringCreativeTemplateVariable.

Parameters:

choices - * The values within the list users need to select from.

getChoices

public ListStringCreativeTemplateVariableVariableChoice getChoices(int i)

setChoices

public void setChoices(int i,
              ListStringCreativeTemplateVariableVariableChoice _value)

getAllowOtherChoice

public Boolean getAllowOtherChoice()

Gets the allowOtherChoice value for this ListStringCreativeTemplateVariable.

Returns:

allowOtherChoice * true if a user can specifiy 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.

setAllowOtherChoice

public void setAllowOtherChoice(Boolean allowOtherChoice)

Sets the allowOtherChoice value for this ListStringCreativeTemplateVariable.

Parameters:

allowOtherChoice - * true if a user can specifiy 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.

equals

public boolean equals(Object obj)

Overrides:

equals in class StringCreativeTemplateVariable

hashCode

public int hashCode()

Overrides:

hashCode in class StringCreativeTemplateVariable

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                Class _javaType,
                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                    Class _javaType,
                                                    QName _xmlType)

Get Custom Deserializer