IMA DAI SDK API Google

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

Class google.ima.dai.api.Ad

Metode

Class yang merepresentasikan objek iklan selama penyisipan iklan dinamis. Class ini mengekspos subset properti ima.Ad.

getAdId()


Hasil string:

getAdPodInfo()


Hasil google.ima.dai.api.AdPodInfo:

getAdSystem()


Hasil string:

getAdvertiserName()


Hasil string:

getApiFramework()


Hasil string:

getCompanionAds()


Hasil Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Hasil string:

getCreativeId()


Hasil string:

getDealId()


Hasil string:

getDescription()


Hasil string:

getDuration()


Hasil number:

getTitle()


Hasil string:

getVastMediaHeight()


Hasil number:

getVastMediaWidth()


Hasil number:

getWrapperAdIds()


Hasil Array.<string>:

getWrapperAdSystems()


Hasil Array.<string>:

getWrapperCreativeIds()


Hasil Array.<string>:

Class google.ima.dai.api.AdPodInfo

Metode

Class yang merepresentasikan objek info pod iklan selama penyisipan iklan dinamis. Class ini mengekspos subset properti ima.AdPodInfo.

getAdPosition()


Hasil number:

getMaxDuration()


Hasil number:

getPodIndex()


Hasil number:

getTimeOffset()


Hasil number:

getTotalAds()


Hasil number:

Class google.ima.dai.api.AdProgressData

Kolom

Class untuk menentukan data progres iklan.

Properti

Nama Jenis Deskripsi
adBreakDuration

adPosition

currentTime

duration

totalAds

Class google.ima.dai.api.CompanionAd

Metode

Class yang merepresentasikan objek iklan pendamping selama penyisipan iklan dinamis. Class ini mengekspos subset properti ima.CompanionAd.

getAdSlotId()


Hasil string:

getContent()


Hasil string:

getContentType()


Hasil string:

getHeight()


Hasil number:

getWidth()


Hasil number:

Class google.ima.dai.api.CuePoint

Kolom

Class untuk menentukan properti cuepoint, yang merepresentasikan jeda iklan dalam streaming VOD DAI.

Properti

Nama Jenis Deskripsi
end

Waktu berakhir untuk titik isyarat ini.
played

Jika titik cuplikan ini telah diputar.
start

Waktu mulai untuk titik cuplikan ini.

Class google.ima.dai.api.LiveStreamRequest

Kolom

Class untuk menentukan properti permintaan live stream.

Konstruktor:
Parameter Jenis Deskripsi
opt_liveStreamRequest Object

objek yang sudah memiliki properti permintaan aliran yang ditetapkan.

Properti

Nama Jenis Deskripsi
assetKey

Ini digunakan untuk menentukan streaming mana yang harus diputar. Kunci aset permintaan live stream adalah ID yang dapat ditemukan di UI DFP.

Class google.ima.dai.api.StreamData

Kolom

Class untuk menentukan data streaming.

Properti

Nama Jenis Deskripsi
adProgressData

Informasi terkait pengaturan waktu untuk iklan yang sedang diputar.
cuepoints

Cuepoint iklan untuk streaming on-demand. Hal ini dapat berubah seiring kemajuan streaming. Kolom ini hanya akan diisi di pemroses peristiwa untuk CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Metode

Jenis peristiwa ini dimunculkan oleh pengelola aliran sebagai notifikasi saat status aliran berubah.

getAd()


Menampilkan google.ima.dai.api.Ad: menampilkan objek dengan informasi iklan.

getStreamData()


Mengembalikan google.ima.dai.api.StreamData: mengembalikan objek dengan informasi streaming.

Enum google.ima.dai.api.StreamEvent.Type

Kolom

Daftar jenis peristiwa yang didukung oleh IMA SDK.

Nilai

Nilai Deskripsi
AD_BREAK_ENDED

Diaktifkan saat jeda iklan berakhir.
AD_BREAK_STARTED

Diaktifkan saat jeda iklan dimulai.
AD_PROGRESS

Diaktifkan saat ada update pada progres iklan.
CLICK

Dikirim saat elemen klik diklik atau diketuk saat iklan sedang diputar.
COMPLETE

Diaktifkan saat iklan selesai.
CUEPOINTS_CHANGED

Dikirim untuk streaming on-demand saat titik sinyal berubah.
ERROR

Diaktifkan saat terjadi error.
FIRST_QUARTILE

Diaktifkan saat iklan mencapai kuartil pertamanya.
LOADED

Diaktifkan saat manifes streaming tersedia.
MIDPOINT

Diaktifkan saat iklan mencapai titik tengahnya.
STARTED

Diaktifkan saat iklan dimulai.
STREAM_INITIALIZED

Diaktifkan saat streaming diinisialisasi.
THIRD_QUARTILE

Diaktifkan saat iklan mencapai kuartil ketiganya.

Class google.ima.dai.api.StreamManager

Metode

Menangani streaming penyisipan iklan dinamis. Modul ini mengelola interaksi dengan backend DAI dan menangani ping pelacakan serta meneruskan peristiwa iklan dan streaming ke penayang. Pengelola ini tidak diwarisi dari BaseAdsManager karena bukan pengelola untuk iklan tertentu, melainkan untuk seluruh streaming

Konstruktor:
Parameter Jenis Deskripsi
videoElement HTMLVideoElement

Elemen pemutar video sebenarnya.

contentTimeForStreamTime(streamTime)

Menampilkan waktu konten tanpa iklan untuk waktu streaming tertentu. Menampilkan waktu streaming yang diberikan untuk live stream.

Menampilkan number: waktu konten yang sesuai dengan waktu streaming yang diberikan setelah iklan dihapus.

Parameter Jenis Deskripsi
streamTime number

waktu streaming dengan iklan yang disisipkan (dalam detik).

onTimedMetadata(metadata)

Meneruskan kamus metadata yang diproses. Kamus mengharapkan kunci 'TXXX' dengan string metadata yang ditentukan pengguna sebagai nilai. Jika pemutar Anda menyediakan metadata mentah, panggil ima.dai.api.StreamManager.processMetadata.

Parameter Jenis Deskripsi
metadata Object

Kamus metadata.

previousCuePointForStreamTime(streamTime)

Menampilkan cuepoint sebelumnya untuk waktu streaming tertentu. Menampilkan null jika tidak ada cuepoint seperti itu. Ini digunakan untuk menerapkan fitur seperti kembali ke posisi semula, dan dipanggil saat penayang mendeteksi bahwa pengguna mencari untuk mengembalikan pengguna ke jeda iklan.

Menampilkan google.ima.dai.api.CuePoint: titik cu sebelumnya untuk waktu streaming tertentu.

Parameter Jenis Deskripsi
streamTime number

waktu streaming yang dicari.

processMetadata(type, data, timestamp)

Memproses metadata berwaktu untuk live stream. Gunakan jika pemutar video Anda menyediakan metadata yang tidak diuraikan bersama dengan stempel waktu, jika tidak, panggil ima.dai.api.StreamManager.onTimedMetadata.

Parameter Jenis Deskripsi
type string

Jenis untuk metadata. Harus 'ID3'.
data Uint8Array

Data tag mentah. Untuk ID3, harus berupa seluruh tag.
timestamp number

Waktu saat data harus diproses.

requestStream(streamRequest)

Meminta agar streaming dimuat menggunakan parameter streaming yang diberikan.

Parameter Jenis Deskripsi
streamRequest google.ima.dai.api.StreamRequest

berisi parameter untuk memuat metadata streaming.

setClickElement(clickElement)

Menetapkan elemen klik-tayang iklan. Elemen ini digunakan sebagai penerima klik atau ketuk saat iklan diputar, dan dapat menyebabkan navigasi keluar dari halaman saat ini.

Parameter Jenis Deskripsi
clickElement Element

elemen yang digunakan sebagai klik-tayang iklan.

streamTimeForContentTime(contentTime)

Menampilkan waktu streaming dengan iklan untuk waktu konten tertentu. Menampilkan waktu konten tertentu untuk live stream.

Mengembalikan number: waktu streaming yang sesuai dengan waktu konten tertentu setelah iklan disisipkan.

Parameter Jenis Deskripsi
contentTime number

waktu konten tanpa iklan (dalam detik).

Class google.ima.dai.api.StreamRequest

Kolom

Class untuk menentukan properti permintaan streaming.

Properti

Nama Jenis Deskripsi
adTagParameters

Anda dapat mengganti serangkaian parameter tag iklan terbatas pada permintaan streaming. Menyediakan parameter penargetan ke streaming Anda memberikan informasi selengkapnya. Anda dapat menggunakan parameter dai-ot dan dai-ov untuk preferensi varian streaming. Lihat Mengganti Parameter Varian Streaming untuk mengetahui informasi selengkapnya.
apiKey

Kunci API permintaan streaming. Konfigurasi ini dilakukan melalui UI Admin DFP dan diberikan kepada penayang untuk membuka kunci konten mereka. Aplikasi ini memverifikasi aplikasi yang mencoba mengakses konten.
streamActivityMonitorId

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

Class google.ima.dai.api.VODStreamRequest

Kolom

Class untuk menentukan properti permintaan streaming VOD.

Konstruktor:
Parameter Jenis Deskripsi
opt_VODStreamRequest Object

objek yang sudah memiliki properti permintaan streaming yang ditetapkan.

Properti

Nama Jenis Deskripsi
contentSourceId

ID unik untuk konten penayang, dari CMS. Diperlukan untuk streaming on-demand.
videoId

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

Konstanta google.ima.VERSION

String yang berisi versi lengkap SDK.