type RichMediaStudioCreativeError (v202411)

  • The RichMediaStudioCreativeError object lists errors encountered with Studio creatives, including issues with creation, connections, and invalid parameters.

  • Errors are categorized by a reason field represented by an enum with values such as CREATION_NOT_ALLOWED, STUDIO_CONNECTION_ERROR, and INVALID_POSITION.

  • The RichMediaStudioCreativeError object inherits properties from ApiError providing context about the error with details like fieldPath and errorString.

  • Only Studio can create a RichMediaStudioCreative, attempts to create it otherwise will result in a CREATION_NOT_ALLOWED error.

  • Issues connecting to Rich Media Studio to save the creative are flagged by STUDIO_CONNECTION_ERROR, often suggesting a temporary problem.
Service
CreativeService CreativeSetService 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

Lists all errors associated with Studio creatives.

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.

RichMediaStudioCreativeError

reason

RichMediaStudioCreativeErro...

The error reason represented by an enum.

Enumerations
CREATION_NOT_ALLOWED
Only Studio can create a RichMediaStudioCreative.
UKNOWN_ERROR
Unknown error
INVALID_CODE_GENERATION_REQUEST
Invalid request indicating missing/invalid request parameters.
INVALID_CREATIVE_OBJECT
Invalid creative object.
STUDIO_CONNECTION_ERROR
Unable to connect to Rich Media Studio to save the creative. Please try again later.
PUSHDOWN_DURATION_NOT_ALLOWED
The push down duration is not allowed
INVALID_POSITION
The position is invalid
INVALID_Z_INDEX
The Z-index is invalid
INVALID_PUSHDOWN_DURATION
The push-down duration is invalid
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.