IMA DAI SDK untuk 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

Kelas ima

Metode

disableLogging, getStreamManager, initSdk, requestStream

Fungsi global yang mengontrol IMA SDK.

disableLogging()

Menonaktifkan logging SDK. Logging akan diaktifkan secara default.

getStreamManager()

Menampilkan pengelola streaming jika tersedia. Jika pengelola streaming belum tersedia, file Tidak Valid akan ditampilkan. Jika terjadi error saat membuat pengelola streaming, objek error akan ditampilkan.

Menampilkan object: Pengelola streaming atau objek error.

initSdk(settings)

Menginisialisasi SDK.

Parameter	Jenis	Deskripsi
settings	object	Objek setelan IMA opsional.

requestStream(streamRequest)

Memulai permintaan streaming asinkron Control segera kembali ke pemutar setelah memanggil metode ini.

Menampilkan object: error atau tidak valid jika tidak ada error

Parameter	Jenis	Deskripsi
streamRequest	object

Kembali ke atas

Kelas ima.AdBreakInfo

Kolom

adPosition, duration, podIndex, timeOffset, totalAds

Metode

createAdBreakInfo

Berisi info tentang jeda iklan. Diteruskan ke callback peristiwa oleh SDK.

Properti

Name	Jenis	Deskripsi
adPosition		Indeks iklan di jeda iklan. Akan menjadi 1 untuk iklan mandiri.
duration		Durasi jeda maksimum dalam detik, atau -1 jika tidak diketahui.
podIndex		Untuk live stream, selalu menampilkan -1. Untuk video on-demand (VOD), menampilkan indeks pod iklan. Untuk pod pre-roll, menampilkan 0. Untuk iklan mid-roll, menampilkan 1, 2, ..., n. Untuk pod post-roll, menampilkan n+1...n+x. Setelan defaultnya adalah 0 jika iklan ini bukan bagian dari pod, atau pod ini bukan bagian dari playlist.
timeOffset		Posisi pod di konten dalam hitungan detik. Pre-roll menampilkan 0, post-roll menampilkan -1, dan mid-roll menampilkan waktu pod yang dijadwalkan.
totalAds		Jumlah total iklan yang ada dalam jeda iklan ini. Akan menjadi 1 untuk iklan mandiri.

createAdBreakInfo()

Menampilkan ima.AdBreakInfo:

Kembali ke atas

Kelas ima.AdEvent

Kolom

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT KITI PROGRESSKIPPABLE_STATE_CHANGEDTHIRD_QUARTILE

Peristiwa yang diaktifkan oleh pengelola iklan.

Properti

Name	Jenis	Deskripsi
AD_PERIOD_ENDED		Diaktifkan setiap kali streaming beralih dari iklan atau slate (layar pemblokir) ke konten. Efek ini akan diaktifkan bahkan saat iklan diputar untuk kedua kalinya atau saat mencari iklan.
AD_PERIOD_STARTED		Diaktifkan setiap kali streaming beralih dari konten ke iklan atau slate (layar pemblokir). Efek ini akan diaktifkan bahkan saat iklan diputar untuk kedua kalinya atau saat mencari iklan.
COMPLETE		Diaktifkan saat iklan selesai diputar.
ERROR		Diaktifkan saat terjadi error.
FIRST_QUARTILE		Diaktifkan saat titik pemutaran iklan melewati kuartil pertama.
ICON_FALLBACK_IMAGE_CLOSED		Diaktifkan saat pengguna menutup dialog gambar penggantian ikon.
ICON_FALLBACK_IMAGE_SHOWN		Diaktifkan saat gambar penggantian ikon ditampilkan.
MIDPOINT		Diaktifkan saat titik pemutaran iklan melewati titik tengah.
PROGRESS		Diaktifkan jika ada pembaruan progres iklan.
SKIPPABLE_STATE_CHANGED		Diaktifkan saat status iklan yang dapat dilewati berubah.
SKIPPED		Diaktifkan saat iklan dilewati.
START		Diaktifkan saat iklan mulai diputar.
THIRD_QUARTILE		Diaktifkan saat titik pemutaran iklan melewati kuartil ketiga.

Kembali ke atas

Kelas ima.AdInfo

Kolom

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, pendamping, currentTime, duration, skipOffset, {20 2Adunivers2Registry}universalAdIDRegistryuniversalAdIDValue

Metode

createAdInfo

Berisi info tentang iklan. Diteruskan ke callback peristiwa oleh SDK.

Properti

Name	Jenis	Deskripsi
adBreakInfo		Info yang terkait dengan seluruh jeda iklan ini.
adDescription		Deskripsi iklan.
adId		ID iklan atau string kosong jika tidak diketahui.
adSystem		Sistem iklan yang menyediakan materi iklan.
adTitle		Judul iklan.
advertiserName		Nama pengiklan seperti yang ditetapkan oleh pihak yang menayangkan iklan.
companions		Iklan pengiring yang ditentukan dalam respons VAST.
currentTime		Waktu saat ini dalam iklan dalam detik atau -1 jika tidak diketahui.
duration		Durasi iklan tunggal ini dalam detik atau -1 jika tidak diketahui.
skipOffset		Waktu yang diperlukan iklan agar dapat dilewati atau -1 jika tidak diketahui.
universalAdIDRegistry		String yang digunakan untuk mengidentifikasi URL untuk situs registry tempat ID Iklan Universal materi iklan yang dipilih dicantumkan dalam katalog.
universalAdIDValue		ID Iklan Universal materi iklan yang dipilih untuk iklan.
wrappers		Array ima.WrapperInfo dengan informasi wrapper untuk iklan ini. Urutan akan dimulai dari wrapper luar ke bagian dalam.

createAdInfo()

Menampilkan ima.AdInfo:

Kembali ke atas

Kelas ima.Companion

Kolom

apiFramework, creativeType, height, trackingEvents, url, lebar

Metode

createCompanion

Berisi informasi tentang pengiring iklan.

Properti

Name	Jenis	Deskripsi
apiFramework		API yang diperlukan untuk menjalankan iklan ini, atau Tidak valid jika tidak tersedia.
creativeType		Mewakili Creativetype, biasanya berupa mimetype.
height		Tinggi pengiring dalam piksel. 0 jika tidak tersedia.
trackingEvents		Peta peristiwa pelacakan dengan kuncinya adalah peristiwa dan nilainya adalah daftar URL yang akan di-ping pada peristiwa tersebut.
url		URL untuk resource statis pendamping ini.
width		Lebar pengiring dalam piksel. 0 jika tidak tersedia.

createCompanion()

Menampilkan ima.Companion:

Kembali ke atas

Kelas ima.CuePoint

Kolom

end, hasPlayed, mulai

Metode

createCuePoint

Berisi info tentang titik tanda.

Properti

Name	Jenis	Deskripsi
end		Waktu berakhir untuk titik tanda dalam detik. Hal ini berkaitan dengan jeda iklan.
hasPlayed		Boolean yang menunjukkan titik tanda telah diputar.
start		Waktu mulai untuk titik tanda dalam detik. Hal ini berkaitan dengan jeda iklan.

createCuePoint()

Menampilkan ima.CuePoint:

Kembali ke atas

Class ima.Error

Kolom

id, info, type

Metode

createError

Objek diteruskan ke pengendali error jika terjadi error.

Properti

Name	Jenis	Deskripsi
id		ID error. Lihat konstanta ErrorEvent untuk mengetahui daftar kode error.
info		Informasi tambahan tentang error tersebut.
type		Selalu tetapkan ke error untuk menunjukkan jenis objek ini.

createError()

Menampilkan ima.Error:

Kembali ke atas

Class ima.ErrorEvent

Kolom

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

Semua error yang mungkin dikirimkan kembali oleh SDK.

Properti

Name	Jenis	Deskripsi
BAD_STREAM_REQUEST		Permintaan streaming tidak diisi dengan benar.
COULD_NOT_LOAD_STREAM		Feed tidak dapat dimuat.
ERROR		Error tidak dikenal.
INVALID_RESPONSE		Respons server tidak valid.
STREAM_API_KEY_NOT_VALID		Kunci API yang diberikan tidak diterima oleh server.

Kembali ke atas

Kelas ima.Player

Metode

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

Opsional. Dipanggil saat jeda iklan berakhir.

Parameter	Jenis	Deskripsi
adBreakInfo	ima.AdBreakInfo	Berisi informasi tentang jeda iklan.

adBreakStarted(adBreakInfo)

Opsional. Dipanggil saat jeda iklan telah dimulai.

Parameter	Jenis	Deskripsi
adBreakInfo	ima.AdBreakInfo	Berisi informasi tentang jeda iklan.

allVideoComplete()

Opsional. Dipanggil saat semua video selesai.

createPlayer()

Membuat objek IMA Player kosong. Anda harus menerapkan fungsi loadUrl untuk memutar iklan. Fungsi lainnya bersifat opsional.

Menampilkan ima.Player:

loadUrl(streamInfo)

Dipanggil saat pemutar harus mulai memutar URL. Anda harus mengimplementasikan metode ini untuk memuat streaming.

Parameter	Jenis	Deskripsi
streamInfo	ima.StreamInfo	Berisi informasi yang diperlukan untuk memutar konten.

Kembali ke atas

Kelas ima.StreamFormat

Kolom

DASH, HLS

Menentukan format streaming.

Properti

Name	Jenis	Deskripsi
DASH
HLS

Kembali ke atas

Kelas ima.StreamInfo

Kolom

format, manifes, streamId, streamType, subtitel

Metode

createStreamInfo

Informasi yang diteruskan dari SDK ke pemutar tentang streaming.

Properti

Name	Jenis	Deskripsi
format		Format video: hls atau tanda hubung. Ditentukan dalam ima.StreamFormat.
manifest		URL untuk streaming.
streamId		ID unik untuk streaming.
streamType		Jenis video: live atau on demand. Ditentukan dalam ima.StreamType.
subtitles		Subtitel, jika tersedia. Tidak valid jika tidak.

createStreamInfo()

Menampilkan ima.StreamInfo:

Kembali ke atas

Kelas ima.StreamManager

Metode

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, mengganti, menggantikanParameter replaceAdTagParameters

Objek untuk mengelola pemutaran streaming.

addEventListener(event, callback)

Menambahkan pemroses untuk peristiwa yang ditentukan. Lihat konstanta AdEvents untuk peristiwa yang didukung.

Parameter	Jenis	Deskripsi
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Menampilkan ima.StreamManager:

Parameter	Jenis	Deskripsi
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Tidak didukung. Sebagai gantinya, teruskan data dari iklan pengiring ke RAF secara langsung. Opsi ini sekarang tidak beroperasi.

getContentTime(streamTime)

Mendapatkan waktu dalam milidetik untuk streaming VOD, yang menunjukkan waktu dalam konten tanpa iklan. Lihat: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Untuk mendapatkan waktu konten untuk waktu streaming saat ini, masukkan -1.

Menampilkan Integer: Waktu konten yang sesuai dengan waktu streaming tertentu.

Parameter	Jenis	Deskripsi
streamTime	Integer	Waktu dalam aliran.

getCuePoints()

Menampilkan semua titik tanda yang sesuai dengan semua jeda iklan. Hal ini hanya valid untuk konten video on-demand dengan semua jeda iklan sudah diketahui sebelumnya. Semua waktu mewakili waktu streaming dalam detik.

Menampilkan Object: Array dengan semua titik tanda.

getPreviousCuePoint(time)

Menampilkan titik tanda sebelum waktu ini. Titik tanda menunjukkan jeda iklan. Semua waktu mewakili waktu streaming dalam detik.

Menampilkan ima.CuePoint: Objek dengan awal, akhir, dan hasPlayed. Menampilkan Tidak valid jika tidak ada titik tanda.

Parameter	Jenis	Deskripsi
time	Float	Waktu untuk mencari, -1 menunjukkan waktu saat ini.

getStreamTime(contentTime)

Mendapatkan waktu streaming dari waktu konten untuk VOD dalam milidetik. Lihat: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

Menampilkan Integer: Waktu streaming yang sesuai dengan waktu konten tertentu.

Parameter	Jenis	Deskripsi
contentTime	Integer	Waktu konten.

loadThirdPartyStream(streamManifest, streamSubtitle)

Memuat metadata iklan dan memanggil fungsi loadUrl dengan data streamManifestUrl dan streamSubtitle yang disediakan. Fungsi ini hanya berfungsi jika jenis permintaan streaming adalah ima.StreamType.POD_VOD.

Parameter	Jenis	Deskripsi
streamManifest	string	URL manifes streaming dengan iklan yang digabungkan.
streamSubtitle	ifArray>|Invalid	Subtitel akan dikaitkan dengan streaming, atau Invalid jika tidak ada.

onMessage(msg)

Menangani semua pesan yang berasal dari objek Video. Harus dipanggil untuk setiap pesan yang diterima di roMessagePort.

Parameter	Jenis	Deskripsi
msg	object	Pesan dari port roVideo.

replaceAdTagParameters(adTagParameters)

Mengganti semua parameter tag iklan yang akan digunakan dalam permintaan iklan berikutnya untuk live stream. Perlu diperhatikan bahwa panggilan ini tidak memiliki pengoperasian untuk streaming VOD.

Parameter	Jenis	Deskripsi
adTagParameters	string	Parameter tag iklan baru.

start()

Memulai pemutaran streaming.

Kembali ke atas

Kelas ima.StreamRequest

Kolom

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, pemutar video, ActivityppidstreamActivityMonitorIdvideoIdvideoObjectvideoStitcherSessionOptions

Metode

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, CreateVideoStitcherVodStreamRequestWithVodConfig, {1415createVodStreamRequestcreateVodStreamRequest

Digunakan untuk menentukan properti permintaan streaming.

Properti

Name	Jenis	Deskripsi
adTagParameters		Opsional. Anda dapat mengganti kumpulan parameter tag iklan terbatas pada permintaan streaming. Sediakan parameter penargetan ke aliran data Anda memberikan informasi selengkapnya. Anda juga dapat menggunakan parameter dai-ot dan dai-ov untuk preferensi varian streaming. Lihat Mengganti parameter varian streaming untuk mengetahui informasi selengkapnya.
adUiNode		Node grafik scene tempat UI iklan ditampilkan. IMA menempatkan elemen seperti tombol Why This Ad dan Skip pada elemen ini selama iklan. Elemen ini harus menempatkan seluruh elemen video.
apiKey		Opsional. Kunci ini dapat digunakan untuk mengautentikasi permintaan streaming. Kunci autentikasi DAI harus disiapkan di UI DFP.
assetKey		Wajib untuk live stream. Hal ini digunakan untuk menentukan streaming mana yang harus diputar. Kunci aset permintaan live stream adalah ID yang dapat ditemukan di UI DFP.
authToken		Token otorisasi permintaan streaming. Digunakan sebagai pengganti kunci API untuk otorisasi konten yang lebih ketat. Penayang dapat mengontrol setiap otorisasi streaming konten berdasarkan token ini.
contentSourceId		Wajib untuk streaming on demand. cmsid berasal dari Sumber Konten Video DFP di UI DFP.
customAssetKey		Kunci aset kustom digunakan untuk menentukan streaming mana yang harus diputar. Kunci aset kustom diperlukan untuk pod yang menayangkan permintaan streaming.
format		Format streaming. Default-nya adalah ima.StreamFormat.HLS.
networkCode		Kode jaringan untuk penayang yang membuat permintaan streaming. Kode jaringan diperlukan untuk pod yang menayangkan permintaan streaming.
player		Implementasi antarmuka pemutar.
ppid		Tidak digunakan lagi. Menggunakan adTagParameters. Opsional. ID yang diberikan penayang Audiens DFP.
streamActivityMonitorId		ID yang akan digunakan untuk men-debug streaming dengan pemantauan aktivitas streaming. Hal ini digunakan untuk memberikan cara mudah guna memungkinkan penayang menemukan log streaming di alat pemantau aktivitas streaming.
videoId		Wajib untuk streaming on demand. ID untuk sumber konten video.
videoObject		Objek video (seperti roSGNode Video) yang bertanggung jawab untuk pemutaran video di aplikasi klien. Objek ini akan dipilih untuk berbagai data yang akan digunakan dalam pengaturan waktu peristiwa ID3 Live HLS dengan benar.
videoStitcherSessionOptions		Opsi sesi digunakan untuk menyetel parameter khusus penampung video untuk streamRequests VideoStitcher.

createLiveStreamRequest(assetKey, apiKey)

Melakukan inisialisasi properti yang diperlukan dari StreamRequest Live. Menggunakan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest generik, tanpa ada properti yang diabaikan.

Menampilkan objek ima.StreamRequest: ima.StreamRequest dengan properti Live yang diperlukan.

Parameter	Jenis	Deskripsi
assetKey	string
apiKey	string	Parameter opsional yang akan ditetapkan ke properti apiKey StreamRequest yang ditampilkan; setelan defaultnya adalah string kosong.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Melakukan inisialisasi properti yang diperlukan dari ima.StreamRequest Pod Live. Menggunakan API ini menyebabkan properti khusus ima.StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest generik, tanpa ada properti yang diabaikan.

Menampilkan objek StreamRequest: ima.StreamRequest dengan properti PodLive yang diperlukan.

Parameter	Jenis	Deskripsi
customAssetKey	string
networkCode	string
apiKey	string	Parameter opsional yang akan ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang ditampilkan; setelan defaultnya adalah string kosong.

createPodVodStreamRequest(networkCode)

Melakukan inisialisasi properti ima.StreamRequest yang diperlukan untuk mendaftarkan streaming VOD saat menggunakan Pod DAI yang menyalurkan dengan penggabung video pihak ketiga. Fungsi ini menetapkan jenis permintaan ke ima.StreamType.POD_VOD dan memvalidasi semua properti yang diperlukan untuk data yang tidak ada. Validasi yang gagal akan mencatat error di konsol debug.

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

Parameter	Jenis	Deskripsi
networkCode	string	kode jaringan Google Ad Manager

createStreamRequest()

Menampilkan ima.StreamRequest: Objek ima.StreamRequest kosong.

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

Melakukan inisialisasi properti yang diperlukan dari Video Stitcher Live StreamRequest. Menggunakan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest generik, tanpa ada properti yang diabaikan.

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

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

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

Melakukan inisialisasi properti yang diperlukan dari Video Stitcher VOD StreamRequest. Menggunakan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest generik, tanpa ada properti yang diabaikan.

Menampilkan objek ima.StreamRequest: ima.StreamRequest dengan properti VideoStitcherVod yang diperlukan.

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

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

Melakukan inisialisasi properti yang diperlukan dari StreamRequest Video Stitcher VOD menggunakan vodConfigId yang dibuat dari penggabung video cloud. Menggunakan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest generik, tanpa ada properti yang diabaikan.

Menampilkan objek ima.StreamRequest: ima.StreamRequest dengan properti VideoStitcherVod yang diperlukan.

Parameter	Jenis	Deskripsi
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Melakukan inisialisasi properti yang diperlukan dari ima.StreamRequest VOD. Menggunakan API ini menyebabkan properti khusus ima.StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest generik, tanpa ada properti yang diabaikan.

Menampilkan objek ima.StreamRequest: ima.StreamRequest dengan properti VOD yang diperlukan.

Parameter	Jenis	Deskripsi
contentSourceId	string
videoId	string
apiKey	string	Parameter opsional yang akan ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang ditampilkan; setelan defaultnya adalah string kosong.

Kembali ke atas

Class ima.StreamType

Kolom

LIVE, VOD

Menentukan jenis streaming yang perlu diputar oleh pemutar. Pre-roll dan VOD akan diputar dari awal streaming.

Properti

Name	Jenis	Deskripsi
LIVE		Video ditayangkan.
VOD		Videonya on demand.

Kembali ke atas

Class ima.WrapperInfo

Kolom

adId, adSystem, creativeAdId, creativeId, dealId

Metode

createWrapperInfo

Berisi informasi tentang wrapper.

Properti

Name	Jenis	Deskripsi
adId		ID iklan atau string kosong jika tidak diketahui.
adSystem		Nama sistem iklan yang dideklarasikan atau dan string kosong jika tidak diketahui.
creativeAdId		ID iklan di materi iklan atau string kosong jika tidak diketahui.
creativeId		ID materi iklan atau string kosong jika tidak diketahui.
dealId		ID transaksi atau string kosong jika tidak diketahui.

createWrapperInfo()

Menampilkan ima.WrapperInfo:

Kembali ke atas