REST Resource: networks.assets.adBreaks

  • AdBreak resource stores ad break metadata for live video events, including duration, custom parameters, and SCTE-35 cue-out data.

  • AdBreaks can be created and listed using the provided APIs for live stream management within Google Ad Manager.

  • BreakState indicates the current status of an Ad Break, ranging from initial decisioning to complete delivery to users.

  • Ad Manager pod template names can be associated with AdBreaks to facilitate ad serving and targeting.

Resource: AdBreak

Ad break metadata used to decision ads for an ad break in a live video event.

JSON representation 
{
  "name": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState)
}
Fields
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.
expectedDuration

string (Duration format)

Required. Expected break duration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
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'
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="
podTemplateName

string

Google Ad Manager pod template name.
breakState

enum (BreakState)

The current state of the Ad Break.

BreakState

The state of an Ad Break.

Enums
BREAK_STATE_UNSPECIFIED The Ad Break state is unknown.
BREAK_STATE_DECISIONED Ad Break decisioning started but not yet delivered to users.
BREAK_STATE_COMPLETE Ad Break was delivered to users.

Methods

create

 API to create an Ad Break within the live stream.

list

 API to list Ad Breaks within the live stream.