enum CompanionDeliveryOption (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
The delivery option for companions. Used for line items whose environmentType is
EnvironmentType.VIDEO_PLAYER.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
| 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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eCompanionDeliveryOption, used for video player line items, dictates how companion ads are delivered alongside primary creatives.\u003c/p\u003e\n"],["\u003cp\u003eIt offers four options: OPTIONAL (companions not required), AT_LEAST_ONE (minimum one companion needed), ALL (all companions must be served), and UNKNOWN (delivery type is unidentified).\u003c/p\u003e\n"],["\u003cp\u003eThese options define whether a creative set can be used based on the availability and requirement of companion ads for the inventory.\u003c/p\u003e\n"]]],["The core content describes the `CompanionDeliveryOption` for video player line items. This option determines how companion creatives are handled. There are four options: `OPTIONAL` (companions are not required), `AT_LEAST_ONE` (at least one companion must serve), `ALL` (all companions must serve), and `UNKNOWN` (delivery type is unknown). These options define the serving requirements of companion creatives alongside video ads. The `LineItemSummary` is noted as a dependency.\n"],null,["# enum CompanionDeliveryOption (v202408)\n\n**Service** \n[ForecastService](/ad-manager/api/reference/v202408/ForecastService.CompanionDeliveryOption) **LineItemService** [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.CompanionDeliveryOption) **Dependencies** \n[LineItemSummary](/ad-manager/api/reference/v202408/LineItemService.LineItemSummary) \n▼\n**CompanionDeliveryOption**\n\nThe delivery option for companions. Used for line items whose environmentType is\n[EnvironmentType.VIDEO_PLAYER](/ad-manager/api/reference/v202408/LineItemService.EnvironmentType#VIDEO_PLAYER).\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Enumeration | Description |\n|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `OPTIONAL` | Companions are not required to serve a creative set. The creative set can serve to inventory that has zero or more matching companions. |\n| `AT_LEAST_ONE` | At least one companion must be served in order for the creative set to be used. |\n| `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. |\n| `UNKNOWN` | The delivery type is unknown. |"]]
