Per discutere e fornire feedback sui nostri prodotti, unisciti al canale Discord ufficiale di Ad Manager nel server della community di Google Advertising and Measurement.

Questa pagina è stata tradotta dall'API Cloud Translation.

SDK IMA DAI per Roku

Class ima

Metodi

disableLogging, getStreamManager, initSdk, requestStream

Funzioni globali che controllano l'SDK IMA.

`disableLogging()`

Disattiva la registrazione SDK. La registrazione sarà attiva per impostazione predefinita.

`getStreamManager()`

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

Restituisce object: lo stream manager o l'oggetto errore.

`initSdk(settings)`

Inizializza l'SDK.

Parametro	Tipo	Descrizione
`settings`	`object`	Oggetto delle impostazioni IMA facoltative.

`requestStream(streamRequest)`

Avvia una richiesta di stream asincrona. Il controllo viene restituito immediatamente al player dopo la chiamata di questo metodo.

Restituisce object: un errore o non valido se non è presente alcun errore

Parametro	Tipo	Descrizione
`streamRequest`	`object`

Nome	Tipo	Descrizione
`adPosition`		L'indice dell'annuncio nell'interruzione pubblicitaria. L'indice è `1` per gli annunci indipendenti.
`duration`		La durata massima della pausa in secondi o `-1` se sconosciuta.
`podIndex`		Per i live streaming, restituisce l'ID interruzione come indice del pod o `0` per un preroll. Non sono presenti post-roll nei live streaming. Il valore predefinito è `-2`. Per il video on demand (VOD), restituisce l'indice del pod di annunci. Per un pod preroll, restituisce `0`. Per i mid-roll, restituisci `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 questo pod non fa parte di una playlist.
`timeOffset`		La posizione del pod nei contenuti in secondi. I pre-roll restituiscono `0`, i post-roll restituiscono `-1` e i mid-roll restituiscono l'ora programmata del podcast.
`totalAds`		Il numero totale di annunci contenuti in questa interruzione pubblicitaria. Il valore è `1` per gli annunci autonomi.

Nome	Tipo	Descrizione
`AD_PERIOD_ENDED`		Attivato ogni volta che lo stream passa dalla pubblicità o dallo slate ai contenuti. Questo evento viene attivato anche quando un annuncio viene riprodotto una seconda volta o quando si cerca all'interno di un annuncio.
`AD_PERIOD_STARTED`		Attivato ogni volta che lo stream passa dai contenuti alla pubblicità o allo slate. Questo evento viene attivato anche quando un annuncio viene riprodotto una seconda volta o quando si cerca all'interno di un annuncio.
`COMPLETE`		Attivato quando termina la riproduzione dell'annuncio.
`ERROR`		Attivato quando si verifica un errore.
`FIRST_QUARTILE`		Attivato quando il cursore 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 medio.
`PROGRESS`		Attivato quando viene aggiornato lo stato di avanzamento di un annuncio.
`SKIPPABLE_STATE_CHANGED`		Attivato quando cambia lo stato di ignorabilità di un annuncio.
`SKIPPED`		Attivato quando un annuncio viene saltato.
`START`		Attivato quando inizia la riproduzione di un annuncio.
`THIRD_QUARTILE`		Attivato quando la testina di riproduzione dell'annuncio supera il terzo quartile.

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 pubblicitario che fornisce la creatività.
`adTitle`		Il titolo dell'annuncio.
`advertiserName`		Il nome dell'inserzionista come definito dalla parte che pubblica l'annuncio.
`companions`		Gli annunci companion specificati nella risposta VAST.
`creativeAdId`		Il codice ISCI (Industry Standard Commercial Identifier) di un annuncio. Si tratta dell'Ad-ID della creatività selezionata nella risposta VAST.
`creativeId`		L'ID della creatività selezionata per l'annuncio.
`currentTime`		L'ora corrente all'interno di un annuncio in secondi o -1 se sconosciuta.
`dealId`		Restituisce il primo ID deal presente nella catena di wrapper per l'annuncio corrente, a partire dall'alto.
`duration`		La durata di questo singolo annuncio in secondi o -1 se sconosciuta.
`skipOffset`		Il tempo necessario prima che l'annuncio diventi ignorabile o -1 se sconosciuto.
`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 le informazioni sul wrapper per questo annuncio. L'ordine sarà dal wrapper esterno a quello interno.

Nome	Tipo	Descrizione
`adSlotId`		L'ID dell'area annuncio del companion. Vuoto se non disponibile.
`apiFramework`		L'API necessaria per eseguire questo annuncio o Invalid se non disponibile.
`companionClickThrough`		L'URL di clickthrough del companion.
`creativeType`		Rappresenta il tipo di creatività, in genere un tipo MIME.
`height`		L'altezza della 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 da pingare in corrispondenza di quell'evento.
`url`		L'URL della risorsa statica di questo companion.
`width`		La larghezza della companion in pixel. 0 se non disponibile.

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 se il cue point è già stato riprodotto.
`start`		L'ora di inizio di un cue point in secondi. Corrisponde a un'interruzione pubblicitaria.

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 error per indicare il tipo di questo oggetto.

Nome	Tipo	Descrizione
`BAD_STREAM_REQUEST`		La richiesta di stream non è stata compilata correttamente.
`COULD_NOT_LOAD_STREAM`		Impossibile caricare lo stream.
`ERROR`		Un errore sconosciuto.
`INVALID_RESPONSE`		La risposta del server non era valida.
`STREAM_API_KEY_NOT_VALID`		La chiave API fornita non è stata accettata dal server.

Nome	Tipo	Descrizione
`format`		Il formato del video: hls o dash. Definito in ima.StreamFormat.
`manifest`		L'URL dello stream.
`streamId`		Un ID univoco per lo stream.
`streamType`		Il tipo di video: live o on demand. Definito in ima.StreamType.
`subtitles`		Sottotitoli, se disponibili. Non valido in caso contrario.

Parametro	Tipo	Descrizione
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

Parametro	Tipo	Descrizione
`streamManifest`	`string`	L'URL del manifest dello stream con gli annunci cuciti.
`streamSubtitle`	`ifArray>\|Invalid`	I sottotitoli associati allo stream o `Invalid` se non presenti.

Nome	Tipo	Descrizione
`adTagParameters`		(Facoltativo) Puoi sostituire un insieme limitato di parametri del tag annuncio nella richiesta di stream. L'articolo Fornire parametri di targeting alla riproduzione in streaming fornisce ulteriori informazioni. Puoi anche utilizzare i parametri dai-ot e dai-ov per la preferenza della variante di stream. Per saperne di più, consulta la pagina Sostituire i parametri delle varianti per la riproduzione in streaming.
`adUiNode`		Un nodo del grafico della scena in cui viene visualizzata l'interfaccia utente dell'annuncio. IMA posiziona elementi come Perché questo annuncio e pulsanti Salta su questo elemento durante gli annunci. L'elemento deve sovrapporsi all'intero elemento video.
`apiKey`		(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 deve essere riprodotto. La chiave asset della richiesta di live streaming è un identificatore che si trova nell'interfaccia utente di DFP.
`authToken`		Il token di autorizzazione della richiesta di stream. Utilizzato al posto della chiave API per un'autorizzazione dei contenuti più rigorosa. L'editore può controllare le autorizzazioni dei singoli stream di contenuti in base a questo token.
`contentSourceId`		Obbligatorio per gli stream on demand. L'cmsid proviene dalla fonte di contenuti video DFP nell'interfaccia utente DFP.
`customAssetKey`		La chiave asset personalizzata viene utilizzata per determinare quale stream deve essere riprodotto. Le chiavi asset personalizzate sono necessarie per le richieste di stream di pubblicazione di pod.
`format`		Il formato dello stream. Il valore predefinito è `ima.StreamFormat.HLS`.
`networkCode`		Il codice di rete del publisher che effettua la richiesta di stream. I codici di rete sono necessari per le richieste di stream di pubblicazione di pod effettuate con createPodLiveStreamRequest o createPodVodStreamRequest. Questi codici sono necessari anche per le richieste di stream di Cloud Stitching effettuate con createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest o createVideoStitcherVodStreamRequestWithVodConfig. Questi codici sono facoltativi e consigliati per le richieste di stream di servizio completo effettuate con createLiveStreamRequest o createVodStreamRequest. L'aggiunta del codice di rete applica le impostazioni selezionate nella UI di Ad Manager, ad esempio l'attivazione degli annunci programmatici con limitazioni. Per il servizio Pod e l'unione di Cloud, l'aggiunta del codice di rete individua e riproduce lo stream. Per trovare il codice di rete, consulta questo articolo.
`player`		Un'implementazione dell'interfaccia del player.
`ppid`		Deprecato. Utilizza adTagParameters. (Facoltativo) Un identificatore fornito dal publisher di un pubblico DFP.
`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.
`videoId`		Obbligatorio per gli stream on demand. Identificatore dell'origine di contenuti video.
`videoObject`		L'oggetto video (ad esempio Video roSGNode) responsabile della riproduzione video nell'app client. Questo oggetto verrà sottoposto a polling per vari dati da utilizzare per sincronizzare correttamente gli eventi ID3 HLS live.
`videoStitcherSessionOptions`		Le opzioni della sessione vengono utilizzate per impostare parametri specifici di Video Stitcher per le richieste di stream di Video Stitcher.

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

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

SDK IMA DAI per Roku Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Class ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Class ima.AdBreakInfo

Proprietà

createAdBreakInfo()

Class ima.AdEvent

Proprietà

Classe ima.AdInfo

Proprietà

createAdInfo()

Classe ima.Companion

Proprietà

createCompanion()

Class ima.CuePoint

Proprietà

createCuePoint()

Class ima.Error

Proprietà

createError()

Class ima.ErrorEvent

Proprietà

Class ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

streamInitialized(streamInfo)

Class ima.StreamFormat

Proprietà

Class ima.StreamInfo

Proprietà

createStreamInfo()

Class ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Class ima.StreamRequest

Proprietà

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

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

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Class ima.StreamType

Proprietà

Class ima.WrapperInfo

Proprietà

createWrapperInfo()

SDK IMA DAI per Roku

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`streamInitialized(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

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

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

`createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`