type SetTopBoxCreativeError (v202411)

  • SetTopBoxCreativeError objects detail issues encountered when working with set-top box creatives in the Ad Manager API.

  • These errors often involve external asset IDs or provider IDs, which have immutability constraints.

  • Reasons for these errors include missing or invalid external asset IDs and attempts to modify immutable fields.

  • The reason field categorizes the specific error encountered, providing more context for troubleshooting.
Service
CreativeService CreativeSetService LineItemCreativeAssociationService NetworkService
Inheritance
ApiError
▼
ApiVersionError AssetError AuthenticationError CollectionSizeError CommonError CreativeAssetMacroError CreativeError CreativeSetError CreativeTemplateError CreativeTemplateOperationError CustomCreativeError CustomFieldValueError EntityLimitReachedError FeatureError FileError HtmlBundleProcessorError ImageError InternalApiError InvalidPhoneNumberError InvalidUrlError LabelEntityAssociationError LineItemCreativeAssociation... NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError RichMediaStudioCreativeError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError SwiffyConversionError TemplateInstantiatedCreativ... TranscodingError TypeError UniqueError

Errors associated with set-top box 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.

SetTopBoxCreativeError

reason

SetTopBoxCreativeError.Reason

The error reason represented by an enum.

Enumerations
EXTERNAL_ASSET_ID_IMMUTABLE
Set-top box creative external asset IDs are immutable after creation.
EXTERNAL_ASSET_ID_REQUIRED
Set-top box creatives require an external asset ID.
PROVIDER_ID_IMMUTABLE
Set-top box creative provider IDs are immutable after creation.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.