type SetTopBoxCreativeError (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis documentation outlines the \u003ccode\u003eSetTopBoxCreativeError\u003c/code\u003e, which indicates errors related to set-top box creatives in Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSetTopBoxCreativeError\u003c/code\u003e inherits from \u003ccode\u003eApiError\u003c/code\u003e and includes fields like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e for detailed error information.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field, with its specific enum values, provides further insight into the cause of the error, such as immutable external asset or provider IDs.\u003c/p\u003e\n"],["\u003cp\u003eErrors may arise due to missing external asset IDs or attempts to modify them after the creative is created.\u003c/p\u003e\n"]]],["The content details error handling within an API, specifically focusing on `SetTopBoxCreativeError` and its association with `CreativeService`, `CreativeSetService`, and `LineItemCreativeAssociationService`. It outlines `ApiError`, a superclass, and lists numerous specific error types derived from it under `NetworkService`. `SetTopBoxCreativeError` includes reasons like `EXTERNAL_ASSET_ID_IMMUTABLE`, `EXTERNAL_ASSET_ID_REQUIRED`, and `PROVIDER_ID_IMMUTABLE`. Each error contains fields such as `fieldPath`, `trigger`, and `errorString` to explain the specific error. The namespace for these errors is also provided.\n"],null,["# type SetTopBoxCreativeError (v202411)\n\n**Service** \n[CreativeService](/ad-manager/api/reference/v202411/CreativeService.SetTopBoxCreativeError) [CreativeSetService](/ad-manager/api/reference/v202411/CreativeSetService.SetTopBoxCreativeError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202411/LineItemCreativeAssociationService.SetTopBoxCreativeError) **NetworkService** **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/NetworkService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/NetworkService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/NetworkService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/NetworkService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/NetworkService.CommonError) [ExchangeSignupApiError](/ad-manager/api/reference/v202411/NetworkService.ExchangeSignupApiError) [FeatureError](/ad-manager/api/reference/v202411/NetworkService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/NetworkService.InternalApiError) [InvalidEmailError](/ad-manager/api/reference/v202411/NetworkService.InvalidEmailError) [InventoryClientApiError](/ad-manager/api/reference/v202411/NetworkService.InventoryClientApiError) [LiveStreamEventSlateError](/ad-manager/api/reference/v202411/NetworkService.LiveStreamEventSlateError) [McmError](/ad-manager/api/reference/v202411/NetworkService.McmError) [NetworkError](/ad-manager/api/reference/v202411/NetworkService.NetworkError) [NotNullError](/ad-manager/api/reference/v202411/NetworkService.NotNullError) [ParseError](/ad-manager/api/reference/v202411/NetworkService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/NetworkService.PermissionError) [PrecisionError](/ad-manager/api/reference/v202411/NetworkService.PrecisionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/NetworkService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/NetworkService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/NetworkService.QuotaError) [RequestError](/ad-manager/api/reference/v202411/NetworkService.RequestError) [RequiredCollectionError](/ad-manager/api/reference/v202411/NetworkService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/NetworkService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/NetworkService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/NetworkService.ServerError) **SetTopBoxCreativeError** [StatementError](/ad-manager/api/reference/v202411/NetworkService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/NetworkService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/NetworkService.StringLengthError) [TypeError](/ad-manager/api/reference/v202411/NetworkService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/NetworkService.UniqueError) [UrlError](/ad-manager/api/reference/v202411/NetworkService.UrlError)\n\nErrors associated with [set-top box creatives](/ad-manager/api/reference/v202411/CreativeService.SetTopBoxCreative).\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202411/NetworkService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`SetTopBoxCreativeError`** ||\n| ### `reason` | ` `[SetTopBoxCreativeError.Reason](/ad-manager/api/reference/v202411/NetworkService.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. \u003cbr /\u003e |"]]
