com.google.api.ads.adwords.v201109.cm
Class TemplateAd

java.lang.Object
  com.google.api.ads.adwords.v201109.cm.Ad
      com.google.api.ads.adwords.v201109.cm.TemplateAd

All Implemented Interfaces:

Serializable

public class TemplateAd
extends Ad
implements Serializable

Represents a Display Ad Builder template ad. A template ad is composed of a template (specified by its ID) and the data that populates the template's fields. For a list of available templates and their required fields, see the Template Ads appendix.

See Also:

Serialized Form

Constructor Summary

TemplateAd()

TemplateAd(Long id, String url, String displayUrl, AdApprovalStatus approvalStatus, String[] disapprovalReasons, Boolean trademarkDisapproved, String adType, Long templateId, AdUnionId adUnionId, TemplateElement[] templateElements, Dimensions dimensions, String name, Integer duration)

Method Summary

boolean	equals(Object obj)
AdUnionId	getAdUnionId() Gets the adUnionId value for this TemplateAd.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Dimensions	getDimensions() Gets the dimensions value for this TemplateAd.
Integer	getDuration() Gets the duration value for this TemplateAd.
String	getName() Gets the name value for this TemplateAd.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
TemplateElement[]	getTemplateElements() Gets the templateElements value for this TemplateAd.
TemplateElement	getTemplateElements(int i)
Long	getTemplateId() Gets the templateId value for this TemplateAd.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAdUnionId(AdUnionId adUnionId) Sets the adUnionId value for this TemplateAd.
void	setDimensions(Dimensions dimensions) Sets the dimensions value for this TemplateAd.
void	setDuration(Integer duration) Sets the duration value for this TemplateAd.
void	setName(String name) Sets the name value for this TemplateAd.
void	setTemplateElements(int i, TemplateElement _value)
void	setTemplateElements(TemplateElement[] templateElements) Sets the templateElements value for this TemplateAd.
void	setTemplateId(Long templateId) Sets the templateId value for this TemplateAd.

Methods inherited from class com.google.api.ads.adwords.v201109.cm.Ad

getAdType, getApprovalStatus, getDisapprovalReasons, getDisapprovalReasons, getDisplayUrl, getId, getTrademarkDisapproved, getUrl, setAdType, setApprovalStatus, setDisapprovalReasons, setDisapprovalReasons, setDisplayUrl, setId, setTrademarkDisapproved, setUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateAd

public TemplateAd()

TemplateAd

public TemplateAd(Long id,
                  String url,
                  String displayUrl,
                  AdApprovalStatus approvalStatus,
                  String[] disapprovalReasons,
                  Boolean trademarkDisapproved,
                  String adType,
                  Long templateId,
                  AdUnionId adUnionId,
                  TemplateElement[] templateElements,
                  Dimensions dimensions,
                  String name,
                  Integer duration)

Method Detail

getTemplateId

public Long getTemplateId()

Gets the templateId value for this TemplateAd.

Returns:

templateId * ID of the template to use. This field can be selected using the value "TemplateId".

setTemplateId

public void setTemplateId(Long templateId)

Sets the templateId value for this TemplateAd.

Parameters:

templateId - * ID of the template to use. This field can be selected using the value "TemplateId".

getAdUnionId

public AdUnionId getAdUnionId()

Gets the adUnionId value for this TemplateAd.

Returns:

adUnionId * Group ID of all template ads, which should be created together. Template ads in the same union reference the same data but have different dimensions. Single ads do not have a union ID. If a template ad specifies an ad union with only one ad, no union will be created. This field can be selected using the value "TemplateAdUnionId".

setAdUnionId

public void setAdUnionId(AdUnionId adUnionId)

Sets the adUnionId value for this TemplateAd.

Parameters:

adUnionId - * Group ID of all template ads, which should be created together. Template ads in the same union reference the same data but have different dimensions. Single ads do not have a union ID. If a template ad specifies an ad union with only one ad, no union will be created. This field can be selected using the value "TemplateAdUnionId".

getTemplateElements

public TemplateElement[] getTemplateElements()

Gets the templateElements value for this TemplateAd.

Returns:

templateElements * List of elements (each containing a set of fields) for the template referenced by templateId. See the Template Ads appendix for the elements and fields required for each template.

setTemplateElements

public void setTemplateElements(TemplateElement[] templateElements)

Sets the templateElements value for this TemplateAd.

Parameters:

templateElements - * List of elements (each containing a set of fields) for the template referenced by templateId. See the Template Ads appendix for the elements and fields required for each template.

getTemplateElements

public TemplateElement getTemplateElements(int i)

setTemplateElements

public void setTemplateElements(int i,
                                TemplateElement _value)

getDimensions

public Dimensions getDimensions()

Gets the dimensions value for this TemplateAd.

Returns:

dimensions * The dimensions for this ad.

setDimensions

public void setDimensions(Dimensions dimensions)

Sets the dimensions value for this TemplateAd.

Parameters:

dimensions - * The dimensions for this ad.

getName

public String getName()

Gets the name value for this TemplateAd.

Returns:

name * Name of this ad. This field can be selected using the value "TemplateAdName". This field is required and should not be null.

setName

public void setName(String name)

Sets the name value for this TemplateAd.

Parameters:

name - * Name of this ad. This field can be selected using the value "TemplateAdName". This field is required and should not be null.

getDuration

public Integer getDuration()

Gets the duration value for this TemplateAd.

Returns:

duration * Duration of this ad (if it contains playable media). This field can be selected using the value "TemplateAdDuration". This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setDuration

public void setDuration(Integer duration)

Sets the duration value for this TemplateAd.

Parameters:

duration - * Duration of this ad (if it contains playable media). This field can be selected using the value "TemplateAdDuration". This field is read only and should not be set. If this field is sent to the API, it will be ignored.

equals

public boolean equals(Object obj)

Overrides:

equals in class Ad

hashCode

public int hashCode()

Overrides:

hashCode in class Ad

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