REST Resource: networks.assets.adBreaks
Stay organized with collections
Save and categorize content based on your preferences.
Resource: AdBreak
Ad break metadata used to decision ads for an ad break in a live video event.
BreakState
The state of an Ad Break.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eAdBreak resource stores ad break metadata for live video events, including duration, custom parameters, and SCTE-35 cue-out data.\u003c/p\u003e\n"],["\u003cp\u003eAdBreaks can be created and listed using the provided APIs for live stream management within Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eBreakState indicates the current status of an Ad Break, ranging from initial decisioning to complete delivery to users.\u003c/p\u003e\n"],["\u003cp\u003eAd Manager pod template names can be associated with AdBreaks to facilitate ad serving and targeting.\u003c/p\u003e\n"]]],["This document outlines the `AdBreak` resource, used for ad decisioning in live video events. Key details include the `name`, `expectedDuration`, `customParams`, `scte35CueOut`, `podTemplateName`, and `breakState`. `breakState` tracks the ad break's progress, with possible states like \"DECISIONED\" or \"COMPLETE\". Two API methods are provided: `create` to generate new ad breaks, and `list` to view existing ones within a live stream.\n"],null,["# REST Resource: networks.assets.adBreaks\n\n- [Resource: AdBreak](#AdBreak)\n - [JSON representation](#AdBreak.SCHEMA_REPRESENTATION)\n - [BreakState](#AdBreak.BreakState)\n- [Methods](#METHODS_SUMMARY)\n\nResource: AdBreak\n-----------------\n\nAd break metadata used to decision ads for an ad break in a live video event.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"expectedDuration\": string, \"customParams\": string, \"scte35CueOut\": string, \"podTemplateName\": string, \"breakState\": enum (/ad-manager/video/rest/v1/networks.assets.adBreaks#AdBreak.BreakState) } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The resource name of the Ad Break. This field will have the format of \"networks//assets//adBreaks/\". network_code is the network code in Google Ad Manager to which this content belongs. asset_key is the key of the Live Stream Event in Google Ad Manage under which the Ad Break was created. adBreakId is the key of the Ad Break. OUTPUT ONLY. |\n| `expectedDuration` | `string (`[Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)` format)` Required. Expected break duration. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| `customParams` | `string` Key-value pairs to be included on ad requests for this break for custom criteria targeting in Ad Manager. Example: 'key1=value\\&key2=value2,value22' |\n| `scte35CueOut` | `string` Base 64 encoded data from the scte35 cue out. May include splice_insert() or time_signal() command. Examples: - with time_signal(): \"/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==\" - with splice_insert(): \"/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=\" |\n| `podTemplateName` | `string` Google Ad Manager pod template name. |\n| `breakState` | `enum (`[BreakState](/ad-manager/video/rest/v1/networks.assets.adBreaks#AdBreak.BreakState)`)` The current state of the Ad Break. |\n\n### BreakState\n\nThe state of an Ad Break.\n\n| Enums ||\n|---------------------------|--------------------------------------------------------------|\n| `BREAK_STATE_UNSPECIFIED` | The Ad Break state is unknown. |\n| `BREAK_STATE_DECISIONED` | Ad Break decisioning started but not yet delivered to users. |\n| `BREAK_STATE_COMPLETE` | Ad Break was delivered to users. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------|---------------------------------------------------|\n| ### [create](/ad-manager/video/rest/v1/networks.assets.adBreaks/create) | API to create an Ad Break within the live stream. |\n| ### [list](/ad-manager/video/rest/v1/networks.assets.adBreaks/list) | API to list Ad Breaks within the live stream. |"]]
