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 specific locations within a video where ads can be targeted, such as pre-roll, mid-roll, or post-roll.\u003c/p\u003e\n"],["\u003cp\u003eThey allow for targeting all positions within a video or specific mid-roll indexes using the \u003ccode\u003epositionType\u003c/code\u003e and \u003ccode\u003emidrollIndex\u003c/code\u003e fields, respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epositionType\u003c/code\u003e field defines the general ad placement (pre-roll, mid-roll, post-roll, or all), while \u003ccode\u003emidrollIndex\u003c/code\u003e specifies the exact mid-roll placement when \u003ccode\u003epositionType\u003c/code\u003e is set to \u003ccode\u003eMIDROLL\u003c/code\u003e.\u003c/p\u003e\n"]]],["The core content details the `VideoPosition` within a video advertising context. It defines targetable positions like pre-roll, mid-roll, or post-roll, and specifies a mid-roll index for targeting specific mid-roll instances. The `positionType` field categorizes positions, including values such as `PREROLL`, `MIDROLL`, and `POSTROLL`. The midrollIndex allows to specify the mid-roll number. The content also presents several services associated to this `VideoPosition` as well as it's namespace.\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** [ProposalService](/ad-manager/api/reference/v202408/ProposalService.VideoPosition) [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/ProposalLineItemService.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/ProposalLineItemService.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. |"]]