API VOD per l'inserimento di annunci dinamici

L'API di inserimento di annunci dinamici ti consente di richiedere e monitorare gli stream video on demand (VOD) DAI. Sono supportati gli stream HLS e DASH.

Servizio: dai.google.com

Il percorso del metodo stream è relativo a https://dai.google.com

Metodo: stream

Richiesta HTTP

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

Intestazione della richiesta

Authorization: DCLKDAI key="<api-key>"

Parametri del percorso

Corpo della richiesta

Il corpo della richiesta è di tipo application/x-www-form-urlencoded e contiene i seguenti parametri:

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un nuovo Stream. Per gli stream di beaconing lato server, questo Stream contiene solo i campi stream_id e stream_manifest.

Open Measurement

Il campo Verifications contiene informazioni per la verifica di Open Measurement per gli stream non server-side-beaconing. Verifications contiene uno o più elementi Verification che elencano le risorse e i metadati necessari per verificare la riproduzione delle creatività con il codice di misurazione di terze parti. È supportato solo JavaScriptResource. Per saperne di più, consulta IAB Tech Lab e la specifica VAST 4.1.

Metodo: verifica dei contenuti multimediali

Dopo aver rilevato un identificatore di contenuti pubblicitari durante la riproduzione, invia immediatamente una richiesta utilizzando media_verification_url dall'endpoint stream. media_verification_url è un percorso assoluto. Le richieste di verifica dei contenuti multimediali non sono necessarie per gli stream di beaconing lato server, in cui il server avvia la verifica dei contenuti multimediali.

Le richieste all'endpoint media verification sono idempotenti.

Richiesta HTTP

GET {media-verification-url}/{ad-media-id}

Corpo della risposta

media verification restituisce le seguenti risposte:

• HTTP/1.1 204 No Content se la verifica dei contenuti multimediali ha esito positivo e vengono inviati tutti i ping.
• HTTP/1.1 404 Not Found se la richiesta non riesce a verificare i contenuti multimediali a causa di una formattazione errata dell'URL o della scadenza.
• HTTP/1.1 404 Not Found se una precedente richiesta di verifica per questo documento d'identità è andata a buon fine.
• HTTP/1.1 409 Conflict se un'altra richiesta sta già inviando ping in questo momento.

ID elementi multimediali annuncio (HLS)

Gli identificatori dei contenuti multimediali dell'annuncio verranno codificati nei metadati temporizzati HLS utilizzando la chiave TXXX, riservata ai frame "informazioni di testo definite dall'utente". I contenuti del frame non saranno criptati e inizieranno sempre con il testo "google_".

L'intero contenuto di testo del frame deve essere aggiunto all'media_verification_url per ogni richiesta di verifica dell'annuncio.

ID elementi multimediali dell'annuncio (DASH)

Gli identificatori dei contenuti multimediali dell'annuncio verranno inseriti nel manifest tramite l'utilizzo dell'elemento EventStream di DASH.

Ogni EventStream avrà un URI ID schema di urn:google:dai:2018. Conterranno eventi con l'attributo messageData contenente un ID media pubblicitari che inizia con "google_". L'intero contenuto dell'attributo messageData deve essere aggiunto all'attributo media_verification_url per ogni richiesta di verifica dell'annuncio.

Dati della risposta

Stream

{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}

AppleTV

{
  "interstitials_url": string,
}

AdBreak

{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}

Annuncio

{
  "seq": number,
  "start": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
  "skip_metadata": object(SkipMetadata),
  "extensions": [],
}

Evento

{
  "time": number,
  "type": string,
}

Sottotitolo

{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}

SkipMetadata

{
  "offset": number,
  "tracking_url": string,
}

Icona

{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}

ClickData

{
  "url": string,
}

FallbackImage

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

Verifica

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

Complementare

{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}

InteractiveFile

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}