type CreativeTemplateError (v202402)
A catch-all error that lists all generic errors associated with CreativeTemplate.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202402
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-13 UTC.
[null,null,["Last updated 2024-02-13 UTC."],[[["CreativeTemplateError is a comprehensive error encompassing generic issues related to CreativeTemplate."],["This error arises from problems such as malformed XML in creative template definitions, duplicate or invalid variable names, issues with list choices, and missing or incorrect placeholders."],["It also addresses platform targeting errors, with restrictions on having no target platforms, multiple platforms assigned to a single template, and unrecognized/unused placeholders in formatters."],["Specifically for interstitial creative templates, the error flags instances where the formatter lacks an interstitial macro, essential for proper functionality."],["This error utilizes an enum, `CreativeTemplateError.Reason`, to represent the specific reason for the error, offering detailed insights for debugging and troubleshooting."]]],["The core content outlines the `CreativeTemplateError`, a comprehensive error type within the ad management system. It includes various specific error reasons, such as parsing failures (`CANNOT_PARSE_CREATIVE_TEMPLATE`), duplicate or invalid variable names, issues with list choices, missing or multiple target platforms, unrecognized placeholders, and missing interstitial macros. It details inherited fields like `fieldPath`, `trigger`, and `errorString`, as well as error codes in the namespace, with detailed information of the errors.\n"]]
