google.
Namespace google.ima menyediakan akses ke class, antarmuka, enumerasi, dan properti SDK.
Class
Iklan
Class iklan yang diperluas oleh class yang mewakili berbagai jenis iklan.
PoinAdCue
Daftar titik tanda mewakili jadwal waktu jeda iklan. Perhatikan bahwa tiap-tiap iklan dalam jeda iklan tidak disertakan dalam jadwal.
AdDisplayContainer
Class ini merepresentasikan penampung untuk menampilkan iklan. SDK akan otomatis membuat struktur di dalam parameter containerElement untuk menyimpan iklan video dan overlay.
Saat dibuat, instance class ini akan membuat IFRAME di
containerElement dan memuat core SDK. IFRAME ini harus dipertahankan agar SDK dapat berfungsi dengan benar. Setelah semua iklan diputar
dan SDK tidak diperlukan lagi, gunakan metode destroy()
untuk menghapus muatan SDK.
Parameter containerElement harus berupa elemen yang merupakan bagian dari DOM. Anda harus memosisikan containerElement dengan benar agar iklan dapat ditampilkan dengan benar. Sebaiknya posisikan di atas pemutar video konten dan sesuaikan ukuran untuk mencakup seluruh pemutar video. Lihat dokumentasi SDK untuk mengetahui detail tentang penerapan yang direkomendasikan.
Catatan: Selalu perlu memanggil metode initialize() dalam kode yang dipanggil langsung oleh tindakan pengguna (seperti klik atau ketuk).
Error Iklan
AdError menampilkan informasi kepada pengguna tentang apakah kegagalan terjadi saat pemuatan atau pemutaran iklan. Aksesor TypeType memberikan informasi tentang apakah error terjadi selama pemuatan iklan atau pemutaran iklan.
AdErrorEvent
Peristiwa ini dipicu saat terjadi error saat memuat iklan dari server Google atau DoubleClick. Jenis tempat Anda dapat mendaftar untuk peristiwa tersebut adalah AdsLoader dan AdsManager.
Acara Iklan
Jenis peristiwa ini dipicu oleh iklan sebagai notifikasi saat status iklan berubah dan saat pengguna berinteraksi dengan iklan. Misalnya, saat iklan mulai diputar, diklik, dan lainnya. Anda dapat mendaftar ke berbagai peristiwa perubahan status di AdsManager.
AdMetadataEvent
Class ini tidak digunakan lagi. Gunakan AdsManager.getCuePoints() API. Peristiwa iklan tertentu yang membawa metadata.
InfoPodPod
Iklan dapat menjadi bagian dari pod iklan. Objek ini mengekspos metadata yang terkait dengan pod tersebut, seperti jumlah iklan dalam pod dan posisi iklan dalam pod.
getTotalAds API yang terdapat dalam objek ini sering kali
benar, tetapi dalam skenario tertentu, API ini mewakili tebakan terbaik SDK. Lihat dokumentasi metode tersebut untuk informasi selengkapnya.
AdProgressData
Objek ini mengekspos informasi tentang progres saat ini ketika iklan sedang diputar.
AdsLoader
AdsLoader memungkinkan klien meminta iklan dari server iklan. Untuk melakukannya, pengguna harus mendaftar ke peristiwa AdsManagerLoadedEvent lalu meminta iklan.
AdsManager
Menyediakan API publik luar kepada penayang dan berkomunikasi dengan instance internal pengelola iklan.
AdsManagerLoadedEvent
Peristiwa ini dipicu saat iklan berhasil dimuat dari server iklan Google atau DoubleClick melalui AdsLoader. Anda dapat mendaftar ke peristiwa ini di AdsLoader.
SetelanRendering
Menentukan parameter yang mengontrol rendering iklan.
AdsRequest
Class untuk menentukan properti permintaan iklan.
Iklan Pengiring
Mewakili iklan pengiring.
SetelanAdCompanionSelection
Objek CompanionAdSelectionSettings digunakan untuk menentukan kriteria pemilihan saat memanggil fungsi ima.Ad.getCompanionAds.
Setelan ImaSdk
Class ini berisi setelan seluruh SDK.
UniversalAdIdInfo
Objek ini mengekspos informasi tentang ID iklan universal yang terkait dengan materi iklan, termasuk nilai ID iklan dan registry ID iklan.
Enumerasi
Mode OmidAccess
string
Mode akses yang tersedia untuk OMID untuk Web, yang mengontrol jumlah akses ke skrip verifikasi.
Nilai |
|
|---|---|
|
TERBATAS |
Skrip verifikasi di-sandbox dan tidak dapat mengakses halaman penayang atau materi iklan, dan tidak dapat langsung mengonfirmasi di domain penayang mana berada. |
|
DOMAIN |
Skrip verifikasi di-sandbox dan tidak dapat mengakses halaman materi iklan atau penayang. Namun, skrip dimuat sedemikian rupa sehingga dapat langsung mengonfirmasi domain penayang tempat skrip tersebut berada. |
|
FULL |
Skrip verifikasi memiliki akses langsung ke materi iklan dan halaman penayang. |
Vendor OmidVerifikasi
angka
Mengidentifikasi vendor verifikasi OMID. Vendor dicantumkan sesuai urutan abjad.
Nilai |
|
|---|---|
|
KOMUNITAS |
|
|
VERIFIKASI GANDA |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
MEETRI |
|
|
MOAT |
|
|
NIELSEN |
|
|
PIKSEL |
|
|
LAINNYA |
Vendor default yang akan digunakan jika URL skrip tidak cocok dengan vendor lainnya. |
UiElements
string
Enum yang menentukan elemen UI berbeda yang dapat dikonfigurasi untuk ditampilkan atau disembunyikan. Setelan ini dapat diabaikan untuk iklan AdSense dan ADX.
Nilai |
|
|---|---|
|
IKLAN_ATRIBUSI |
Menampilkan teks "Iklan" di UI iklan. Harus ada untuk menampilkan penghitung mundur. |
|
COUNTDOWN |
Atribusi iklan diperlukan agar penghitung mundur dapat ditampilkan. |
Mode Tampilan
string
Enum yang menentukan mode tampilan VPAID yang berbeda untuk iklan.
Nilai |
|
|---|---|
|
NORMAL |
Mode tampilan iklan normal. |
|
LAYAR PENUH |
Mode tampilan iklan layar penuh. Menunjukkan kepada pengelola iklan bahwa penayang menganggap pengaturan AdDisplayContainer saat ini sebagai layar penuh (misalnya, simulasi layar penuh). Hal ini tidak menyebabkan pengelola iklan memasuki layar penuh. |
- Tidak digunakan lagi
Properti
Mode OmidAccess
string
Mode akses yang tersedia untuk OMID untuk Web, yang mengontrol jumlah akses ke skrip verifikasi.
Nilai |
|
|---|---|
|
TERBATAS |
Skrip verifikasi di-sandbox dan tidak dapat mengakses halaman penayang atau materi iklan, dan tidak dapat langsung mengonfirmasi di domain penayang mana berada. |
|
DOMAIN |
Skrip verifikasi di-sandbox dan tidak dapat mengakses halaman materi iklan atau penayang. Namun, skrip dimuat sedemikian rupa sehingga dapat langsung mengonfirmasi domain penayang tempat skrip tersebut berada. |
|
FULL |
Skrip verifikasi memiliki akses langsung ke materi iklan dan halaman penayang. |
Vendor OmidVerifikasi
angka
Mengidentifikasi vendor verifikasi OMID. Vendor dicantumkan sesuai urutan abjad.
Nilai |
|
|---|---|
|
KOMUNITAS |
|
|
VERIFIKASI GANDA |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
MEETRI |
|
|
MOAT |
|
|
NIELSEN |
|
|
PIKSEL |
|
|
LAINNYA |
Vendor default yang akan digunakan jika URL skrip tidak cocok dengan vendor lainnya. |
UiElements
string
Enum yang menentukan elemen UI berbeda yang dapat dikonfigurasi untuk ditampilkan atau disembunyikan. Setelan ini dapat diabaikan untuk iklan AdSense dan ADX.
Nilai |
|
|---|---|
|
IKLAN_ATRIBUSI |
Menampilkan teks "Iklan" di UI iklan. Harus ada untuk menampilkan penghitung mundur. |
|
COUNTDOWN |
Atribusi iklan diperlukan agar penghitung mundur dapat ditampilkan. |
Mode Tampilan
string
Enum yang menentukan mode tampilan VPAID yang berbeda untuk iklan.
Nilai |
|
|---|---|
|
NORMAL |
Mode tampilan iklan normal. |
|
LAYAR PENUH |
Mode tampilan iklan layar penuh. Menunjukkan kepada pengelola iklan bahwa penayang menganggap pengaturan AdDisplayContainer saat ini sebagai layar penuh (misalnya, simulasi layar penuh). Hal ini tidak menyebabkan pengelola iklan memasuki layar penuh. |
- Tidak digunakan lagi
setelan
ImaSdkSettings non-null
Instance setelan singleton global.