type CreativeTemplateError (v202411)
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.
|
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-11-19 UTC.
[null,null,["Last updated 2024-11-19 UTC."],[[["CreativeTemplateError is a generic error encompassing issues related to Creative Templates in Google Ad Manager."],["It covers various reasons like malformed XML, duplicate variable names, invalid characters in variables, issues with list choices, missing target platforms, and unrecognized placeholders."],["The error provides details such as the field path, trigger, and a string representation of the error for debugging."],["Reasons for the error are represented by the `CreativeTemplateError.Reason` enum, which includes values like `CANNOT_PARSE_CREATIVE_TEMPLATE`, `VARIABLE_DUPLICATE_UNIQUE_NAME`, and others."],["Developers can use the information provided in the error to identify and resolve the specific issue with their creative templates."]]],["The content details error handling within various services related to ad creatives, including `CreativeService`, `CreativeSetService`, `CreativeTemplateService`, and `NativeStyleService`. It outlines `CreativeTemplateError`, a catch-all for errors related to creative templates, listing specific error reasons via an enum. Error causes include malformed XML, duplicate/invalid variable names, incorrect list choices, missing/multiple target platforms, and incorrect formatting. `ApiError` fields include `fieldPath`, `trigger`, and `errorString`.\n"]]
