Google Ads Ad Manager V1 Client - Class AdPod (0.14.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class AdPod.

Information about a single decisioned ad pod in this session. This message pertains to the smallest unit of ads to insert in a session, and might be a pod fragment.

Generated from protobuf message google.ads.admanager.v1.DaiSession.AdPod

Namespace

Google \ Ads \ AdManager \ V1 \ DaiSession

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ requested_break_type`	`int` Output only. Type of ad break this ad pod was decisioned for.
`↳ ad_request_key`	`int\|string` Output only. Ad request ID that links to the ad request that resulted in this ad pod.
`↳ creatives`	`array\|Google\Protobuf\Internal\MapField` Output only. The creatives in this ad pod. Keyed by a unique ID used to reference this creative from a different submessage.
`↳ prefetch_stage`	`int` Output only. Indicates the prefetch stage for this ad pod. If prefetch is not enabled this stage is set to the PrefetchStageType.DISABLED value.
`↳ ad_break_id`	`string` Output only. Publisher-provided or DAI-generated break ID for the Ad break API or pod serving API.
`↳ label`	`string` Output only. Descriptive label for this ad pod, used to distinguish ad pods from one another in this session. e.g. "midroll-1", "2".

getRequestedBreakType

Output only. Type of ad break this ad pod was decisioned for.

Returns
Type	Description
`int`

hasRequestedBreakType

clearRequestedBreakType

setRequestedBreakType

Output only. Type of ad break this ad pod was decisioned for.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAdRequestKey

Output only. Ad request ID that links to the ad request that resulted in this ad pod.

Returns
Type	Description
`int\|string`

hasAdRequestKey

clearAdRequestKey

setAdRequestKey

Output only. Ad request ID that links to the ad request that resulted in this ad pod.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getCreatives

Output only. The creatives in this ad pod. Keyed by a unique ID used to reference this creative from a different submessage.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setCreatives

Output only. The creatives in this ad pod. Keyed by a unique ID used to reference this creative from a different submessage.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getPrefetchStage

Output only. Indicates the prefetch stage for this ad pod. If prefetch is not enabled this stage is set to the PrefetchStageType.DISABLED value.

Returns
Type	Description
`int`

hasPrefetchStage

clearPrefetchStage

setPrefetchStage