type VideoPosition (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Represents a targetable position within a video. A video ad can be targeted
to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
Field
|
positionType
|
VideoPosition.Type
The type of video position (pre-roll, mid-roll, or post-roll).
Enumerations
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
-
ALL
- This position targets all of the above video positions.
-
PREROLL
- The position defined as showing before the video starts playing.
-
MIDROLL
- The position defined as showing within the middle of the playing video.
-
POSTROLL
- The position defined as showing after the video is completed.
|
midrollIndex
|
xsd:int
The index of the mid-roll to target. Only valid if the positionType is
VideoPositionType.MIDROLL, otherwise this field will be ignored.
|
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\u003eVideoPosition represents a targetable position within a video for ad targeting.\u003c/p\u003e\n"],["\u003cp\u003eIt allows targeting specific positions like pre-roll, mid-roll, or post-roll.\u003c/p\u003e\n"],["\u003cp\u003eFor mid-roll targeting, \u003ccode\u003emidrollIndex\u003c/code\u003e specifies the desired mid-roll's index.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003epositionType\u003c/code\u003e defines the type of video position, such as pre-roll, mid-roll, or post-roll.\u003c/p\u003e\n"],["\u003cp\u003eIt belongs to the namespace \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202411\u003c/code\u003e.\u003c/p\u003e\n"]]],["The content defines `VideoPosition`, a targetable location within a video ad. It's used by various services, including AdRuleService, AdjustmentService, and ForecastService. Key information includes `positionType`, specifying pre-roll, mid-roll, or post-roll, and `midrollIndex`, which targets a specific mid-roll segment. The possible `positionType` are : `UNKNOWN` `ALL` `PREROLL` `MIDROLL` and `POSTROLL`. `VideoPosition` is part of the namespace `https://www.google.com/apis/ads/publisher/v202411`.\n"],null,["# type VideoPosition (v202411)\n\n**Service** \n**AdRuleService** [AdjustmentService](/ad-manager/api/reference/v202411/AdjustmentService.VideoPosition) [ForecastService](/ad-manager/api/reference/v202411/ForecastService.VideoPosition) [LineItemService](/ad-manager/api/reference/v202411/LineItemService.VideoPosition) [NativeStyleService](/ad-manager/api/reference/v202411/NativeStyleService.VideoPosition) [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.VideoPosition) [ProposalService](/ad-manager/api/reference/v202411/ProposalService.VideoPosition) [PublisherQueryLanguageService](/ad-manager/api/reference/v202411/PublisherQueryLanguageService.VideoPosition) [TargetingPresetService](/ad-manager/api/reference/v202411/TargetingPresetService.VideoPosition) [YieldGroupService](/ad-manager/api/reference/v202411/YieldGroupService.VideoPosition) **Dependencies** \n[VideoPositionTarget](/ad-manager/api/reference/v202411/AdRuleService.VideoPositionTarget) \n▼\n**VideoPosition**\n\nRepresents a targetable position within a video. A video ad can be targeted\nto a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `positionType` | ` `[VideoPosition.Type](/ad-manager/api/reference/v202411/AdRuleService.VideoPosition.Type)` ` The type of video position (pre-roll, mid-roll, or post-roll). *** ** * ** *** **Enumerations** `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. `ALL` : This position targets all of the above video positions. `PREROLL` : The position defined as showing before the video starts playing. `MIDROLL` : The position defined as showing within the middle of the playing video. `POSTROLL` : The position defined as showing after the video is completed. \u003cbr /\u003e |\n| ### `midrollIndex` | ` `xsd:`int` The index of the mid-roll to target. Only valid if the `positionType` is `VideoPositionType.MIDROLL`, otherwise this field will be ignored. |"]]
