enum CompanionDeliveryOption (v202411)

  • CompanionDeliveryOption affects how companion ads are delivered with video player line items.

  • It offers four options: OPTIONAL, AT_LEAST_ONE, ALL, and UNKNOWN, dictating the requirement for companion ads to serve.

  • OPTIONAL allows creative sets to serve without companions, AT_LEAST_ONE requires at least one, and ALL mandates serving all companions in the set.

  • UNKNOWN represents an undefined delivery type.

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


Namespace
https://www.google.com/apis/ads/publisher/v202411
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.