type SetTopBoxLineItemError (v202502)
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
SetTopBoxLineItemError represents errors associated with set-top box line items in the specified Google Ad Manager API version.
This error type inherits from ApiError, providing fields like fieldPath, fieldPathElements, trigger, and errorString for detailed error information.
The SetTopBoxLineItemError has a reason field, an enum detailing specific issues such as invalid targeting, unsupported features, or incorrect settings for set-top box line items.
Enumerated reasons cover restrictions on targeted ad units, required targeting, excluded ad units, acceptable pod and midroll positions, feature enablement, valid environment and creative sizes, allowed line item types, order content constraints, valid cost types and associated settings, delivery rate limitations, status change rules, acceptable line item priorities, sync revision requirements, archiving limitations, copying restrictions, line item type change rules, creative rotation type limitations, and valid frequency cap time units and ranges.
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.
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.
[[["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."],[],["The content outlines the `SetTopBoxLineItemError` and its associated restrictions within the Ad Manager API. These errors occur when managing set-top box line items. Key actions that trigger errors include targeting unsupported ad units, attempting to exclude ad units, using invalid pod or midroll positions, not enabling the set-top box feature, and utilizing incorrect environment or cost types. Other errors relate to unsupported discounts, delivery rates, status changes, priority settings, revision handling, and frequency cap settings.\n"]]
