type ListStringCreativeTemplateVariable (v202411)

  • ListStringCreativeTemplateVariable represents a list variable within a creative template, offering predefined choices for users to select when creating TemplateCreatives.

  • It inherits properties from StringCreativeTemplateVariable and CreativeTemplateVariable, such as label, uniqueName, description, isRequired, and defaultValue.

  • Users can select from predefined choices specified in the choices field when creating TemplateCreatives, and an 'other' option can be enabled using allowOtherChoice.

  • This variable type is used to define list-based options within creative templates, allowing for structured and controlled input when building creatives.

  • The namespace for this object is https://www.google.com/apis/ads/publisher/v202411.

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.


Namespace
https://www.google.com/apis/ads/publisher/v202411

Field

CreativeTemplateVariable (inherited)

label

xsd:string

Label that is displayed to users when creating TemplateCreative from the CreativeTemplate. This attribute is required and has a maximum length of 127 characters.

uniqueName

xsd:string

Unique name used to identify the variable. This attribute is read-only and is assigned by Google, by deriving from label, when a creative template variable is created.

description

xsd:string

A descriptive help text that is displayed to users along with the label. This attribute is required and has a maximum length of 255 characters.

isRequired

xsd:boolean

true if this variable is required to be filled in by users when creating TemplateCreative from the CreativeTemplate.

StringCreativeTemplateVariable (inherited)

defaultValue

xsd:string

Default value to be filled in when creating creatives from the creative template.

ListStringCreativeTemplateVariable

choices

ListStringCreativeTemplateV...[]

The values within the list users need to select from.

allowOtherChoice

xsd:boolean

true if a user can specifiy an 'other' value. For example, if a variable called backgroundColor is defined as a list with values: red, green, blue, this boolean can be set to allow a user to enter a value not on the list such as purple.