- [Resource: AdBreak](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEventsByCustomAssetKey.adBreaks#AdBreak)
  - [JSON representation](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEventsByCustomAssetKey.adBreaks#AdBreak.SCHEMA_REPRESENTATION)
- [Methods](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEventsByCustomAssetKey.adBreaks#METHODS_SUMMARY)

## Resource: AdBreak

The `AdBreak` resource.

| JSON representation |
|---|
| ``` { "name": string, "adBreakId": string, "assetKey": string, "customAssetKey": string, "expectedStartTime": string, "duration": string, "breakState": enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEvents.adBreaks#AdBreak.AdBreakState`), "breakSequence": string, "podTemplateName": string, "customParams": string, "scte35CueOut": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the `AdBreak`. This field uses the `LiveStreamEvent` resource's asset key in the URI, even if the ad break was created, updated, or queried using the custom asset key. Format: `networks/{networkCode}/liveStreamEventsByAssetKey/{assetKey}/adBreaks/{adBreakId}` |
| `adBreakId` | `string` Optional. Immutable. `AdBreak` ID. Must consist only of lowercase letters, digits, and hyphens. Ad break IDs have a maximum length of 63 characters. If not set, an ad break ID is generated as a UUID string. |
| `assetKey` | `string` Optional. Immutable. The asset key of the `LiveStreamEvent` that the ad break belongs to. Either an asset key or a custom asset key must be provided for creation. |
| `customAssetKey` | `string` Optional. Immutable. The custom asset key of the `LiveStreamEvent` that the ad break belongs to. Either an asset key or a custom asset key must be provided for creation. |
| `expectedStartTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Optional. The expected start time of the ad break. When set, the scheduled ad break will be decisioned shortly before the expected start time. If this field is not set, ad decisioning begins immediately. An ad break can be created up to six hours before the expected start time. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `duration` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#duration` format)`` Required. The duration of the `AdBreak`. An expected duration in seconds with up to nine fractional digits, ending with `s`, for example, `3.5s`. This value will be updated to match the actual duration from the manifest or pod request after the ad break's state is `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEvents.adBreaks#AdBreak.AdBreakState.ENUM_VALUES.COMPLETE`. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`. |
| `breakState` | ``enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEvents.adBreaks#AdBreak.AdBreakState`)`` Output only. The state of the `AdBreak`. |
| `breakSequence` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The sequence id of the `AdBreak`. The unique sequence number of the created ad break. This value is only set after the `AdBreak` starts decisioning indicated by the ad break state's being `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEvents.adBreaks#AdBreak.AdBreakState.ENUM_VALUES.DECISIONED` . |
| `podTemplateName` | `string` Optional. The pod template name of the `AdBreak`. This field is the required unique name across all pod templates in the network, not the display name. |
| `customParams` | `string` Optional. The key-value pairs to be included on the ad requests for this `AdBreak`. Key-value pairs to include on ad requests for this break for custom criteria targeting in Google Ad Manager, separated by `=` and joined by `&`. Format:"key1=value\&key2=value" |
| `scte35CueOut` | `string` Optional. The Base64-encoded SCTE-35 command associated with the `AdBreak`. This field can include the `spliceInsert()` or `timeSignal()` command. **Examples** - `timeSignal()` ` /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg== ` - `spliceInsert()` ` /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo= ` |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEventsByCustomAssetKey.adBreaks/create` | Creates an `AdBreak` object. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEventsByCustomAssetKey.adBreaks/get` | Retrieves an `AdBreak` object. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.liveStreamEventsByCustomAssetKey.adBreaks/list` | Lists `AdBreak` objects. |