Halaman ini diterjemahkan oleh Cloud Translation API.

Kelas: Iklan

Metode

IDIklan

getAdId() menampilkan string

ID iklan digunakan untuk menyinkronkan iklan utama dan iklan pengiring.

Hasil: string ID iklan, atau string kosong jika informasi ini tidak tersedia.

getAdPodInfo

getAdPodInfo() menampilkan AdPodInfo

Menampilkan informasi pod iklan.

Hasil: non-null AdPodInfo Informasi pod iklan.

getAdSystem

getAdSystem() menampilkan string

Informasi server iklan sumber yang disertakan dalam respons iklan.

Hasil: string Server iklan sumber iklan, atau string kosong jika informasi ini tidak tersedia.

getAdvertiserName

getAdvertiserName() menampilkan string

Nama pengiklan seperti yang ditetapkan oleh pihak yang menayangkan.

Hasil: string Nama pengiklan, atau string kosong jika informasi ini tidak tersedia.

getApiFramework

getApiFramework() menampilkan string

Mengidentifikasi API yang diperlukan untuk menjalankan iklan. Ini sesuai dengan apiFramework yang ditentukan secara luas.

Hasil: nullable string Framework API harus menjalankan iklan, atau null jika informasi ini tidak tersedia.

getCompanionAds

getCompanionAds(adSlotWidth, adSlotHeight, settings) menampilkan Array iklan CompanionAd non-null

Mendapatkan iklan pengiring untuk iklan ini berdasarkan ukuran slot iklan pengiring. Secara opsional, setelan pilihan lanjutan diterima. Perhatikan bahwa metode ini hanya akan menampilkan array yang tidak kosong untuk instance iklan yang diperoleh pada atau setelah peristiwa STARTED. Secara khusus, iklan dari peristiwa LOADED akan menampilkan array kosong.

Parameter
LebarSlotiklan	angka Lebar slot iklan pengiring.
TinggiSlotIklan	angka Tinggi slot iklan pengiring.
setelan	Opsional Setelan PendampingAdSelection Setelan pilihan untuk iklan pengiring. Nilai tidak boleh kosong.

Parameter

LebarSlotiklan

angka

Lebar slot iklan pengiring.

TinggiSlotIklan

angka

Tinggi slot iklan pengiring.

setelan

Opsional

Setelan PendampingAdSelection

Setelan pilihan untuk iklan pengiring.

Nilai tidak boleh kosong.

Hasil: non-null Array of non-null CompanionAd Array iklan pengiring yang cocok dengan setelan dan ukuran slot.

getContentType

getContentType() menampilkan string

Menampilkan jenis konten materi iklan yang saat ini dipilih, atau string kosong jika tidak ada materi iklan yang dipilih atau jenis konten tidak tersedia. Untuk iklan linear, jenis konten hanya akan tersedia setelah peristiwa START, saat file media dipilih.

Hasil: string Jenis konten, string kosong jika tidak tersedia.

getCreativeAdId

getCreativeAdId() menampilkan string

Menampilkan kode ISCI (Industry Standard Commercial Identifier) iklan, atau string kosong jika kode tidak tersedia. Ini adalah ID Iklan materi iklan dalam respons VAST.

Hasil: string

IDmateri iklan

getCreativeId() menampilkan string

Mengambil ID materi iklan yang dipilih untuk iklan.

Hasil: string ID materi iklan yang dipilih untuk iklan, atau string kosong jika informasi ini tidak tersedia.

ID promo

getDealId() menampilkan string

Menampilkan ID transaksi pertama yang ada dalam rantai wrapper untuk iklan saat ini, mulai dari atas. Menampilkan string kosong jika tidak tersedia.

Hasil: string

getDescription

getDescription() menampilkan string

Menampilkan deskripsi iklan ini dari respons VAST.

Hasil: string Deskripsi, kosong jika tidak ditentukan.

getDuration

getDuration() menampilkan jumlah

Menampilkan durasi materi iklan yang dipilih, atau -1 untuk materi iklan non-linear.

Hasil: number Durasi materi iklan yang dipilih dalam detik, -1 jika tidak linear.

getHeight

getHeight() menampilkan angka

Menampilkan tinggi materi iklan non-linear yang dipilih.

Hasil: number Tinggi materi iklan non-linear yang dipilih atau 0 untuk materi iklan linear.

getMediaUrl

getMediaUrl() menampilkan string

Menampilkan URL file media yang dipilih dari iklan berdasarkan setelan pemilihan media yang sedang digunakan. Menampilkan null jika informasi ini tidak tersedia. Tersedia di acara yang DIMULAI.

Hasil: nullable string

getMinsuggestedDuration

getMinsuggestedDuration() menampilkan jumlah

Menampilkan durasi minimum yang disarankan dalam detik saat materi iklan non-linear harus ditampilkan. Menampilkan -2 jika durasi minimum yang disarankan tidak diketahui. Materi iklan linear akan menampilkan keseluruhan durasi iklan.

Hasil: number Durasi minimum yang disarankan dalam detik saat materi iklan akan ditampilkan.

getSkipTimeOffset

getSkipTimeOffset() menampilkan jumlah

Jumlah detik pemutaran sebelum iklan dapat dilewati. -1 ditampilkan untuk iklan yang tidak dapat dilewati atau jika tidak tersedia.

Hasil: number Offset dalam detik, atau -1.

getSurveyUrl

getSurveyUrl() menampilkan string

Menampilkan URL yang terkait dengan survei untuk iklan tertentu. Menampilkan null jika tidak tersedia.

Hasil: nullable string

getTitle

getTitle() menampilkan string

Menampilkan judul iklan ini dari respons VAST.

Hasil: string Judul, kosong jika tidak ditentukan.

getTraffickingParameters

getTraffickingParameters() menampilkan Objek dengan properti string

Mendapatkan parameter kustom yang terkait dengan iklan pada saat proses iklan.

Hasil: non-null Object with string properties Pemetaan kunci proses iklan ke nilainya, atau Objek kosong jika informasi ini tidak tersedia.

getTraffickingParametersString

getTraffickingParametersString() menampilkan string

Mendapatkan parameter kustom yang terkait dengan iklan pada saat proses iklan. Menampilkan versi string mentah dari parameter yang diuraikan dari getTraffickingParameters.

Hasil: string Parameter pemrosesan iklan, atau string kosong jika informasi ini tidak tersedia.

getUiElements

getUiElements() menampilkan Array string

Menampilkan elemen UI yang sedang ditampilkan saat iklan ini diputar. Lihat UiElements untuk kemungkinan elemen array yang ditampilkan.

Hasil: non-null Array of string Elemen UI yang sedang ditampilkan.

getUniversalAdIdRegistry

getUniversalAdIdRegistry() menampilkan string

Registry yang terkait dengan pembuatan katalog UniversalAdId materi iklan yang dipilih untuk iklan.

Tidak digunakan lagi: Gunakan ad.getUniversalAdIds() sebagai gantinya
Hasil: string Menampilkan nilai registry, atau "unknown" jika tidak tersedia.

getUniversalAdIdValue

getUniversalAdIdValue() mengembalikan string

UniversalAdId materi iklan yang dipilih untuk iklan.

Tidak digunakan lagi: Gunakan ad.getUniversalAdIds() sebagai gantinya
Hasil: string Menampilkan nilai ID atau "tidak diketahui" jika tidak tersedia.

getUniversalAdIds

getUniversalAdIds() menampilkan Array UniversalAdIdInfo non-null

Daftar UniversalAdIds materi iklan yang dipilih untuk iklan.

Hasil: non-null Array of non-null UniversalAdIdInfo Menampilkan daftar informasi ID iklan universal yang berlaku untuk iklan ini.

getVastMediaBitrate

getVastMediaBitrate() mengembalikan angka

Jika materi iklan dan file media telah dipilih oleh SDK, ini akan menampilkan kecepatan bit untuk file media seperti yang tercantum dalam respons yang luas.

Hasil: number Kecepatan bit untuk file media yang dipilih atau 0.

getVastMediaTinggi

getVastMediaHeight() mengembalikan angka

Menampilkan tinggi media VAST dari materi iklan yang dipilih.

Hasil: number Tinggi media VAST dari materi iklan yang dipilih atau 0 jika tidak ada yang dipilih.

getVastMediaWidth

getVastMediaWidth() menampilkan jumlah

Menampilkan lebar media VAST dari materi iklan yang dipilih.

Hasil: number Lebar media VAST dari materi iklan yang dipilih atau 0 jika tidak ada yang dipilih.

getWidth

getWidth() menampilkan angka

Menampilkan lebar materi iklan yang dipilih.

Hasil: number Lebar materi iklan non-linear yang dipilih atau 0 untuk materi iklan linear.

getWrapperAdIds

getWrapperAdIds() menampilkan Array string

ID iklan yang digunakan untuk iklan wrapper. ID yang ditampilkan dimulai dari iklan inline (paling dalam) dan berpindah ke iklan wrapper terluar. Array kosong akan ditampilkan jika tidak ada iklan wrapper.

Hasil: non-null Array of string ID iklan, mulai dari iklan inline, atau array kosong jika tidak ada iklan wrapper.

getWrapperAdSystems

getWrapperAdSystems() menampilkan Array string

Sistem iklan yang digunakan untuk iklan wrapper. Sistem iklan yang ditampilkan dimulai di iklan inline dan mengarah ke iklan wrapper terluar. Array kosong akan ditampilkan jika tidak ada iklan wrapper.

Hasil: non-null Array of string Sistem iklan iklan, dimulai pada iklan inline, atau array kosong jika tidak ada iklan wrapper.

getWrapperCreativeIds

getWrapperCreativeIds() menampilkan Array string

ID materi iklan yang dipilih dan digunakan untuk iklan kode wrapper. ID materi iklan yang ditampilkan dimulai pada iklan inline dan berpindah ke iklan wrapper terluar. Array kosong akan ditampilkan jika tidak ada iklan wrapper.

Hasil: non-null Array of string ID materi iklan, mulai dari iklan inline, atau array kosong jika tidak ada iklan wrapper.

Linear

isLinear() menampilkan boolean

Menunjukkan apakah mode operasi iklan saat ini adalah linear atau non-linear. Jika nilainya benar, ini menunjukkan bahwa iklan berada dalam mode pemutaran linier; jika nilainya salah, ini menunjukkan mode non-linear. Pemutar memeriksa properti linear dan memperbarui statusnya sesuai dengan detail penempatan iklan. Saat iklan berada dalam mode linear, pemutar akan menjeda video konten. Jika linear awalnya terjadi, dan iklan adalah pre-roll (ditentukan secara eksternal), pemutar dapat memilih untuk menunda pemuatan video konten hingga mendekati akhir pemutaran iklan.

Hasil: boolean Benar jika iklan linear, salah jika sebaliknya.