type SetTopBoxLineItemError (v202505)

AI-generated Key Takeaways

• Errors associated with set-top box line items are detailed, including various reasons for these errors.

• Set-top box line items have specific restrictions on targeting ad units, excluding ad units, pod/midroll positions, environment types, companions, creative sizes, line item types, cost types, and delivery rates.

• There are constraints on set-top box line item status changes, priorities based on reservation type, and sync revision requirements.

• Frequency capping for set-top box line items is limited to specific time units and ranges.

• Set-top box line items only support impressions as the primary goal unit type.

Service

ForecastService LineItemService LineItemTemplateService OrderService

Inheritance

ApiError

▼

ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidUrlError InventoryTargetingError LabelEntityAssociationError LineItemActivityAssociation... LineItemCreativeAssociation... LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError NullError OrderActionError OrderError ParseError PermissionError PrecisionError ProgrammaticError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError SetTopBoxLineItemError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TimeZoneError TranscodingError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

Errors associated with set-top box line items.

---

Namespace

https://www.google.com/apis/ads/publisher/v202505

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.
SetTopBoxLineItemError
reason	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 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, LineItemType.HOUSE, and LineItemType.SPONSORSHIP line item types. ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS orders containing LineItemType.STANDARD set-top box line items cannot contain set-top box line items of type LineItemType.HOUSE or LineItemType.SPONSORSHIP. INVALID_COST_TYPE Set-top box line items only support 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. 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 or 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. INVALID_FREQUENCY_CAP_TIME_UNIT Set-top box line items can only have frequency capping with time units of TimeUnit.DAY, TimeUnit.HOUR, TimeUnit.POD, or TimeUnit.STREAM. INVALID_FREQUENCY_CAP_TIME_RANGE Set-top box line items can only have specific time ranges for certain time units: TimeUnit.HOUR => 1, 2, 6 TimeUnit.DAY => 1, 3 INVALID_PRIMARY_GOAL_UNIT_TYPE Set-top box line items can only have a unit type of UnitType.IMPRESSIONS. UNKNOWN The value returned if the actual value is not exposed by the requested API version.