type CreativeTemplateError (v202411)

  • CreativeTemplateError is a catch-all error for generic issues related to Creative Templates.

  • It includes inherited ApiError fields like fieldPath and trigger, as well as its own reason field.

  • The reason field is an enum that specifies various errors such as malformed XML, duplicate variable names, invalid characters, and issues with list variables or target platforms.

  • Other potential errors include unrecognized or unused placeholders in the formatter, or a missing interstitial macro for interstitial templates.
Service
CreativeService CreativeSetService CreativeTemplateService LineItemCreativeAssociationService NativeStyleService
Inheritance
ApiError
▼
ApiVersionError AssetError AuthenticationError CollectionSizeError CommonError CreativeAssetMacroError CreativeError CreativeSetError CreativeTemplateError CreativeTemplateOperationError CustomCreativeError CustomFieldValueError EntityLimitReachedError FeatureError FileError HtmlBundleProcessorError ImageError InternalApiError InvalidPhoneNumberError InvalidUrlError LabelEntityAssociationError LineItemCreativeAssociation... NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError RichMediaStudioCreativeError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError SwiffyConversionError TemplateInstantiatedCreativ... TranscodingError TypeError UniqueError

A catch-all error that lists all generic errors associated with CreativeTemplate.

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

Field
ApiError (inherited)

fieldPath

xsd:string

The OGNL field path to identify cause of error.

fieldPathElements

FieldPathElement[]

A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.

trigger

xsd:string

The data that caused the error.

errorString

xsd:string

A simple string representation of the error and reason.

CreativeTemplateError

reason

CreativeTemplateError.Reason

The error reason represented by an enum.

Enumerations
CANNOT_PARSE_CREATIVE_TEMPLATE
The XML of the creative template definition is malformed and cannot be parsed.
VARIABLE_DUPLICATE_UNIQUE_NAME
A creative template has multiple variables with the same uniqueName.
VARIABLE_INVALID_UNIQUE_NAME
The creative template contains a variable with invalid characters. Valid characters are letters, numbers, spaces, forward slashes, dashes, and underscores.
LIST_CHOICE_DUPLICATE_VALUE
Multiple choices for a CreativeTemplateListStringVariable have the same value.
LIST_CHOICE_NEEDS_DEFAULT
The choices for a CreativeTemplateListStringVariable do not contain the default value.
LIST_CHOICES_EMPTY
There are no choices specified for the list variable.
NO_TARGET_PLATFORMS
No target platform is assigned to a creative template.
MULTIPLE_TARGET_PLATFORMS
More than one target platform is assigned to a single creative template.
UNRECOGNIZED_PLACEHOLDER
The formatter contains a placeholder which is not defined as a variable.
PLACEHOLDERS_NOT_IN_FORMATTER
There are variables defined which are not being used in the formatter.
MISSING_INTERSTITIAL_MACRO
The creative template is interstitial, but the formatter doesn't contain an interstitial macro.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.