com.google.api.ads.adwords.jaxws.v201809.cm

Class TemplateAd

java.lang.Object

com.google.api.ads.adwords.jaxws.v201809.cm.Ad

com.google.api.ads.adwords.jaxws.v201809.cm.TemplateAd

public class TemplateAd
extends Ad

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 Template Ads. This is disabled for AdX when it is contained within Operators: ADD, SET.

Java class for TemplateAd complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="TemplateAd">
   <complexContent>
     <extension base="{https://adwords.google.com/api/adwords/cm/v201809}Ad">
       <sequence>
         <element name="templateId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="adUnionId" type="{https://adwords.google.com/api/adwords/cm/v201809}AdUnionId" minOccurs="0"/>
         <element name="templateElements" type="{https://adwords.google.com/api/adwords/cm/v201809}TemplateElement" maxOccurs="unbounded" minOccurs="0"/>
         <element name="adAsImage" type="{https://adwords.google.com/api/adwords/cm/v201809}Image" minOccurs="0"/>
         <element name="dimensions" type="{https://adwords.google.com/api/adwords/cm/v201809}Dimensions" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="duration" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="originAdId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected Image	adAsImage
protected AdUnionId	adUnionId
protected Dimensions	dimensions
protected Integer	duration
protected String	name
protected Long	originAdId
protected List<TemplateElement>	templateElements
protected Long	templateId

Fields inherited from class com.google.api.ads.adwords.jaxws.v201809.cm.Ad

adType, automated, devicePreference, displayUrl, finalAppUrls, finalMobileUrls, finalUrls, finalUrlSuffix, id, systemManagedEntitySource, trackingUrlTemplate, type, url, urlCustomParameters, urlData

Constructor Summary

Constructors

Constructor and Description
TemplateAd()

Method Summary

Modifier and Type	Method and Description
Image	getAdAsImage() Gets the value of the adAsImage property.
AdUnionId	getAdUnionId() Gets the value of the adUnionId property.
Dimensions	getDimensions() Gets the value of the dimensions property.
Integer	getDuration() Gets the value of the duration property.
String	getName() Gets the value of the name property.
Long	getOriginAdId() Gets the value of the originAdId property.
List<TemplateElement>	getTemplateElements() Gets the value of the templateElements property.
Long	getTemplateId() Gets the value of the templateId property.
void	setAdAsImage(Image value) Sets the value of the adAsImage property.
void	setAdUnionId(AdUnionId value) Sets the value of the adUnionId property.
void	setDimensions(Dimensions value) Sets the value of the dimensions property.
void	setDuration(Integer value) Sets the value of the duration property.
void	setName(String value) Sets the value of the name property.
void	setOriginAdId(Long value) Sets the value of the originAdId property.
void	setTemplateId(Long value) Sets the value of the templateId property.

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

getAdType, getDevicePreference, getDisplayUrl, getFinalAppUrls, getFinalMobileUrls, getFinalUrls, getFinalUrlSuffix, getId, getSystemManagedEntitySource, getTrackingUrlTemplate, getType, getUrl, getUrlCustomParameters, getUrlData, isAutomated, setAdType, setAutomated, setDevicePreference, setDisplayUrl, setFinalUrlSuffix, setId, setSystemManagedEntitySource, setTrackingUrlTemplate, setType, setUrl, setUrlCustomParameters

Methods inherited from class java.lang.Object

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

Field Detail

templateId

protected Long templateId

adUnionId

protected AdUnionId adUnionId

templateElements

protected List<TemplateElement> templateElements

adAsImage

protected Image adAsImage

dimensions

protected Dimensions dimensions

name

protected String name

duration

protected Integer duration

originAdId

protected Long originAdId

Constructor Detail

TemplateAd

public TemplateAd()

Method Detail

getTemplateId

public Long getTemplateId()

Gets the value of the templateId property.

Returns:

possible object is Long

setTemplateId

public void setTemplateId(Long value)

Sets the value of the templateId property.

Parameters:

value - allowed object is Long

getAdUnionId

public AdUnionId getAdUnionId()

Gets the value of the adUnionId property.

Returns:

possible object is AdUnionId

setAdUnionId

public void setAdUnionId(AdUnionId value)

Sets the value of the adUnionId property.

Parameters:

value - allowed object is AdUnionId

getTemplateElements

public List<TemplateElement> getTemplateElements()

Gets the value of the templateElements property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the templateElements property.

For example, to add a new item, do as follows:

    getTemplateElements().add(newItem);
 

Objects of the following type(s) are allowed in the list TemplateElement

getAdAsImage

public Image getAdAsImage()

Gets the value of the adAsImage property.

Returns:

possible object is Image

setAdAsImage

public void setAdAsImage(Image value)

Sets the value of the adAsImage property.

Parameters:

value - allowed object is Image

getDimensions

public Dimensions getDimensions()

Gets the value of the dimensions property.

Returns:

possible object is Dimensions

setDimensions

public void setDimensions(Dimensions value)

Sets the value of the dimensions property.

Parameters:

value - allowed object is Dimensions

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getDuration

public Integer getDuration()

Gets the value of the duration property.

Returns:

possible object is Integer

setDuration

public void setDuration(Integer value)

Sets the value of the duration property.

Parameters:

value - allowed object is Integer

getOriginAdId

public Long getOriginAdId()

Gets the value of the originAdId property.

Returns:

possible object is Long

setOriginAdId

public void setOriginAdId(Long value)

Sets the value of the originAdId property.

Parameters:

value - allowed object is Long