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

Kelas google.ima.dai.api.Ad

Metode

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

getAdId()


Menampilkan string:

getAdPodInfo()


Menampilkan google.ima.dai.api.AdPodInfo:

getAdSystem()


Menampilkan string:

getAdvertiserName()


Menampilkan string:

getApiFramework()


Menampilkan string:

getCompanionAds()


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

getCreativeAdId()


Menampilkan string:

getCreativeId()


Menampilkan string:

getDealId()


Menampilkan string:

getDescription()


Menampilkan string:

getDuration()


Menampilkan number:

getTitle()


Menampilkan string:

getVastMediaHeight()


Menampilkan number:

getVastMediaWidth()


Menampilkan number:

getWrapperAdIds()


Menampilkan Array.<string>:

getWrapperAdSystems()


Menampilkan Array.<string>:

getWrapperCreativeIds()


Menampilkan Array.<string>:

Kelas google.ima.dai.api.AdPodInfo

Metode

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

getAdPosition()


Menampilkan number:

getMaxDuration()


Menampilkan number:

getPodIndex()


Menampilkan number:

getTimeOffset()


Menampilkan number:

getTotalAds()


Menampilkan number:

Kelas google.ima.dai.api.AdProgressData

Kolom

Class untuk menentukan data progres iklan.

Properti

Nama Jenis Deskripsi
adBreakDuration

adPosition

currentTime

duration

totalAds

Kelas google.ima.dai.api.CompanionAd

Metode

Class yang mewakili objek iklan pengiring selama penyisipan iklan dinamis. Class ini mengekspos subkumpulan properti ima.CompanionAd.

getAdSlotId()


Menampilkan string:

getContent()


Menampilkan string:

getContentType()


Menampilkan string:

getHeight()


Menampilkan number:

getWidth()


Menampilkan number:

Kelas google.ima.dai.api.CuePoint

Kolom

Class untuk menentukan properti titik tanda, yang mewakili jeda iklan dalam streaming VOD DAI.

Properti

Nama Jenis Deskripsi
end

Waktu berakhir untuk titik tanda ini.
played

Jika titik tanda ini telah diputar.
start

Waktu mulai untuk titik tanda ini.

Kelas google.ima.dai.api.LiveStreamRequest

Kolom

Class untuk menentukan properti permintaan live stream.

Konstruktor:
Parameter Jenis Deskripsi
opt_liveStreamRequest Object

yang sudah memiliki properti permintaan streaming yang ditetapkan.

Properti

Nama Jenis Deskripsi
assetKey

Hal ini digunakan untuk menentukan streaming mana yang sebaiknya 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 aliran data.

Properti

Nama Jenis Deskripsi
adProgressData

Informasi terkait waktu untuk iklan yang sedang diputar.
cuepoints

Titik tanda iklan untuk streaming on demand. Hal ini dapat berubah saat streaming berlangsung. Ini hanya akan diisi pada pemroses peristiwa untuk CUEPOINTS_AL AdEvent.
errorMessage

streamId

subtitles

url

Kelas google.ima.dai.api.StreamEvent

Metode

Jenis peristiwa ini dipicu oleh pengelola streaming sebagai notifikasi saat status streaming berubah.

getAd()


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

getStreamData()


Menampilkan google.ima.dai.api.StreamData: menampilkan objek yang berisi informasi aliran data.

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 info terbaru pada progres iklan.
CLICK

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

Diaktifkan saat iklan selesai.
CUEPOINTS_CHANGED

Dikirim untuk streaming on demand saat titik tanda 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. Layanan tersebut mengelola interaksi dengan backend DAI dan menangani ping pelacakan serta meneruskan streaming dan peristiwa iklan kepada penayang. Pengelola ini tidak mewarisi dari BaseAdsManager karena bukan pengelola untuk iklan tertentu, tetapi satu untuk seluruh aliran data

Konstruktor:
Parameter Jenis Deskripsi
videoElement HTMLVideoElement

Elemen pemutar video yang sebenarnya.

contentTimeForStreamTime(streamTime)

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

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

Parameter Jenis Deskripsi
streamTime number

waktu streaming dengan iklan yang disisipkan (dalam detik).

onTimedMetadata(metadata)

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

Parameter Jenis Deskripsi
metadata Object

Kamus metadata.

previousCuePointForStreamTime(streamTime)

Menampilkan titik tanda sebelumnya untuk waktu streaming yang ditentukan. Menampilkan null jika tidak ada cuepoint seperti itu. Layanan ini digunakan untuk mengimplementasikan fitur seperti snap back, dan dipanggil saat penayang mendeteksi bahwa pengguna mencari untuk mengembalikan pengguna ke jeda iklan.

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

Parameter Jenis Deskripsi
streamTime number

waktu streaming yang diinginkan.

processMetadata(type, data, timestamp)

Metadata diproses dengan waktu untuk live stream. Gunakan jika pemutar video Anda memberikan metadata yang tidak diurai beserta 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 ketika data harus diproses.

requestStream(streamRequest)

Meminta streaming untuk dimuat menggunakan parameter streaming yang disediakan.

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 pengguna keluar dari halaman saat ini.

Parameter Jenis Deskripsi
clickElement Element

elemen yang digunakan saat iklan diklik.

streamTimeForContentTime(contentTime)

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

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

Parameter Jenis Deskripsi
contentTime number

waktu konten tanpa iklan (dalam detik).

Kelas google.ima.dai.api.StreamRequest

Kolom

Class untuk menentukan properti permintaan streaming.

Properti

Nama Jenis Deskripsi
adTagParameters

Anda dapat mengganti sekumpulan parameter tag iklan terbatas pada permintaan streaming. Sediakan parameter penargetan ke streaming Anda akan memberikan informasi lebih lanjut. Anda dapat menggunakan parameter dai-ot dan dai-ov untuk preferensi varian streaming. Lihat Mengganti Parameter Varian Aliran untuk mengetahui informasi selengkapnya.
apiKey

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

ID yang akan digunakan untuk men-debug streaming dengan pemantauan aktivitas streaming. Hal ini digunakan untuk memberikan cara praktis guna memungkinkan penayang menemukan log streaming dalam alat pemantauan aktivitas streaming.

Kelas google.ima.dai.api.VODStreamRequest

Kolom

Class untuk menentukan properti permintaan streaming VOD.

Konstruktor:
Parameter Jenis Deskripsi
opt_VODStreamRequest Object

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. Wajib untuk streaming on demand.

Konstanta google.ima.VERSION

String yang berisi SDK versi lengkap.