0.16.0 (latest) 0.15.1 0.14.1 0.8.0 0.7.0 0.6.2 0.5.0 0.4.1 0.3.1 0.2.0 0.1.3 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` | `https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.DaiSession.AdBreak.LinearBreak` Output only. Information on the break for a linear session. |
| `↳ vod` | `https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.DaiSession.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](https://docs.cloud.google.com/ad-manager/dynamic-ad-insertion/api/ad-break) or [pod serving API](https://docs.cloud.google.com/ad-manager/dynamic-ad-insertion/pod-serving). |
| `↳ 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** |
| `https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.DaiSession.AdBreak.LinearBreak|null` |   |

### hasLinear

### setLinear

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.DaiSession.AdBreak.LinearBreak` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getVod

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.DaiSession.AdBreak.VodBreak|null` |   |

### hasVod

### setVod

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.DaiSession.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](https://docs.cloud.google.com/ad-manager/dynamic-ad-insertion/api/ad-break) or [pod serving
API](https://docs.cloud.google.com/ad-manager/dynamic-ad-insertion/pod-serving).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasAdBreakId

### clearAdBreakId

### setAdBreakId

Output only. Publisher-provided or DAI-generated break ID for the [Ad
break API](https://docs.cloud.google.com/ad-manager/dynamic-ad-insertion/api/ad-break) or [pod serving
API](https://docs.cloud.google.com/ad-manager/dynamic-ad-insertion/pod-serving).

| **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

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getServedAdsDuration

Output only. The duration of ads that were inserted for this break.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\Duration|null` |   |

### hasServedAdsDuration

### clearServedAdsDuration

### setServedAdsDuration

Output only. The duration of ads that were inserted for this break.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `Google\Protobuf\Duration` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getExecutedBreakDuration

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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\Duration|null` |   |

### hasExecutedBreakDuration

### clearExecutedBreakDuration

### setExecutedBreakDuration

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `Google\Protobuf\Duration` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTrackingPings

Output only. Tracking pings that were issued for this break. Keyed by a
unique ID to reference this tracking ping from a different submessage.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\Internal\MapField` |   |

### setTrackingPings

Output only. Tracking pings that were issued for this break. Keyed by a
unique ID to reference this tracking ping from a different submessage.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStreamTypeInfo

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |