Reference documentation and code samples for the Google Ads Ad Manager V1 Client class VideoPosition.
Video Position Targeting Criterion
Generated from protobuf message google.ads.admanager.v1.VideoPosition
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ midroll_index |
int|string
Optional. The index of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL. |
↳ reverse_midroll_index |
int|string
Optional. The index from the back of the pod of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL or if targeting a specific midroll index (e.g. midroll_index != 0). |
↳ pod_position |
int|string
Optional. The video position within a pod to target. This field must be unset in order to target a specific video position (e.g. position_type), bumper type (e.g. bumper_type), or custom ad spot (e.g. custom_spot_id). |
↳ position_type |
int
Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index. |
↳ bumper_type |
int
Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. position_type), pod position (e.g. pod_position), or custom ad spot (e.g. custom_spot_id). |
getMidrollIndex
Optional. The index of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMidrollIndex
clearMidrollIndex
setMidrollIndex
Optional. The index of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReverseMidrollIndex
Optional. The index from the back of the pod of the mid-roll to target.
This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL or if targeting a specific midroll index (e.g. midroll_index != 0).
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasReverseMidrollIndex
clearReverseMidrollIndex
setReverseMidrollIndex
Optional. The index from the back of the pod of the mid-roll to target.
This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL or if targeting a specific midroll index (e.g. midroll_index != 0).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPodPosition
Optional. The video position within a pod to target. This field must be unset in order to target a specific video position (e.g. position_type), bumper type (e.g. bumper_type), or custom ad spot (e.g. custom_spot_id).
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasPodPosition
clearPodPosition
setPodPosition
Optional. The video position within a pod to target. This field must be unset in order to target a specific video position (e.g. position_type), bumper type (e.g. bumper_type), or custom ad spot (e.g. custom_spot_id).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPositionType
Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasPositionType
clearPositionType
setPositionType
Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBumperType
Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. position_type), pod position (e.g. pod_position), or custom ad spot (e.g. custom_spot_id).
| Returns | |
|---|---|
| Type | Description |
int |
|
hasBumperType
clearBumperType
setBumperType
Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. position_type), pod position (e.g. pod_position), or custom ad spot (e.g. custom_spot_id).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|