API SDK IMA DAI di Google

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

Classe google.ima.dai.api.Ad

Metodi

Una classe che rappresenta un oggetto annuncio durante l'inserimento di annunci dinamici. Questa classe espone un sottoinsieme delle proprietà ima.Ad.

getAdId()


Restituisci string:

getAdPodInfo()


Restituisci google.ima.dai.api.AdPodInfo:

getAdSystem()


Restituisci string:

getAdvertiserName()


Restituisci string:

getApiFramework()


Restituisci string:

getCompanionAds()


Restituisci Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Restituisci string:

getCreativeId()


Restituisci string:

getDealId()


Restituisci string:

getDescription()


Restituisci string:

getDuration()


Restituisci number:

getTitle()


Restituisci string:

getVastMediaHeight()


Restituisci number:

getVastMediaWidth()


Restituisci number:

getWrapperAdIds()


Restituisci Array.<string>:

getWrapperAdSystems()


Restituisci Array.<string>:

getWrapperCreativeIds()


Restituisci Array.<string>:

Classe google.ima.dai.api.AdPodInfo

Metodi

Una classe che rappresenta un oggetto informazioni pod di annunci durante l'inserimento di annunci dinamici. Questa classe espone un sottoinsieme delle proprietà ima.AdPodInfo.

getAdPosition()


Restituisci number:

getMaxDuration()


Restituisci number:

getPodIndex()


Restituisci number:

getTimeOffset()


Restituisci number:

getTotalAds()


Restituisci number:

Classe google.ima.dai.api.AdProgressData

Campi

Una classe per specificare i dati sull'avanzamento dell'annuncio.

Proprietà

Nome Tipo Descrizione
adBreakDuration

adPosition

currentTime

duration

totalAds

Classe google.ima.dai.api.CompanionAd

Metodi

Una classe che rappresenta un oggetto di annuncio companion durante l'inserimento di annunci dinamici. Questa classe espone un sottoinsieme delle proprietà ima.CompanionAd.

getAdSlotId()


Restituisci string:

getContent()


Restituisci string:

getContentType()


Restituisci string:

getHeight()


Restituisci number:

getWidth()


Restituisci number:

Classe google.ima.dai.api.CuePoint

Campi

Una classe per specificare le proprietà di un cue point, che rappresenta un'interruzione pubblicitaria nei flussi VOD DAI.

Proprietà

Nome Tipo Descrizione
end

L'ora di fine del cue point.
played

Se il cue point è stato riprodotto.
start

L'ora di inizio del cue point.

Corso google.ima.dai.api.LiveStreamRequest

Campi

Una classe per specificare le proprietà della richiesta di live streaming.

Costruttore:
Parametro Tipo Descrizione
opt_liveStreamRequest Object

oggetto di richiesta di flusso già assegnato.

Proprietà

Nome Tipo Descrizione
assetKey

Questo viene utilizzato per determinare lo stream da riprodurre. La chiave asset della richiesta di live streaming è un identificatore reperibile nell'interfaccia utente di DFP.

Classe google.ima.dai.api.StreamData

Campi

Una classe per specificare i dati dei flussi.

Proprietà

Nome Tipo Descrizione
adProgressData

Informazioni relative alle tempistiche per l'annuncio attualmente in riproduzione.
cuepoints

I cue point degli annunci per lo stream on demand. che possono cambiare con l'avanzamento del live streaming. Verrà completato solo nel listener di eventi per CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Classe google.ima.dai.api.StreamEvent

Metodi

Questo tipo di evento viene generato dal gestore dello streaming come notifica quando lo stato del flusso cambia.

getAd()


Restituisci google.ima.dai.api.Ad: restituisce l'oggetto con le informazioni sull'annuncio.

getStreamData()


Restituisci google.ima.dai.api.StreamData: restituisce l'oggetto con le informazioni sul flusso.

Enum google.ima.dai.api.StreamEvent.Type

Campi

Elenco dei tipi di eventi supportati dall'SDK IMA.

Valori

Valore Descrizione
AD_BREAK_ENDED

Attivato al termine di un'interruzione pubblicitaria.
AD_BREAK_STARTED

Attivato quando inizia un'interruzione pubblicitaria.
AD_PROGRESS

Attivato quando è presente un aggiornamento dell'avanzamento di un annuncio.
CLICK

Inviato quando viene fatto clic sull'elemento clic o toccato durante la riproduzione di un annuncio.
COMPLETE

Attivato al completamento di un annuncio.
CUEPOINTS_CHANGED

Inviato per gli stream on demand quando cambiano i cue point.
ERROR

Attivato quando si verifica un errore.
FIRST_QUARTILE

Attivato quando un annuncio raggiunge il primo quartile.
LOADED

Attivato quando il manifest del flusso è disponibile.
MIDPOINT

Attivato quando un annuncio raggiunge il punto centrale.
STARTED

Attivato all'avvio di un annuncio.
STREAM_INITIALIZED

Attivato quando il flusso viene inizializzato.
THIRD_QUARTILE

Attivato quando un annuncio raggiunge il terzo quartile.

Classe google.ima.dai.api.StreamManager

Metodi

Gestisce gli stream di inserimento di annunci dinamici. Gestisce le interazioni con il backend DAI e gestisce i ping di monitoraggio, nonché l'inoltro dello stream e degli eventi relativi agli annunci al publisher. Questo gestore non eredita da BaseAdsManager poiché non è un gestore per un annuncio specifico, ma uno per l'intero stream

Costruttore:
Parametro Tipo Descrizione
videoElement HTMLVideoElement

L'elemento effettivo del video player.

contentTimeForStreamTime(streamTime)

Restituisce l'ora dei contenuti senza annunci per una determinata durata di streaming. Restituisce il tempo di streaming specificato per i live streaming.

Restituisci number: l'ora dei contenuti che corrisponde all'ora dello stream specificata una volta rimossi gli annunci.

Parametro Tipo Descrizione
streamTime number

il tempo di streaming con gli annunci inseriti (in secondi).

onTimedMetadata(metadata)

Passa in un dizionario di metadati elaborati. Il dizionario prevede la chiave "TXXX" con la stringa di metadati definita dall'utente come valore. Se il tuo player fornisce metadati non elaborati, chiama invece ima.dai.api.StreamManager.processMetadata.

Parametro Tipo Descrizione
metadata Object

Il dizionario dei metadati.

previousCuePointForStreamTime(streamTime)

Restituisce il cue point precedente per la durata dello stream specificata. Restituisce null se questo cue point non esiste. Questo viene utilizzato per implementare funzionalità come lo snapshot e chiamato quando l'editore rileva che l'utente ha cercato per riportarlo a un'interruzione pubblicitaria.

Restituisci google.ima.dai.api.CuePoint: il cue point precedente per il tempo di streaming specificato.

Parametro Tipo Descrizione
streamTime number

il tempo di streaming desiderato.

processMetadata(type, data, timestamp)

Elabora i metadati con timestamp per i live streaming. Da utilizzare se il video player fornisce metadati non analizzati insieme a timestamp. In caso contrario, chiama ima.dai.api.StreamManager.onTimedMetadata.

Parametro Tipo Descrizione
type string

Tipo per i metadati. Deve essere "ID3".
data Uint8Array

Dati dei tag non elaborati. Per ID3, deve essere l'intero tag.
timestamp number

Momento in cui devono essere elaborati i dati.

requestStream(streamRequest)

Richiede il caricamento di uno stream utilizzando i parametri di streaming forniti.

Parametro Tipo Descrizione
streamRequest google.ima.dai.api.StreamRequest

contiene parametri per caricare i metadati dello stream.

setClickElement(clickElement)

Imposta l'elemento di clickthrough degli annunci. Questo elemento viene utilizzato come ricevitore di clic o tocco durante la riproduzione di un annuncio e potrebbe causare l'uscita dalla pagina corrente.

Parametro Tipo Descrizione
clickElement Element

l'elemento utilizzato come click-through sull'annuncio.

streamTimeForContentTime(contentTime)

Restituisce il tempo di streaming con gli annunci per un determinato periodo di tempo dei contenuti. Restituisce l'ora dei contenuti specificata per i live streaming.

Restituisci number: il tempo di streaming che corrisponde all'ora dei contenuti specificata dopo l'inserimento degli annunci.

Parametro Tipo Descrizione
contentTime number

la durata dei contenuti senza annunci (in secondi).

Classe google.ima.dai.api.StreamRequest

Campi

Una classe per specificare le proprietà della richiesta di flusso.

Proprietà

Nome Tipo Descrizione
adTagParameters

Puoi sostituire un insieme limitato di parametri del tag annuncio nella richiesta di streaming. Fornire parametri di targeting alla riproduzione in streaming fornisce ulteriori informazioni. Puoi utilizzare i parametri dai-ot e dai-ov per la preferenza della variante streaming. Per ulteriori informazioni, consulta la sezione Override dei parametri delle varianti di flusso.
apiKey

La chiave API della richiesta di streaming. Viene configurato tramite l' interfaccia utente amministratore di DFP e fornito al publisher per sbloccare i suoi contenuti. Verifica le applicazioni che tentano di accedere ai contenuti.
streamActivityMonitorId

L'ID da utilizzare per eseguire il debug dello stream con il Monitoraggio attività di streaming. Questo viene utilizzato per fornire agli editori un modo pratico per trovare un log del flusso nello strumento di monitoraggio dell'attività di streaming.

Classe google.ima.dai.api.VODStreamRequest

Campi

Una classe per specificare le proprietà della richiesta di streaming VOD.

Costruttore:
Parametro Tipo Descrizione
opt_VODStreamRequest Object

oggetto di richiesta di flusso già assegnato.

Proprietà

Nome Tipo Descrizione
contentSourceId

Identificatore univoco per i contenuti del publisher, da un CMS. Obbligatorio per i flussi on demand.
videoId

Identificatore della fonte di contenuto video. Obbligatorio per gli stream on demand.

Costante google.ima.VERSION

Una stringa contenente la versione completa dell'SDK.