type SetTopBoxCreativeError (v202411)

  • SetTopBoxCreativeError is associated with errors related to set-top box creatives.

  • This error inherits properties from ApiError, such as fieldPath, fieldPathElements, trigger, and errorString.

  • Specific reasons for SetTopBoxCreativeError include immutable external asset IDs and provider IDs, required external asset IDs, and an unknown error.
Service
CreativeService CreativeSetService LineItemCreativeAssociationService NetworkService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError ExchangeSignupApiError FeatureError InternalApiError InvalidEmailError InventoryClientApiError LiveStreamEventSlateError McmError NetworkError NotNullError ParseError PermissionError PrecisionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequestError RequiredCollectionError RequiredError RequiredNumberError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError TypeError UniqueError UrlError

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.