type CreativeTemplateError (v202405)
A catch-all error that lists all generic errors associated with CreativeTemplate.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202405
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-05-15 UTC.
[null,null,["Last updated 2024-05-15 UTC."],[[["CreativeTemplateError is a comprehensive error encompassing generic errors related to CreativeTemplate."],["It inherits from ApiError and provides detailed information about the error, including field path, trigger, and error string."],["CreativeTemplateError uses the `reason` field with the `CreativeTemplateError.Reason` enum to specify the cause of the error."],["Reasons for CreativeTemplateError include issues like malformed XML, duplicate variable names, invalid characters, and missing placeholders."],["The error also addresses platform targeting issues, such as no target platform assigned or multiple target platforms specified for a single template."]]],["The content outlines error handling and services related to creative management. Key services include CreativeService, CreativeSetService, CreativeTemplateService, LineItemCreativeAssociationService, and NativeStyleService. It defines `CreativeTemplateError`, which includes specific error reasons like `CANNOT_PARSE_CREATIVE_TEMPLATE`, `VARIABLE_DUPLICATE_UNIQUE_NAME`, and `UNKNOWN`. The structure details the inherited `ApiError` with fields like `fieldPath`, `trigger`, and `errorString`. Many error types like `AssetError` and `InternalApiError` were mentioned, all related to `CreativeSetService`.\n"]]
