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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eSetTopBoxCreativeError objects detail issues encountered when working with set-top box creatives within the Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003eThese errors often involve problems with external asset IDs and provider IDs, which are crucial for identifying and managing these creatives.\u003c/p\u003e\n"],["\u003cp\u003eImmutable properties like external asset IDs and provider IDs cannot be changed after the creative is created, and attempting to do so will result in an error.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field within the error object provides specific information about the cause, using an enum to represent different error types.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should refer to the documentation for \u003ccode\u003eSetTopBoxCreativeError.Reason\u003c/code\u003e to understand the various error codes and how to address them.\u003c/p\u003e\n"]]],["The document outlines error handling for ad management services, specifically focusing on `SetTopBoxCreativeError`. It details errors related to `CreativeService`, `CreativeSetService`, and `LineItemCreativeAssociationService`. `NetworkService`'s `ApiError` is the base for various errors like `AuthenticationError`, `QuotaError`, and more, which are inherited. `SetTopBoxCreativeError`'s specific reasons include immutable external asset/provider IDs, required external asset IDs, or an unknown error. Core data fields are `fieldPath`, `trigger`, `errorString` and `reason`.\n"],null,["# type SetTopBoxCreativeError (v202408)\n\n**Service** \n[CreativeService](/ad-manager/api/reference/v202408/CreativeService.SetTopBoxCreativeError) [CreativeSetService](/ad-manager/api/reference/v202408/CreativeSetService.SetTopBoxCreativeError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202408/LineItemCreativeAssociationService.SetTopBoxCreativeError) **NetworkService** **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/NetworkService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/NetworkService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/NetworkService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/NetworkService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/NetworkService.CommonError) [ExchangeSignupApiError](/ad-manager/api/reference/v202408/NetworkService.ExchangeSignupApiError) [FeatureError](/ad-manager/api/reference/v202408/NetworkService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/NetworkService.InternalApiError) [InvalidEmailError](/ad-manager/api/reference/v202408/NetworkService.InvalidEmailError) [InventoryClientApiError](/ad-manager/api/reference/v202408/NetworkService.InventoryClientApiError) [LiveStreamEventSlateError](/ad-manager/api/reference/v202408/NetworkService.LiveStreamEventSlateError) [McmError](/ad-manager/api/reference/v202408/NetworkService.McmError) [NetworkError](/ad-manager/api/reference/v202408/NetworkService.NetworkError) [NotNullError](/ad-manager/api/reference/v202408/NetworkService.NotNullError) [ParseError](/ad-manager/api/reference/v202408/NetworkService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/NetworkService.PermissionError) [PrecisionError](/ad-manager/api/reference/v202408/NetworkService.PrecisionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/NetworkService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/NetworkService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/NetworkService.QuotaError) [RequestError](/ad-manager/api/reference/v202408/NetworkService.RequestError) [RequiredCollectionError](/ad-manager/api/reference/v202408/NetworkService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/NetworkService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202408/NetworkService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202408/NetworkService.ServerError) **SetTopBoxCreativeError** [StatementError](/ad-manager/api/reference/v202408/NetworkService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/NetworkService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/NetworkService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/NetworkService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/NetworkService.UniqueError) [UrlError](/ad-manager/api/reference/v202408/NetworkService.UrlError)\n\nErrors associated with [set-top box creatives](/ad-manager/api/reference/v202408/CreativeService.SetTopBoxCreative).\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\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/v202408/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/v202408/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 |"]]
