type VideoPosition (v202408)
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/v202408
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 objects represent targetable ad positions within a video, such as pre-roll, mid-roll, or post-roll.\u003c/p\u003e\n"],["\u003cp\u003eThese positions can be targeted broadly (e.g., all mid-rolls) or specifically (e.g., a particular mid-roll index).\u003c/p\u003e\n"],["\u003cp\u003eVideoPosition includes two key properties: \u003ccode\u003epositionType\u003c/code\u003e indicating the general position, and \u003ccode\u003emidrollIndex\u003c/code\u003e specifying the index for mid-roll positions.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003epositionType\u003c/code\u003e can be one of: \u003ccode\u003ePREROLL\u003c/code\u003e, \u003ccode\u003eMIDROLL\u003c/code\u003e, \u003ccode\u003ePOSTROLL\u003c/code\u003e, \u003ccode\u003eALL\u003c/code\u003e (targeting all positions), or \u003ccode\u003eUNKNOWN\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eWhen \u003ccode\u003epositionType\u003c/code\u003e is \u003ccode\u003eMIDROLL\u003c/code\u003e, the \u003ccode\u003emidrollIndex\u003c/code\u003e property is used to pinpoint the desired mid-roll slot.\u003c/p\u003e\n"]]],["The content outlines services and a core dependency, `VideoPosition`, within a video advertising context. Key services include `AdRuleService`, `AdjustmentService`, `ForecastService`, `LineItemService`, `NativeStyleService`, `ProposalLineItemService`, `ProposalService`, `PublisherQueryLanguageService`, `TargetingPresetService`, and `YieldGroupService`. `VideoPosition` defines targetable positions like pre-roll, mid-roll, and post-roll, using `positionType` to specify these. For mid-rolls, `midrollIndex` determines the specific index. `positionType` can be `UNKNOWN`, `ALL`, `PREROLL`, `MIDROLL`, `POSTROLL`.\n"],null,["# type VideoPosition (v202408)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202408/AdRuleService.VideoPosition) [AdjustmentService](/ad-manager/api/reference/v202408/AdjustmentService.VideoPosition) [ForecastService](/ad-manager/api/reference/v202408/ForecastService.VideoPosition) [LineItemService](/ad-manager/api/reference/v202408/LineItemService.VideoPosition) [NativeStyleService](/ad-manager/api/reference/v202408/NativeStyleService.VideoPosition) [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.VideoPosition) **ProposalService** [PublisherQueryLanguageService](/ad-manager/api/reference/v202408/PublisherQueryLanguageService.VideoPosition) [TargetingPresetService](/ad-manager/api/reference/v202408/TargetingPresetService.VideoPosition) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.VideoPosition) **Dependencies** \n[VideoPositionTarget](/ad-manager/api/reference/v202408/ProposalService.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/v202408`\n\n| Field ----- ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `positionType` | ` `[VideoPosition.Type](/ad-manager/api/reference/v202408/ProposalService.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. |"]]
