SDK IMA DAI per Roku

1. 1. Ima
   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

Classe ima

Metodi

disableLogging, getStreamManager, initSdk, requestStream

Funzioni globali che controllano l'SDK IMA.

disableLogging()

Disattiva il logging dell'SDK. Il logging è attivo per impostazione predefinita.

getStreamManager()

Restituisce un gestore dello stream, se disponibile. Se la gestione stream non è ancora disponibile, viene restituito Non valido. Se si è verificato un errore durante la creazione di Gestore flussi, 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 impostazioni IMA facoltativo.

requestStream(streamRequest)

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

Restituisci object: un errore o non è valido se non sono presenti errori

Parametro	Tipo	Descrizione
streamRequest	object

Torna all'inizio

Classe ima.AdBreakInfo

Campi

adPosition, duration, podIndex, timeOffset, totalAds

Metodi

createAdBreakInfo

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 l'annuncio non fa parte di un pod o se questo pod non fa parte di una playlist.
timeOffset		La posizione del pod nei contenuti in secondi. Il pre-roll restituisce 0, i resi post-roll -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()

Restituisce ima.AdBreakInfo:

Torna all'inizio

Classe ima.AdEvent

Campi

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, {18SK16} {18SK16} SKIPPABLE_STATE_CHANGEDTHIRD_QUARTILE

Eventi attivati da Gestione annunci.

Proprietà

Nome	Tipo	Descrizione
AD_PERIOD_ENDED		Attivato ogni volta che lo stream passa dalla pubblicità o dallo slate ai contenuti. Questo verrà attivato anche quando l'annuncio viene riprodotto una seconda volta o quando ne cerchi uno.
AD_PERIOD_STARTED		Attivato ogni volta che lo stream passa dai contenuti alla pubblicità o allo slate. Questo verrà attivato anche quando l'annuncio viene riprodotto una seconda volta o quando ne cerchi uno.
COMPLETE		Attivato quando termina la riproduzione dell'annuncio.
ERROR		Attivato quando si verifica un errore.
FIRST_QUARTILE		Attivato quando la testina di riproduzione dell'annuncio supera il primo quartile.
ICON_FALLBACK_IMAGE_CLOSED		Attivato quando l'utente chiude la finestra di dialogo dell'immagine di riserva dell'icona.
ICON_FALLBACK_IMAGE_SHOWN		Attivato quando viene visualizzata l'immagine di riserva dell'icona.
MIDPOINT		Attivato quando la testina di riproduzione dell'annuncio supera il punto centrale.
PROGRESS		Attivato quando è presente un aggiornamento dell'avanzamento di un annuncio.
SKIPPABLE_STATE_CHANGED		Attivato quando cambia lo stato di un annuncio ignorabile.
SKIPPED		Attivato quando un annuncio viene ignorato.
START		Attivato quando inizia la riproduzione di un annuncio.
THIRD_QUARTILE		Attivato quando la testina di riproduzione dell'annuncio supera il terzo quartile.

Torna all'inizio

Classe ima.AdInfo

Campi

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, associato, currentTime, duration, skipOffset, }{20wraps2UniversalValue}2universalAdIDRegistryuniversalAdIDValue

Metodi

createAdInfo

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 all'interno di un annuncio in secondi o -1 se sconosciuta.
duration		La durata di questo singolo annuncio in secondi o -1 se sconosciuta.
skipOffset		Il tempo necessario affinché l'annuncio diventi ignorabile o -1 se sconosciuto.
universalAdIDRegistry		Stringa utilizzata per identificare l'URL del sito web del registry 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 wrapper per l'annuncio. dall'involucro esterno a quello interno.

createAdInfo()

Restituisce ima.AdInfo:

Torna all'inizio

Classe ima.Companion

Campi

apiFramework, creativeType, height, trackingEvents, url, width

Metodi

createCompanion

Contiene informazioni sui companion di un annuncio.

Proprietà

Nome	Tipo	Descrizione
apiFramework		API necessaria per pubblicare l'annuncio oppure 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 a cui inviare il ping per tale evento.
url		L'URL della risorsa statica di questo companion.
width		La larghezza della creatività companion in pixel. 0 se non disponibile.

createCompanion()

Restituisce ima.Companion:

Torna all'inizio

Classe ima.CuePoint

Campi

end, hasPlayed, start

Metodi

createCuePoint

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

Restituisce ima.CuePoint:

Torna all'inizio

Classe ima.Error

Campi

id, informazioni, tipo

Metodi

createError

Oggetto passato al gestore degli errori in caso di errore.

Proprietà

Nome	Tipo	Descrizione
id		L'ID dell'errore. Consulta la costante ErrorEvent per un elenco dei codici di errore.
info		Informazioni aggiuntive sull'errore.
type		Imposta sempre su errore per indicare il tipo di questo oggetto.

createError()

Restituisce ima.Error:

Torna all'inizio

Classe ima.ErrorEvent

Campi

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

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, adBreakStarted, allVideoComplete, createPlayer, loadUrl

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 all'inizio di un'interruzione pubblicitaria.

Parametro	Tipo	Descrizione
adBreakInfo	ima.AdBreakInfo	Contiene informazioni sull'interruzione pubblicitaria.

allVideoComplete()

Campo facoltativo. Richiamato quando tutto il video è stato completato.

createPlayer()

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

Restituisce ima.Player:

loadUrl(streamInfo)

Richiamato se il player deve iniziare a riprodurre un URL. Devi implementare questo metodo per caricare il flusso.

Parametro	Tipo	Descrizione
streamInfo	ima.StreamInfo	Contiene le informazioni necessarie per riprodurre i contenuti.

Torna all'inizio

Classe ima.StreamFormat

Campi

DASH, HLS

Definisce il formato del flusso.

Proprietà

Nome	Tipo	Descrizione
DASH
HLS

Torna all'inizio

Classe ima.StreamInfo

Campi

format, manifest, streamId, streamType, sottotitoli

Metodi

createStreamInfo

Informazioni passate dall'SDK al player riguardo al flusso.

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. In caso contrario non valido.

createStreamInfo()

Restituisce ima.StreamInfo:

Torna all'inizio

Classe ima.StreamManager

Metodi

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, {18 19AdTag}replaceAdTagreplaceAdTagParameters

Oggetto per la gestione della riproduzione dello stream.

addEventListener(event, callback)

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

Parametro	Tipo	Descrizione
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Restituisce ima.StreamManager:

Parametro	Tipo	Descrizione
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Non supportata. Trasmetti invece i dati direttamente dall'annuncio companion a RAF. Questa è un'operazione no.

getContentTime(streamTime)

Restituisce il tempo in millisecondi per uno stream VOD, che rappresenta il tempo trascorso nei contenuti senza annunci. Vedi: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Per ottenere il tempo dei contenuti per il passaggio del tempo di streaming corrente in -1.

Restituisci Integer: la durata dei contenuti corrispondente alla durata dello streaming specificata.

Parametro	Tipo	Descrizione
streamTime	Integer	L'ora nello stream.

getCuePoints()

Restituisce tutti i cue point corrispondenti a tutte le interruzioni pubblicitarie. È valido 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 che precede l'ora specificata. 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 alcun cue point.

Parametro	Tipo	Descrizione
time	Float	L'ora per cercare, -1 indica l'ora attuale.

getStreamTime(contentTime)

Restituisce il tempo dello stream da un tempo di contenuto per VOD in millisecondi. Vedi: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

Restituisci Integer: il tempo di streaming corrispondente al tempo di contenuto specificato.

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 flusso è ima.StreamType.POD_VOD.

Parametro	Tipo	Descrizione
streamManifest	string	L'URL del manifest dello stream con gli annunci uniti.
streamSubtitle	ifArray>|Invalid	I sottotitoli associati allo stream o Invalid, in caso contrario.

onMessage(msg)

Consente di gestire 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 del tag annuncio da utilizzare per le prossime richieste di annunci per un live streaming. Tieni presente che questa chiamata è completamente autonoma per gli streaming VOD.

Parametro	Tipo	Descrizione
adTagParameters	string	I nuovi parametri tag annuncio.

start()

Avvia la riproduzione dello stream.

Torna all'inizio

Classe ima.StreamRequest

Campi

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, playerActivity56 ppidstreamActivityMonitorIdvideoIdvideoObjectvideoStitcherSessionOptions

Metodi

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, CreateVideoStitcherVodStreamRequestWithVodConfig, createVodStreamRequest

Utilizzato per specificare le proprietà della richiesta di flusso.

Proprietà

Nome	Tipo	Descrizione
adTagParameters		Campo facoltativo. Puoi sostituire un insieme limitato di parametri di tag annuncio nella richiesta di streaming. Fornisci parametri di targeting al tuo stream fornisce maggiori informazioni. Puoi anche utilizzare i parametri dai-ot e dai-ov per la preferenza della variante streaming. Per ulteriori informazioni, consulta Sostituire i parametri delle varianti per la riproduzione in streaming.
adUiNode		Nodo del grafico di una scena in cui viene visualizzata l'UI dell'annuncio. L'IMA inserisce elementi come i pulsanti 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 flusso. Le chiavi di autenticazione DAI devono essere impostate nell'interfaccia utente di DFP.
assetKey		Obbligatorio per i live streaming. Viene usato per stabilire quale streaming deve essere riprodotto. La chiave asset della richiesta di live streaming è un identificatore che puoi trovare nell'interfaccia utente di DFP.
authToken		Il token di autorizzazione per la richiesta di flusso. Utilizzata al posto della chiave API per un'autorizzazione dei contenuti più rigorosa. L'editore può controllare le autorizzazioni per gli stream di contenuti individuali in base a questo token.
contentSourceId		Obbligatorio per gli stream on demand. cmsid proviene dall'origine di contenuto video di DFP nell'interfaccia utente di DFP.
customAssetKey		La chiave asset personalizzata viene utilizzata per stabilire quale stream riprodurre. Per le richieste di flusso di pubblicazione dei pod, sono necessarie chiavi asset personalizzate.
format		Il formato del flusso. Il valore predefinito è ima.StreamFormat.HLS.
networkCode		Il codice di rete del publisher che effettua la richiesta di streaming. I codici di rete sono necessari per le richieste di flusso di gestione dei 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 il Monitoraggio attività di streaming. Viene utilizzato per fornire un modo conveniente per consentire agli editori di trovare un log dello stream nello strumento Monitoraggio attività di streaming.
videoId		Obbligatorio per gli stream on demand. Identificatore della fonte di contenuto video.
videoObject		L'oggetto video (ad esempio Video roSGNode) responsabile della riproduzione del video nell'app client. Questo oggetto eseguirà il polling di vari dati da utilizzare per sincronizzare correttamente gli eventi ID3 HLS dal vivo.
videoStitcherSessionOptions		Le opzioni della sessione vengono utilizzate per impostare parametri specifici dello strumento video per le richieste stream di VideoStitcher.

createLiveStreamRequest(assetKey, apiKey)

Inizializza le proprietà richieste di un StreamRequest attivo. Se utilizzi questa API, tutte le altre proprietà specifiche di StreamType vengono ignorate. Se i parametri obbligatori sono stringhe vuote, si verifica la registrazione degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci ima.StreamRequest: l'oggetto ima.StreamRequest con le proprietà attive 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à richieste di un pod live ima.StreamRequest. Se utilizzi questa API, tutte le altre proprietà specifiche di ima.StreamType verranno ignorate. Se i parametri obbligatori sono stringhe vuote, si verifica la registrazione degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci StreamRequest: l'oggetto ima.StreamRequest con le proprietà PodLive obbligatorie.

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à richieste di un ima.StreamRequest per registrare uno stream VOD quando si utilizza la pubblicazione di pod DAI con uno strumento di 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 registrano un errore nella console di debug.

Restituisci StreamRequest: un oggetto ima.StreamRequest. Se sono 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à richieste di uno strumento di stitching video pubblicato StreamRequest. Se utilizzi questa API, tutte le altre proprietà specifiche di StreamType verranno ignorate. Se i parametri obbligatori sono stringhe vuote, si verifica la registrazione degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci ima.StreamRequest: l'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 dello stitching video StreamRequest. Se utilizzi questa API, tutte le altre proprietà specifiche di StreamType verranno ignorate. Se i parametri obbligatori sono stringhe vuote, si verifica la registrazione degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

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

Parametro	Tipo	Descrizione
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

CreateVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Inizializza le proprietà richieste di un VOD dello stitching video StreamRequest utilizzando vodConfigId creato dallo strumento di stitching video cloud. Se utilizzi questa API, tutte le altre proprietà specifiche di StreamType verranno ignorate. Se i parametri obbligatori sono stringhe vuote, si verifica la registrazione degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

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

Parametro	Tipo	Descrizione
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Inizializza le proprietà obbligatorie di un ima.StreamRequest VOD. Se utilizzi questa API, tutte le altre proprietà specifiche di ima.StreamType verranno ignorate. Se i parametri obbligatori sono stringhe vuote, si verifica la registrazione degli errori e l'API restituisce un valore StreamRequest generico, senza proprietà ignorate.

Restituisci ima.StreamRequest: l'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

DAL VIVO, VOD

Definisce il tipo di stream che il player deve riprodurre. I pre-roll e i VOD dovrebbero essere riprodotti dall'inizio dello stream.

Proprietà

Nome	Tipo	Descrizione
LIVE		Il video è pubblico.
VOD		Il video è on demand.

Torna all'inizio

Classe ima.WrapperInfo

Campi

adId, adSystem, creativeAdId, creativeId, dealId

Metodi

createWrapperInfo

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 di annunci o la stringa vuota, se sconosciuta.
creativeAdId		L'ID annuncio nella creatività o una stringa vuota se sconosciuta.
creativeId		L'ID della creatività o una stringa vuota se sconosciuto.
dealId		L'ID deal o una stringa vuota, se sconosciuta.

createWrapperInfo()

Restituisce ima.WrapperInfo:

Torna all'inizio