IMA DAI SDK untuk Roku

    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

Class ima

Metode

Fungsi global yang mengontrol IMA SDK.

disableLogging()

Menonaktifkan logging SDK. Logging akan aktif secara default.

getStreamManager()

Menampilkan pengelola streaming jika tersedia. Jika pengelola streaming belum tersedia, Invalid 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 Kontrol langsung ditampilkan ke pemutar setelah memanggil metode ini.

Menampilkan object: error atau tidak valid jika tidak ada error

Parameter Jenis Deskripsi
streamRequest object

Kembali ke atas

Class ima.AdBreakInfo

Kolom

Metode

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

Properti

Nama Jenis Deskripsi
adPosition

Indeks iklan dalam jeda iklan. Indeksnya adalah 1 untuk iklan mandiri.
duration

Durasi maksimum jeda dalam detik, atau -1 jika tidak diketahui.
podIndex

Untuk live stream, menampilkan ID jeda sebagai indeks pod, atau 0 untuk preroll. Tidak ada postroll di live stream. Default-nya adalah -2. Untuk video on demand (VOD), menampilkan indeks pod iklan. Untuk pod pra-putar, menampilkan 0. Untuk mid-roll, menampilkan 1, 2, ..., n. Untuk pod pasca-roll, menampilkan n+1...n+x. Nilai default-nya adalah 0 jika iklan ini bukan bagian dari pod, atau pod ini bukan bagian dari playlist.
timeOffset

Posisi pod dalam konten dalam hitungan detik. Pre-roll menampilkan 0, post-roll menampilkan -1, dan mid-roll menampilkan waktu terjadwal pod.
totalAds

Jumlah total iklan yang terdapat dalam jeda iklan ini. Nilainya adalah 1 untuk iklan mandiri.

createAdBreakInfo()


Menampilkan ima.AdBreakInfo:

Kembali ke atas

Class ima.AdEvent

Kolom

Peristiwa yang diaktifkan oleh pengelola iklan.

Properti

Nama Jenis Deskripsi
AD_PERIOD_ENDED

Diaktifkan setiap kali streaming beralih dari iklan atau slate ke konten. Peristiwa ini akan diaktifkan meskipun iklan diputar untuk kedua kalinya atau saat mencari ke iklan.
AD_PERIOD_STARTED

Diaktifkan setiap kali streaming beralih dari konten ke iklan atau slate. Peristiwa ini akan diaktifkan meskipun iklan diputar untuk kedua kalinya atau saat mencari ke iklan.
COMPLETE

Diaktifkan saat iklan selesai diputar.
ERROR

Diaktifkan saat terjadi error.
FIRST_QUARTILE

Diaktifkan saat playhead 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 playhead iklan melewati titik tengah.
PROGRESS

Diaktifkan saat ada pembaruan pada 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 playhead iklan melewati kuartil ketiga.

Kembali ke atas

Class ima.AdInfo

Kolom

Metode

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

Properti

Nama Jenis Deskripsi
adBreakInfo

Info terkait 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 ditentukan oleh pihak penayangan.
companions

Iklan pengiring yang ditentukan dalam respons VAST.
creativeAdId

Kode ISCI (Industry Standard Commercial Identifier) untuk iklan. Ini adalah ID Iklan materi iklan yang dipilih dalam respons VAST.
creativeId

ID materi iklan yang dipilih untuk iklan.
currentTime

Waktu saat ini dalam iklan dalam hitungan detik atau -1 jika tidak diketahui.
dealId

Menampilkan ID transaksi pertama yang ada dalam rantai wrapper untuk iklan saat ini, dimulai dari atas.
duration

Durasi iklan tunggal ini dalam detik atau -1 jika tidak diketahui.
skipOffset

Waktu yang diperlukan agar iklan dapat dilewati atau -1 jika tidak diketahui.
universalAdIDRegistry

String yang digunakan untuk mengidentifikasi URL situs registry tempat ID Iklan Universal materi iklan yang dipilih dikatalogkan.
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 dalam.

createAdInfo()


Menampilkan ima.AdInfo:

Kembali ke atas

Class ima.Companion

Kolom

Metode

Berisi informasi tentang pengiring iklan.

Properti

Nama Jenis Deskripsi
apiFramework

API yang diperlukan untuk menjalankan iklan ini, atau Tidak valid jika tidak tersedia.
creativeType

Merepresentasikan creativetype yang biasanya berupa mimetype.
height

Tinggi pendamping dalam piksel. 0 jika tidak tersedia.
trackingEvents

Peta peristiwa pelacakan dengan kunci adalah peristiwa dan nilainya adalah daftar URL yang akan di-ping setelah peristiwa tersebut.
url

URL untuk resource statis pendamping ini.
width

Lebar pendamping dalam piksel. 0 jika tidak tersedia.

createCompanion()


Menampilkan ima.Companion:

Kembali ke atas

Class ima.CuePoint

Kolom

Metode

Berisi info tentang titik tanda.

Properti

Nama Jenis Deskripsi
end

Waktu akhir untuk titik tanda dalam detik. Ini sesuai dengan jeda iklan.
hasPlayed

Boolean yang menunjukkan bahwa titik tanda telah diputar.
start

Waktu mulai untuk titik tanda dalam detik. Ini sesuai dengan jeda iklan.

createCuePoint()


Menampilkan ima.CuePoint:

Kembali ke atas

Class ima.Error

Kolom

Metode

Objek yang diteruskan ke pengendali error jika ada error.

Properti

Nama Jenis Deskripsi
id

ID error. Lihat konstanta ErrorEvent untuk mengetahui daftar kode error.
info

Informasi tambahan tentang error.
type

Selalu tetapkan ke error untuk menunjukkan jenis objek ini.

createError()


Menampilkan ima.Error:

Kembali ke atas

Class ima.ErrorEvent

Kolom

Semua error yang mungkin dikirim kembali oleh SDK.

Properti

Nama Jenis Deskripsi
BAD_STREAM_REQUEST

Permintaan streaming tidak diisi dengan benar.
COULD_NOT_LOAD_STREAM

Streaming tidak dapat dimuat.
ERROR

Error tidak diketahui.
INVALID_RESPONSE

Respons server tidak valid.
STREAM_API_KEY_NOT_VALID

Kunci API yang diberikan tidak diterima oleh server.

Kembali ke atas

Class ima.Player

Metode

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 dimulai.

Parameter Jenis Deskripsi
adBreakInfo ima.AdBreakInfo

Berisi informasi tentang jeda iklan.

allVideoComplete()

Opsional. Dipanggil saat semua video selesai.

createPlayer()

Membuat objek Player IMA 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

Class ima.StreamFormat

Kolom

Menentukan format aliran data.

Properti

Nama Jenis Deskripsi
DASH

HLS

Kembali ke atas

Class ima.StreamInfo

Kolom

Metode

Informasi yang diteruskan dari sdk ke pemutar tentang streaming.

Properti

Nama Jenis Deskripsi
format

Format video: hls atau dash. Ditentukan di ima.StreamFormat.
manifest

URL untuk streaming.
streamId

ID unik untuk streaming.
streamType

Jenis video: live atau on demand. Ditentukan di ima.StreamType.
subtitles

Subtitel, jika tersedia. Tidak valid jika tidak.

createStreamInfo()


Menampilkan ima.StreamInfo:

Kembali ke atas

Class ima.StreamManager

Metode

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. Sekarang tidak ada operasi.

getContentTime(streamTime)

Mendapatkan waktu dalam milidetik untuk streaming VOD, yang mewakili waktu dalam konten tanpa iklan. Untuk mengetahui detail selengkapnya, lihat FAQ. Untuk mendapatkan waktu konten untuk waktu streaming saat ini, teruskan -1.

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

Parameter Jenis Deskripsi
streamTime Integer

Waktu dalam streaming.

getCuePoints()

Menampilkan semua titik tanda yang sesuai dengan semua jeda iklan. Hal ini hanya berlaku untuk konten video on demand yang semua jeda iklannya diketahui terlebih dahulu. Semua waktu mewakili waktu streaming dalam detik. Untuk streaming Cloud Stitching API, properti hasPlayed dari setiap ima.CuePoint selalu salah.

Menampilkan Object: Array dengan semua titik tanda.

getPreviousCuePoint(time)

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

Menampilkan ima.CuePoint: Objek dengan start, end, dan hasPlayed. Menampilkan Invalid jika tidak ada titik tanda yang tersedia.

Parameter Jenis Deskripsi
time Float

Waktu untuk mencari, -1 menunjukkan waktu saat ini, dan menampilkan Invalid untuk semua streaming lainnya.

getStreamTime(contentTime)

Mendapatkan waktu untuk streaming dari waktu konten untuk VOD dalam milidetik. Untuk mengetahui detail selengkapnya, lihat FAQ.

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

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 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 untuk permintaan iklan berikutnya di live stream. Perhatikan bahwa panggilan ini tidak berfungsi untuk streaming VOD.

Parameter Jenis Deskripsi
adTagParameters string

Parameter tag iklan baru.

start()

Memulai pemutaran streaming.

Kembali ke atas

Class ima.StreamRequest

Kolom

Metode

Digunakan untuk menentukan properti permintaan streaming.

Properti

Nama Jenis Deskripsi
adTagParameters

Opsional. Anda dapat mengganti kumpulan parameter tag iklan terbatas pada permintaan streaming. Menyediakan parameter penargetan ke streaming 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 tampilan tempat UI iklan ditampilkan. IMA menempatkan elemen seperti tombol Mengapa Iklan Ini dan Lewati pada elemen ini selama iklan. Elemen 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. Ini digunakan untuk menentukan streaming mana yang akan 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 aliran konten berdasarkan token ini.
contentSourceId

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

Kunci aset kustom digunakan untuk menentukan streaming yang akan diputar. Kunci aset kustom diperlukan untuk permintaan streaming penayangan pod.
format

Format streaming. Default-nya adalah ima.StreamFormat.HLS.
networkCode

Kode jaringan untuk penayang yang membuat permintaan streaming. Kode jaringan diperlukan untuk permintaan streaming penayangan Pod yang dibuat dengan createPodLiveStreamRequest atau createPodVodStreamRequest. Kode ini juga diperlukan untuk permintaan streaming penyambungan Cloud yang dibuat dengan createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, atau createVideoStitcherVodStreamRequestWithVodConfig. Kode ini bersifat opsional dan direkomendasikan untuk permintaan streaming Layanan lengkap yang dibuat dengan createLiveStreamRequest atau createVodStreamRequest. Menambahkan kode jaringan akan menerapkan setelan yang dipilih di UI Ad Manager, seperti pengaktifan iklan terbatas terprogram. Untuk penayangan Pod dan penyambungan Cloud, menambahkan kode jaringan akan menemukan dan memutar streaming. Untuk menemukan kode jaringan, lihat artikel ini.
player

Implementasi antarmuka pemutar.
ppid

Tidak digunakan lagi. Gunakan adTagParameters. Opsional. ID yang diberikan penayang Audiens DFP.
streamActivityMonitorId

ID yang akan digunakan untuk men-debug streaming dengan pemantauan aktivitas streaming. Ini digunakan untuk memberikan cara yang mudah bagi penayang untuk menemukan log streaming di alat pemantauan aktivitas streaming.
videoId

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

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

Opsi sesi digunakan untuk menetapkan parameter khusus stitcher video untuk streamRequests VideoStitcher.

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

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

Parameter Jenis Deskripsi
assetKey string

apiKey string

Parameter yang ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang ditampilkan. 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.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

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

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

Parameter Jenis Deskripsi
customAssetKey string

networkCode string

apiKey string

Parameter opsional yang ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang ditampilkan; defaultnya adalah string kosong.

createPodVodStreamRequest(networkCode)

Melakukan inisialisasi properti yang diperlukan dari ima.StreamRequest untuk mendaftarkan streaming VOD saat menggunakan penayangan Pod DAI dengan stitcher 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 yang diperlukan ditentukan, jenis permintaan akan 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 StreamRequest Live Penggabung Video. Penggunaan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Menampilkan ima.StreamRequest: Objek 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 StreamRequest VOD Video Stitcher. Penggunaan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Menampilkan ima.StreamRequest: Objek 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 VOD Penggabung Video menggunakan vodConfigId yang dibuat dari penggabung video cloud. Penggunaan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika parameter yang diperlukan berupa string kosong, logging error akan terjadi dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

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

Parameter Jenis Deskripsi
vodConfigId string

networkCode string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Melakukan inisialisasi properti yang diperlukan dari ima.StreamRequest VOD. Penggunaan 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 umum, tanpa properti yang diabaikan.

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

Parameter Jenis Deskripsi
contentSourceId string

videoId string

apiKey string

Parameter yang ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang ditampilkan. 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.

Kembali ke atas

Class ima.StreamType

Kolom

Menentukan jenis streaming yang diminta untuk diputar oleh pemutar. Preroll dan VOD harus diputar dari awal streaming.

Properti

Nama Jenis Deskripsi
LIVE

Video ditayangkan.
VOD

Video ini tersedia sesuai permintaan.

Kembali ke atas

Class ima.WrapperInfo

Kolom

Metode

Berisi informasi tentang wrapper.

Properti

Nama Jenis Deskripsi
adId

ID iklan atau string kosong jika tidak diketahui.
adSystem

Nama sistem iklan yang dideklarasikan atau 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 promo atau string kosong jika tidak diketahui.

createWrapperInfo()


Menampilkan ima.WrapperInfo:

Kembali ke atas