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 affects how companion ads are delivered with video player line items.\u003c/p\u003e\n"],["\u003cp\u003eIt offers four options: OPTIONAL, AT_LEAST_ONE, ALL, and UNKNOWN, dictating the requirement for companion ads to serve.\u003c/p\u003e\n"],["\u003cp\u003eOPTIONAL allows creative sets to serve without companions, AT_LEAST_ONE requires at least one, and ALL mandates serving all companions in the set.\u003c/p\u003e\n"],["\u003cp\u003eUNKNOWN represents an undefined delivery type.\u003c/p\u003e\n"]]],["The document outlines `CompanionDeliveryOption` settings for video player line items within the ad management service. Options include `OPTIONAL` (companions are not required), `AT_LEAST_ONE` (at least one companion must serve), and `ALL` (all companions must serve). An `UNKNOWN` option exists for undefined delivery types. This setting is linked to `ForecastService`, `LineItemService`, and `ProposalLineItemService`, with a dependency on `LineItemSummary`.\n"],null,["# enum CompanionDeliveryOption (v202411)\n\n**Service** \n[ForecastService](/ad-manager/api/reference/v202411/ForecastService.CompanionDeliveryOption) **LineItemService** [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.CompanionDeliveryOption) **Dependencies** \n[LineItemSummary](/ad-manager/api/reference/v202411/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/v202411/LineItemService.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. |"]]
