API VOD per l'inserimento di annunci dinamici

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

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 beacon lato server. 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 ulteriori informazioni, consulta IAB Tech Lab e la specifica VAST 4.1.

Metodo: verifica dei contenuti multimediali

Quando durante la riproduzione viene rilevato un identificatore dei contenuti multimediali dell'annuncio, 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 con beacon lato server, in cui è il server ad avviare 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 va a buon fine e tutti i ping vengono inviati.
• HTTP/1.1 404 Not Found se la richiesta non riesce a verificare i contenuti multimediali a causa di una formattazione o di una scadenza dell'URL errata.
• HTTP/1.1 404 Not Found se una richiesta di verifica precedente per questo documento è andata a buon fine.
• HTTP/1.1 409 Conflict se in questo momento è già in corso l'invio di ping da un'altra richiesta.

ID elementi multimediali dell'annuncio (HLS)

Gli identificatori dei contenuti multimediali degli annunci verranno codificati nei metadati a tempo HLS utilizzando la chiave TXXX, riservata per i frame "Informazioni di testo definite dall'utente". I contenuti dell'inquadratura non saranno criptati e inizieranno sempre con il testo "google_".

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

ID elementi multimediali dell'annuncio (DASH)

Gli identificatori dei contenuti multimediali degli annunci verranno inseriti nel manifest tramite l'elemento EventStream di DASH.

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

Dati di 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,
}

Companion

{
  "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,
}