type VideoPosition (v202502)

  • VideoPosition represents a targetable position within a video, such as pre-roll, all mid-rolls, or post-roll, or a specific mid-roll index.

  • The positionType field indicates the type of video position, with available enumerations including UNKNOWN, ALL, PREROLL, MIDROLL, and POSTROLL.

  • The midrollIndex field specifies the index of the mid-roll to target and is only applicable when positionType is MIDROLL.

  • VideoPosition is used by several services including AdRuleService, AdjustmentService, ForecastService, LineItemService, NativeStyleService, ProposalLineItemService, ProposalService, PublisherQueryLanguageService, TargetingPresetService, and YieldGroupService.

  • A relevant dependency for VideoPosition is VideoPositionTarget, which is part of the ProposalLineItemService.
Service
AdRuleService AdjustmentService ForecastService LineItemService NativeStyleService ProposalLineItemService ProposalService PublisherQueryLanguageService TargetingPresetService YieldGroupService
Dependencies
VideoPositionTarget
▼
VideoPosition

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/v202502

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.