SDK IMA DAI per Roku

    1. IMMA
    2. ima.AdBreakInfo
    3. ima.AdEvent
    4. ima.AdInfo
    5. ima.Companion
    6. ima.CuePoint
    7. ima.Error
    8. ima.ErrorEvent
    9. ima.Player
    10. ima.StreamFormat
    11. ima.StreamInfo
    12. ima.StreamManager
    13. ima.StreamRequest
    14. ima.StreamType
    15. ima.WrapperInfo

Class ima

Metodi

Funzioni globali che controllano l'SDK IMA.

disableLogging()

Disattiva il logging dell'SDK. Logging sarà attivo per impostazione predefinita.

getStreamManager()

Restituisce un gestore di streaming, se disponibile. Se il gestore di streaming non è ancora disponibile, viene restituito il valore Non valido. Se si è verificato un errore durante la creazione del gestore di stream, viene restituito un oggetto di errore.

Restituisci object: il gestore dello stream o l'oggetto di errore.

initSdk(settings)

Inizializza l'SDK.

Parametro Tipo Descrizione
settings object

Oggetto facoltativo delle impostazioni IMA.

requestStream(streamRequest)

Avvia una richiesta di flusso asincrono Il controllo torna immediatamente al player dopo aver chiamato questo metodo.

Restituisci object: un errore oppure non valido se non c'è nessun errore

Parametro Tipo Descrizione
streamRequest object

Torna all'inizio

Classe ima.AdBreakInfo

Campi

Metodi

Contiene informazioni su un'interruzione pubblicitaria. Passato ai callback eventi dall'SDK.

Proprietà

Nome Tipo Descrizione
adPosition

L'indice dell'annuncio nell'interruzione pubblicitaria. sarà 1 per gli annunci autonomi.

duration

La durata massima dell'interruzione in secondi o -1 se sconosciuta.

podIndex

Per i live streaming, restituisce sempre -1. Per i video on demand (VOD), restituisce l'indice del pod di annunci. Per un pod pre-roll, restituisce 0. Per gli annunci mid-roll, restituisce 1, 2, ..., n. Per un pod post-roll, restituisce n+1...n+x. Il valore predefinito è 0 se questo annuncio non fa parte di un pod o se il pod non fa parte di una playlist.

timeOffset

La posizione del pod nei contenuti, espressa in secondi. Il pre-roll restituisce 0, mentre i post-roll restituiscono -1 e i mid-roll restituiscono il tempo pianificato del pod.

totalAds

Il numero totale di annunci contenuti in questa interruzione pubblicitaria. sarà 1 per gli annunci autonomi.

createAdBreakInfo()


Restituisci ima.AdBreakInfo:

Torna all'inizio

Classe ima.AdEvent

Campi

Eventi attivati da gestore annunci.

Proprietà

Nome Tipo Descrizione
AD_PERIOD_ENDED

Viene attivato ogni volta che lo stream passa da pubblicità o slate ai contenuti. Viene attivato anche quando un annuncio viene riprodotto una seconda volta o durante la ricerca di un annuncio.

AD_PERIOD_STARTED

Viene attivato ogni volta che lo stream passa dai contenuti alla pubblicità o allo slate. Viene attivato anche quando un annuncio viene riprodotto una seconda volta o durante la ricerca di un annuncio.

COMPLETE

Attivato al termine della riproduzione dell'annuncio.

ERROR

Attivato quando si verifica un errore.

FIRST_QUARTILE

Viene attivato quando la testina di riproduzione dell'annuncio supera il primo quartile.

MIDPOINT

Viene attivato quando la testina di riproduzione dell'annuncio supera il punto centrale.

PROGRESS

Attivato quando si aggiorna l'avanzamento di un annuncio.

SKIPPABLE_STATE_CHANGED

Viene attivato quando viene modificato lo stato di un annuncio ignorabile.

SKIPPED

Attivato quando un annuncio viene ignorato.

START

Attivato quando inizia la riproduzione di un annuncio.

THIRD_QUARTILE

Viene attivato quando la testina di riproduzione dell'annuncio supera il terzo quartile.

Torna all'inizio

Classe ima.AdInfo

Campi

Metodi

Contiene informazioni su un annuncio. Passato ai callback eventi dall'SDK.

Proprietà

Nome Tipo Descrizione
adBreakInfo

Informazioni relative all'intera interruzione in cui si trova questo annuncio.

adDescription

La descrizione dell'annuncio.

adId

L'ID dell'annuncio o una stringa vuota se sconosciuto.

adSystem

Il sistema di annunci che fornisce la creatività.

adTitle

Il titolo dell'annuncio.

advertiserName

Il nome dell'inserzionista come definito dalla parte pubblicata.

companions

Gli annunci companion specificati nella risposta VAST.

currentTime

L'ora corrente di un annuncio in secondi o -1 se sconosciuta.

duration

La durata di questo singolo annuncio in secondi o -1 se sconosciuta.

universalAdIDRegistry

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

universalAdIDValue

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

wrappers

Un array di ima.WrapperInfo con informazioni sul wrapper per questo annuncio. L'ordine partirà dall'involucro esterno a quello interno.

createAdInfo()


Restituisci ima.AdInfo:

Torna all'inizio

Class ima.Companion

Campi

Metodi

Contiene informazioni sugli annunci associati a un annuncio.

Proprietà

Nome Tipo Descrizione
apiFramework

L'API necessaria per eseguire questo annuncio o non valida se non disponibile.

creativeType

Rappresenta il tipo di creatività, generalmente un tipo MIME.

height

L'altezza dell'annuncio companion in pixel. 0 se non disponibile.

trackingEvents

Una mappa degli eventi di monitoraggio in cui la chiave è l'evento e il valore è un elenco di URL di cui eseguire il ping su quell'evento.

url

L'URL per la risorsa statica di questo companion.

width

La larghezza dell'annuncio companion in pixel. 0 se non disponibile.

createCompanion()


Restituisci ima.Companion:

Torna all'inizio

Classe ima.CuePoint

Campi

Metodi

Contiene informazioni su un cue point.

Proprietà

Nome Tipo Descrizione
end

L'ora di fine di un cue point in secondi. Corrisponde a un'interruzione pubblicitaria.

hasPlayed

Un valore booleano che indica che il cue point è già stato riprodotto.

start

L'ora di inizio di un cue point in secondi. Corrisponde a un'interruzione pubblicitaria.

createCuePoint()


Restituisci ima.CuePoint:

Torna all'inizio

Classe ima.Error

Campi

Metodi

Oggetto passato al gestore degli errori in caso di errore.

Proprietà

Nome Tipo Descrizione
id

L'ID dell'errore. Controlla la costante ErrorEvent per un elenco di codici di errore.

info

Informazioni aggiuntive sull'errore.

type

Imposta sempre su errore per indicare il tipo di oggetto.

createError()


Restituisci ima.Error:

Torna all'inizio

Classe ima.ErrorEvent

Campi

Tutti gli errori che l'SDK potrebbe restituire.

Proprietà

Nome Tipo Descrizione
BAD_STREAM_REQUEST

La richiesta di stream non è stata compilata correttamente.

COULD_NOT_LOAD_STREAM

Impossibile caricare lo stream.

ERROR

Errore sconosciuto.

INVALID_RESPONSE

La risposta del server non è valida.

STREAM_API_KEY_NOT_VALID

La chiave API fornita non è stata accettata dal server.

Torna all'inizio

Classe ima.Player

Metodi

adBreakEnded(adBreakInfo)

Campo facoltativo. Richiamato al termine di un'interruzione pubblicitaria.

Parametro Tipo Descrizione
adBreakInfo ima.AdBreakInfo

Contiene informazioni sull'interruzione pubblicitaria.

adBreakStarted(adBreakInfo)

Campo facoltativo. Richiamato quando è iniziata un'interruzione pubblicitaria.

Parametro Tipo Descrizione
adBreakInfo ima.AdBreakInfo

Contiene informazioni sull'interruzione pubblicitaria.

allVideoComplete()

Campo facoltativo. Richiamato quando tutto il video è completo.

createPlayer()

Crea un oggetto IMA Player vuoto. Per riprodurre gli annunci, devi implementare la funzione loadUrl. Le altre funzioni sono facoltative.

Restituisci ima.Player:

loadUrl(streamInfo)

Richiamato quando il player deve iniziare la riproduzione di un URL. Devi implementare questo metodo per caricare lo stream.

Parametro Tipo Descrizione
streamInfo ima.StreamInfo

Contiene le informazioni necessarie per riprodurre i contenuti.

Torna all'inizio

Classe ima.StreamFormat

Campi

Definisce il formato dello stream.

Proprietà

Nome Tipo Descrizione
DASH

HLS

Torna all'inizio

Classe ima.StreamInfo

Campi

Metodi

Informazioni trasmesse dall'SDK al player in merito allo stream.

Proprietà

Nome Tipo Descrizione
format

Il formato del video: hls o trattino. Definito in ima.StreamFormat.

manifest

URL dello stream.

streamId

Un ID univoco per lo stream.

streamType

Il tipo di video: dal vivo oppure on demand. Definito in ima.StreamType.

subtitles

Sottotitoli, se disponibili. Non valido in caso contrario.

createStreamInfo()


Restituisci ima.StreamInfo:

Torna all'inizio

Classe ima.StreamManager

Metodi

Oggetto per la gestione della riproduzione dello stream.

addEventListener(event, callback)

Aggiunge un listener per l'evento specificato. Visualizza la costante AdEvents per gli eventi supportati.

Parametro Tipo Descrizione
event string

callback function

createStreamManager(streamRequest, streamInitResponse)


Restituisci ima.StreamManager:

Parametro Tipo Descrizione
streamRequest ima.StreamRequest

streamInitResponse ima.StreamInitResponse

enableInteractiveAds()

Non supportata. Passa invece i dati dall'annuncio companion direttamente a RAF. Ora questa operazione è no-op.

getContentTime(streamTime)

Recupera un tempo in millisecondi per uno stream VOD, che rappresenta il tempo trascorso nei contenuti senza annunci. Consulta: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Per ottenere la data e l'ora dei contenuti per il tempo di streaming corrente in -1.

Restituisci Integer: l'ora per i contenuti corrispondente al momento dello streaming specificato.

Parametro Tipo Descrizione
streamTime Integer

Il tempo dello stream.

getCuePoints()

Restituisce tutti i cue point corrispondenti a tutte le interruzioni pubblicitarie. Questa opzione è valida solo per i contenuti video on demand in cui tutte le interruzioni pubblicitarie sono note in anticipo. Tutti gli orari rappresentano la durata dello streaming in secondi.

Restituisci Object: un array con tutti i cue point.

getPreviousCuePoint(time)

Restituisce il cue point precedente questo orario. Il cue point indica un'interruzione pubblicitaria. Tutti gli orari rappresentano la durata dello streaming in secondi.

Restituisci ima.CuePoint: un oggetto con start, end e hasPlayed. Restituisce Non valido se non è disponibile nessun cue point.

Parametro Tipo Descrizione
time Float

Il tempo di ricerca, -1 indica l'ora corrente.

getStreamTime(contentTime)

Recupera il tempo per lo stream da un tempo di contenuti per VOD in millisecondi. Consulta: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq.

Restituisci Integer: la durata dello stream corrispondente all'ora specificata per i contenuti.

Parametro Tipo Descrizione
contentTime Integer

L'ora dei contenuti.

loadThirdPartyStream(streamManifest, streamSubtitle)

Carica i metadati dell'annuncio e chiama la funzione loadUrl con i dati streamManifestUrl e streamSubtitle forniti. Questa funzione funziona solo quando il tipo di richiesta di streaming è ima.StreamType.POD_VOD.

Parametro Tipo Descrizione
streamManifest string

L'URL del file manifest dello stream con annunci uniti.

streamSubtitle ifArray>|Invalid

I sottotitoli sono associati allo stream o Invalid se non sono presenti.

onMessage(msg)

Gestisce tutti i messaggi provenienti dall'oggetto Video. Deve essere chiamato per ogni messaggio ricevuto su roMessagePort.

Parametro Tipo Descrizione
msg object

Il messaggio proveniente dalla porta roVideo.

replaceAdTagParameters(adTagParameters)

Sostituisce tutti i parametri tag annuncio da utilizzare per le prossime richieste di annunci per un live streaming. Tieni presente che questa chiamata è automatica per gli stream VOD.

Parametro Tipo Descrizione
adTagParameters string

I nuovi parametri del tag annuncio.

start()

Avvia la riproduzione dello stream.

Torna all'inizio

Classe ima.StreamRequest

Campi

Metodi

Utilizzato per specificare le proprietà della richiesta di streaming.

Proprietà

Nome Tipo Descrizione
adTagParameters

Campo facoltativo. Puoi sostituire un insieme limitato di parametri tag annuncio nella richiesta di streaming. Fornisci parametri di targeting al tuo stream fornisce ulteriori informazioni. Puoi anche usare i parametri dai-ot e dai-ov per la preferenza di variante per lo streaming. Per ulteriori informazioni, consulta Sostituire i parametri delle varianti di streaming.

adUiNode

Nodo del grafico delle scene in cui viene visualizzata l'UI dell'annuncio. L'IMA posiziona elementi come Perché questo annuncio? e Salta su questo elemento durante gli annunci. L'elemento deve sovrapporsi all'intero elemento video.

apiKey

Campo facoltativo. Queste chiavi possono essere utilizzate per autenticare le richieste di streaming. Le chiavi di autenticazione DAI devono essere configurate nell'interfaccia utente di DFP.

assetKey

Obbligatorio per i live streaming. Viene utilizzato per determinare quale stream riprodurre. La chiave asset della richiesta di live streaming è un identificatore disponibile nell'interfaccia utente di DFP.

authToken

Il token di autorizzazione della richiesta di flusso. Utilizzata al posto della chiave API per un'autorizzazione dei contenuti più restrittiva. L'editore può controllare le singole autorizzazioni per i flussi di contenuti in base a questo token.

contentSourceId

Obbligatorio per i flussi on demand. cmsid proviene dalla fonte di contenuto video di DFP nell'interfaccia utente di DFP.

customAssetKey

La chiave asset personalizzata viene utilizzata per stabilire quale stream riprodurre. Le chiavi asset personalizzate sono necessarie per le richieste di stream che gestiscono pod.

format

Il formato dello stream. Il valore predefinito è ima.StreamFormat.HLS.

networkCode

Il codice di rete del publisher che effettua la richiesta di streaming. I codici di rete sono obbligatori per le richieste di flusso che gestiscono i pod.

player

Un'implementazione dell'interfaccia del player.

ppid

Deprecato. Utilizzare adTagParameters. Campo facoltativo. Un identificatore fornito dal publisher di DFP Audience.

streamActivityMonitorId

L'ID da utilizzare per eseguire il debug dello stream con la funzionalità Monitoraggio attività di streaming. Questo viene utilizzato per consentire agli editori di trovare facilmente un log dei flussi nello strumento di monitoraggio dell'attività di flusso.

videoId

Obbligatorio per i flussi on demand. Identificatore dell'origine di contenuto video.

videoObject

L'oggetto video (ad esempio roSGNode video) responsabile della riproduzione video sull'app client. Su questo oggetto verranno sottoposti a polling vari dati da utilizzare per la corretta sincronizzazione degli eventi HLS ID3 live.

createLiveStreamRequest(assetKey, apiKey)

Inizializza le proprietà obbligatorie di un StreamRequest pubblicato. L'utilizzo di questa API fa sì che qualsiasi altra proprietà specifica di StreamType venga ignorata. Se i parametri obbligatori sono stringhe vuote, avviene il logging degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci ima.StreamRequest: oggetto ima.StreamRequest con le proprietà Live richieste.

Parametro Tipo Descrizione
assetKey string

apiKey string

Parametro facoltativo che verrà assegnato alla proprietà apiKey di StreamRequest restituita; il valore predefinito è una stringa vuota.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Inizializza le proprietà obbligatorie di un pod ima.StreamRequest pubblicato. L'uso di questa API consente di ignorare qualsiasi altra proprietà specifica di ima.StreamType. Se i parametri obbligatori sono stringhe vuote, avviene il logging degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci StreamRequest: oggetto ima.StreamRequest con le proprietà PodLive richieste.

Parametro Tipo Descrizione
customAssetKey string

networkCode string

apiKey string

Parametro facoltativo che verrà assegnato alla proprietà ima.StreamRequest.apiKey di ima.StreamRequest restituita; il valore predefinito è una stringa vuota.

createPodVodStreamRequest(networkCode)

Inizializza le proprietà obbligatorie di un elemento ima.StreamRequest per registrare uno stream VOD quando viene utilizzata la pubblicazione di pod DAI con uno stitching video di terze parti. Questa funzione imposta il tipo di richiesta su ima.StreamType.POD_VOD e convalida tutte le proprietà obbligatorie per i dati mancanti. Le convalide non riuscite registreranno un errore nella console di debug.

Restituisci StreamRequest: un oggetto ima.StreamRequest. Se vengono specificate tutte le proprietà obbligatorie, il tipo di richiesta è impostato su ima.StreamType.POD_VOD.

Parametro Tipo Descrizione
networkCode string

il codice di rete Google Ad Manager

createStreamRequest()


Restituisci ima.StreamRequest: un oggetto ima.StreamRequest vuoto.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Inizializza le proprietà obbligatorie di un stitching video live StreamRequest. L'utilizzo di questa API fa sì che eventuali altre proprietà specifiche di StreamType vengano ignorate. Se i parametri obbligatori sono stringhe vuote, avviene il logging degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci ima.StreamRequest: oggetto ima.StreamRequest con le proprietà VideoStitcherLive richieste.

Parametro Tipo Descrizione
customAssetKey string

networkCode string

liveConfigId string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Inizializza le proprietà obbligatorie di un VOD stitching video StreamRequest. L'utilizzo di questa API fa sì che eventuali altre proprietà specifiche di StreamType vengano ignorate. Se i parametri obbligatori sono stringhe vuote, avviene il logging degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci ima.StreamRequest: oggetto ima.StreamRequest con le proprietà VideoStitcherVod richieste.

Parametro Tipo Descrizione
adTagUrl string

networkCode string

contentSourceUrl string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Inizializza le proprietà obbligatorie di un ima.StreamRequest VOD. Se utilizzi questa API, vengono ignorate eventuali altre proprietà specifiche di ima.StreamType. Se i parametri obbligatori sono stringhe vuote, avviene il logging degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci ima.StreamRequest: oggetto ima.StreamRequest con le proprietà VOD richieste.

Parametro Tipo Descrizione
contentSourceId string

videoId string

apiKey string

Parametro facoltativo che verrà assegnato alla proprietà ima.StreamRequest.apiKey di ima.StreamRequest restituita; il valore predefinito è una stringa vuota.

Torna all'inizio

Classe ima.StreamType

Campi

Definisce il tipo di stream che il player deve riprodurre. Gli annunci pre-roll e VOD devono essere riprodotti dall'inizio dello streaming.

Proprietà

Nome Tipo Descrizione
LIVE

Il video è pubblicato.

VOD

Il video è on demand.

Torna all'inizio

Classe ima.WrapperInfo

Campi

Metodi

Contiene informazioni su un wrapper.

Proprietà

Nome Tipo Descrizione
adId

L'ID dell'annuncio o una stringa vuota se sconosciuto.

adSystem

Il nome dichiarato del sistema pubblicitario o la stringa vuota, se sconosciuta.

creativeAdId

L'ID annuncio nella creatività o una stringa vuota se sconosciuto.

creativeId

L'ID della creatività o una stringa vuota se sconosciuto.

dealId

L'ID deal o una stringa vuota se sconosciuto.

createWrapperInfo()


Restituisci ima.WrapperInfo:

Torna all'inizio