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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the creative template. Format: |
↳ 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 |
↳ interstitial |
bool
Optional. |
↳ native_eligible |
bool
Optional. |
↳ native_video_eligible |
bool
Optional. |
↳ safe_frame_compatible |
bool
Optional. Whether the Creative produced is compatible for SafeFrame rendering. This attribute defaults to |
↳ variables |
array<CreativeTemplateVariable>
Required. The list of creative template variables. |
getName
Identifier. The resource name of the creative template.
Format: networks/{network_code}/creativeTemplates/{creative_template_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the creative template.
Format: networks/{network_code}/creativeTemplates/{creative_template_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of the creative template. This has a maximum length of 255 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Required. The display name of the creative template. This has a maximum length of 255 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The description of the creative template.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
Optional. The description of the creative template.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSnippet
Required. The code snippet of the creative template, with placeholders for the associated variables.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSnippet
clearSnippet
setSnippet
Required. The code snippet of the creative template, with placeholders for the associated variables.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The status of the creative template. This attribute is assigned by Google.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasStatus
clearStatus
setStatus
Output only. The status of the creative template. This attribute is assigned by Google.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Optional. The type of the creative template. Users can only create or
update CreativeTemplateType.CUSTOM templates.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasType
clearType
setType
Optional. The type of the creative template. Users can only create or
update CreativeTemplateType.CUSTOM templates.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNativeEligible
Optional. True if this creative template produces native-eligible
creatives.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasNativeEligible
clearNativeEligible
setNativeEligible
Optional. True if this creative template produces native-eligible
creatives.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNativeVideoEligible
Optional. True if this creative template produces native video-eligible
creatives.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasNativeVideoEligible
clearNativeVideoEligible
setNativeVideoEligible
Optional. True if this creative template produces native video-eligible
creatives.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSafeFrameCompatible
Optional. Whether the Creative produced is compatible for SafeFrame
rendering. This attribute defaults to True.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasSafeFrameCompatible
clearSafeFrameCompatible
setSafeFrameCompatible
Optional. Whether the Creative produced is compatible for SafeFrame
rendering. This attribute defaults to True.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVariables
Required. The list of creative template variables.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setVariables
Required. The list of creative template variables.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CreativeTemplateVariable>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|