type CreativeWrapperError (v202508)

    • CreativeWrapperError defines specific errors related to creative wrappers in the Ad Manager API.

    • This error type inherits properties from ApiError, including fieldPath, fieldPathElements, trigger, and errorString.

    • CreativeWrapperError includes a reason field which is an enum indicating the specific cause of the error, such as invalid label type or unrecognized macros.

    • There are various specific reasons listed for CreativeWrapperError, covering scenarios like label association issues, invalid label types, missing header/footer, and restrictions on applying creative wrappers to certain ad unit types.
    Service
    CreativeWrapperService InventoryService LabelService
    Inheritance
    ApiError
    ▼
    ApiVersionError AuthenticationError CollectionSizeError CommonError CreativeWrapperError FeatureError InternalApiError LabelError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TypeError UniqueError

    Errors specific to creative wrappers.

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

    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.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: