**Service** [ForecastService](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.SetTopBoxLineItemError) [LineItemService](https://developers.google.com/ad-manager/api/reference/v202605/LineItemService.SetTopBoxLineItemError) [LineItemTemplateService](https://developers.google.com/ad-manager/api/reference/v202605/LineItemTemplateService.SetTopBoxLineItemError) **OrderService** **Inheritance** [ApiError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ApiError) ▼ [ApiVersionError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ApiVersionError) [AssetError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.AssetError) [AudienceSegmentError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.AudienceSegmentError) [AuthenticationError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.AuthenticationError) [ClickTrackingLineItemError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ClickTrackingLineItemError) [CollectionSizeError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.CollectionSizeError) [CommonError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.CommonError) [CompanyCreditStatusError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.CompanyCreditStatusError) [CreativeError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.CreativeError) [CrossSellError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.CrossSellError) [CurrencyCodeError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.CurrencyCodeError) [CustomFieldValueError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.CustomFieldValueError) [CustomTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.CustomTargetingError) [DateTimeRangeTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.DateTimeRangeTargetingError) [DayPartTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.DayPartTargetingError) [EntityChildrenLimitReachedE...](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.EntityChildrenLimitReachedError "EntityChildrenLimitReachedError") [EntityLimitReachedError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.EntityLimitReachedError) [FeatureError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.FeatureError) [ForecastError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ForecastError) [FrequencyCapError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.FrequencyCapError) [GenericTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.GenericTargetingError) [GeoTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.GeoTargetingError) [GrpSettingsError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.GrpSettingsError) [ImageError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ImageError) [InternalApiError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.InternalApiError) [InvalidEmailError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.InvalidEmailError) [InvalidUrlError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.InvalidUrlError) [InventoryTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.InventoryTargetingError) [LabelEntityAssociationError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.LabelEntityAssociationError) [LineItemActivityAssociation...](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.LineItemActivityAssociationError "LineItemActivityAssociationError") [LineItemCreativeAssociation...](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.LineItemCreativeAssociationError "LineItemCreativeAssociationError") [LineItemError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.LineItemError) [LineItemFlightDateError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.LineItemFlightDateError) [LineItemOperationError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.LineItemOperationError) [MobileApplicationTargetingE...](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.MobileApplicationTargetingError "MobileApplicationTargetingError") [NotNullError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.NotNullError) [NullError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.NullError) [OrderActionError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.OrderActionError) [OrderError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.OrderError) [ParseError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ParseError) [PermissionError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.PermissionError) [PrecisionError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.PrecisionError) [ProgrammaticError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ProgrammaticError) [PublisherProvidedSignalsTar...](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.PublisherProvidedSignalsTargetingError "PublisherProvidedSignalsTargetingError") [PublisherQueryLanguageConte...](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.PublisherQueryLanguageContextError "PublisherQueryLanguageContextError") [PublisherQueryLanguageSynta...](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.PublisherQueryLanguageSyntaxError "PublisherQueryLanguageSyntaxError") [QuotaError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.QuotaError) [RangeError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.RangeError) [RegExError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.RegExError) [RequestError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.RequestError) [RequestPlatformTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.RequestPlatformTargetingError) [RequiredCollectionError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.RequiredCollectionError) [RequiredError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.RequiredError) [RequiredNumberError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.RequiredNumberError) [RequiredSizeError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.RequiredSizeError) [ReservationDetailsError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ReservationDetailsError) [ServerError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.ServerError) **SetTopBoxLineItemError** [StatementError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.StatementError) [StringFormatError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.StringFormatError) [StringLengthError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.StringLengthError) [TeamError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.TeamError) [TechnologyTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.TechnologyTargetingError) [TemplateInstantiatedCreativ...](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.TemplateInstantiatedCreativeError "TemplateInstantiatedCreativeError") [TimeZoneError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.TimeZoneError) [TranscodingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.TranscodingError) [TypeError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.TypeError) [UniqueError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.UniqueError) [UserDomainTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.UserDomainTargetingError) [VideoPositionTargetingError](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.VideoPositionTargetingError) Errors associated with set-top box [line items](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.LineItem). *** ** * ** *** Namespace : `https://www.google.com/apis/ads/publisher/v202605` | ## Field || |---|---| | **`ApiError` (inherited)** || | ### `fieldPath` | ` xsd:string` The OGNL field path to identify cause of error. | | ### `fieldPathElements` | ` https://developers.google.com/ad-manager/api/reference/v202605/OrderService.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. | | **`SetTopBoxLineItemError`** || | ### `reason` | ` https://developers.google.com/ad-manager/api/reference/v202605/OrderService.SetTopBoxLineItemError.Reason ` The error reason represented by an enum. *** ** * ** *** **Enumerations** `NON_SET_TOP_BOX_AD_UNIT_TARGETED` : The set-top box line item cannot target an ad unit that doesn't have an external set-top box channel ID. `AT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED` : The set-top box line item must target at least one ad unit. `CANNOT_EXCLUDE_AD_UNITS` : The set-top box line item cannot exclude ad units. `POD_POSITION_OUT_OF_RANGE` : The set-top box line item can only target pod positions 1 - 15. `MIDROLL_POSITION_OUT_OF_RANGE` : The set-top box line item can only target midroll positions 4 - 100. `FEATURE_NOT_ENABLED` : The set-top box feature is not enabled. `INVALID_ENVIRONMENT_TYPE` : Only [EnvironmentType.VIDEO_PLAYER](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.EnvironmentType#VIDEO_PLAYER) is supported for set-top box line items. `COMPANIONS_NOT_SUPPORTED` : Companions are not supported for set-top box line items. `INVALID_CREATIVE_SIZE` : Set-top box line items only support sizes supported by Canoe. `INVALID_LINE_ITEM_TYPE` : Set-top box line items only support [LineItemType.STANDARD](https://developers.google.com/ad-manager/api/reference/v202605/AdRuleService.LineItemType#STANDARD), [LineItemType.HOUSE](https://developers.google.com/ad-manager/api/reference/v202605/AdRuleService.LineItemType#HOUSE), and [LineItemType.SPONSORSHIP](https://developers.google.com/ad-manager/api/reference/v202605/AdRuleService.LineItemType#SPONSORSHIP) line item types. `ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS` : [orders](https://developers.google.com/ad-manager/api/reference/v202605/OrderService.Order) containing [LineItemType.STANDARD](https://developers.google.com/ad-manager/api/reference/v202605/AdRuleService.LineItemType#STANDARD) set-top box line items cannot contain set-top box line items of type [LineItemType.HOUSE](https://developers.google.com/ad-manager/api/reference/v202605/AdRuleService.LineItemType#HOUSE) or [LineItemType.SPONSORSHIP](https://developers.google.com/ad-manager/api/reference/v202605/AdRuleService.LineItemType#SPONSORSHIP). `INVALID_COST_TYPE` : Set-top box line items only support [CostType.CPM](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.CostType#CPM). `COST_PER_UNIT_NOT_ALLOWED` : Set-top box line items do not support a cost per unit. `DISCOUNT_NOT_ALLOWED` : Set-top box line items do not support discounts. `FRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED` : Set-top box line items do not support [DeliveryRateType.FRONTLOADED](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.DeliveryRateType#FRONTLOADED). `INVALID_LINE_ITEM_STATUS_CHANGE` : Set-top box line items cannot go from a state that is ready to be synced to a state that is not ready to be synced. `INVALID_LINE_ITEM_PRIORITY` : Set-top box line items can only have certain priorities for different `reservation types`: - `ReservationType.SPONSORSHIP` =\> 1 - `ReservationType.HOUSE` =\> 16 - `ReservationType.STANDARD` =\> Between 1 and 16 inclusive. `SYNC_REVISION_NOT_INCREASING` : When a set-top box line item is pushed to Canoe, a revision number is used to keep track of the last version of the line item that Ad Manager synced with Canoe. The only change allowed on revisions within Ad Manager is increasing the revision number. `SYNC_REVISION_MUST_BE_GREATER_THAN_ZERO` : When a set-top box line item is pushed to Canoe, a revision number is used to keep track of the last version of the line item that Ad Manager synced with Canoe. Sync revisions begin at one and can only increase in value. `CANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS` : Set Top box line items cannot be unarchived. `COPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED` : Set-top box enabled line items cannot be copied for V0 of the video Canoe campaign push. `INVALID_LINE_ITEM_TYPE_CHANGE` : Standard set-top box line items cannot be updated to be [LineItemType.House](https://developers.google.com/ad-manager/api/reference/v202605/AdRuleService.LineItemType#House) or [LineItemType.Sponsorship](https://developers.google.com/ad-manager/api/reference/v202605/AdRuleService.LineItemType#Sponsorship) line items and vice versa. `CREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED` : Set-top box line items can only have a creative rotation type of `CreativeRotationType.EVEN` or [CreativeRotationType.MANUAL](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.CreativeRotationType#MANUAL). `INVALID_FREQUENCY_CAP_TIME_UNIT` : Set-top box line items can only have frequency capping with time units of [TimeUnit.DAY](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.TimeUnit#DAY), [TimeUnit.HOUR](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.TimeUnit#HOUR), [TimeUnit.POD](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.TimeUnit#POD), or [TimeUnit.STREAM](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.TimeUnit#STREAM). `INVALID_FREQUENCY_CAP_TIME_RANGE` : Set-top box line items can only have specific time ranges for certain time units: - [TimeUnit.HOUR](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.TimeUnit#HOUR) =\> 1, 2, 6 - [TimeUnit.DAY](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.TimeUnit#DAY) =\> 1, 3 `INVALID_PRIMARY_GOAL_UNIT_TYPE` : Set-top box line items can only have a unit type of [UnitType.IMPRESSIONS](https://developers.google.com/ad-manager/api/reference/v202605/ForecastService.UnitType#IMPRESSIONS). `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version.
|