type CreativeWrapperError (v202408)
Errors specific to creative wrappers.
- 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.
|
CreativeWrapperError
|
reason
|
CreativeWrapperError.Reason
The error reason represented by an enum.
Enumerations
-
LABEL_ALREADY_ASSOCIATED_WITH_CREATIVE_WRAPPER
- The label is already associated with a CreativeWrapper.
-
INVALID_LABEL_TYPE
- The label type of a creative wrapper must be LabelType.CREATIVE_WRAPPER.
-
UNRECOGNIZED_MACRO
- A macro used inside the snippet is not recognized.
-
NEITHER_HEADER_NOR_FOOTER_SPECIFIED
- When creating a new creative wrapper, either header or footer should exist.
-
NEITHER_HEADER_NOR_FOOTER_NOR_VIDEO_TRACKING_URLS_SPECIFIED
- Creative wrapper must have either header and/or footer, or video tracking URLs.
-
CANNOT_USE_CREATIVE_WRAPPER_TYPE
- The network has not been enabled for creating labels of type
LabelType.CREATIVE_WRAPPER.
-
CANNOT_UPDATE_LABEL_ID
- Cannot update CreativeWrapper.labelId.
-
CANNOT_APPLY_TO_AD_UNIT_WITH_VIDEO_SIZES
- Cannot apply LabelType.CREATIVE_WRAPPER labels to an ad unit
if it has no descendants with AdUnit.adUnitSizes of
AdUnitSize#environmentType as
EnvironmentType.BROWSER.
-
CANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES
- Cannot apply LabelType.CREATIVE_WRAPPER labels with a CreativeWrapper.VIDEO_TRACKING_URL type to an ad unit if it has no descendants with AdUnit.adUnitSizes of
AdUnitSize#environmentType as EnvironmentType.VIDEO_PLAYER.
-
CANNOT_APPLY_TO_AD_UNIT_WITHOUT_LABEL_ASSOCIATION
- Cannot apply LabelType.CREATIVE_WRAPPER labels to an ad unit if the label is not
associated with a creative wrapper.
-
CANNOT_APPLY_TO_MOBILE_AD_UNIT
- Cannot apply LabelType.CREATIVE_WRAPPER labels to an ad unit
if AdUnit.targetPlatform is of type
TargetPlatform#MOBILE
-
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."],[[["CreativeWrapperError objects represent errors specific to creative wrappers in Google Ad Manager."],["This error type inherits from ApiError and provides details about the error, including field path, trigger, and error string."],["CreativeWrapperError includes a reason field that specifies the cause of the error, such as label type mismatch or macro issues."],["Several reasons are related to applying creative wrapper labels to ad units with or without video sizes, or incorrect label association."],["This error can occur when creating or updating creative wrappers and when applying them to ad units."]]],["The core content outlines the `LabelService` and `CreativeWrapperError` within the ad management API. It details various error types that can occur, such as `ApiError`, `AuthenticationError`, and `LabelError`. The content specifies `CreativeWrapperError` reasons, including issues like an invalid label type, unrecognized macros, missing header or footer, and improper application to ad units with or without video sizes. There are also some limitations with the `LabelType.CREATIVE_WRAPPER`. Field information is included.\n"]]