- Resource: CreativeTemplate
- CreativeTemplateStatus
- CreativeTemplateType
- CreativeTemplateVariable
- AssetCreativeTemplateVariable
- MimeType
- ListStringCreativeTemplateVariable
- VariableChoice
- LongCreativeTemplateVariable
- StringCreativeTemplateVariable
- UrlCreativeTemplateVariable
- CreativeTemplateVariableUrlType
- Methods
Resource: CreativeTemplate
A template that can be used to create a [TemplateCreative][].
JSON representation |
---|
{ "name": string, "variables": [ { object ( |
Fields | |
---|---|
name |
Identifier. The resource name of the creative template. Format: |
variables[] |
Required. The list of creative template variables. |
displayName |
Required. The display name of the creative template. This has a maximum length of 255 characters. |
description |
Optional. The description of the creative template. |
snippet |
Required. The code snippet of the creative template, with placeholders for the associated variables. |
status |
Output only. The status of the creative template. This attribute is assigned by Google. |
type |
Optional. The type of the creative template. Users can only create or update |
interstitial |
Optional. |
nativeEligible |
Optional. |
nativeVideoEligible |
Optional. |
safeFrameCompatible |
Optional. Whether the Creative produced is compatible for SafeFrame rendering. This attribute defaults to |
CreativeTemplateStatus
Describes status of the creative template
Enums | |
---|---|
CREATIVE_TEMPLATE_STATUS_UNSPECIFIED |
Default value. This value is unused. |
ACTIVE |
The CreativeTemplate is active |
DELETED |
The CreativeTemplate is deleted. Creatives created from this CreativeTemplate can no longer serve. |
INACTIVE |
The CreativeTemplate is inactive. Users cannot create new creatives from this template, but existing ones can be edited and continue to serve |
CreativeTemplateType
Describes type of the creative template.
Enums | |
---|---|
CREATIVE_TEMPLATE_TYPE_UNSPECIFIED |
Default value. This value is unused. |
STANDARD |
Creative templates that are included in Ad Manager by default. |
CUSTOM |
Creative templates created by an administrator or other user in the network. |
CreativeTemplateVariable
Represents a variable defined in a creative template.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field SubType . The specific type of variable represented by this CreativeTemplateVariable . Exactly one must be set. SubType can be only one of the following: |
|
assetVariable |
Optional. Represents a file asset variable defined in a creative template. |
listStringVariable |
Optional. Represents a list variable defined in a creative template. |
longVariable |
Optional. Represents a long variable defined in a creative template. |
stringVariable |
Optional. Represents a string variable defined in a creative template. |
urlVariable |
Optional. Represents a url variable defined in a creative template. |
label |
Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters. |
uniqueDisplayName |
Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created. |
description |
Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters. |
required |
Optional. |
AssetCreativeTemplateVariable
Represents a file asset variable defined in a creative template.
Use [AssetCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a CreativeTemplate
.
JSON representation |
---|
{
"mimeTypes": [
enum ( |
Fields | |
---|---|
mimeTypes[] |
Optional. The set of allowed MIME types. If unspecified, all MIME types are allowed. |
MimeType
Different MIME types that the asset variable supports.
Enums | |
---|---|
MIME_TYPE_UNSPECIFIED |
Default value. This value is unused. |
JPG |
The image/jpeg MIME type. |
PNG |
The image/png MIME type. |
GIF |
The image/gif MIME type. |
ListStringCreativeTemplateVariable
Represents a list variable defined in a creative template. This is similar to StringCreativeTemplateVariable
, except that there are possible choices to choose from.
Use [StringCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a CreativeTemplate
.
JSON representation |
---|
{
"choices": [
{
object ( |
Fields | |
---|---|
choices[] |
Optional. The selectable values that the user can choose from. |
defaultValue |
Optional. Default value to be filled in when creating creatives from the creative template. |
sampleValue |
Optional. Sample value that is used when previewing the template in the UI. |
allowOtherChoice |
Optional. |
VariableChoice
Stores variable choices selectable by users.
JSON representation |
---|
{ "label": string, "value": string } |
Fields | |
---|---|
label |
Required. A label is displayed to users when creating a [TemplateCreative][]. This attribute is intended to be more descriptive than value. This attribute has a maximum length of 255 characters. |
value |
Required. When creating a [TemplateCreative][], the value in [StringCreativeTemplateVariableValue][] should match this value, if you intend to select this value. This attribute has a maximum length of 255 characters. |
LongCreativeTemplateVariable
Represents a long variable defined in a creative template.
Use [LongCreativeTemplateVariableValue][] to specify the value for this variable when creating [TemplateCreative][] from a CreativeTemplate
.
JSON representation |
---|
{ "defaultValue": string, "sampleValue": string } |
Fields | |
---|---|
defaultValue |
Optional. Default value to be filled in when creating creatives from the creative template. |
sampleValue |
Optional. Sample value that is used when previewing the template in the UI. |
StringCreativeTemplateVariable
Represents a string variable defined in a creative template.
Use [StringCreativeTemplateVariableValue][] to specify the value for this variable when creating [TemplateCreative][] from a CreativeTemplate
.
JSON representation |
---|
{ "defaultValue": string, "sampleValue": string } |
Fields | |
---|---|
defaultValue |
Optional. Default value to be filled in when creating creatives from the creative template. |
sampleValue |
Optional. Sample value that is used when previewing the template in the UI. |
UrlCreativeTemplateVariable
Represents a url variable defined in a creative template.
Use [UrlCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a CreativeTemplate
.
JSON representation |
---|
{
"defaultValue": string,
"sampleValue": string,
"urlType": enum ( |
Fields | |
---|---|
defaultValue |
Optional. Default value to be filled in when creating creatives from the creative template. |
sampleValue |
Optional. Sample value that is used when previewing the template in the UI. |
urlType |
Optional. The type of URL that this variable represents. Different types of URLs may be handled differently at rendering time. |
CreativeTemplateVariableUrlType
Types of URLs that a UrlCreativeTemplateVariable can represent.
Enums | |
---|---|
CREATIVE_TEMPLATE_VARIABLE_URL_TYPE_UNSPECIFIED |
Default value. This value is unused. |
CLICK_TRACKER |
Click tracking URL. |
DEEPLINK |
Deep-link URL. |
IMPRESSION_TRACKER |
Impression tracking URL. |
STANDARD_HTTP |
Standard HTTP URL. |
Methods |
|
---|---|
|
API to retrieve a CreativeTemplate object. |
|
API to retrieve a list of CreativeTemplate objects. |