REST Resource: networks.customAssets.adBreaks

Resource: AdBreak

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

JSON representation 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
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.
createTime

string (Timestamp format)

Output only. The create time of the Ad Break.

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".
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
(deprecated)

string

Optional. 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' Deprecated: Please set cust_params in breakParams.ad_tag_params by using the "cust_params" key.
scte35CueOut

string

Optional. 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
(deprecated)

string

Optional. Google Ad Manager pod template name. Deprecated: Please set cust_params in breakParams.ad_tag_params by using the "ptpln" key.
breakState

enum (BreakState)

Output only. The current state of the Ad Break.
expectedStartTime

string (Timestamp format)

Optional. The expected start time of the Ad Break.

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".
expireDuration

string (Duration format)

Optional. Expires the Ad Break at expectedStartTime + expireDuration. If expectedStartTime is not set, the Ad Break will expire expireDuration after decisioning starts. Default: 30m Minimum: 5m Maximum: 6h

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
breakSequence

string (int64 format)

Output only. The midroll sequence ID of the Ad Break. Multiple ad breaks may have the same breakSequence if explicitly specified through breakParams.ad_tag_params with the mridx key. This effectively links two GAM ad breaks.
breakParams

object (BreakParams)

Optional. Break parameters to be included on ad requests for this break.
matchParams

object (MatchParams)

Optional. Used for Stitched DAI to determine how an Ad Break created through the API is matched with an in-manifest ad break. When a new break is detected, a match function will be run against all ad breaks of an event that have a breakState of SCHEDULED or DECISIONED to check if all set parameters in matchParams of an Ad Break match the detected break. A match occurs if either of these conditions are met: 1. The Ad Break has a matchParams field, and all parameters set in it match the new break. 2. The Ad Break is DECISIONED and does not have a matchParams field.

To prevent accidental "match-all" behavior (which would occur with an empty but present matchParams), matchParams cannot be empty if set. If the field is present in a request, at least one of its own fields must be set.

Ad Breaks are checked in this order: 1. with matchParams, ordered by ascending expectedStartTime, ascending createTime, where Ad Breaks without expectedStartTime are prioritized when sorted 2. without matchParams, ordered by ascending expectedStartTime, ascending createTime, where Ad Breaks without expectedStartTime are prioritized when sorted

If all pending EABNs do not match, DAI will fall back to JIT decisioning behavior utilizing the next available midroll index
servedBreak

object (ServedBreak)

Output only. This reflects the actual information of the served ad break. Only set for ad breaks with a COMPLETE breakState.

Methods

create

 API to create an Ad Break within the live stream.

list

 API to list Ad Breaks within the live stream.