REST Resource: adBreak.networks.assets.adBreaks

Risorsa: AdBreak

Metadati dell'interruzione pubblicitaria utilizzati per decidere gli annunci per un'interruzione pubblicitaria in un evento video live.

Rappresentazione JSON 
{
  "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)
  }
}
Campi
name

string

Solo output. Il nome della risorsa dell'interruzione pubblicitaria. Questo campo avrà il formato "networks//assets//adBreaks/".

network_code è il codice di rete in Google Ad Manager a cui appartengono questi contenuti.

asset_key è la chiave dell'evento live streaming in Google Ad Manager in cui è stata creata l'interruzione pubblicitaria.

adBreakId è la chiave dell'interruzione pubblicitaria. SOLO OUTPUT.
createTime

string (Timestamp format)

Solo output. L'ora di creazione dell'interruzione pubblicitaria.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

Obbligatorio. Durata prevista della pausa.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
customParams
(deprecated)

string

Facoltativo. Le coppie chiave-valore da includere nelle richieste di annunci per questa interruzione per il targeting dei criteri personalizzati in Ad Manager. Esempio: "key1=value&key2=value2,value22" Deprecato: imposta cust_params in breakParams.ad_tag_params utilizzando la chiave "cust_params".
scte35CueOut

string

Facoltativo. Dati con codifica Base64 a partire dal cue-out di scte35. Può includere il comando splice_insert() o time_signal(). Esempi: - con time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - con splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

Facoltativo. Nome del modello pod di Google Ad Manager. Obsoleto: imposta cust_params in breakParams.ad_tag_params utilizzando la chiave "ptpln".
breakState

enum (BreakState)

Solo output. Lo stato attuale dell'interruzione pubblicitaria.
expectedStartTime

string (Timestamp format)

Facoltativo. L'ora di inizio prevista dell'interruzione pubblicitaria.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Facoltativo. Scade l'interruzione pubblicitaria all'ora expectedStartTime + expireDuration. Se expectedStartTime non è impostato, l'interruzione pubblicitaria scadrà dopo expireDuration dall'inizio del processo decisionale. Valore predefinito: 30 minuti. Minimo: 5 minuti. Massimo: 6 ore.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
breakSequence

string (int64 format)

Solo output. L'ID sequenza mid-roll dell'interruzione pubblicitaria. Più interruzioni pubblicitarie possono avere lo stesso breakSequence se specificato esplicitamente tramite breakParams.ad_tag_params con la chiave mridx. In questo modo, vengono collegati due intervalli pubblicitari GAM.
breakParams

object (BreakParams)

Facoltativo. Parametri dell'interruzione da includere nelle richieste di annuncio per questa interruzione.
matchParams

object (MatchParams)

Facoltativo. Utilizzato per l'inserimento di annunci dinamici (DAI) per determinare la corrispondenza tra un'interruzione pubblicitaria creata tramite l'API e un'interruzione pubblicitaria nel manifest. Quando viene rilevata una nuova interruzione, viene eseguita una funzione di corrispondenza su tutte le interruzioni pubblicitarie di un evento con un valore breakState di SCHEDULED o DECISIONED per verificare se tutti i parametri impostati in matchParams di un'interruzione pubblicitaria corrispondono all'interruzione rilevata. Si verifica una corrispondenza se è soddisfatta una delle seguenti condizioni: 1. La pausa pubblicitaria ha un campo matchParams e tutti i parametri impostati al suo interno corrispondono alla nuova pausa. 2. L'interruzione pubblicitaria è DECISIONED e non ha un campo matchParams.

Per evitare un comportamento "corrispondenza con tutto" accidentale (che si verificherebbe con un matchParams vuoto ma presente), matchParams non può essere vuoto se impostato. Se il campo è presente in una richiesta, deve essere impostato almeno uno dei suoi campi.

Le interruzioni pubblicitarie vengono controllate in questo ordine: 1. con matchParams, ordinate in base a expectedStartTime crescente, createTime crescente, dove le interruzioni pubblicitarie senza expectedStartTime hanno la priorità quando vengono ordinate 2. senza matchParams, ordinate in base a expectedStartTime crescente, createTime crescente, dove le interruzioni pubblicitarie senza expectedStartTime hanno la priorità quando vengono ordinate

Se tutti gli EABN in attesa non corrispondono, DAI tornerà al comportamento di decisione JIT utilizzando l'indice mid-roll successivo disponibile
servedBreak

object (ServedBreak)

Solo output. Riflette le informazioni effettive dell'interruzione pubblicitaria pubblicata. Impostato solo per le interruzioni pubblicitarie con un COMPLETE breakState.

BreakState

Lo stato di un'interruzione pubblicitaria.

Enum
BREAK_STATE_UNSPECIFIED Lo stato dell'interruzione pubblicitaria è sconosciuto.
BREAK_STATE_DECISIONED La decisione relativa alla pausa pubblicitaria è stata avviata, ma non è ancora stata comunicata agli utenti.
BREAK_STATE_COMPLETE La pausa pubblicitaria è stata mostrata agli utenti.
BREAK_STATE_SCHEDULED L'interruzione pubblicitaria è pianificata per la decisione.
BREAK_STATE_EXPIRED L'interruzione pubblicitaria è scaduta e inutilizzabile. Per impostazione predefinita, le interruzioni pubblicitarie scadono 30 minuti dopo expectedStartTime o 30 minuti dopo l'inizio del processo decisionale dell'interruzione pubblicitaria se expectedStartTime non è impostato. Una scadenza può essere impostata in modo esplicito utilizzando il campo expireDuration.

BreakParams

Parametri associati a un'interruzione pubblicitaria.

Rappresentazione JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Campi
macros[]

object (KeyValue)

Facoltativo. Valori delle macro personalizzate che sostituiscono un segnaposto arbitrario nel tag annuncio. Al momento della richiesta di annuncio, DAI espanderà le macro dei tag annuncio nel formato %%DAI_PATTERN:[MACRO_KEY]%%, dove MACRO_KEY è la chiave.

Se impostate, queste macro avranno la precedenza sulle macro impostate in una richiesta di pubblicazione di pod.
adTagParams[]

object (KeyValue)

Facoltativo. Esegue l'override dei parametri del tag annuncio nella richiesta di annuncio principale.

Questi vengono utilizzati per la decisione se vengono attivati prima delle richieste di pubblicazione del pod con cust_params impostato.

In genere, i parametri eseguono l'override di un parametro stringa di query nella richiesta di annuncio principale per l'interruzione. Per alcuni ad server con formati URL personalizzati, i parametri possono sostituire posizioni specifiche nel tag annuncio per rispettare i requisiti dell'ad server. Se imposti il valore "mridx" su AdBreak, il campo breakSequence verrà sovrascritto con il valore fornito, se si tratta di un numero intero positivo valido. Questo vale anche per i server pubblicitari non GAM.

Se impostati, questi parametri avranno la precedenza sui parametri impostati in una richiesta di pubblicazione di pod.

KeyValue

Rappresenta una coppia chiave-valore.

Rappresentazione JSON 
{
  "key": string,
  "value": string
}
Campi
key

string

Obbligatorio. Chiave di questa coppia chiave-valore.
value

string

Obbligatorio. Valore di questa coppia chiave-valore.

MatchParams

Parametri da abbinare a un'interruzione pubblicitaria DAI cucita rilevata.

Rappresentazione JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Campi
scte35Binary

string

Facoltativo. SCTE-35 binario. Per corrispondere a questo campo, l'interruzione pubblicitaria nel file manifest deve avere la stessa stringa binaria SCTE-35 (codificata in base64). Se è vuoto, viene ignorato.
scte35Upid

string

Facoltativo. UPID (Unique Program Identifier) SCTE-35. Per corrispondere a questo campo, l'interruzione pubblicitaria nel manifest deve avere lo stesso UPID SCTE-35. L'UPID è un valore analizzato dal binario SCTE-35. Se è vuoto, viene ignorato.
scte35EventId

integer (uint32 format)

Facoltativo. ID evento SCTE-35. Per la corrispondenza di questo campo, la pausa pubblicitaria nel manifest deve avere lo stesso ID evento (ID evento di splicing/ID evento di segmentazione). L'ID evento è un valore analizzato dal file binario SCTE-35. Se è vuoto, viene ignorato.
breakDuration

boolean

Facoltativo. Durata interruzione. Per corrispondere a questo campo, l'interruzione pubblicitaria nel manifest deve avere la stessa durata dell'interruzione di expectedDuration, con una tolleranza di 1 ms. Se è false, questo passaggio viene ignorato.

ServedBreak

Rappresenta le informazioni effettive dell'interruzione pubblicitaria pubblicata.

Rappresentazione JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Campi
breakDetectTime

string (Timestamp format)

Solo output. L'ora in cui viene rilevata l'interruzione pubblicitaria corrispondente. Per la pubblicazione di pod, questo è il momento in cui viene richiesto il primo segmento/manifest del pod di annunci. Per l'inserimento di annunci dinamici cuciti, questo è il momento in cui viene rilevata per la prima volta l'interruzione pubblicitaria nel manifest.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
detectedDuration

string (Duration format)

Solo output. La durata rilevata è stata superata nell'interruzione pubblicitaria corrispondente.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
scte35CueOut

string

Solo output. Il messaggio SCTE-35 con codifica base64 rilevato è stato trasmesso durante l'interruzione pubblicitaria corrispondente.

Metodi

create

 API per creare un'interruzione pubblicitaria all'interno del live streaming.

delete

 API per eliminare un'interruzione pubblicitaria all'interno del live streaming.

get

 API per ottenere un'interruzione pubblicitaria all'interno del live streaming.

list

 API per elencare le interruzioni pubblicitarie all'interno del live streaming.

patch

 API per aggiornare un'interruzione pubblicitaria all'interno del live streaming.