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

Class 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à di ima.Ad.

getAdId()


Resi string:

getAdPodInfo()


Resi google.ima.dai.api.AdPodInfo:

getAdSystem()


Resi string:

getAdvertiserName()


Resi string:

getApiFramework()


Resi string:

getCompanionAds()


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

getCreativeAdId()


Resi string:

getCreativeId()


Resi string:

getDealId()


Resi string:

getDescription()


Resi string:

getDuration()


Resi number:

getTitle()


Resi string:

getVastMediaHeight()


Resi number:

getVastMediaWidth()


Resi number:

getWrapperAdIds()


Resi Array.<string>:

getWrapperAdSystems()


Resi Array.<string>:

getWrapperCreativeIds()


Resi Array.<string>:

Classe google.ima.dai.api.AdPodInfo

Metodi

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

getAdPosition()


Resi number:

getMaxDuration()


Resi number:

getPodIndex()


Resi number:

getTimeOffset()


Resi number:

getTotalAds()


Resi number:

Classe google.ima.dai.api.AdProgressData

Campi

Una classe per specificare i dati di avanzamento degli annunci.

Proprietà

Nome Tipo Descrizione
adBreakDuration

adPosition

currentTime

duration

totalAds

Class google.ima.dai.api.CompanionAd

Metodi

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

getAdSlotId()


Resi string:

getContent()


Resi string:

getContentType()


Resi string:

getHeight()


Resi number:

getWidth()


Resi number:

Class 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.

Class google.ima.dai.api.LiveStreamRequest

Campi

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

Constructor:
Parametro Tipo Descrizione
opt_liveStreamRequest Object

oggetto a cui sono già state assegnate le proprietà della richiesta di stream.

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 può essere trovato nell'interfaccia utente di DFP.

Classe google.ima.dai.api.StreamData

Campi

Una classe per specificare i dati dello stream.

Proprietà

Nome Tipo Descrizione
adProgressData

Informazioni relative alla tempistica dell'annuncio in riproduzione.
cuepoints

I cue point pubblicitari per lo stream on demand. Questi potrebbero cambiare man mano che lo stream avanza. Questo campo verrà compilato solo nel listener di eventi per CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Metodi

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

getAd()


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

getStreamData()


Restituisce google.ima.dai.api.StreamData: oggetto restituito con 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 all'inizio di un'interruzione pubblicitaria.
AD_PROGRESS

Attivato quando viene aggiornato lo stato di avanzamento di un annuncio.
CLICK

Viene inviato quando si fa clic o si tocca l'elemento di clic durante la riproduzione di un annuncio.
COMPLETE

Attivato al termine di un annuncio.
CUEPOINTS_CHANGED

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

Attivato quando si verifica un errore.
FIRST_QUARTILE

Attivato quando un annuncio raggiunge il primo quartile.
LOADED

Attivato quando è disponibile il file manifest dello stream.
MIDPOINT

Viene attivato quando un annuncio raggiunge il punto medio.
STARTED

Attivato all'avvio di un annuncio.
STREAM_INITIALIZED

Attivato quando lo stream 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 di eventi di stream e annunci al publisher. Questo gestore non eredita da BaseAdsManager perché non è un gestore per un annuncio specifico, ma per l'intero stream

Constructor:
Parametro Tipo Descrizione
videoElement HTMLVideoElement

L'elemento video player effettivo.

contentTimeForStreamTime(streamTime)

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

Returns number: the content time that corresponds with the given stream time once ads are removed.

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 lettore 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 il ritorno rapido e viene chiamato quando il publisher rileva che l'utente ha cercato per riportarlo a un'interruzione pubblicitaria.

Returns google.ima.dai.api.CuePoint: il cue point precedente per il dato stream time.

Parametro Tipo Descrizione
streamTime number

il tempo di streaming a cui è stato eseguito il seek.

processMetadata(type, data, timestamp)

Elabora i metadati temporizzati per i live streaming. Utilizza questa funzione se il video player fornisce metadati non analizzati insieme ai timestamp, altrimenti chiama ima.dai.api.StreamManager.onTimedMetadata.

Parametro Tipo Descrizione
type string

Tipo di metadati. Deve essere "ID3".
data Uint8Array

Dati dei tag non elaborati. 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 parametri per caricare i metadati dello stream.

setClickElement(clickElement)

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

Parametro Tipo Descrizione
clickElement Element

l'elemento utilizzato come clic sull'annuncio.

streamTimeForContentTime(contentTime)

Restituisce l'ora dello stream con gli annunci per un determinato orario dei contenuti. Restituisce l'ora dei contenuti specificata 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

il tempo dei contenuti senza annunci (in secondi).

Class google.ima.dai.api.StreamRequest

Campi

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

Proprietà

Nome Tipo Descrizione
adTagParameters

Puoi ignorare un insieme limitato di parametri del tag annuncio nella richiesta di stream. Fornire parametri di targeting alla riproduzione in streaming fornisce ulteriori informazioni. Puoi utilizzare i parametri dai-ot e dai-ov per la preferenza delle varianti dello stream. Per saperne di più, consulta Override Stream Variant Parameters.
apiKey

La chiave API della richiesta di stream. Viene configurato tramite l' interfaccia utente di amministrazione 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. Viene utilizzato per fornire un modo pratico per consentire agli editori di trovare un log di stream nello strumento Monitoraggio attività di streaming.

Class google.ima.dai.api.VODStreamRequest

Campi

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

Constructor:
Parametro Tipo Descrizione
opt_VODStreamRequest Object

oggetto a cui sono già state assegnate le proprietà della richiesta di stream.

Proprietà

Nome Tipo Descrizione
contentSourceId

Identificatore univoco dei 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.