enum CompanionDeliveryOption (v202411)
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/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.
|
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 dictates how companion ads are delivered alongside video content within Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eIt offers four options: OPTIONAL, AT_LEAST_ONE, ALL, and UNKNOWN, influencing whether companions are required or not for creative set delivery.\u003c/p\u003e\n"],["\u003cp\u003eThis setting is applicable to line items configured for video player environments (EnvironmentType.VIDEO_PLAYER).\u003c/p\u003e\n"]]],["The core content describes the `CompanionDeliveryOption` for video player line items, defining how companion creatives are served. It outlines four delivery options: `OPTIONAL` (companions not required), `AT_LEAST_ONE` (at least one companion required), `ALL` (all companions required), and `UNKNOWN` (delivery type undefined). This enumeration is found within the `ProposalLineItemService` namespace, affecting the `ProposalLineItem` and how video ad creative sets are served.\n"],null,["# enum CompanionDeliveryOption (v202411)\n\n**Service** \n[ForecastService](/ad-manager/api/reference/v202411/ForecastService.CompanionDeliveryOption) [LineItemService](/ad-manager/api/reference/v202411/LineItemService.CompanionDeliveryOption) **ProposalLineItemService** **Dependencies** \n[ProposalLineItem](/ad-manager/api/reference/v202411/ProposalLineItemService.ProposalLineItem) \n▼\n**CompanionDeliveryOption**\n\nThe delivery option for companions. Used for line items whose environmentType is\n[EnvironmentType.VIDEO_PLAYER](/ad-manager/api/reference/v202411/ProposalLineItemService.EnvironmentType#VIDEO_PLAYER).\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\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. |"]]
