Halaman ini diterjemahkan oleh Cloud Translation API.

Kelas: ImaSdkSettings

Enumerasi

CompanionBackfillMode

konstanta statis

string

Menentukan kumpulan konstanta untuk setelan pengisian ulang pengiring. Setelan ini menunjukkan apakah pengiring harus diisi ulang dalam berbagai skenario.

Jika nilainya adalah ALWAYS, pengisian ulang pengiring akan dicoba di semua situasi, meskipun tidak ada iklan utama yang ditampilkan.

Jika nilainya ON_MASTER_AD, pengisian ulang pengiring akan dicoba jika ada iklan utama dengan pengiring lebih sedikit daripada slot pengiring. Pengiring yang hilang akan diisi ulang.

Nilai default-nya adalah ALWAYS.

Perhatikan bahwa pengisian ulang pengiring sisi klien memerlukan pemberian tag pengiring secara tepat dengan Tag Google Publisher (GPT). Untuk mengaktifkan pengisian ulang, perubahan berikut pada penyiapan GPT standar diperlukan:

...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();

Untuk video putar otomatis, perubahan tambahan berikut direkomendasikan untuk mencegah slot pengiring dipramuat, lalu segera diganti dengan pengiring.

googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Nilai
SELALU
ON_MASTER_AD

Mode Vpaid

konstanta statis

angka

Sekumpulan konstanta untuk mengaktifkan fungsi VPAID.

Nilai
DINONAKTIFKAN	Iklan VPAID tidak akan diputar dan error akan ditampilkan.
AKTIF	Iklan VPAID diaktifkan menggunakan iframe lintas domain. Iklan VPAID tidak dapat mengakses situs. Iklan VPAID yang bergantung pada akses iframe yang sesuai mungkin mengalami error. Ini adalah defaultnya.
TIDAK AMAN	Iklan VPAID diaktifkan menggunakan iframe yang mudah digunakan. Tindakan ini memungkinkan iklan mengakses situs melalui JavaScript.

Properti

CompanionBackfillMode

konstanta statis

string

Menentukan kumpulan konstanta untuk setelan pengisian ulang pengiring. Setelan ini menunjukkan apakah pengiring harus diisi ulang dalam berbagai skenario.

Jika nilainya adalah ALWAYS, pengisian ulang pengiring akan dicoba di semua situasi, meskipun tidak ada iklan utama yang ditampilkan.

Jika nilainya ON_MASTER_AD, pengisian ulang pengiring akan dicoba jika ada iklan utama dengan pengiring lebih sedikit daripada slot pengiring. Pengiring yang hilang akan diisi ulang.

Nilai default-nya adalah ALWAYS.

...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();

Untuk video putar otomatis, perubahan tambahan berikut direkomendasikan untuk mencegah slot pengiring dipramuat, lalu segera diganti dengan pengiring.

googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Nilai
SELALU
ON_MASTER_AD

Mode Vpaid

konstanta statis

angka

Sekumpulan konstanta untuk mengaktifkan fungsi VPAID.

Nilai
DINONAKTIFKAN	Iklan VPAID tidak akan diputar dan error akan ditampilkan.
AKTIF	Iklan VPAID diaktifkan menggunakan iframe lintas domain. Iklan VPAID tidak dapat mengakses situs. Iklan VPAID yang bergantung pada akses iframe yang sesuai mungkin mengalami error. Ini adalah defaultnya.
TIDAK AMAN	Iklan VPAID diaktifkan menggunakan iframe yang mudah digunakan. Tindakan ini memungkinkan iklan mengakses situs melalui JavaScript.

Metode

getCompanionBackfill

getCompanionBackfill() menampilkan CompanionBackfillMode

Menampilkan mode pengisian ulang pengiring saat ini.

Hasil: non-null CompanionBackfillMode Nilai saat ini.

getDisableCustomPlaybackForIOS10Plus

getDisableCustomPlaybackForIOS10Plus() menampilkan boolean

Mendapatkan apakah menonaktifkan pemutaran khusus di browser iOS 10+ atau tidak. Nilai defaultnya adalah false.

Hasil: boolean

getFeatureFlags

getFeatureFlags() menampilkan Objek dengan properti jenis apa pun

Menampilkan objek dengan kunci sebagai tanda dan nilai fitur sebagai statusnya saat ini.

Hasil: non-null Object with any type properties

getLocal

getLocale() menampilkan string

Menampilkan lokal yang disediakan penayang.

Hasil: string Lokalitas yang diberikan penayang.

getNumRedirects

getNumRedirects() menampilkan jumlah

Menampilkan jumlah maksimum pengalihan untuk pengalihan berikutnya akan ditolak.

Hasil: number jumlah maksimum pengalihan.

getPlayerType

getPlayerType() menampilkan string

Menampilkan jenis pemain yang disediakan oleh partner.

Hasil: string Jenis pemutar partner.

getPlayerVersion

getPlayerVersion() menampilkan string

Menampilkan versi pemutar yang disediakan partner.

Hasil: string Versi pemain partner.

getPpid

getPpid() menampilkan (null atau string)

Menampilkan id yang diberikan penayang.

Hasil: ID (null or string) yang diberikan penayang.

isCookiesEnabled

isCookiesEnabled() menampilkan boolean

Hasil: boolean Apakah penayang mengizinkan penggunaan cookie.

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) menampilkan batal

Menetapkan apakah jeda iklan VMAP dan aturan iklan akan otomatis diputar

Parameter
JedaIklanOtomatis	boolean Apakah jeda iklan akan diputar otomatis.

Parameter

JedaIklanOtomatis

boolean

Apakah jeda iklan akan diputar otomatis.

Hasil: void

setCompanionBackfill

setCompanionBackfill(mode) batal void

Menetapkan mode pengisian ulang pengiring. Lihat berbagai mode yang tersedia di ImaSdkSettings.CompanionBackfillMode.

Mode defaultnya adalah ImaSdkSettings.CompanionBackfillMode.ALWAYS.

Parameter
mode	CompanionBackfillMode Mode pengisian ulang pengiring yang dipilih. Nilai tidak boleh kosong.

Hasil: void

setCookieEnabled

setCookiesEnabled(cookiesEnabled) menampilkan void

Apakah SDK tersebut harus menyimpan cookie Google Ad Manager (Cookie GFP) di domain penayang, sebagai cookie pihak pertama. Hal ini memungkinkan persistensi di seluruh kunjungan ke domain yang sama tanpa menggunakan cookie pihak ketiga. Nilai defaultnya adalah true (benar).

Setelan ini tidak akan memengaruhi cookie lain yang mungkin ditetapkan oleh pihak lain atau untuk tujuan lain. Izin dan pilihan tidak ikut dari pengguna juga dapat menonaktifkan penggunaan cookie pihak pertama. Ini akan diambil oleh penggunaan Penyedia Pengelolaan Izin yang mematuhi IAB oleh penayang, jika dalam frame yang sama.

Parameter
cookieDiaktifkan	boolean

Hasil: void

setDisableCustomPlaybackForIOS10Plus

setDisableCustomPlaybackForIOS10Plus(disable) menampilkan batal

Menetapkan apakah pemutaran kustom akan dinonaktifkan pada browser iOS 10+. Jika true (benar), iklan akan diputar jika video konten inline. Tindakan ini akan mengaktifkan iklan TrueView yang dapat dilewati. Namun, iklan akan tetap inline dan tidak mendukung layar penuh native iOS. Jika salah, iklan akan diputar di pemutar yang sama dengan konten Anda. Nilai yang ditetapkan di sini saat AdDisplayContainer dibuat digunakan selama masa aktif penampung. Nilai defaultnya adalah false.

Parameter
nonaktifkan	boolean Apakah menonaktifkan pemutaran khusus atau tidak.

Parameter

nonaktifkan

boolean

Apakah menonaktifkan pemutaran khusus atau tidak.

Hasil: void

setFiturFlag

setFeatureFlags(featureFlags) tidak akan ditampilkan

Tetapkan nilai untuk setiap tanda fitur. Setelan ini harus ditetapkan seawal mungkin, sebelum meminta iklan. Setelan akan tetap sama hingga permintaan iklan berikutnya. Memanggil metode ini lagi akan mereset flag fitur apa pun untuk permintaan iklan berikutnya.

Parameter
featureFlags	Objek dengan properti jenis apa pun Nilai tidak boleh kosong.

Parameter

featureFlags

Objek dengan properti jenis apa pun

Nilai tidak boleh kosong.

Hasil: void

setLocal

setLocale(lokalitas) menampilkan nilai batal

Menetapkan lokal yang disediakan penayang. Harus dipanggil sebelum membuat AdsLoader atau AdDisplayContainer. Lokalitas menentukan bahasa yang akan digunakan untuk menampilkan elemen UI. Kode yang didukung dapat ditemukan di Melokalkan untuk Bahasa dan Lokal.

Parameter
locale	string Lokalitas yang diberikan penayang.

Parameter

locale

string

Lokalitas yang diberikan penayang.

Hasil: void

setNumRedirects

setNumRedirects(numRedirects) mengembalikan void

Menentukan jumlah maksimum pengalihan sebelum pengalihan berikutnya akan ditolak, dan pemuatan iklan dibatalkan. Jumlah pengalihan secara langsung memengaruhi latensi, sehingga memengaruhi pengalaman pengguna. Ini berlaku untuk semua iklan kode pembungkus VAST.

Parameter
numRedirects	angka jumlah maksimum pengalihan.

Parameter

numRedirects

angka

jumlah maksimum pengalihan.

Hasil: void

setPlayerType

setPlayerType(playerType) menampilkan void

Menetapkan jenis pemain yang disediakan partner. Setelan ini harus digunakan untuk menentukan nama pemutar yang terintegrasi dengan SDK. Jenis pemain yang lebih dari 20 karakter akan dipotong. Jenis pemutar yang ditentukan harus singkat dan unik. Ini adalah setelan opsional yang digunakan untuk meningkatkan kegunaan SDK dengan melacak jenis pemain.

Contoh:


settings.setPlayerType('google/gmf-player');

Parameter
playerType	string Jenis pemutar partner.

Parameter

playerType

string

Jenis pemutar partner.

Hasil: void

setPlayerVersion

setPlayerVersion(playerVersion) menampilkan batal

Menetapkan versi pemutar yang disediakan partner. Setelan ini harus digunakan untuk menentukan versi pemutar partner yang terintegrasi dengan SDK. Versi pemain yang lebih dari 20 karakter akan dipotong. Ini adalah setelan opsional yang digunakan untuk meningkatkan kegunaan SDK dengan melacak versi pemutar.

Contoh:


settings.setPlayerVersion('1.0.0');

Parameter
playerVersion	string Versi pemutar partner.

Parameter

playerVersion

string

Versi pemutar partner.

Hasil: void

setPpid

setPpid(ppid) mengembalikan void

Menetapkan ID yang diberikan penayang.

Parameter
ppid	string ID yang diberikan penayang.

Hasil: void

setSessionId

setSessionId(sessionId) menampilkan void

ID sesi adalah ID acak sementara. ID ini digunakan secara eksklusif untuk pembatasan frekuensi. ID sesi harus berupa UUID.

Parameter
ID sesi	string UUID sementara yang digunakan untuk pembatasan frekuensi.

Parameter

ID sesi

string

UUID sementara yang digunakan untuk pembatasan frekuensi.

Hasil: void

setVpaidDiizinkan

setVpaidAllowed(allowVpaid) kembali batal

Tidak digunakan lagi. Menggunakan setVpaidMode. Menetapkan apakah materi iklan VPAID diizinkan.

Parameter
allowVpaid	boolean Apakah akan mengizinkan materi iklan VPAID.

Parameter

allowVpaid

boolean

Apakah akan mengizinkan materi iklan VPAID.

Hasil: void

setVpaidMode

setVpaidMode(vpaidMode) menampilkan void

Menetapkan mode pemutaran VPAID.

Parameter
vpaidMode	Mode Vpaid Menetapkan cara iklan VPAID akan diputar. Defaultnya adalah mode aman. Nilai tidak boleh kosong.

Parameter

vpaidMode

Mode Vpaid

Menetapkan cara iklan VPAID akan diputar. Defaultnya adalah mode aman.

Nilai tidak boleh kosong.

Hasil: void