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

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

Information about an ad break in this session. Includes statuses such as ad and slate durations.

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

Namespace

Google \ Ads \ AdManager \ V1 \ DaiSession

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ linear`	`AdBreak\LinearBreak` Output only. Information on the break for a linear session.
`↳ vod`	`AdBreak\VodBreak` Output only. Information on the break for a VOD session.
`↳ pod_keys`	`int[]\|string[]` Output only. Ad pod ID that links to one or more decisioned ad pods for this break. Most types of sessions will have a single pod key, but in the case of prefetched pods there will be two pod keys.
`↳ ad_break_id`	`string` Output only. Publisher-provided or DAI-generated break ID for the Ad break API or pod serving API.
`↳ break_type`	`int` Output only. Type of break this represents.
`↳ break_sequence`	`int\|string` Output only. The index of this ad break in the session.
`↳ served_ads_duration`	`Google\Protobuf\Duration` Output only. The duration of ads that were inserted for this break.
`↳ executed_break_duration`	`Google\Protobuf\Duration` Output only. The total duration of the break as it was served by DAI. In VOD, this value is the duration of ads inserted in between content. In linear, this value is the duration between cue out and cue in.
`↳ tracking_pings`	`array\|Google\Protobuf\Internal\MapField` Output only. Tracking pings that were issued for this break. Keyed by a unique ID to reference this tracking ping from a different submessage.

getLinear

Output only. Information on the break for a linear session.

Returns
Type	Description
`AdBreak\LinearBreak\|null`

hasLinear

setLinear

Output only. Information on the break for a linear session.

Parameter
Name	Description
`var`	`AdBreak\LinearBreak`

Returns
Type	Description
`$this`

getVod

Output only. Information on the break for a VOD session.

Returns
Type	Description
`AdBreak\VodBreak\|null`

hasVod

setVod

Output only. Information on the break for a VOD session.

Parameter
Name	Description
`var`	`AdBreak\VodBreak`

Returns
Type	Description
`$this`

getPodKeys

Output only. Ad pod ID that links to one or more decisioned ad pods for this break. Most types of sessions will have a single pod key, but in the case of prefetched pods there will be two pod keys.

Returns
Type	Description
`Google\Protobuf\RepeatedField<int>\|Google\Protobuf\RepeatedField<string>`

setPodKeys

Output only. Ad pod ID that links to one or more decisioned ad pods for this break. Most types of sessions will have a single pod key, but in the case of prefetched pods there will be two pod keys.

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

Returns
Type	Description
`$this`

getAdBreakId

Output only. Publisher-provided or DAI-generated break ID for the Ad break API or pod serving API.

Returns
Type	Description
`string`

hasAdBreakId

clearAdBreakId

setAdBreakId

Output only. Publisher-provided or DAI-generated break ID for the Ad break API or pod serving API.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBreakType

Output only. Type of break this represents.

Returns
Type	Description
`int`

hasBreakType

clearBreakType

setBreakType

Output only. Type of break this represents.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getBreakSequence

Output only. The index of this ad break in the session.

Returns
Type	Description
`int\|string`

hasBreakSequence

clearBreakSequence

setBreakSequence