Reference documentation and code samples for the Google Ads Ad Manager V1 Client class CreativeTemplate.
A template that can be used to create a TemplateCreative .
Generated from protobuf message google.ads.admanager.v1.CreativeTemplate
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The resource name of the creative template. Format: networks/{network_code}/creativeTemplates/{creative_template_id}
↳ display_name
string
Required. The display name of the creative template. This has a maximum length of 255 characters.
↳ description
string
Optional. The description of the creative template.
↳ snippet
string
Required. The code snippet of the creative template, with placeholders for the associated variables.
↳ status
int
Output only. The status of the creative template. This attribute is assigned by Google.
↳ type
int
Optional. The type of the creative template. Users can only create or update CreativeTemplateType.CUSTOM
templates.
↳ interstitial
bool
Optional. True
if this creative template produces out-of-page creatives. Creative templates with this setting enabled must include the viewed impression macro.
↳ native_eligible
bool
Optional. True
if this creative template produces native-eligible creatives.
↳ native_video_eligible
bool
Optional. True
if this creative template produces native video-eligible creatives.
↳ safe_frame_compatible
bool
Optional. Whether the Creative produced is compatible for SafeFrame rendering. This attribute defaults to True
.
↳ variables
getName
Identifier. The resource name of the creative template.
Format: networks/{network_code}/creativeTemplates/{creative_template_id}
string
setName
Identifier. The resource name of the creative template.
Format: networks/{network_code}/creativeTemplates/{creative_template_id}
var
string
$this
getDisplayName
Required. The display name of the creative template. This has a maximum length of 255 characters.
string
hasDisplayName
clearDisplayName
setDisplayName
Required. The display name of the creative template. This has a maximum length of 255 characters.
var
string
$this
getDescription
Optional. The description of the creative template.
string
hasDescription
clearDescription
setDescription
Optional. The description of the creative template.
var
string
$this
getSnippet
Required. The code snippet of the creative template, with placeholders for the associated variables.
string
hasSnippet
clearSnippet
setSnippet
Required. The code snippet of the creative template, with placeholders for the associated variables.
var
string
$this
getStatus
Output only. The status of the creative template. This attribute is assigned by Google.
int
hasStatus
clearStatus
setStatus
Output only. The status of the creative template. This attribute is assigned by Google.
var
int
$this
getType
Optional. The type of the creative template. Users can only create or
update CreativeTemplateType.CUSTOM
templates.
int
hasType
clearType
setType
Optional. The type of the creative template. Users can only create or
update CreativeTemplateType.CUSTOM
templates.
var
int
$this
getInterstitial
Optional. True
if this creative template produces out-of-page creatives.
Creative templates with this setting enabled must include the viewed impression macro.
bool
hasInterstitial
clearInterstitial
setInterstitial
Optional. True
if this creative template produces out-of-page creatives.
Creative templates with this setting enabled must include the viewed impression macro.
var
bool
$this
getNativeEligible
Optional. True
if this creative template produces native-eligible
creatives.
bool
hasNativeEligible
clearNativeEligible
setNativeEligible
Optional. True
if this creative template produces native-eligible
creatives.
var
bool
$this
getNativeVideoEligible
Optional. True
if this creative template produces native video-eligible
creatives.
bool
hasNativeVideoEligible
clearNativeVideoEligible
setNativeVideoEligible
Optional. True
if this creative template produces native video-eligible
creatives.
var
bool
$this
getSafeFrameCompatible
Optional. Whether the Creative produced is compatible for SafeFrame
rendering. This attribute defaults to True
.
bool
hasSafeFrameCompatible
clearSafeFrameCompatible
setSafeFrameCompatible
Optional. Whether the Creative produced is compatible for SafeFrame
rendering. This attribute defaults to True
.
var
bool
$this
getVariables
Required. The list of creative template variables.
setVariables
Required. The list of creative template variables.
$this
