com.google.api.ads.dfp.v201111
Class CreativeTemplateVariable

java.lang.Object
  com.google.api.ads.dfp.v201111.CreativeTemplateVariable

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetCreativeTemplateVariable, LongCreativeTemplateVariable, StringCreativeTemplateVariable, UrlCreativeTemplateVariable

public abstract class CreativeTemplateVariable
extends Object
implements Serializable

Represents a variable defined in a creative template.

See Also:

Serialized Form

Constructor Summary

CreativeTemplateVariable()

CreativeTemplateVariable(String label, String uniqueName, String description, Boolean isRequired, String creativeTemplateVariableType)

Method Summary

boolean	equals(Object obj)
String	getCreativeTemplateVariableType() Gets the creativeTemplateVariableType value for this CreativeTemplateVariable.
String	getDescription() Gets the description value for this CreativeTemplateVariable.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Boolean	getIsRequired() Gets the isRequired value for this CreativeTemplateVariable.
String	getLabel() Gets the label value for this CreativeTemplateVariable.
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
String	getUniqueName() Gets the uniqueName value for this CreativeTemplateVariable.
int	hashCode()
void	setCreativeTemplateVariableType(String creativeTemplateVariableType) Sets the creativeTemplateVariableType value for this CreativeTemplateVariable.
void	setDescription(String description) Sets the description value for this CreativeTemplateVariable.
void	setIsRequired(Boolean isRequired) Sets the isRequired value for this CreativeTemplateVariable.
void	setLabel(String label) Sets the label value for this CreativeTemplateVariable.
void	setUniqueName(String uniqueName) Sets the uniqueName value for this CreativeTemplateVariable.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreativeTemplateVariable

public CreativeTemplateVariable()

CreativeTemplateVariable

public CreativeTemplateVariable(String label,
                                String uniqueName,
                                String description,
                                Boolean isRequired,
                                String creativeTemplateVariableType)

Method Detail

getLabel

public String getLabel()

Gets the label value for this CreativeTemplateVariable.

Returns:

label * Label that is displayed to users when creating TemplateCreative from the CreativeTemplate. This attribute is required and has a maximum length of 127 characters.

setLabel

public void setLabel(String label)

Sets the label value for this CreativeTemplateVariable.

Parameters:

label - * Label that is displayed to users when creating TemplateCreative from the CreativeTemplate. This attribute is required and has a maximum length of 127 characters.

getUniqueName

public String getUniqueName()

Gets the uniqueName value for this CreativeTemplateVariable.

Returns:

uniqueName * Unique name used to identify the variable. This attribute is read-only and is assigned by Google, by deriving from label, when a creative template variable is created.

setUniqueName

public void setUniqueName(String uniqueName)

Sets the uniqueName value for this CreativeTemplateVariable.

Parameters:

uniqueName - * Unique name used to identify the variable. This attribute is read-only and is assigned by Google, by deriving from label, when a creative template variable is created.

getDescription

public String getDescription()

Gets the description value for this CreativeTemplateVariable.

Returns:

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

setDescription

public void setDescription(String description)

Sets the description value for this CreativeTemplateVariable.

Parameters:

description - * A descriptive help text that is displayed to users along with the label. This attribute is required and has a maximum length of 255 characters.

getIsRequired

public Boolean getIsRequired()

Gets the isRequired value for this CreativeTemplateVariable.

Returns:

isRequired * true if this variable is required to be filled in by users when creating TemplateCreative from the CreativeTemplate.

setIsRequired

public void setIsRequired(Boolean isRequired)

Sets the isRequired value for this CreativeTemplateVariable.

Parameters:

isRequired - * true if this variable is required to be filled in by users when creating TemplateCreative from the CreativeTemplate.

getCreativeTemplateVariableType

public String getCreativeTemplateVariableType()

Gets the creativeTemplateVariableType value for this CreativeTemplateVariable.

Returns:

creativeTemplateVariableType * Indicates that this instance is a subtype of CreativeTemplateVariable. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

setCreativeTemplateVariableType

public void setCreativeTemplateVariableType(String creativeTemplateVariableType)

Sets the creativeTemplateVariableType value for this CreativeTemplateVariable.

Parameters:

creativeTemplateVariableType - * Indicates that this instance is a subtype of CreativeTemplateVariable. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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