REST Resource: networks.sources.content.adBreaks

Ressource: AdBreak

Metadaten für Werbeunterbrechungen, die verwendet werden, um Anzeigen für eine Werbeunterbrechung in einem Live-Videoereignis zu bestimmen.

JSON-Darstellung 
{
  "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)
  }
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der Werbeunterbrechung. Dieses Feld hat das Format „networks//assets//adBreaks/“.

„network_code“ ist der Netzwerkcode in Google Ad Manager, zu dem diese Inhalte gehören.

„asset_key“ ist der Schlüssel des Livestreamtermins in Google Ad Manager, unter dem die Werbeunterbrechung erstellt wurde.

„adBreakId“ ist der Schlüssel der Werbeunterbrechung. NUR AUSGABE.
createTime

string (Timestamp format)

Nur Ausgabe. Erstellungszeitpunkt der Werbeunterbrechung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
expectedDuration

string (Duration format)

Erforderlich. Erwartete Dauer der Pause.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
customParams
(deprecated)

string

Optional. Schlüssel/Wert-Paare, die in Anzeigenanfragen für diese Werbeunterbrechung beim Targeting auf benutzerdefinierte Kriterien in Ad Manager eingefügt werden sollen. Beispiel: 'key1=value&key2=value2,value22' Veraltet: Bitte legen Sie cust_params in breakParams.ad_tag_params mit dem Schlüssel „cust_params“ fest.
scte35CueOut

string

Optional. Base64-codierte Daten aus dem SCTE-35-Cue-out-Ereignis. Kann den Befehl „splice_insert()“ oder „time_signal()“ enthalten. Beispiele: – mit time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” – mit splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

Optional. Name der Google Ad Manager-Pod-Vorlage. Veraltet: Legen Sie „cust_params“ in „breakParams.ad_tag_params“ mit dem Schlüssel „ptpln“ fest.
breakState

enum (BreakState)

Nur Ausgabe. Der aktuelle Status der Werbeunterbrechung.
expectedStartTime

string (Timestamp format)

Optional. Die erwartete Startzeit der Werbeunterbrechung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Optional. Die Werbeunterbrechung läuft nach expectedStartTime + expireDuration ab. Wenn „expectedStartTime“ nicht festgelegt ist, läuft die Werbeunterbrechung „expireDuration“ nach Beginn der Entscheidungsfindung ab. Standard: 30 Minuten, Minimum: 5 Minuten, Maximum: 6 Stunden

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
breakSequence

string (int64 format)

Nur Ausgabe. Die Mid-Roll-Sequenz-ID der Werbeunterbrechung. Mehrere Werbeunterbrechungen können dieselbe breakSequence haben, wenn dies explizit über breakParams.ad_tag_params mit dem Schlüssel „mridx“ angegeben wird. Dadurch werden zwei GAM-Werbeunterbrechungen verknüpft.
breakParams

object (BreakParams)

Optional. Parameter für die Werbeunterbrechung, die in Anzeigenanfragen für diese Werbeunterbrechung enthalten sein sollen.
matchParams

object (MatchParams)

Optional. Wird für Stitched DAI verwendet, um zu bestimmen, wie eine über die API erstellte Werbeunterbrechung mit einer Werbeunterbrechung im Manifest abgeglichen wird. Wird eine neue Unterbrechung erkannt, wird eine Abgleichsfunktion für alle Werbeunterbrechungen eines Ereignisses mit dem breakState SCHEDULED oder DECISIONED ausgeführt, um zu prüfen, ob alle festgelegten Parameter in matchParams einer Werbeunterbrechung mit der erkannten Unterbrechung übereinstimmen. Ein Abgleich erfolgt, wenn eine der folgenden Bedingungen erfüllt ist: 1. Die Unterbrechung hat ein „matchParams“-Feld und alle darin festgelegten Parameter stimmen mit der neuen Unterbrechung überein. 2. Die Werbeunterbrechung ist DECISIONED und hat kein „matchParams“-Feld.

Um ein versehentliches „Match-all“-Verhalten zu verhindern (das bei leeren, aber vorhandenen matchParams auftreten würde), dürfen matchParams nicht leer sein, wenn sie festgelegt sind. Wenn das Feld in einer Anfrage vorhanden ist, muss mindestens eines seiner eigenen Felder festgelegt werden.

Werbeunterbrechungen werden in dieser Reihenfolge geprüft: 1. mit matchParams, sortiert nach aufsteigender expectedStartTime, aufsteigender createTime, wobei Werbeunterbrechungen ohne expectedStartTime beim Sortieren priorisiert werden. 2. ohne matchParams, sortiert nach aufsteigender expectedStartTime, aufsteigender createTime, wobei Werbeunterbrechungen ohne expectedStartTime beim Sortieren priorisiert werden.

Wenn alle ausstehenden EABNs nicht übereinstimmen, greift DAI auf das JIT-Entscheidungsverhalten zurück und verwendet den nächsten verfügbaren Midroll-Index.
servedBreak

object (ServedBreak)

Nur Ausgabe. Diese Werte entsprechen den tatsächlichen Informationen der ausgelieferten Werbeunterbrechung. Wird nur für Werbeunterbrechungen mit einem COMPLETE-BreakState festgelegt.

Methoden

create

 API zum Erstellen einer Werbeunterbrechung im Livestream.

list

 API zum Auflisten von Werbeunterbrechungen in einem Livestream.