type CreativePreviewError (v202505)

  • CreativePreviewError is a type of ApiError related to the generation of creative preview URIs.

  • CreativePreviewError includes a 'reason' field which is an enumeration indicating the specific cause of the error.

  • Possible reasons for a CreativePreviewError include inability to generate a preview URL, limitations with native creatives, missing HTML snippets for third-party creatives, or an unknown error.

  • ApiError, which CreativePreviewError inherits from, provides fields like fieldPath, fieldPathElements, trigger, and errorString for more detailed error information.
Service
LineItemCreativeAssociation...
Inheritance
ApiError
▼
AdSenseAccountError ApiVersionError AssetError AudienceExtensionError AuthenticationError CollectionSizeError CommonError CreativeAssetMacroError CreativeError CreativePreviewError CreativeSetError CreativeTemplateError CreativeTemplateOperationError CrossSellError CustomCreativeError CustomFieldValueError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError FileError HtmlBundleProcessorError ImageError InternalApiError InvalidPhoneNumberError InvalidUrlError LabelEntityAssociationError LineItemCreativeAssociation... LineItemCreativeAssociation... LineItemError NotNullError NullError OrderError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError RichMediaStudioCreativeError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError SwiffyConversionError TemplateInstantiatedCreativ... TranscodingError TypeError UniqueError

Errors associated with generation of creative preview URIs.

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.

CreativePreviewError

reason

CreativePreviewError.Reason

Enumerations
CANNOT_GENERATE_PREVIEW_URL
The creative cannot be previewed on this page.
CANNOT_GENERATE_PREVIEW_URL_FOR_NATIVE_CREATIVES
Preview URLs for native creatives must be retrieved with LineItemCreativeAssociationService.getPreviewUrlsForNativeStyles.
HTML_SNIPPET_REQUIRED_FOR_THIRD_PARTY_CREATIVE
Third party creatives must have an html snippet set in order to obtain a preview URL.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.