type CreativeWrapperError (v202411)
Errors specific to creative wrappers.
- 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.
|
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-11-19 UTC.
[null,null,["Last updated 2024-11-19 UTC."],[[["CreativeWrapperError objects represent errors specific to creative wrappers in Google Ad Manager."],["This error type inherits from ApiError and provides additional fields for context."],["Reasons for CreativeWrapperError can include issues like label types, macros, header/footer specifications, and ad unit compatibility."],["The `reason` field provides an enum value indicating the specific cause of the error."],["CreativeWrapperError is part of the Google Ad Manager API and falls under the namespace `https://www.google.com/apis/ads/publisher/v202411`."]]],["The content outlines error handling within the `LabelService`, `CreativeWrapperService`, and `InventoryService`. Key elements include `ApiError`, which provides details like `fieldPath`, `trigger`, and `errorString` for debugging. The `CreativeWrapperError` specifies issues related to creative wrappers, detailing specific reasons such as `INVALID_LABEL_TYPE`, `UNRECOGNIZED_MACRO`, or restrictions on applying labels to certain ad units based on size or target platform, and the association with the creative wrapper. The namespace used is `https://www.google.com/apis/ads/publisher/v202411`.\n"]]