Corso: StreamRequest

ima.StreamRequest

class   static

Costruttore

StreamRequest

nuovo StreamRequest()

Utilizzato per specificare le proprietà della richiesta di flusso.

Proprietà

adTagParameters

static

Stringa

Facoltativo. Puoi sovrascrivere un set limitato di parametri dei tag degli annunci nella tua richiesta di streaming. Fornisci parametri di targeting al tuo stream fornisce maggiori informazioni. È anche possibile utilizzare i parametri dai-ot e dai-ov per la preferenza della variante dello stream. Per ulteriori informazioni, vedere Sostituire i parametri delle varianti dello stream.

adUiNode

static

roSGNode

Un nodo del grafico della scena in cui viene visualizzata l'interfaccia utente dell'annuncio. IMA posiziona elementi come i pulsanti Perché questo annuncio e Salta su questo elemento durante gli annunci. L'elemento deve sovrapporsi all'intero elemento video.

apiKey

static

Stringa

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

static

Stringa

Necessario per i live streaming. Serve a determinare quale flusso deve essere riprodotto. La chiave asset della richiesta di streaming live è un identificatore che può essere trovato nell'interfaccia utente di DFP.

authToken

static

Stringa

Il token di autorizzazione della richiesta di stream. Utilizzato al posto della chiave API per un'autorizzazione più rigorosa dei contenuti. L'editore può controllare le autorizzazioni dei singoli flussi di contenuti in base a questo token.

contentSourceId

static

Stringa

Obbligatorio per gli stream on demand. Il cmsid proviene dalla sorgente dei contenuti video DFP nell'interfaccia utente di DFP.

customAssetKey

static

Stringa

La chiave asset personalizzata viene utilizzata per determinare quale stream deve essere riprodotto. Per le richieste di streaming tramite pod sono necessarie chiavi di asset personalizzate.

dell'annuncio

static

ima.StreamFormat

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

networkCode

static

Stringa

Il codice di rete dell'editore che effettua la richiesta di streaming. I codici di rete sono necessari per le richieste di streaming di Pod effettuate con createPodLiveStreamRequest o createPodVodStreamRequest. Questi codici sono necessari anche per le richieste di streaming Cloud stitching effettuate con createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest o createVideoStitcherVodStreamRequestWithVodConfig. Questi codici sono facoltativi e consigliati per le richieste di streaming di servizi completi 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 Pod serving e lo stitching nel Cloud, l'aggiunta del codice di rete individua e riproduce lo streaming. Per trovare il codice di rete, consulta questo articolo.

player

static

(ima.Player o non valido)

Un'implementazione dell'interfaccia del lettore.

ppid

static

Stringa

Deprecato. Utilizzare adTagParameters. Facoltativo. Un identificatore fornito dall'editore di DFP Audience.

streamActivityMonitorId

static

Stringa

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

static

Stringa

Necessario per i flussi on-demand. Identificatore per la fonte del contenuto video.

videoObject

static

(roVideo o non valido)

L'oggetto video (ad esempio Video roSGNode) responsabile della riproduzione video sull'app client. Questo oggetto verrà interrogato per raccogliere vari dati da utilizzare per sincronizzare correttamente gli eventi ID3 HLS in tempo reale.

videoStitcherSessionOptions

static

Matrice di V

Le opzioni di sessione vengono utilizzate per impostare parametri specifici di VideoStitcher per le richieste di streaming di VideoStitcher.

Metodi

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) restituisce ima.StreamRequest

Inizializza le proprietà richieste di un Live StreamRequest. Utilizzando questa API, tutte le altre proprietà specifiche di StreamType verranno ignorate. Se uno qualsiasi dei parametri richiesti è una stringa vuota, si verifica la registrazione degli errori e l'API restituisce un StreamRequest generico, senza ignorare alcuna proprietà.

Parametro
assetKey	stringa
apiKey	stringa Parametro assegnato alla proprietà ima.StreamRequest.apiKey del ima.StreamRequest restituito. Se non esiste alcuna chiave API, passare una stringa vuota.
networkCode	stringa Codice di rete per l'editore che effettua la richiesta di streaming. L'inserimento del codice di rete è facoltativo, ma consigliato.

Resi

ima.StreamRequest Oggetto ima.StreamRequest con proprietà Live richieste.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) restituisce StreamRequest

Inizializza le proprietà richieste di un Pod Live ima.StreamRequest. L'utilizzo di questa API comporta l'ignoramento di qualsiasi altra proprietà specifica di ima.StreamType. Se uno dei parametri obbligatori è una stringa vuota, viene registrato un errore e l'API restituisce un StreamRequest generico, senza proprietà ignorate.

Parametro
customAssetKey	stringa
networkCode	stringa
apiKey	stringa Parametro facoltativo assegnato alla proprietà ima.StreamRequest.apiKey del ima.StreamRequest restituito; il valore predefinito è una stringa vuota.

Resi

Oggetto StreamRequest ima.StreamRequest con proprietà PodLive obbligatorie.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) restituisce StreamRequest

Inizializza le proprietà richieste di un ima.StreamRequest per registrare uno stream VOD quando utilizzi la pubblicazione di pod DAI con uno stitcher 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.

Parametro
networkCode	stringa il codice di rete di Google Ad Manager

Resi

StreamRequest un oggetto ima.StreamRequest. Se vengono specificate tutte le proprietà richieste, il tipo di richiesta viene impostato su ima.StreamType.POD_VOD.

createStreamRequest

static

createStreamRequest() restituisce ima.StreamRequest

Resi

ima.StreamRequest Un oggetto ima.StreamRequest vuoto.

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) restituisce ima.StreamRequest

Inizializza le proprietà richieste di un StreamRequest di Video Stitcher Live. L'utilizzo di questa API comporta l'ignoramento di qualsiasi altra proprietà specifica di StreamType. Se uno qualsiasi dei parametri richiesti è una stringa vuota, si verifica la registrazione degli errori e l'API restituisce un StreamRequest generico, senza ignorare alcuna proprietà.

Parametro
customAssetKey	stringa
networkCode	stringa
liveConfigId	stringa
regione	stringa
projectNumber	stringa
oAuthToken	stringa

Resi

ima.StreamRequest Oggetto ima.StreamRequest con proprietà VideoStitcherLive richieste.

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) restituisce ima.StreamRequest

Inizializza le proprietà richieste di un Video Stitcher VOD StreamRequest. Utilizzando questa API, tutte le altre proprietà specifiche di StreamType verranno ignorate. Se uno dei parametri obbligatori è una stringa vuota, viene registrato un errore e l'API restituisce un StreamRequest generico, senza proprietà ignorate.

Parametro
adTagUrl	stringa
networkCode	stringa
contentSourceUrl	stringa
regione	stringa
projectNumber	stringa
oAuthToken	stringa

Resi

ima.StreamRequest Oggetto ima.StreamRequest con le proprietà VideoStitcherVod obbligatorie.

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) restituisce ima.StreamRequest

Inizializza le proprietà richieste di una sessione VOD StreamRequest utilizzando vodConfigId creato da cloud video stitcher. Utilizzando questa API, tutte le altre proprietà specifiche di StreamType verranno ignorate. Se uno qualsiasi dei parametri richiesti è una stringa vuota, si verifica la registrazione degli errori e l'API restituisce un StreamRequest generico, senza ignorare alcuna proprietà.

Parametro
vodConfigId	stringa
networkCode	stringa
regione	stringa
projectNumber	stringa
oAuthToken	stringa

Resi

ima.StreamRequest Oggetto ima.StreamRequest con le proprietà VideoStitcherVod obbligatorie.

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) restituisce ima.StreamRequest

Inizializza le proprietà richieste di un ima.StreamRequest VOD. Utilizzando questa API, tutte le altre proprietà specifiche di ima.StreamType verranno ignorate. Se uno qualsiasi dei parametri richiesti è una stringa vuota, si verifica la registrazione degli errori e l'API restituisce un StreamRequest generico, senza ignorare alcuna proprietà.

Parametro
contentSourceId	stringa
videoId	stringa
apiKey	stringa Parametro assegnato alla proprietà ima.StreamRequest.apiKey del ima.StreamRequest restituito. Se non esiste alcuna chiave API, passare una stringa vuota.
networkCode	stringa Codice di rete per l'editore che effettua la richiesta di streaming. L'inserimento del codice di rete è facoltativo, ma consigliato.

Resi

ima.StreamRequest Oggetto ima.StreamRequest con proprietà VOD richieste.