type CreativePreviewError (v202502)

  • CreativePreviewError is associated with errors when generating creative preview URIs.

  • This error type inherits from ApiError and includes fields like reason, fieldPath, and trigger.

  • The CreativePreviewError has specific reasons such as CANNOT_GENERATE_PREVIEW_URL and HTML_SNIPPET_REQUIRED_FOR_THIRD_PARTY_CREATIVE.

  • Preview URLs for native creatives require a specific method, getPreviewUrlsForNativeStyles.

  • The UNKNOWN reason is used when the actual error value is not available in the API version.

Errors associated with generation of creative preview URIs.


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

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.