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 dictates how companion ads are delivered alongside video content, influencing whether they are optional, required, or need to be fully served.\u003c/p\u003e\n"],["\u003cp\u003eThis setting applies specifically to line items with video player environments, impacting how creative sets are utilized based on companion availability.\u003c/p\u003e\n"],["\u003cp\u003eThere are four options: OPTIONAL, AT_LEAST_ONE, ALL, and UNKNOWN, each defining different requirements for companion ad delivery for creative sets.\u003c/p\u003e\n"],["\u003cp\u003eThis delivery option is part of the ForecastService, LineItemService, and ProposalLineItemService namespaces within the Google Ad Manager API.\u003c/p\u003e\n"]]],["The content defines the `CompanionDeliveryOption` for line items in a video player environment. It specifies how companion creatives are delivered. Four options are detailed: `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 determine the requirements for companion creatives to be used with a creative set.\n"],null,["# enum CompanionDeliveryOption (v202408)\n\n**Service** \n[ForecastService](/ad-manager/api/reference/v202408/ForecastService.CompanionDeliveryOption) [LineItemService](/ad-manager/api/reference/v202408/LineItemService.CompanionDeliveryOption) **ProposalLineItemService** **Dependencies** \n[ProposalLineItem](/ad-manager/api/reference/v202408/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/v202408/ProposalLineItemService.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. |"]]
