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

Classi 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()


Restituisce string:

getAdPodInfo()


Restituisce google.ima.dai.api.AdPodInfo:

getAdSystem()


Restituisce string:

getAdvertiserName()


Restituisce string:

getApiFramework()


Restituisce string:

getCompanionAds()


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

getCreativeAdId()


Restituisce string:

getCreativeId()


Restituisce string:

getDealId()


Restituisce string:

getDescription()


Restituisce string:

getDuration()


Restituisce number:

getTitle()


Restituisce string:

getVastMediaHeight()


Restituisce number:

getVastMediaWidth()


Restituisce number:

getWrapperAdIds()


Restituisce Array.<string>:

getWrapperAdSystems()


Restituisce Array.<string>:

getWrapperCreativeIds()


Restituisce Array.<string>:

Classi google.ima.dai.api.AdPodInfo

Metodi

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

getAdPosition()


Restituisce number:

getMaxDuration()


Restituisce number:

getPodIndex()


Restituisce number:

getTimeOffset()


Restituisce number:

getTotalAds()


Restituisce number:

Classi google.ima.dai.api.AdProgressData

Campi

Una classe per specificare i dati relativi all'avanzamento dell'annuncio.

Proprietà

Nome Tipo Descrizione
adBreakDuration

adPosition

currentTime

duration

totalAds

Classi google.ima.dai.api.CompanionAd

Metodi

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

getAdSlotId()


Restituisce string:

getContent()


Restituisce string:

getContentType()


Restituisce string:

getHeight()


Restituisce number:

getWidth()


Restituisce number:

Classe google.ima.dai.api.CuePoint

Campi

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

Proprietà

Nome Tipo Descrizione
end

L'ora di fine di questo cue point.
played

Se questo cue point è stato riprodotto.
start

L'ora di inizio di questo cue point.

Classe google.ima.dai.api.LiveStreamRequest

Campi

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

Costruttore:
Parametro Tipo Descrizione
opt_liveStreamRequest Object

che ha già proprietà di richiesta stream assegnate.

Proprietà

Nome Tipo Descrizione
assetKey

Viene utilizzato per determinare quale stream deve essere riprodotto. La chiave asset della richiesta di live streaming è un identificatore che puoi trovare nell'interfaccia utente di DFP.

Classi google.ima.dai.api.StreamData

Campi

Una classe per specificare i dati dello stream.

Proprietà

Nome Tipo Descrizione
adProgressData

Informazioni relative alla temporizzazione dell'annuncio attualmente in riproduzione.
cuepoints

I cue point degli annunci per lo stream on demand. Questi potrebbero cambiare con l'evolversi dello stream. Questo campo verrà compilato solo nel listener di eventi per AdEventCUEPOINTS_CHANGED.
errorMessage

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Metodi

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

getAd()


Restituisce google.ima.dai.api.Ad: oggetto restituito con le informazioni sull'annuncio.

getStreamData()


Restituisce google.ima.dai.api.StreamData: restituisce l'oggetto con le informazioni sullo stream.

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

Viene attivato quando viene aggiornato l'avanzamento di un annuncio.
CLICK

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

Attivato quando un annuncio è completo.
CUEPOINTS_CHANGED

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

Viene attivato quando si verifica un errore.
FIRST_QUARTILE

Viene attivato quando un annuncio raggiunge il primo quartile.
LOADED

Viene attivato quando il file manifest dello stream è disponibile.
MIDPOINT

Attivato quando un annuncio raggiunge il suo punto intermedio.
STARTED

Attivato quando inizia un annuncio.
STREAM_INITIALIZED

Viene attivato quando lo stream viene inizializzato.
THIRD_QUARTILE

Attivato quando un annuncio raggiunge il terzo quartile.

Class google.ima.dai.api.StreamManager

Metodi

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

Costruttore:
Parametro Tipo Descrizione
videoElement HTMLVideoElement

L'elemento video player effettivo.

contentTimeForStreamTime(streamTime)

Restituisce il tempo dei contenuti senza annunci per un determinato momento dello stream. Restituisce l'ora di streaming specificata per i live streaming.

Restituisce number: il tempo dei contenuti corrispondente al tempo dello stream specificato una volta rimossi gli annunci.

Parametro Tipo Descrizione
streamTime number

il tempo dello stream con gli annunci inseriti (in secondi).

onTimedMetadata(metadata)

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

Parametro Tipo Descrizione
metadata Object

Il dizionario dei metadati.

previousCuePointForStreamTime(streamTime)

Restituisce il cue point precedente per il tempo dello stream specificato. Restituisce null se non esiste un cue point di questo tipo. Viene utilizzato per implementare funzionalità come lo snap back e viene chiamato quando il publisher rileva che l'utente ha cercato di tornare a un'interruzione pubblicitaria.

Restituisce google.ima.dai.api.CuePoint: il cue point precedente per il tempo di stream specificato.

Parametro Tipo Descrizione
streamTime number

l'ora dello stream a cui è stato eseguito il seek.

processMetadata(type, data, timestamp)

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

Parametro Tipo Descrizione
type string

Digita i metadati. Deve essere "ID3".
data Uint8Array

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

Ora in cui devono essere elaborati i dati.

requestStream(streamRequest)

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

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

contiene i parametri per caricare i metadati dello stream.

setClickElement(clickElement)

Imposta l'elemento di clickthrough degli annunci. Questo elemento viene utilizzato come destinatario del clic o del tocco durante la riproduzione di un annuncio e può comportare il passaggio ad un'altra pagina.

Parametro Tipo Descrizione
clickElement Element

L'elemento utilizzato come clic sull'annuncio.

streamTimeForContentTime(contentTime)

Restituisce il tempo dello stream con gli annunci per un determinato momento dei contenuti. Restituisce il tempo dei contenuti specificato per i live streaming.

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

Parametro Tipo Descrizione
contentTime number

La durata dei contenuti senza annunci (in secondi).

Classi google.ima.dai.api.StreamRequest

Campi

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

Proprietà

Nome Tipo Descrizione
adTagParameters

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

La chiave API della richiesta di stream. Viene configurato tramite la UI amministratore di DFP e fornito all'editore 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 un modo pratico per consentire ai publisher di trovare un log dello stream nello strumento di monitoraggio delle attività di streaming.

Classi google.ima.dai.api.VODStreamRequest

Campi

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

Costruttore:
Parametro Tipo Descrizione
opt_VODStreamRequest Object

che ha già proprietà di richiesta di stream assegnate.

Proprietà

Nome Tipo Descrizione
contentSourceId

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

Identificatore dell'origine di contenuti video. Obbligatorio per gli stream on demand.

Costante google.ima.VERSION

Una stringa contenente la versione completa dell'SDK.