REST Resource: networks.customAssets.adBreaks

  • An AdBreak resource provides metadata for decisioning ads during a live video event ad break.

  • The resource includes fields like name, expected duration, custom parameters, SCTE35 cue out data, pod template name, and the current break state.

  • The AdBreak resource name is output only and follows a specific format including the network code, asset key, and ad break ID.

  • The expected duration field is required and specifies the break's length in seconds with up to nine fractional digits.

  • Methods are available to create and list Ad Breaks within a live stream.

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.

Methods

create

 API to create an Ad Break within the live stream.

list

 API to list Ad Breaks within the live stream.