type CreativeTemplateError (v202408)
A catch-all error that lists all generic errors associated with CreativeTemplate.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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-08-20 UTC.
[null,null,["Last updated 2024-08-20 UTC."],[[["CreativeTemplateError is a comprehensive error type encompassing generic errors related to CreativeTemplate."],["It inherits from ApiError and provides specific reasons for errors through the `reason` field."],["Errors can arise from issues like malformed XML, duplicate variables, invalid characters, and platform assignment problems."],["The `reason` field uses an enumeration to categorize errors such as parsing issues, variable conflicts, list choice problems, platform assignment errors, and placeholder inconsistencies."],["This error type aids in troubleshooting CreativeTemplate-related issues by providing detailed information about the cause of the error."]]],["The content details services and errors within an API, specifically focusing on `CreativeTemplateError`. Services include `CreativeService`, `CreativeSetService`, `CreativeTemplateService`, `LineItemCreativeAssociationService`, and `NativeStyleService`. Errors inherit from `ApiError` and encompass a wide range of issues, like `AuthenticationError`, `CreativeError`, and `QuotaError`. `CreativeTemplateError` itself has reasons such as `CANNOT_PARSE_CREATIVE_TEMPLATE`, `VARIABLE_DUPLICATE_UNIQUE_NAME`, `NO_TARGET_PLATFORMS`, `UNRECOGNIZED_PLACEHOLDER`, and `MISSING_INTERSTITIAL_MACRO`. It provides information about field paths and error causes, and includes an enumerated list of error types.\n"]]
