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

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

Representation of an individual Dynamic Ad Insertion (DAI) session watching a LiveStream resource or VOD Content resource. Use the Stream Activity Monitor (SAM) on the Google Ad Manager UI to look up this session. For details, see Locate a DAI session ID or debug key.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The resource name of the `DaiSession`.
`↳ creation_context`	`DaiSession\CreationContext` Output only. Context data to create the DAI session.
`↳ slate`	`DaiSession\Creative` Output only. Slate creative to use in the DAI session for unfilled ad durations.
`↳ ad_selections`	`array\|Google\Protobuf\Internal\MapField` Output only. The ad requests, ad responses and nested ads in the DAI session.
`↳ ad_pods`	`array\|Google\Protobuf\Internal\MapField` Output only. All decisioned ad pods for this session, disregarding serving status. Keyed by a unique ID to reference an ad pod from a different submessage.
`↳ ad_breaks`	`array\|Google\Protobuf\Internal\MapField` Output only. All DAI ad breaks for this session. Contains information such as ad duration, slate duration, and various ad statuses. Keyed by a unique ID to reference an ad break from a different submessage.
`↳ findings`	`array<DaiSession\Finding>` Output only. Information about errors or notable discoveries that occurred during a session.
`↳ session_duration`	`Google\Protobuf\Duration` Output only. The duration of the DAI session, calculated as the difference between the timestamp of DAI's latest recorded event and the timestamp of the session create request.

getName

Identifier. The resource name of the DaiSession.

Returns
Type	Description
`string`

setName

Identifier. The resource name of the DaiSession.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreationContext

Output only. Context data to create the DAI session.

Returns
Type	Description
`DaiSession\CreationContext\|null`

hasCreationContext

clearCreationContext

setCreationContext

Output only. Context data to create the DAI session.

Parameter
Name	Description
`var`	`DaiSession\CreationContext`

Returns
Type	Description
`$this`

getSlate

Output only. Slate creative to use in the DAI session for unfilled ad durations.

Returns
Type	Description
`DaiSession\Creative\|null`

hasSlate

clearSlate

setSlate

Output only. Slate creative to use in the DAI session for unfilled ad durations.

Parameter
Name	Description
`var`	`DaiSession\Creative`

Returns
Type	Description
`$this`

getAdSelections

Output only. The ad requests, ad responses and nested ads in the DAI session.

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

setAdSelections

Output only. The ad requests, ad responses and nested ads in the DAI session.

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

Returns
Type	Description
`$this`

getAdPods

Output only. All decisioned ad pods for this session, disregarding serving status. Keyed by a unique ID to reference an ad pod from a different submessage.

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

setAdPods