API VOD per la pubblicazione di pod di inserimento di annunci dinamici

L'API di inserimento di annunci dinamici ti consente di richiedere e monitorare gli stream on demand DAI.

Servizio: dai.google.com

Tutti gli URI sono relativi a https://dai.google.com.

Metodo: create stream

Questo metodo crea uno stream direttamente dal dispositivo, restituendo tutte le risorse necessarie all'applicazione client per riprodurre e monitorare gli annunci e visualizzare gli elementi dell'interfaccia utente.

Metodi
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

Crea una sessione VOD di pubblicazione di pod DAI.

Richiesta HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream

Parametri del percorso

Parametri
network_code string

Il codice di rete Google Ad Manager del publisher.

Corpo della richiesta

Il corpo della richiesta è di tipo application/json e deve contenere un oggetto CreateStreamRequest.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un nuovo oggetto CreateStreamResponse.

Metodo: registra flussi

Questo metodo registra uno stream nel backend di Google DAI dal dispositivo, restituendo tutte le risorse necessarie all'applicazione client per monitorare gli annunci e visualizzare gli elementi dell'interfaccia utente. A differenza del metodo create stream, questo metodo non restituisce un manifest degli annunci riproducibili. Questa azione viene invece eseguita in una chiamata al server separata: decision ad pods.

Metodi
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

Registra una sessione VOD di pubblicazione di pod DAI.

Richiesta HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

Parametri del percorso

Parametri
network_code string

Il codice di rete Google Ad Manager del publisher.

Corpo della richiesta

Il corpo della richiesta è di tipo application/json e deve contenere un oggetto StreamRegistrationRequest.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un nuovo oggetto StreamRegistrationResponse.

Metodo: recupera i pod di annunci

Questo metodo segue una chiamata register stream da un dispositivo ed è necessario per recuperare i manifest degli annunci riproducibili da unire ai manifest dei contenuti.

Metodi
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Pod di annunci decisionali per una sessione VOD di pubblicazione di pod DAI.

Richiesta HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Parametri del percorso

Parametri
network_code string

Il codice di rete Google Ad Manager del publisher.

stream_id string

L'ID stream ricevuto da una chiamata stream_registration.

Corpo della richiesta

Il corpo della richiesta è di tipo application/json e deve contenere un oggetto AdPodDecisionRequest.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un nuovo oggetto AdPodDecisionResponse.

Metodo: metadati dei pod di annunci

Questo metodo restituisce tutte le informazioni necessarie all'app client per monitorare gli annunci e visualizzare con precisione gli elementi dell'interfaccia utente appropriati.

Metodi
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

Recupera i metadati dei pod di annunci per una sessione specifica. Questo URL viene restituito nell'attributo metadata_url StreamRegistrationResponse.

Richiesta HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un oggetto Ad pods metadata.

Dati

PodMetadata

PodMetadata contiene informazioni sui metadati di annunci, interruzioni pubblicitarie e tag ID media.
Rappresentazione JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "polling_frequency": number,
}
Campi
tags map[string, object(TagSegment)]

Mappa dei segmenti di tag indicizzati in base al prefisso del tag.
ads map[string, object(Ad)]

Mappa degli annunci indicizzati per ID annuncio.
ad_breaks map[string, object(AdBreak)]

Mappa delle interruzioni pubblicitarie indicizzate per ID interruzione pubblicitaria.
polling_frequency number

Frequenza di polling dell'URL dei metadati consigliata, in secondi. Compilato per gli stream VOD che utilizzano il processo decisionale on demand.

TagSegment

TagSegment contiene un riferimento a un annuncio, alla relativa interruzione pubblicitaria e al tipo di evento. TagSegment con type="progress" non deve essere pingato all'endpoint di verifica dei contenuti multimediali dell'annuncio.
Rappresentazione JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Campi
ad string

L'ID dell'annuncio di questo tag.
ad_break_id string

L'ID dell'interruzione pubblicitaria di questo tag.
type string

Il tipo di evento di questo tag.

AdBreak

AdBreak descrive una singola interruzione pubblicitaria nel flusso. Contiene una durata, un tipo (mid/pre/post) e il numero di annunci.
Rappresentazione JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Campi
type string

I tipi di interruzione validi sono: pre, mid e post.
duration number

Durata totale dell'annuncio per questa interruzione pubblicitaria, in secondi.
expected_duration number

Durata prevista dell'interruzione pubblicitaria (in secondi), inclusi tutti gli annunci e qualsiasi slate.
ads number

Numero di annunci nell'interruzione pubblicitaria.
Annuncio descrive un annuncio nello stream.
Rappresentazione JSON
{
  "ad_break_id": string,
  "position": 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,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Campi
ad_break_id string

L'ID dell'interruzione pubblicitaria di questo annuncio.
position number

Posizione di questo annuncio nell'interruzione pubblicitaria, a partire da 1.
duration number

Durata dell'annuncio, in secondi.
title string

Titolo facoltativo dell'annuncio.
description string

Descrizione facoltativa dell'annuncio.
advertiser string

Identificatore inserzionista facoltativo.
ad_system string

Sistema pubblicitario facoltativo.
ad_id string

ID annuncio facoltativo.
creative_id string

ID creatività facoltativo.
creative_ad_id string

ID annuncio creatività facoltativo.
deal_id string

ID deal facoltativo.
clickthrough_url string

(Facoltativo) URL di clickthrough.
click_tracking_urls string

(Facoltativo) URL di monitoraggio dei clic.
verifications [object(Verification)]

Voci di verifica Open Measurement facoltative che elencano le risorse e i metadati necessari per eseguire il codice di misurazione di terze parti per verificare la riproduzione delle creatività.
slate boolean

Valore booleano facoltativo che indica che la voce corrente è una scheda.
icons [object(Icon)]

Un elenco di icone, omesso se vuoto.
wrappers [object(Wrapper)]

Un elenco di wrapper, omesso se vuoto.
universal_ad_id object(UniversalAdID)

ID annuncio universale facoltativo.
extensions string

Elenco facoltativo di tutti i nodi <Extension> in VAST.
companions [object(Companion)]

Companion facoltativi che possono essere visualizzati insieme a questo annuncio.
interactive_file object(InteractiveFile)

Creatività interattiva facoltativa (SIMID) da visualizzare durante la riproduzione dell'annuncio.

MatchOpts

MatchOpts specifica requisiti rigorosi di corrispondenza dei contenuti multimediali per uno stream.
Rappresentazione JSON
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
Campi
audio_channels boolean

Abbina i canali audio tra contenuti e annunci.
audio_sample_rate boolean

Corrispondenza della frequenza di campionamento audio tra contenuti e annunci.

CreateStreamRequest

CreateStreamRequest descrive le informazioni contenute nelle richieste HTTP all'API di pubblicazione dei pod VOD. La creazione dello stream viene avviata dal partner tecnologico video (VTP), per conto dell'SDK e del publisher, per ogni utente. Lo stream creato genera pod di annunci decisi che devono essere uniti dal VTP. Ciò è in contrasto con il flusso StreamRegistrationRequest+AdPodDecisionRequest che registra un flusso e decide gli ad pod in più richieste.
Rappresentazione JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
Campi
encoding_profiles [object(EncodingProfile)]

Un elenco di profili di codifica. Obbligatorio.
ad_tag string

Il tag annuncio di base per la decisione. Obbligatorio.
cuepoints number

Un elenco di cue point, in secondi. Obbligatorio quando la risposta del tag annuncio utilizza offset temporali posizionali.
manifest_type string

I tipi di manifest validi sono: hls e dash. Valore predefinito: hls. Facoltativo.
enable_hls_asset_list boolean

Indica se sono abilitati gli interstitial dell'elenco di asset HLS. Se attivata, DAI restituirà gli URL dell'elenco degli asset per ogni interruzione pubblicitaria, che possono essere utilizzati per gli interstitial HLS.
targeting_parameters string

Parametri di targeting di Ad Manager aggiuntivi. Facoltativo.
content_duration_seconds number

ContentDurationSeconds è la durata dei contenuti in secondi. Obbligatorio quando la risposta del tag annuncio utilizza offset temporali in percentuale.
decision_timing_options object(DecisionTimingOptions)

Indica quando devono essere prese decisioni sugli ad pod.
enable_inline_manifests boolean

Indica se i manifest di interruzione devono essere incorporati nella risposta JSON.
dai_options object(CreateStreamOptions)

DAIOptions per la creazione di stream.

CreateStreamOptions

CreateStreamOptions rappresenta le opzioni disponibili nel flusso di lavoro di creazione dello stream in un solo passaggio.
Rappresentazione JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
Campi
dash_profile string

Profilo MPEG-DASH da utilizzare: "live" o "on demand".
match_options object(MatchOpts)

data_sharing_policy_code string

Consente agli editori di ignorare il criterio di condivisione dei dati predefinito della rete.
sam_id string

sam_id è la chiave di debug SAM per la sessione, facoltativa.
session_title string

session_title è il titolo della sessione SAM per lo stream, facoltativo.
dash_inband_event_stream boolean

dash_inband_event_stream indica che DAI inserisce i messaggi ID3 come eventi in banda (in-media) utilizzando l'elemento InbandEventStream, anziché come elementi EventStream (nel manifest).
distinct_ad_profiles boolean

Se impostato su true, indica che il server utilizzerà qualsiasi profilo pubblicitario disponibile al massimo una volta quando abbina i profili di codifica richiesti.
tracking_mode string

tracking_mode è il tipo di monitoraggio degli annunci da utilizzare per lo stream, facoltativo. I valori validi sono: "ad_media", "server", "client".
emsg_version uint32

emsg_version impone l'utilizzo di una versione emsg specifica per gli ID3 in-media. Supportato solo quando dash_inband_event_stream è true.

StreamRegistrationRequest

StreamRegistrationRequest registra uno stream dal dispositivo per future decisioni relative ai pod pubblicitari. Ciò è in contrasto con una CreateStreamRequest che crea un flusso e adpod di decisioni in un'unica richiesta.
Rappresentazione JSON
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
Campi
targeting_parameters string

Parametri di targeting di Ad Manager aggiuntivi. Facoltativo.
dai_options object(StreamRegistrationOptions)

DAIOptions per la registrazione dello stream.

StreamRegistrationOptions

StreamRegistrationOptions elenca le opzioni disponibili per la creazione di stream
Rappresentazione JSON
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
Campi
sam_id string

sam_id è la chiave di debug SAM per la sessione, facoltativa.
tracking_mode string

tracking_mode è il tipo di monitoraggio degli annunci da utilizzare per lo stream, facoltativo. I valori validi sono: "ad_media", "server", "client".
emsg_version uint32

emsg_version impone l'utilizzo di una versione emsg specifica per gli ID3 in-media. Supportato solo quando dash_inband_event_stream è true.
skippable_ads_supported boolean

Indica se gli annunci ignorabili sono supportati.

StreamRegistrationResponse

StreamRegistrationResponse rappresenta la risposta JSON inviata al client in risposta a una StreamRegistrationRequest. Include l'ID stream e tutti gli URL di cui il dispositivo avrà bisogno. L'ID stream può essere utilizzato in una richiesta di decisione relativa al pod pubblicitario successiva. Ciò è in contrasto con una CreateStreamResponse che rappresenta una risposta per la creazione di uno stream e la decisione relativa agli ad pod contemporaneamente.
Rappresentazione JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
Campi
stream_id string

StreamID è l'identificatore univoco dello stream corrente dello spettatore.
media_verification_url string

MediaVerificationURL è il prefisso dell'URL da utilizzare nelle richieste di verifica dei contenuti multimediali degli annunci descritte di seguito. Assente per gli stream di beaconing lato client.
valid_for string

ValidFor è la durata di validità di questo stream, nel formato "00h00m00s".
valid_until string

ValidUntil è la data e l'ora fino alle quali questo stream è valido.
metadata_url string

MetadataURL è l'URL dei metadati da utilizzare per richiedere i metadati del pod pubblicitario.

DecisionTimingOptions

DecisionTimingOptions descrive le opzioni di tempistica per la decisione relativa alle interruzioni pubblicitarie per lo stream.
Rappresentazione JSON
{
  "type": string,
  "on_create_breaks": [],
}
Campi
type string

Il tipo descrive quando vengono prese le decisioni relative ai pod di annunci per lo stream. I tipi validi sono: on_create (impostazione predefinita), on_demand. Quando il tipo è on_demand, gli annunci vengono decisi in modo differito quando viene richiesto il manifest per una determinata interruzione. Quando il tipo è on_create, tutte le decisioni relative agli annunci vengono prese al momento della creazione dello stream.
on_create_breaks string

OnCreateBreaks è un elenco di ID interruzione VMAP sensibili alle maiuscole che devono essere decisi durante la creazione dello stream. Questo campo è consentito solo se il tipo è on_demand. Gli identificatori speciali delle interruzioni pubblicitarie "preroll" e "postroll" possono essere utilizzati per indicare che l'interruzione preroll o post-roll deve essere decisa al momento della creazione dello stream.

EncodingProfile

EncodingProfile descrive la codifica di una singola variante di contenuti. Può contenere solo impostazioni video, solo impostazioni audio (nel caso del tipo di contenuti multimediali), sia impostazioni video che audio o nessuna delle due nel caso dei sottotitoli codificati.
Rappresentazione JSON
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
Campi
profile_name string

Il nome del profilo fornito dal publisher. Unico per stream. Obbligatorio.
type string

I tipi validi sono: media, iframe, sottotitoli. Obbligatorio.
container_type string

I tipi validi sono: mpeg2ts, fmp4cmaf e hls_packed_audio. Obbligatorio per i tipi di media e iframe.
video_settings object(VideoSettings)

Le impostazioni video sono obbligatorie se il tipo di contenitore è iframe. In caso contrario, sono presenti solo se il profilo contiene video.
audio_settings object(AudioSettings)

Le impostazioni audio sono presenti se il profilo contiene audio. Le impostazioni audio sono consentite solo se il tipo di contenitore è multimediale.
subtitle_settings object(SubtitleSettings)

Le impostazioni dei sottotitoli sono obbligatorie per il tipo di sottotitoli.

VideoSettings

VideoSettings descrive il video di un profilo di codifica. Se è presente un'impostazione video, devono essere presenti tutte.
Rappresentazione JSON
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
Campi
codec string

La stringa del codec RFC6381 del video.
bitrate int32

La velocità in bit massima del profilo di codifica.
frames_per_second number

I frame al secondo del video.
resolution object(Resolution)

La risoluzione larghezza x altezza del video.

AudioSettings

AudioSettings descrive l'audio di un profilo di codifica. Se è presente un'impostazione audio, devono essere presenti tutte.
Rappresentazione JSON
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
Campi
codec string

La stringa del codec RFC6381 dell'audio.
bitrate int32

La velocità in bit audio massima del profilo di codifica.
channels int32

Il numero di canali audio (inclusi i canali a bassa frequenza).
sample_rate int64

La frequenza di campionamento dell'audio, in hertz.

SubtitleSettings

SubtitleSettings descrive i sottotitoli codificati di un profilo di codifica.
Rappresentazione JSON
{
  "format": string,
  "language": string,
}
Campi
format string

Il formato dei sottotitoli codificati: webvtt per HLS, webvtt o ttml per DASH.
language string

La lingua da inserire nel file manifest.

Risoluzione

La risoluzione descrive la larghezza x altezza di un video.
Rappresentazione JSON
{
  "width": int32,
  "height": int32,
}
Campi
width int32

Larghezza del video, in pixel. Obbligatorio.
height int32

Altezza del video, in pixel. Obbligatorio.

AdPodDecisionRequest

AdPodDecisionRequest rappresenta una richiesta di decisione dei pod di annunci per uno stream registrato in precedenza.
Rappresentazione JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
Campi
encoding_profiles [object(EncodingProfile)]

Un elenco di profili di codifica. Obbligatorio.
ad_tag string

Il tag annuncio di base per la decisione. Obbligatorio.
cuepoints number

Un elenco di cue point, in secondi. Obbligatorio quando la risposta del tag annuncio utilizza offset temporali posizionali.
manifest_type string

I tipi di manifest validi sono: hls e dash. Valore predefinito: hls. Facoltativo.
enable_hls_asset_list boolean

Indica se sono abilitati gli interstitial dell'elenco di asset HLS. Se attivata, DAI restituirà gli URL dell'elenco degli asset per ogni interruzione pubblicitaria, che possono essere utilizzati per gli interstitial HLS.
targeting_parameters string

Parametri di targeting di Ad Manager aggiuntivi. Facoltativo.
content_duration_seconds number

ContentDurationSeconds è la durata dei contenuti in secondi. Obbligatorio quando la risposta del tag annuncio utilizza offset temporali in percentuale.
decision_timing_options object(DecisionTimingOptions)

Indica quando devono essere prese decisioni sugli ad pod.
enable_inline_manifests boolean

Indica se i manifest di interruzione devono essere incorporati nella risposta JSON.
dai_options object(AdPodDecisionOptions)

DAIOptions per la decisione relativa al pod di annunci.

AdPodDecisionResponse

AdPodDecisionResponse rappresenta una risposta ai pod di annunci decisionali per uno stream registrato in precedenza. Contiene un elenco dei pod di annunci per cui è stata presa una decisione per lo stream.
Rappresentazione JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Campi
valid_for string

ValidFor è la durata di validità di questo stream, nel formato "00h00m00s".
valid_until string

ValidUntil è la data e l'ora fino alle quali questo stream è valido.
ad_pods [object(AdPod)]

Un elenco di pod di annunci ordinati in base all'ordine di inserimento.

CreateStreamResponse

CreateStreamResponse rappresenta la risposta JSON inviata al client in risposta a una CreateStreamRequest.
Rappresentazione JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
Campi
valid_for string

ValidFor è la durata di validità di questo stream, nel formato "00h00m00s".
valid_until string

ValidUntil è la data e l'ora fino alle quali questo stream è valido.
ad_pods [object(AdPod)]

Un elenco di pod di annunci ordinati in base all'ordine di inserimento.
stream_id string

StreamID è l'identificatore univoco dello stream corrente dello spettatore.
media_verification_url string

MediaVerificationURL è il prefisso dell'URL da utilizzare nelle richieste di verifica dei contenuti multimediali degli annunci descritte di seguito. Assente per gli stream di beaconing lato client.
pod_metadata object(PodMetadata)

PodMetadata contiene le informazioni aggiuntive necessarie per il rendering del pod sul dispositivo e per attivare la verifica. Come descritto nella documentazione dell'API Dynamic Ad Insertion Linear. Incluso solo per gli stream con beaconing lato client.
metadata_url string

MetadataURL è l'URL dei metadati da utilizzare per richiedere i metadati del pod pubblicitario.

AdPod

AdPod rappresenta un'interruzione pubblicitaria decisa e pronta per la riproduzione.
Rappresentazione JSON
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
Campi
manifest_uris string

ManifestURIs è una mappa del nome del profilo di codifica per manifest_uris della variante HLS per i contenuti HLS.
multivariant_uri string

MultivariantURI è l'URI del manifest multivariante per i contenuti HLS.
mpd_uri string

MPDURI è l'URI per l'MPD per i contenuti DASH.
manifests string

Manifests è una mappa del nome del profilo di codifica al manifest della variante HLS. Compilato solo se enable_inline_manifests del flusso è impostato su true.
multivariant_manifest string

MultivariantManifest è il manifest multivariante per i contenuti HLS. Compilato solo se enable_inline_manifests del flusso è impostato su true.
mpd_manifest string

MPDManifest è il manifest MPD per i contenuti DASH. Compilato solo se enable_inline_manifests del flusso è impostato su true.
asset_list_uri string

AssetListURI è l'URI dell'elenco di asset interstitial HLS per i contenuti HLS. Compilato solo se per lo stream sono attivati gli interstitial con elenco di asset HLS.
start number

Ora di inizio del pod di annunci nella cronologia degli asset (senza includere i pod di annunci precedenti) in secondi con virgola mobile.
duration number

Durata del pod di annunci in secondi con virgola mobile.
type string

Tipo di interruzione pubblicitaria.
midroll_index number

Indice basato su 1 dei mid-roll in uno stream, in base all'ID interruzione VMAP. Omesse per i pre-roll e i post-roll.

AdPodDecisionOptions

AdPodDecisionOptions rappresenta opzioni aggiuntive per lo stream.
Rappresentazione JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
Campi
dash_profile string

Profilo MPEG-DASH da utilizzare: "live" o "on demand".
match_options object(MatchOpts)

data_sharing_policy_code string

Consente agli editori di ignorare il criterio di condivisione dei dati predefinito della rete.
sam_id string

sam_id è la chiave di debug SAM per la sessione, facoltativa.
session_title string

session_title è il titolo della sessione SAM per lo stream, facoltativo.
dash_inband_event_stream boolean

dash_inband_event_stream indica che DAI inserisce i messaggi ID3 come eventi in banda (in-media) utilizzando l'elemento InbandEventStream, anziché come elementi EventStream (nel manifest).
distinct_ad_profiles boolean

Se impostato su true, indica che il server utilizzerà qualsiasi profilo pubblicitario disponibile al massimo una volta quando abbina i profili di codifica richiesti.

Stream

Stream viene utilizzato per eseguire il rendering di un elenco di tutte le risorse per un nuovo stream creato in formato JSON .
Rappresentazione JSON
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
Campi
stream_id string

Identificatore dello stream.
valid_for string

Durata per cui il flusso è valido, nel formato "00h00m00s".
valid_until string

Data fino alla quale lo stream è valido, nel formato RFC 3339.
media_verification_url string

URL di verifica dei contenuti multimediali.

Icona

L'icona contiene informazioni su un'icona VAST.
Rappresentazione JSON
{
  "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,
}
Campi
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

ClickData contiene informazioni su un clickthrough di un'icona.
Rappresentazione JSON
{
  "url": string,
}
Campi
url string

FallbackImage

FallbackImage contiene informazioni su un'immagine di riserva VAST.
Rappresentazione JSON
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Campi
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

Il wrapper contiene informazioni su un annuncio wrapper. Non include un ID deal se non esiste.
Rappresentazione JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Campi
system string

Identificatore del sistema pubblicitario.
ad_id string

ID annuncio utilizzato per l'annuncio wrapper.
creative_id string

ID creatività utilizzato per l'annuncio wrapper.
creative_ad_id string

ID annuncio della creatività utilizzato per l'annuncio wrapper.
deal_id string

ID deal facoltativo per l'annuncio wrapper.

Verifica

La verifica contiene informazioni per Open Measurement, che facilita la misurazione della visibilità e della verifica di terze parti. Al momento sono supportate solo le risorse JavaScript. Visita la pagina https://iabtechlab.com/standards/open-measurement-sdk/
Rappresentazione JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Campi
vendor string

Il fornitore di soluzioni di verifica.
java_script_resources [object(JavaScriptResource)]

Elenco delle risorse JavaScript per la verifica.
tracking_events [object(TrackingEvent)]

Elenco degli eventi di monitoraggio per la verifica.
parameters string

Una stringa opaca passata al codice di verifica di bootstrap.

JavaScriptResource

JavaScriptResource contiene informazioni per la verifica tramite JavaScript.
Rappresentazione JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Campi
script_url string

URI del payload JavaScript.
api_framework string

APIFramework è il nome del framework video che esercita il codice di verifica.
browser_optional boolean

Indica se questo script può essere eseguito al di fuori di un browser.

TrackingEvent

TrackingEvent contiene URL che devono essere pingati dal client in determinate situazioni.
Rappresentazione JSON
{
  "event": string,
  "uri": string,
}
Campi
event string

Il tipo di evento di monitoraggio.
uri string

L'evento di monitoraggio a cui inviare il ping.

UniversalAdID

UniversalAdID viene utilizzato per fornire un identificatore univoco della creatività che viene mantenuto nei sistemi pubblicitari.
Rappresentazione JSON
{
  "id_value": string,
  "id_registry": string,
}
Campi
id_value string

L'ID annuncio universale della creatività selezionata per l'annuncio.
id_registry string

Una stringa utilizzata per identificare l'URL del sito web del registro in cui è catalogato l'ID annuncio universale della creatività selezionata.

Complementare

Companion contiene informazioni sugli annunci companion che potrebbero essere visualizzati insieme all'annuncio.
Rappresentazione JSON
{
  "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)],
}
Campi
click_data object(ClickData)

I dati sui clic per questa creatività companion.
creative_type string

L'attributo CreativeType nel nodo <StaticResource> del tag VAST se si tratta di una companion di tipo statico.
height int32

L'altezza in pixel di questo annuncio companion.
width int32

La larghezza in pixel di questo annuncio companion.
resource string

Per i companion statici e iframe, questo sarà l'URL da caricare e visualizzare. Per i companion HTML, questo sarà lo snippet HTML da mostrare come companion.
type string

Tipo di questa creatività companion. Può essere statico, iframe o HTML.
ad_slot_id string

L'ID slot per questo annuncio companion.
api_framework string

Il framework API per questo componente aggiuntivo.
tracking_events [object(TrackingEvent)]

Elenco degli eventi di monitoraggio per questo annuncio companion.

InteractiveFile

InteractiveFile contiene informazioni per la creatività interattiva (ad es. SIMID) che devono essere visualizzate durante la riproduzione dell'annuncio.
Rappresentazione JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Campi
resource string

L'URL della creatività interattiva.
type string

Il tipo MIME del file fornito come risorsa.
variable_duration boolean

Indica se questa creatività può richiedere l'estensione della durata.
ad_parameters string

Il valore del nodo <AdParameters> nel tag VAST.