REST Resource: adBreak.networks.assets.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.

BreakState

Der Status einer Werbeunterbrechung.

Enums
BREAK_STATE_UNSPECIFIED Der Status der Werbeunterbrechung ist unbekannt.
BREAK_STATE_DECISIONED Die Entscheidung für die Werbeunterbrechung wurde gestartet, aber noch nicht an die Nutzer ausgeliefert.
BREAK_STATE_COMPLETE Die Werbeunterbrechung wurde für Nutzer ausgeliefert.
BREAK_STATE_SCHEDULED Die Werbeunterbrechung ist für die Entscheidungsfindung geplant.
BREAK_STATE_EXPIRED Die Werbeunterbrechung ist abgelaufen und kann nicht mehr verwendet werden. Standardmäßig laufen Werbeunterbrechungen 30 Minuten nach expectedStartTime ab oder 30 Minuten nach Beginn der Entscheidungsfindung für die Werbeunterbrechung, wenn expectedStartTime nicht festgelegt ist. Ein Ablauf kann explizit mit dem Feld „expireDuration“ festgelegt werden.

BreakParams

Parameter, die einer Werbebuchung zugeordnet sind.

JSON-Darstellung 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Felder
macros[]

object (KeyValue)

Optional. Benutzerdefinierte Makrowerte, die einen beliebigen Platzhalter im Anzeigen-Tag ersetzen. Bei der Anzeigenanfrage werden DAI-Anzeigen-Tag-Makros in der Form %%DAI_PATTERN:[MACRO_KEY]%% erweitert, wobei MACRO_KEY der Schlüssel ist.

Wenn sie festgelegt sind, haben sie Vorrang vor Makros, die in einer Pod-Serving-Anfrage festgelegt sind.
adTagParams[]

object (KeyValue)

Optional. Überschreibt Anzeigen-Tag-Parameter in der primären Anzeigenanfrage.

Sie werden für Entscheidungen verwendet, wenn sie vor Pod-Bereitstellungsanfragen mit festgelegten „cust_params“ ausgelöst werden.

Im Allgemeinen überschreiben Parameter einen Abfragestringparameter in der primären Anzeigenanfrage für die Unterbrechung. Bei einigen Ad-Servern mit benutzerdefinierten URL-Formaten können Parameter bestimmte Stellen im Ad-Tag überschreiben, um die Ad-Server-Anforderungen zu erfüllen. Wenn Sie den Wert „mridx“ für den AdBreak festlegen, wird das Feld „breakSequence“ mit dem angegebenen Wert überschrieben, sofern es sich um eine gültige positive Ganzzahl handelt. Das gilt auch für Ad-Server, die nicht von GAM stammen.

Wenn diese Parameter festgelegt sind, haben sie Vorrang vor Parametern, die in einer Pod Serving-Anfrage festgelegt sind.

KeyValue

Stellt ein Schlüssel/Wert-Paar dar.

JSON-Darstellung 
{
  "key": string,
  "value": string
}
Felder
key

string

Erforderlich. Schlüssel dieses Schlüssel/Wert-Paares.
value

string

Erforderlich. Wert dieses Schlüssel/Wert-Paares.

MatchParams

Parameter, die mit einer erkannten zusammengefügten DAI-Werbeunterbrechung übereinstimmen müssen.

JSON-Darstellung 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Felder
scte35Binary

string

Optional. SCTE‑35-Binärdatei. Damit dieses Feld übereinstimmt, muss die im Manifest enthaltene Werbeunterbrechung denselben binären SCTE-35-String (base64-codiert) haben. Wenn leer, wird dieser Schritt übersprungen.
scte35Upid

string

Optional. SCTE‑35‑UPID (Unique Program Identifier, eindeutige Programm-ID). Damit dieses Feld übereinstimmt, muss die In-Manifest-Werbeunterbrechung dieselbe SCTE-35-UPID haben. Die UPID ist ein Wert, der aus dem binären SCTE-35-Signal geparst wird. Wenn leer, wird dieser Schritt übersprungen.
scte35EventId

integer (uint32 format)

Optional. SCTE‑35‑Ereignis-ID. Damit dieses Feld übereinstimmt, muss die im Manifest enthaltene Werbeunterbrechung dieselbe Ereignis-ID (Splice-Ereignis-ID/Segmentierungsereignis-ID) haben. Die Ereignis-ID ist ein Wert, der aus dem binären SCTE‑35-Code geparst wird. Wenn leer, wird dieser Schritt übersprungen.
breakDuration

boolean

Optional. Dauer der Pause. Damit dieses Feld übereinstimmt, muss die Pausendauer des im Manifest enthaltenen Ad Breaks mit der expectedDuration des Ad Breaks übereinstimmen. Die Toleranz beträgt 1 ms. Wenn „false“, wird dieser Schritt übersprungen.

ServedBreak

Stellt tatsächliche Informationen zur ausgelieferten Werbeunterbrechung dar.

JSON-Darstellung 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Felder
breakDetectTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die übereinstimmende Werbeunterbrechung erkannt wird. Bei der Pod-Auslieferung ist das der Zeitpunkt, zu dem das erste Segment/Manifest des Anzeigen-Pods angefordert wird. Bei Stitched DAI ist das der Zeitpunkt, zu dem die Werbeunterbrechung zum ersten Mal im Manifest erkannt wird.

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"
detectedDuration

string (Duration format)

Nur Ausgabe. Die erkannte Dauer der übereinstimmenden Werbeunterbrechung.

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

string

Nur Ausgabe. Die erkannte base64-codierte SCTE-35-Nachricht, die für die entsprechende Werbeunterbrechung übergeben wurde.

Methoden

create

 API zum Erstellen einer Werbeunterbrechung im Livestream.

delete

 API zum Löschen einer Werbeunterbrechung im Livestream.

get

 API zum Abrufen einer Werbeunterbrechung im Livestream.

list

 API zum Auflisten von Werbeunterbrechungen in einem Livestream.

patch

 API zum Aktualisieren einer Werbeunterbrechung im Livestream.