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 represents a targetable position within a video, allowing for ad targeting before, during, or after video playback.\u003c/p\u003e\n"],["\u003cp\u003eIt includes two main fields: \u003ccode\u003epositionType\u003c/code\u003e which specifies pre-roll, mid-roll, or post-roll, and \u003ccode\u003emidrollIndex\u003c/code\u003e to target specific mid-roll positions.\u003c/p\u003e\n"],["\u003cp\u003eWhen targeting mid-rolls, the \u003ccode\u003emidrollIndex\u003c/code\u003e field becomes relevant, while other position types utilize the broader \u003ccode\u003epositionType\u003c/code\u003e categories.\u003c/p\u003e\n"],["\u003cp\u003eThis object is used within the Ad Manager API to precisely define where video ads should appear within video content.\u003c/p\u003e\n"]]],["The core content describes the `VideoPosition` within a video ad, detailing its targetable positions like pre-roll, mid-roll, and post-roll. Key information includes the `positionType`, which specifies the ad placement, and `midrollIndex`, which targets a specific mid-roll. `VideoPosition` is utilized by multiple services such as `AdRuleService`, `AdjustmentService`, and others. Possible position types are `UNKNOWN`, `ALL`, `PREROLL`, `MIDROLL`, and `POSTROLL`.\n"],null,["# type VideoPosition (v202408)\n\n**Service** \n**AdRuleService** [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](/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/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/v202408`\n\n| Field ----- ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `positionType` | ` `[VideoPosition.Type](/ad-manager/api/reference/v202408/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. |"]]
