type CreativeWrapperError (v202505)

  • CreativeWrapperError specifies errors related to creative wrappers, inheriting from ApiError.

  • CreativeWrapperError reasons include invalid label types, unrecognized macros, and issues with header/footer or video tracking URLs.

  • Additional reasons cover constraints on applying creative wrapper labels based on ad unit size, environment type, and platform.
Service
CreativeWrapperService InventoryService LabelService
Inheritance
ApiError
▼
AdSenseAccountError AdUnitCodeError AdUnitHierarchyError ApiVersionError AuthenticationError CollectionSizeError CommonError CompanyError CreativeWrapperError CrossSellError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError FrequencyCapError InternalApiError InvalidColorError InvalidUrlError InventoryUnitError InventoryUnitRefreshRateError InventoryUnitSizesError LabelEntityAssociationError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

Errors specific to creative wrappers.

Namespace
https://www.google.com/apis/ads/publisher/v202505

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.