Looking for a REST API? The Ad Manager API (Beta) is now available.

enum CompanionDeliveryOption (v202411)

AI-generated Key Takeaways

CompanionDeliveryOption is used for line items with an environmentType of VIDEO_PLAYER.
It defines delivery options for companions, including OPTIONAL, AT_LEAST_ONE, and ALL.
OPTIONAL companions are not required, AT_LEAST_ONE requires at least one companion to serve, and ALL requires all companions in the set to serve.

Service

ForecastService LineItemService ProposalLineItemService

Dependencies

LineItemSummary ProposalLineItem

▼

CompanionDeliveryOption

The delivery option for companions. Used for line items whose environmentType is EnvironmentType.VIDEO_PLAYER.

Enumeration	Description
`OPTIONAL`	Companions are not required to serve a creative set. The creative set can serve to inventory that has zero or more matching companions.
`AT_LEAST_ONE`	At least one companion must be served in order for the creative set to be used.
`ALL`	All companions in the set must be served in order for the creative set to be used. This can still serve to inventory that has more companions than can be filled.
`UNKNOWN`	The delivery type is unknown.