Kelas: StreamRequest

ima.StreamRequest

class   static

Konstruktor

StreamRequest

StreamRequest() baru

Digunakan untuk menentukan properti permintaan streaming.

Properti

adTagParameters

statis

String

Opsional. Anda dapat mengganti serangkaian parameter tag iklan terbatas pada permintaan streaming Anda. Memberikan parameter penargetan ke aliran Anda memberikan informasi lebih lanjut. Anda juga dapat menggunakan parameter dai-ot dan dai-ov untuk preferensi varian aliran. Lihat Mengganti parameter varian aliran untuk informasi selengkapnya.

adUiNode

statis

roSGNode

Node grafik adegan tempat UI iklan ditampilkan. IMA menempatkan elemen seperti tombol Mengapa Iklan Ini dan Lewati pada elemen ini selama iklan. Elemen harus menutupi seluruh elemen video.

apiKey

statis

String

Opsional. Kunci ini dapat digunakan untuk mengautentikasi permintaan streaming. Kunci autentikasi DAI harus disiapkan di UI DFP.

assetKey

statis

String

Diperlukan untuk siaran langsung. Ini digunakan untuk menentukan streaming mana yang harus diputar. Kunci aset permintaan streaming langsung adalah pengenal yang dapat ditemukan di UI DFP.

authToken

statis

String

Token otorisasi permintaan aliran. Digunakan sebagai pengganti kunci API untuk otorisasi konten yang lebih ketat. Penerbit dapat mengontrol otorisasi aliran konten individual berdasarkan token ini.

contentSourceId

statis

String

Diperlukan untuk streaming on-demand. cmsid berasal dari Sumber Konten Video DFP di UI DFP.

customAssetKey

statis

String

Kunci aset kustom digunakan untuk menentukan streaming mana yang harus diputar. Kunci aset kustom diperlukan untuk pod yang menyajikan permintaan aliran.

format

statis

ima.StreamFormat

Format aliran. Default-nya adalah ima.StreamFormat.HLS.

networkCode

statis

String

Kode jaringan untuk penerbit yang membuat permintaan streaming. Kode jaringan diperlukan untuk Pod yang menyajikan permintaan aliran yang dibuat dengan createPodLiveStreamRequest atau createPodVodStreamRequest. Kode-kode ini juga diperlukan untuk permintaan aliran penjahitan Cloud yang dibuat dengan createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, atau createVideoStitcherVodStreamRequestWithVodConfig. Kode ini bersifat opsional dan direkomendasikan untuk permintaan streaming layanan Penuh yang dibuat dengan createLiveStreamRequest atau createVodStreamRequest. Menambahkan kode jaringan akan menerapkan pengaturan yang dipilih di UI Ad Manager, seperti pengaktifan iklan terbatas terprogram. Untuk penyajian Pod dan penggabungan Cloud, penambahan kode jaringan akan menemukan dan memutar aliran. Untuk menemukan kode jaringan, lihat artikel ini.

pemain

statis

(ima.Player atau Tidak Valid)

Implementasi antarmuka pemutar.

ppid

statis

String

Tidak digunakan lagi. Gunakan adTagParameters. Opsional. Pengidentifikasi yang disediakan penerbit Audiens DFP.

streamActivityMonitorId

statis

String

ID yang akan digunakan untuk men-debug streaming dengan pemantau aktivitas streaming. ID ini digunakan untuk menyediakan cara mudah bagi penayang untuk menemukan log streaming di alat pemantau aktivitas streaming.

videoId

statis

String

Diperlukan untuk streaming on-demand. ID untuk sumber konten video.

videoObject

statis

(roVideo atau Tidak Valid)

Objek video (seperti Video roSGNode) yang bertanggung jawab atas pemutaran video di aplikasi klien. Objek ini akan di-polling untuk berbagai data yang akan digunakan dalam menentukan waktu yang tepat untuk peristiwa ID3 HLS Live.

videoStitcherSessionOptions

statis

Array V

Opsi sesi digunakan untuk menyetel parameter khusus penyambung video untuk streamRequest VideoStitcher.

Metode

createLiveStreamRequest

statis

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

Menginisialisasi properti wajib dari StreamRequest Live. Penggunaan API ini menyebabkan properti spesifik StreamType lainnya diabaikan. Jika ada parameter wajib diisi yang berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Parameter
assetKey	string
apiKey	string Parameter yang ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang dikembalikan. Jika tidak ada kunci API, teruskan string kosong.
networkCode	string Kode jaringan untuk penayang yang membuat permintaan streaming. Menyertakan kode jaringan bersifat opsional, tetapi direkomendasikan.

Hasil

Objek ima.StreamRequest ima.StreamRequest dengan properti Live yang diperlukan.

createPodLiveStreamRequest

statis

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) menampilkan StreamRequest

Menginisialisasi properti yang diperlukan dari Pod Live ima.StreamRequest. Penggunaan API ini menyebabkan properti spesifik ima.StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, pencatatan kesalahan terjadi dan API mengembalikan StreamRequest generik, tanpa properti apa pun yang diabaikan.

Parameter
customAssetKey	string
networkCode	string
apiKey	string Parameter opsional yang ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang dikembalikan; default ke string kosong.

Hasil

Objek StreamRequest ima.StreamRequest dengan properti PodLive yang wajib.

createPodVodStreamRequest

statis

createPodVodStreamRequest(networkCode) mengembalikan StreamRequest

Menginisialisasi properti ima.StreamRequest yang diperlukan untuk mendaftarkan streaming VOD saat menggunakan penayangan Pod DAI dengan penyambung video pihak ketiga. Fungsi ini menetapkan jenis permintaan ke ima.StreamType.POD_VOD dan memvalidasi semua properti yang diperlukan untuk data yang hilang. Validasi yang gagal akan mencatat error di konsol debug.

Parameter
networkCode	string kode jaringan Google Ad Manager

Hasil

StreamRequest sebuah objek ima.StreamRequest. Jika semua properti wajib ditentukan, jenis permintaan ditetapkan ke ima.StreamType.POD_VOD.

createStreamRequest

statis

createStreamRequest() mengembalikan ima.StreamRequest

Hasil

ima.StreamRequest Objek ima.StreamRequest kosong.

createVideoStitcherLiveStreamRequest

statis

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

Menginisialisasi properti yang diperlukan dari Video Stitcher Live StreamRequest. Penggunaan API ini menyebabkan properti spesifik StreamType lainnya diabaikan. Jika ada parameter wajib diisi yang berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Parameter
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

Hasil

ima.StreamRequest ima.StreamRequest objek dengan properti VideoStitcherLive yang diperlukan.

createVideoStitcherVodStreamRequest

statis

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

Menginisialisasi properti yang diperlukan dari Video Stitcher VOD StreamRequest. Penggunaan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika ada parameter wajib diisi yang berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Parameter
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

Hasil

Objek ima.StreamRequest ima.StreamRequest dengan properti VideoStitcherVod yang diperlukan.

createVideoStitcherVodStreamRequestWithVodConfig

statis

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

Menginisialisasi properti yang diperlukan dari Video Stitcher VOD StreamRequest menggunakan vodConfigId yang dibuat dari cloud video stitcher. Penggunaan API ini menyebabkan properti spesifik StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, pencatatan kesalahan terjadi dan API mengembalikan StreamRequest generik, tanpa properti apa pun yang diabaikan.

Parameter
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

Hasil

Objek ima.StreamRequest ima.StreamRequest dengan properti VideoStitcherVod yang diperlukan.

createVodStreamRequest

statis

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

Menginisialisasi properti yang diperlukan dari VOD ima.StreamRequest. Penggunaan API ini menyebabkan properti spesifik ima.StreamType lainnya diabaikan. Jika ada parameter wajib diisi yang berupa string kosong, error logging akan terjadi dan API akan menampilkan StreamRequest umum, tanpa ada properti yang diabaikan.

Parameter
contentSourceId	string
videoId	string
apiKey	string Parameter yang ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang dikembalikan. Jika tidak ada kunci API, teruskan string kosong.
networkCode	string Kode jaringan untuk penayang yang membuat permintaan streaming. Menyertakan kode jaringan bersifat opsional, tetapi direkomendasikan.

Hasil

Objek ima.StreamRequest ima.StreamRequest dengan properti VOD yang diperlukan.