Docs For Class awTemplateAd

Description

Represents a <a href=

"http://www.google.com/adwords/displaynetwork/plan-creative-campaigns/display-ad-builder.html" >Display Ad Builder</a> 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 <a href= "/apis/adwords/docs/appendix/templateads.html">Template Ads appendix</a>.

copyright: Mirchev Ideas Ltd. © 2011
link: http://code.google.com/apis/adwords/docs/reference/v201109/MutateJobService.TemplateAd.html

Located in /classes/cm/TemplateAd.php

awComplexObject
   |
   --awAd
      |
      --awTemplateAd

Variable Summary

awAdUnionId $adUnionId

awDimensions $dimensions

int $duration

string $name

awTemplateElement[] $templateElements

long $templateId

mixed $_checkFields

Method Summary

void getRow ()

Variables

awAdUnionId $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".

awDimensions $dimensions

The dimensions for this ad.

int $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.

string $name

Name of this ad.

This field can be selected using the value "TemplateAdName". This field is required and should not be {@code null}.

awTemplateElement[] $templateElements

List of elements (each containing a set of fields) for the template referenced by {@code templateId}. See the <a href="/apis/adwords/docs/appendix/templateads.html">Template Ads appendix</a> for the elements and fields required for each template.

long $templateId

ID of the template to use.

This field can be selected using the value "TemplateId".

mixed $_checkFields = array(
'adUnionId' => array(
'objName' => 'awAdUnionId',
'type' => 'obj'
),'templateElements'=>array('objName'=>'awTemplateElement','type'=>'array'),'dimensions'=>array('objName'=>'awDimensions','type'=>'obj'),)

access: public

Redefinition of:

awComplexObject::$_checkFields

Inherited Variables

Inherited from awAd

awAd::$approvalStatus
awAd::$disapprovalReasons
awAd::$displayUrl
awAd::$id
awAd::$trademarkDisapproved
awAd::$url

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
awComplexObject::$_row

Methods

access: public

void getRow ()

Redefinition of:

awComplexObject::getRow()

Inherited Methods

Inherited From awAd

awAd::factory()

Inherited From awComplexObject

awComplexObject::__construct()
awComplexObject::factory()
awComplexObject::get()
awComplexObject::getAsObj()
awComplexObject::getCheckFields()
awComplexObject::getRow()
awComplexObject::getSoapVars()
awComplexObject::getXml()
awComplexObject::isEmpty()
awComplexObject::remove()
awComplexObject::set()
awComplexObject::setRow()