Referensi GPT

Referensi ini menggunakan notasi TypeScript untuk mendeskripsikan jenis. Tabel berikut memberikan penjelasan singkat berdasarkan contoh.

Ekspresi jenis
string	Jenis string primitif.
string[]	Jenis array, dengan nilai yang hanya boleh berupa string.
number | string	Jenis union, dengan nilai yang dapat berupa angka atau string.
Array<number | string>	Jenis array, dengan nilai berupa jenis kompleks (gabungan).
[number, string]	Jenis tuple, dengan nilai berupa array dua elemen yang harus berisi angka dan string dalam urutan tersebut.
Slot	Jenis objek, dengan nilai adalah instance googletag.Slot.
() => void	Jenis fungsi tanpa argumen yang ditentukan dan tanpa nilai yang ditampilkan.

Untuk mempelajari lebih lanjut jenis dan ekspresi jenis yang didukung, lihat Handbook TypeScript .

Anotasi Type

Titik dua setelah variabel, nama parameter, nama properti, atau tanda tangan fungsi menunjukkan anotasi jenis. Anotasi jenis menjelaskan jenis elemen di sebelah kiri titik dua yang dapat menerima atau menampilkan. Tabel berikut menunjukkan contoh anotasi jenis yang mungkin Anda lihat dalam referensi ini.

Anotasi jenis
param: string	Menunjukkan bahwa param menerima atau menampilkan nilai string. Sintaksis ini digunakan untuk variabel, parameter, properti, dan jenis nilai yang ditampilkan.
param?: number | string	Menunjukkan bahwa param bersifat opsional, tetapi menerima angka atau string saat ditentukan. Sintaksis ini digunakan untuk parameter dan properti.
...params: Array<() => void>	Menunjukkan bahwa params adalah parameter rest yang menerima fungsi. Parameter Rest menerima jumlah nilai yang tidak terbatas dari jenis yang ditentukan.

---

googletag

Namespace global yang digunakan Tag Google Publisher untuk API-nya.

Namespace
config	Antarmuka konfigurasi utama untuk setelan tingkat halaman.
enums	Ini adalah namespace yang digunakan GPT untuk jenis enum.
events	Ini adalah namespace yang digunakan GPT untuk Peristiwa.
secureSignals	Ini adalah namespace yang digunakan GPT untuk mengelola sinyal aman.

Antarmuka
CommandArray	Array perintah menerima urutan fungsi dan memanggilnya secara berurutan.
CompanionAdsService	Layanan Iklan Pengiring.
PrivacySettingsConfig	Objek konfigurasi untuk setelan privasi.
PubAdsService	Layanan Iklan Penayang.
ResponseInformation	Objek yang mewakili satu respons iklan.
RewardedPayload	Objek yang mewakili reward yang terkait dengan iklan reward.
SafeFrameConfig	Objek konfigurasi untuk penampung SafeFrame.
Service	Class layanan dasar yang berisi metode yang umum untuk semua layanan.
SizeMappingBuilder	Builder untuk objek spesifikasi pemetaan ukuran.
Slot	Slot adalah objek yang mewakili satu slot iklan di halaman.

Alias Jenis
GeneralSize	Konfigurasi ukuran yang valid untuk slot, yang dapat berupa satu atau beberapa ukuran.
MultiSize	Daftar satu ukuran yang valid.
NamedSize	Ukuran bernama yang dapat dimiliki slot.
SingleSize	Satu ukuran yang valid untuk slot.
SingleSizeArray	Array dua angka yang mewakili [width, height].
SizeMapping	Pemetaan ukuran area pandang ke ukuran iklan.
SizeMappingArray	Daftar pemetaan ukuran.

Variabel
apiReady	Flag yang menunjukkan bahwa GPT API dimuat dan siap dipanggil.
cmd	Referensi ke antrean perintah global untuk eksekusi asinkron panggilan terkait GPT.
pubadsReady	Flag yang menunjukkan bahwa PubAdsService diaktifkan, dimuat, dan beroperasi sepenuhnya.
secureSignalProviders	Referensi ke array penyedia sinyal aman.

Fungsi
companionAds	Menampilkan referensi ke CompanionAdsService.
defineOutOfPageSlot	Membuat slot iklan di luar halaman dengan jalur unit iklan yang diberikan.
defineSlot	Membuat slot iklan dengan jalur dan ukuran unit iklan tertentu, lalu mengaitkannya dengan ID elemen div di halaman yang akan berisi iklan.
destroySlots	Menghancurkan slot yang diberikan, menghapus semua objek dan referensi terkait slot tersebut dari GPT.
disablePublisherConsole	Menonaktifkan Konsol Google Publisher.
display	Memberi petunjuk layanan slot untuk merender slot.
enableServices	Mengaktifkan semua layanan GPT yang telah ditentukan untuk slot iklan di halaman.
getVersion	Menampilkan versi GPT saat ini.
openConsole	Membuka Konsol Google Publisher.
pubads	Menampilkan referensi ke PubAdsService.
setAdIframeTitle	Menetapkan judul untuk semua iframe penampung iklan yang dibuat oleh PubAdsService, mulai dari titik ini dan seterusnya.
setConfig	Menetapkan opsi konfigurasi umum untuk halaman.
sizeMapping	Membuat SizeMappingBuilder baru.

Alias Jenis

---

GeneralSize

GeneralSize: SingleSize | MultiSize

Konfigurasi ukuran yang valid untuk slot, yang dapat berupa satu atau beberapa ukuran.

---

MultiSize

MultiSize: SingleSize[]

Daftar satu ukuran yang valid.

---

NamedSize

NamedSize: "fluid" | ["fluid"]

Ukuran bernama yang dapat dimiliki slot. Dalam sebagian besar kasus, ukuran adalah persegi panjang berukuran tetap, tetapi ada beberapa kasus saat kita memerlukan jenis spesifikasi ukuran lainnya. Hanya ukuran berikut yang valid:

• fluid: penampung iklan menggunakan 100% lebar div induk, lalu mengubah ukuran tingginya agar sesuai dengan konten materi iklan. Mirip dengan perilaku elemen blok biasa di halaman. Digunakan untuk iklan native (lihat artikel terkait). Perhatikan bahwa fluid dan ['fluid'] adalah bentuk yang dapat diterima untuk mendeklarasikan ukuran slot sebagai fleksibel.

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

Satu ukuran yang valid untuk slot.

---

SingleSizeArray

SingleSizeArray: [number, number]

Array dua angka yang mewakili [width, height].

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Pemetaan ukuran area pandang ke ukuran iklan. Digunakan untuk iklan responsif.

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

Daftar pemetaan ukuran.

Variabel

---

Const apiReady

apiReady: boolean | undefined

Flag yang menunjukkan bahwa GPT API dimuat dan siap dipanggil. Properti ini akan menjadi undefined hingga API siap.

Perhatikan bahwa cara yang direkomendasikan untuk menangani asinkron adalah menggunakan googletag.cmd untuk mengantrekan callback saat GPT siap. Callback ini tidak perlu memeriksa googletag.apiReady karena callback ini dijamin akan dieksekusi setelah API disiapkan.

---

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray

Referensi ke antrean perintah global untuk eksekusi asinkron panggilan terkait GPT.

Variabel googletag.cmd diinisialisasi ke array JavaScript kosong oleh sintaksis tag GPT di halaman, dan cmd.push adalah metode Array.push standar yang menambahkan elemen ke akhir array. Saat dimuat, JavaScript GPT akan memeriksa array dan mengeksekusi semua fungsi secara berurutan. Skrip kemudian akan mengganti cmd dengan objek CommandArray yang metode push-nya ditentukan untuk mengeksekusi argumen fungsi yang diteruskan ke objek tersebut. Mekanisme ini memungkinkan GPT mengurangi latensi yang dirasakan dengan mengambil JavaScript secara asinkron sekaligus memungkinkan browser terus merender halaman.

Contoh

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

JavaScript (lama)

googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

---

Const pubadsReady

pubadsReady: boolean | undefined

Flag yang menunjukkan bahwa PubAdsService diaktifkan, dimuat, dan beroperasi sepenuhnya. Properti ini akan menjadi undefined hingga enableServices dipanggil dan PubAdsService dimuat dan diinisialisasi.

---

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

Referensi ke array penyedia sinyal aman.

Array penyedia sinyal aman menerima urutan fungsi penghasil sinyal dan memanggilnya secara berurutan. Fungsi ini dimaksudkan untuk menggantikan array standar yang digunakan untuk mengantrekan fungsi penghasil sinyal yang akan dipanggil setelah GPT dimuat.

Contoh

JavaScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

JavaScript (lama)

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    return Promise.resolve("signal");
  },
});

TypeScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

Lihat juga

• Membagikan sinyal aman kepada bidder

Fungsi

---

companionAds

companionAds(): CompanionAdsService

Menampilkan referensi ke CompanionAdsService.

Hasil
CompanionAdsService	Layanan Iklan Pengiring.

---

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null

Membuat slot iklan di luar halaman dengan jalur unit iklan yang diberikan.

Untuk iklan di luar halaman kustom, div adalah ID elemen div yang akan berisi iklan. Lihat artikel tentang materi iklan di luar halaman untuk mengetahui detail selengkapnya.

Untuk iklan di luar halaman yang dikelola GPT, div adalah OutOfPageFormat yang didukung.

Contoh

JavaScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

JavaScript (lama)

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

TypeScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

Lihat juga

• Menampilkan iklan reward
• Menampilkan iklan interstisial web
• Menampilkan iklan anchor
• Menampilkan iklan di luar halaman

Parameter
adUnitPath: string	Jalur unit iklan lengkap dengan kode jaringan dan kode unit iklan.
Optional div: string | OutOfPageFormat	ID div yang akan berisi unit iklan ini atau OutOfPageFormat.

Hasil
Slot | null	Slot yang baru dibuat, atau null jika slot tidak dapat dibuat.

---

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null

Membuat slot iklan dengan jalur dan ukuran unit iklan tertentu, lalu mengaitkannya dengan ID elemen div di halaman yang akan berisi iklan.

Contoh

JavaScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

JavaScript (lama)

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

Lihat juga

• Memulai Tag Google Publisher

Parameter
adUnitPath: string	Jalur unit iklan lengkap dengan kode jaringan dan kode unit.
size: GeneralSize	Lebar dan tinggi slot yang ditambahkan. Ini adalah ukuran yang digunakan dalam permintaan iklan jika tidak ada pemetaan ukuran responsif yang diberikan atau ukuran area pandang lebih kecil dari ukuran terkecil yang diberikan dalam pemetaan.
Optional div: string	ID div yang akan berisi unit iklan ini.

Hasil
Slot | null	Slot yang baru dibuat, atau null jika slot tidak dapat dibuat.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

Menghancurkan slot yang diberikan, menghapus semua objek dan referensi terkait slot tersebut dari GPT. API ini tidak mendukung slot passback dan slot pendamping.

Memanggil API ini di slot akan menghapus iklan dan menghapus objek slot dari status internal yang dikelola oleh GPT. Memanggil fungsi lainnya pada objek slot akan menghasilkan perilaku yang tidak ditentukan. Perhatikan bahwa browser mungkin masih tidak mengosongkan memori yang terkait dengan slot tersebut jika referensi ke slot tersebut dikelola oleh halaman penayang. Memanggil API ini akan membuat div yang terkait dengan slot tersebut tersedia untuk digunakan kembali.

Secara khusus, menghancurkan slot akan menghapus iklan dari tampilan halaman berumur panjang GPT, sehingga permintaan mendatang tidak akan terpengaruh oleh hambatan atau pengecualian kompetitif yang melibatkan iklan ini. Kegagalan untuk memanggil fungsi ini sebelum menghapus div slot dari halaman akan menyebabkan perilaku yang tidak ditentukan.

Contoh

JavaScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

JavaScript (lama)

// The calls to construct an ad and display contents.
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

TypeScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

Parameter
Optional slots: Slot[]	Array slot yang akan dihancurkan. Array bersifat opsional; semua slot akan dihancurkan jika tidak ditentukan.

Hasil
boolean	true jika slot telah dihancurkan, false jika tidak.

---

disablePublisherConsole

disablePublisherConsole(): void

Menonaktifkan Konsol Google Publisher.

Lihat juga

• Konsol Google Publisher

---

display

display(divOrSlot: string | Element | Slot): void

Memberi petunjuk layanan slot untuk merender slot. Setiap slot iklan hanya boleh ditampilkan satu kali per halaman. Semua slot harus ditentukan dan memiliki layanan yang terkait sebelum ditampilkan. Panggilan tampilan tidak boleh terjadi hingga elemen ada di DOM. Cara biasa untuk melakukannya adalah dengan menempatkannya dalam blok skrip dalam elemen div yang diberi nama dalam panggilan metode.

Jika arsitektur permintaan tunggal (SRA) sedang digunakan, semua slot iklan yang tidak diambil pada saat metode ini dipanggil akan diambil sekaligus. Untuk memaksa slot iklan agar tidak ditampilkan, seluruh div harus dihapus.

Lihat juga

• Memulai Tag Google Publisher
• Menampilkan iklan pengujian
• Mengontrol pemuatan dan pembaruan iklan

Parameter
divOrSlot: string | Element | Slot	ID elemen div yang berisi slot iklan atau elemen div, atau objek slot. Jika disediakan, elemen div harus memiliki atribut 'id' yang cocok dengan ID yang diteruskan ke defineSlot.

---

enableServices

enableServices(): void

Mengaktifkan semua layanan GPT yang telah ditentukan untuk slot iklan di halaman.

---

getVersion

getVersion(): string

Menampilkan versi GPT saat ini.

Lihat juga

• Histori versi GPT

Hasil
string	String versi GPT yang sedang dieksekusi.

---

openConsole

openConsole(div?: string): void

Membuka Konsol Google Publisher.

Contoh

JavaScript

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

JavaScript (lama)

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

TypeScript

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

Lihat juga

• Konsol Google Publisher

Parameter
Optional div: string	ID div slot iklan. Nilai ini bersifat opsional. Jika diberikan, Konsol Publisher akan mencoba membuka dengan detail slot iklan yang ditentukan dalam tampilan.

---

pubads

pubads(): PubAdsService

Menampilkan referensi ke PubAdsService.

Hasil
PubAdsService	Layanan Iklan Penayang.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

Menetapkan judul untuk semua iframe penampung iklan yang dibuat oleh PubAdsService, mulai dari titik ini dan seterusnya.

Contoh

JavaScript

googletag.setAdIframeTitle("title");

JavaScript (lama)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Parameter
title: string	Judul baru untuk semua iframe penampung iklan.

---

setConfig

setConfig(config: PageSettingsConfig): void

Menetapkan opsi konfigurasi umum untuk halaman.

Parameter
config: PageSettingsConfig

---

sizeMapping

sizeMapping(): SizeMappingBuilder

Membuat SizeMappingBuilder baru.

Lihat juga

• Ukuran iklan: Iklan responsif

Hasil
SizeMappingBuilder	Builder baru.

---

googletag.CommandArray

Array perintah menerima urutan fungsi dan memanggilnya secara berurutan. Fungsi ini dimaksudkan untuk menggantikan array standar yang digunakan untuk mengantrekan fungsi yang akan dipanggil setelah GPT dimuat.

Metode
push	Menjalankan urutan fungsi yang ditentukan dalam argumen secara berurutan.

Metode

---

push

push(...f: ((this: typeof globalThis) => void)[]): number

Menjalankan urutan fungsi yang ditentukan dalam argumen secara berurutan.

Contoh

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

JavaScript (lama)

googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

Parameter
Rest ...f: ((this: typeof globalThis) => void)[]	Fungsi JavaScript yang akan dieksekusi. Binding runtime akan selalu globalThis. Pertimbangkan untuk meneruskan fungsi panah guna mempertahankan nilai this dari konteks leksikalis yang melingkupi.

Hasil
number	Jumlah perintah yang diproses sejauh ini. Hal ini kompatibel dengan nilai yang ditampilkan Array.push (panjang array saat ini).

---

googletag.CompanionAdsService

Memperluas Service

Layanan Iklan Pengiring. Layanan ini digunakan oleh iklan video untuk menampilkan iklan pengiring.

Metode
addEventListener	Mendaftarkan pemroses yang memungkinkan Anda menyiapkan dan memanggil fungsi JavaScript saat peristiwa GPT tertentu terjadi di halaman. Diwarisi dari Service.addEventListener
getSlots	Dapatkan daftar slot yang terkait dengan layanan ini. Diwarisi dari Service.getSlots
removeEventListener	Menghapus pemroses yang terdaftar sebelumnya. Diwarisi dari Service.removeEventListener
setRefreshUnfilledSlots	Menetapkan apakah slot pengiring yang belum diisi akan diisi ulang secara otomatis.

Lihat juga

• Iklan pengiring untuk video dan audio

Metode

---

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

Menetapkan apakah slot pengiring yang belum diisi akan diisi ulang secara otomatis.

Metode ini dapat dipanggil beberapa kali selama masa aktif halaman untuk mengaktifkan dan menonaktifkan pengisian ulang. Hanya slot yang juga terdaftar dengan PubAdsService yang akan diisi ulang. Karena batasan kebijakan, metode ini tidak dirancang untuk mengisi slot pengiring yang kosong saat video Ad Exchange ditayangkan.

Contoh

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (lama)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Parameter
value: boolean	true untuk mengisi ulang slot yang tidak terisi secara otomatis, false untuk membiarkannya tidak berubah.

---

googletag.PrivacySettingsConfig

Objek konfigurasi untuk setelan privasi.

Properti
childDirectedTreatment?	Menunjukkan apakah halaman harus diperlakukan sebagai ditujukan untuk anak-anak.
limitedAds?	Memungkinkan penayangan berjalan dalam mode iklan terbatas untuk membantu memenuhi kebutuhan kepatuhan peraturan penayang.
nonPersonalizedAds?	Memungkinkan penayangan berjalan dalam mode iklan yang tidak dipersonalisasi untuk membantu kebutuhan kepatuhan peraturan penayang.
restrictDataProcessing?	Memungkinkan penayangan berjalan dalam mode pemrosesan yang dibatasi untuk membantu memenuhi kebutuhan kepatuhan terhadap peraturan penayang.
trafficSource?	Menunjukkan apakah permintaan mewakili traffic yang dibeli atau organik.
underAgeOfConsent?	Menunjukkan apakah akan menandai permintaan iklan sebagai berasal dari pengguna yang berusia di bawah usia dewasa.

Lihat juga

• Mengonfigurasi setelan privasi

Properti

---

Optional childDirectedTreatment

childDirectedTreatment?: null | boolean

Menunjukkan apakah halaman harus diperlakukan sebagai ditujukan untuk anak-anak. Tetapkan ke null untuk menghapus konfigurasi.

---

Optional limitedAds

limitedAds?: boolean

Memungkinkan penayangan berjalan dalam mode iklan terbatas untuk membantu kebutuhan kepatuhan peraturan penayang.

Anda dapat memerintahkan GPT untuk meminta iklan terbatas dengan dua cara:

• Secara otomatis, dengan menggunakan sinyal dari platform pengelolaan izin TCF v2.0 IAB.
• Secara manual, dengan menetapkan nilai kolom ini ke true.

Mengonfigurasi iklan terbatas secara manual hanya dapat dilakukan jika GPT dimuat dari URL iklan terbatas. Mencoba mengubah setelan ini saat GPT telah dimuat dari URL standar akan menghasilkan peringatan Konsol Penayang.

Perhatikan bahwa Anda tidak perlu mengaktifkan iklan terbatas secara manual saat CMP sedang digunakan.

Contoh

JavaScript

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

JavaScript (lama)

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

TypeScript

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

Lihat juga

• Menampilkan iklan terbatas

---

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean

Memungkinkan penayangan berjalan dalam mode iklan yang tidak dipersonalisasi untuk membantu kebutuhan kepatuhan peraturan penayang.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Memungkinkan penayangan berjalan dalam mode pemrosesan yang dibatasi untuk membantu memenuhi kebutuhan kepatuhan terhadap peraturan penayang.

---

Optional trafficSource

trafficSource?: TrafficSource

Menunjukkan apakah permintaan mewakili traffic yang dibeli atau organik. Nilai ini mengisi dimensi Sumber traffic dalam pelaporan Ad Manager. Jika tidak ditetapkan, sumber traffic akan ditetapkan secara default ke undefined dalam pelaporan.

Contoh

JavaScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

JavaScript (lama)

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

TypeScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

---

Optional underAgeOfConsent

underAgeOfConsent?: null | boolean

Menunjukkan apakah akan menandai permintaan iklan sebagai berasal dari pengguna yang berusia di bawah usia dewasa. Tetapkan ke null untuk menghapus konfigurasi.

---

googletag.PubAdsService

Memperluas Service

Layanan Iklan Penayang. Layanan ini digunakan untuk mengambil dan menampilkan iklan dari akun Google Ad Manager Anda.

Metode
addEventListener	Mendaftarkan pemroses yang memungkinkan Anda menyiapkan dan memanggil fungsi JavaScript saat peristiwa GPT tertentu terjadi di halaman. Diwarisi dari Service.addEventListener
clear	Menghapus iklan dari slot yang diberikan dan menggantinya dengan konten kosong.
clearCategoryExclusions	Menghapus semua label pengecualian kategori iklan tingkat halaman.
clearTargeting	Menghapus parameter penargetan kustom untuk kunci tertentu atau untuk semua kunci.
collapseEmptyDivs	Mengaktifkan penciutan div slot sehingga tidak memakan ruang di halaman jika tidak ada konten iklan yang ditampilkan.
disableInitialLoad	Menonaktifkan permintaan iklan saat pemuatan halaman, tetapi memungkinkan iklan diminta dengan panggilan PubAdsService.refresh.
display	Membuat dan menampilkan slot iklan dengan jalur dan ukuran unit iklan yang diberikan.
enableLazyLoad	Mengaktifkan pemuatan lambat di GPT seperti yang ditentukan oleh objek konfigurasi.
enableSingleRequest	Mengaktifkan mode permintaan tunggal untuk mengambil beberapa iklan secara bersamaan.
enableVideoAds	Memberi sinyal ke GPT bahwa iklan video akan ada di halaman.
get	Menampilkan nilai untuk atribut AdSense yang terkait dengan kunci yang diberikan.
getAttributeKeys	Menampilkan kunci atribut yang telah ditetapkan di layanan ini.
getSlots	Dapatkan daftar slot yang terkait dengan layanan ini. Diwarisi dari Service.getSlots
getTargeting	Menampilkan parameter penargetan tingkat layanan kustom tertentu yang telah ditetapkan.
getTargetingKeys	Menampilkan daftar semua kunci penargetan tingkat layanan kustom yang telah ditetapkan.
isInitialLoadDisabled	Menampilkan apakah permintaan awal untuk iklan berhasil dinonaktifkan oleh panggilan PubAdsService.disableInitialLoad sebelumnya atau tidak.
refresh	Mengambil dan menampilkan iklan baru untuk slot tertentu atau semua slot di halaman.
removeEventListener	Menghapus pemroses yang terdaftar sebelumnya. Diwarisi dari Service.removeEventListener
set	Menetapkan nilai untuk atribut AdSense yang berlaku untuk semua slot iklan dalam layanan Iklan Penayang.
setCategoryExclusion	Menetapkan pengecualian kategori iklan tingkat halaman untuk nama label yang diberikan.
setCentering	Mengaktifkan dan menonaktifkan pemusatan iklan secara horizontal.
setForceSafeFrame	Mengonfigurasi apakah semua iklan di halaman harus dipaksa untuk dirender menggunakan penampung SafeFrame.
setLocation	Meneruskan informasi lokasi dari situs sehingga Anda dapat menargetkan item baris secara geografis ke lokasi tertentu.
setPrivacySettings	Mengizinkan konfigurasi semua setelan privasi dari satu API menggunakan objek konfigurasi.
setPublisherProvidedId	Menetapkan nilai untuk ID yang diberikan penayang.
setSafeFrameConfig	Menetapkan preferensi tingkat halaman untuk konfigurasi SafeFrame.
setTargeting	Menetapkan parameter penargetan kustom untuk kunci tertentu yang berlaku untuk semua slot iklan layanan Iklan Penayang.
setVideoContent	Menetapkan informasi konten video yang akan dikirim bersama dengan permintaan iklan untuk tujuan penargetan dan pengecualian konten.
updateCorrelator	Mengubah korelator yang dikirim dengan permintaan iklan, yang secara efektif memulai kunjungan halaman baru.

Metode

---

clear

clear(slots?: Slot[]): boolean

Menghapus iklan dari slot yang diberikan dan menggantinya dengan konten kosong. Slot akan ditandai sebagai tidak diambil.

Secara khusus, menghapus slot akan menghapus iklan dari tayangan halaman berumur panjang GPT, sehingga permintaan mendatang tidak akan terpengaruh oleh hambatan atau pengecualian kompetitif yang melibatkan iklan ini.

Contoh

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

JavaScript (lama)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

Parameter
Optional slots: Slot[]	Array slot yang akan dihapus. Array bersifat opsional; semua slot akan dihapus jika tidak ditentukan.

Hasil
boolean	Menampilkan true jika slot telah dihapus, false jika tidak.

---

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

Menghapus semua label pengecualian kategori iklan tingkat halaman. Tindakan ini berguna jika Anda ingin memuat ulang slot.

Contoh

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.

JavaScript (lama)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.

Lihat juga

• Label khusus untuk memblokir iklan

Hasil
PubAdsService	Objek layanan tempat metode dipanggil.

---

clearTargeting

clearTargeting(key?: string): PubAdsService

Menghapus parameter penargetan kustom untuk kunci tertentu atau untuk semua kunci.

Contoh

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

JavaScript (lama)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

Lihat juga

• Penargetan nilai kunci

Parameter
Optional key: string	Kunci parameter penargetan. Kunci bersifat opsional; semua parameter penargetan akan dihapus jika tidak ditentukan.

Hasil
PubAdsService	Objek layanan tempat metode dipanggil.

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Mengaktifkan penciutan div slot sehingga tidak memakan ruang di halaman jika tidak ada konten iklan yang ditampilkan. Mode ini harus ditetapkan sebelum layanan diaktifkan.

Lihat juga

• Menciutkan slot iklan kosong
• Meminimalkan pergeseran tata letak

Parameter
Optional collapseBeforeAdFetch: boolean	Apakah akan menciutkan slot bahkan sebelum iklan diambil. Parameter ini bersifat opsional; jika tidak diberikan, false akan digunakan sebagai nilai default.

Hasil
boolean	Menampilkan true jika mode div collapse diaktifkan dan false jika tidak dapat mengaktifkan mode collapse karena metode dipanggil setelah layanan diaktifkan.

---

disableInitialLoad

disableInitialLoad(): void

Menonaktifkan permintaan iklan saat pemuatan halaman, tetapi memungkinkan iklan diminta dengan panggilan PubAdsService.refresh. Hal ini harus ditetapkan sebelum mengaktifkan layanan. Mode asinkron harus digunakan; jika tidak, Anda tidak akan dapat meminta iklan menggunakan refresh.

Lihat juga

• Mengontrol pemuatan dan pembaruan iklan
• Mengontrol pengelompokan SRA

---

display

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void

Membuat dan menampilkan slot iklan dengan jalur dan ukuran unit iklan yang diberikan. Metode ini tidak berfungsi dengan mode permintaan tunggal.

Catatan: Saat metode ini dipanggil, snapshot slot dan status halaman dibuat untuk memastikan konsistensi saat mengirim permintaan iklan dan merender respons. Setiap perubahan yang dilakukan pada slot atau status halaman setelah metode ini dipanggil (termasuk penargetan, setelan privasi, memaksa SafeFrame, dll.) hanya akan berlaku untuk permintaan display() atau refresh() berikutnya.

Contoh

JavaScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

JavaScript (lama)

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

Lihat juga

• Menampilkan iklan pengujian
• Mengontrol pemuatan dan pembaruan iklan

Parameter
adUnitPath: string	Jalur unit iklan slot yang akan dirender.
size: GeneralSize	Lebar dan tinggi slot.
Optional div: string | Element	ID div yang berisi slot atau elemen div itu sendiri.
Optional clickUrl: string	URL klik yang akan digunakan di slot ini.

---

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void

Mengaktifkan pemuatan lambat di GPT seperti yang ditentukan oleh objek konfigurasi. Untuk contoh yang lebih mendetail, lihat contoh Pemuatan lambat.

Catatan: Pengambilan lambat di SRA hanya berfungsi jika semua slot berada di luar margin pengambilan.

Contoh

JavaScript

googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});

JavaScript (lama)

googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});

TypeScript

googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});

Lihat juga

• Praktik terbaik iklan: Memprioritaskan slot iklan "penting"
• Pemuatan lambat

Parameter

Optional config: {   fetchMarginPercent?: number;   mobileScaling?: number;   renderMarginPercent?: number; }

Objek konfigurasi memungkinkan penyesuaian perilaku lambat. Semua konfigurasi yang dihilangkan akan menggunakan setelan default yang ditetapkan oleh Google dan akan disesuaikan dari waktu ke waktu. Untuk menonaktifkan setelan tertentu, seperti margin pengambilan, tetapkan nilai ke -1. fetchMarginPercent Jarak minimum dari area pandang saat ini yang harus dimiliki slot sebelum kita mengambil iklan sebagai persentase dari ukuran area pandang. Nilai 0 berarti "saat slot memasuki area pandang", 100 berarti "saat iklan berada 1 area pandang dari area pandang", dan seterusnya. renderMarginPercent Jarak minimum dari area pandang saat ini yang harus dimiliki slot sebelum kami merender iklan. Hal ini memungkinkan pengambilan data iklan secara prefetch, tetapi menunggu untuk merender dan mendownload sub-resource lainnya. Nilai ini berfungsi seperti fetchMarginPercent sebagai persentase area pandang. mobileScaling Pengganda yang diterapkan ke margin di perangkat seluler. Hal ini memungkinkan margin yang bervariasi di perangkat seluler vs. desktop. Misalnya, nilai 2,0 akan mengalikan semua margin dengan 2 di perangkat seluler, sehingga meningkatkan jarak minimum slot sebelum pengambilan dan rendering.

---

enableSingleRequest

enableSingleRequest(): boolean

Mengaktifkan mode permintaan tunggal untuk mengambil beberapa iklan secara bersamaan. Hal ini mengharuskan semua slot Iklan Penayang ditentukan dan ditambahkan ke PubAdsService sebelum mengaktifkan layanan. Mode permintaan tunggal harus ditetapkan sebelum layanan diaktifkan.

Lihat juga

• Praktik terbaik iklan: Menggunakan Arsitektur Permintaan Tunggal dengan benar
• Mengontrol pengelompokan SRA

Hasil
boolean	Menampilkan true jika mode permintaan tunggal diaktifkan dan false jika tidak dapat mengaktifkan mode permintaan tunggal karena metode dipanggil setelah layanan diaktifkan.

---

enableVideoAds

enableVideoAds(): void

Memberi sinyal ke GPT bahwa iklan video akan ada di halaman. Tindakan ini memungkinkan batasan pengecualian kompetitif pada iklan Display dan video. Jika konten video diketahui, panggil PubAdsService.setVideoContent agar dapat menggunakan pengecualian konten untuk iklan Display.

---

get

get(key: string): null | string

Menampilkan nilai untuk atribut AdSense yang terkait dengan kunci yang diberikan.

Contoh

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (lama)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

Lihat juga

• Atribut AdSense

Parameter
key: string	Nama atribut yang akan dicari.

Hasil
null | string	Nilai saat ini untuk kunci atribut, atau null jika kunci tidak ada.

---

getAttributeKeys

getAttributeKeys(): string[]

Menampilkan kunci atribut yang telah ditetapkan di layanan ini.

Contoh

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (lama)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

Hasil
string[]	Array kunci atribut yang ditetapkan di layanan ini. Pengurutan tidak ditentukan.

---

getTargeting

getTargeting(key: string): string[]

Menampilkan parameter penargetan tingkat layanan kustom tertentu yang telah ditetapkan.

Contoh

JavaScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

JavaScript (lama)

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

TypeScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

Parameter
key: string	Kunci penargetan yang akan dicari.

Hasil
string[]	Nilai yang terkait dengan kunci ini, atau array kosong jika tidak ada kunci tersebut.

---

getTargetingKeys

getTargetingKeys(): string[]

Menampilkan daftar semua kunci penargetan tingkat layanan kustom yang telah ditetapkan.

Contoh

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

JavaScript (lama)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

Hasil
string[]	Array kunci penargetan. Pengurutan tidak ditentukan.

---

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Menampilkan apakah permintaan awal untuk iklan berhasil dinonaktifkan oleh panggilan PubAdsService.disableInitialLoad sebelumnya atau tidak.

Hasil
boolean	Menampilkan true jika panggilan sebelumnya ke PubAdsService.disableInitialLoad berhasil, false jika tidak.

---

refresh

refresh(slots?: null | Slot[], options?: {
  changeCorrelator: boolean;
}): void

Mengambil dan menampilkan iklan baru untuk slot tertentu atau semua slot di halaman. Hanya berfungsi dalam mode rendering asinkron.

Untuk perilaku yang tepat di semua browser, pemanggilan refresh harus didahului dengan panggilan ke display slot iklan. Jika panggilan ke display dihilangkan, pembaruan mungkin berperilaku tidak terduga. Jika diinginkan, metode PubAdsService.disableInitialLoad dapat digunakan untuk menghentikan display mengambil iklan.

Memuat ulang slot akan menghapus iklan lama dari tampilan halaman berumur panjang GPT, sehingga permintaan mendatang tidak akan terpengaruh oleh hambatan atau pengecualian kompetitif yang melibatkan iklan tersebut.

Contoh

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

JavaScript (lama)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

Lihat juga

• Mengontrol pemuatan dan pembaruan iklan
• Memuat ulang slot iklan

Parameter
Optional slots: null | Slot[]	Slot yang akan dimuat ulang. Array bersifat opsional; semua slot akan dimuat ulang jika tidak ditentukan.
Optional options: {   changeCorrelator: boolean; }	Opsi konfigurasi yang terkait dengan panggilan refresh ini. changeCorrelator Menentukan apakah korelator baru akan dibuat untuk mengambil iklan atau tidak. Server iklan kami mempertahankan nilai korelator ini secara singkat (saat ini selama 30 detik, tetapi dapat berubah), sehingga permintaan dengan korelator yang sama yang diterima dalam waktu berdekatan akan dianggap sebagai satu kunjungan halaman. Secara default, korelator baru dibuat untuk setiap pembaruan. Catatan: opsi ini tidak berpengaruh pada tampilan halaman berumur panjang GPT, yang secara otomatis mencerminkan iklan yang saat ini ada di halaman dan tidak memiliki waktu habis masa berlaku.

---

set

set(key: string, value: string): PubAdsService

Menetapkan nilai untuk atribut AdSense yang berlaku untuk semua slot iklan dalam layanan Iklan Penayang.

Memanggilnya lebih dari sekali untuk kunci yang sama akan mengganti nilai yang ditetapkan sebelumnya untuk kunci tersebut. Semua nilai harus ditetapkan sebelum memanggil display atau refresh.

Contoh

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");

JavaScript (lama)

googletag.pubads().set("adsense_background_color", "#FFFFFF");

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");

Lihat juga

• Atribut AdSense

Parameter
key: string	Nama atribut.
value: string	Nilai atribut.

Hasil
PubAdsService	Objek layanan tempat metode dipanggil.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

Menetapkan pengecualian kategori iklan tingkat halaman untuk nama label yang diberikan.

Contoh

JavaScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

JavaScript (lama)

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

TypeScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

Lihat juga

• Label khusus untuk memblokir iklan

Parameter
categoryExclusion: string	Label pengecualian kategori iklan yang akan ditambahkan.

Hasil
PubAdsService	Objek layanan tempat metode dipanggil.

---

setCentering

setCentering(centerAds: boolean): void

Mengaktifkan dan menonaktifkan pemusatan iklan secara horizontal. Penentuan tengah dinonaktifkan secara default. Di gpt_mobile.js lama, pemusatan diaktifkan secara default.

Metode ini harus dipanggil sebelum memanggil display atau refresh karena hanya iklan yang diminta setelah memanggil metode ini yang akan dipusatkan.

Contoh

JavaScript

// Make ads centered.
googletag.pubads().setCentering(true);

JavaScript (lama)

// Make ads centered.
googletag.pubads().setCentering(true);

TypeScript

// Make ads centered.
googletag.pubads().setCentering(true);

Parameter
centerAds: boolean	true untuk memusatkan iklan, false untuk meratakan kiri.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Mengonfigurasi apakah semua iklan di halaman harus dipaksa untuk dirender menggunakan penampung SafeFrame.

Perhatikan hal-hal berikut saat menggunakan API ini:

• Setelan ini hanya akan berlaku untuk permintaan iklan berikutnya yang dibuat untuk slot masing-masing.
• Setelan tingkat slot, jika ditentukan, akan selalu menggantikan setelan tingkat halaman.
• Jika ditetapkan ke true (di tingkat slot atau tingkat halaman), iklan akan selalu dirender menggunakan penampung SafeFrame, terlepas dari pilihan yang dibuat di UI Google Ad Manager.
• Namun, jika ditetapkan ke false atau tidak ditentukan, iklan akan dirender menggunakan penampung SafeFrame, bergantung pada jenis materi iklan dan pilihan yang dibuat di UI Google Ad Manager.
• API ini harus digunakan dengan hati-hati karena dapat memengaruhi perilaku materi iklan yang mencoba keluar dari iFrame-nya atau mengandalkan materi iklan yang dirender langsung di halaman penayang.

Contoh

JavaScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (lama)

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Lihat juga

• Merender materi iklan menggunakan SafeFrame

Parameter
forceSafeFrame: boolean	true untuk memaksa semua iklan di halaman dirender dalam SafeFrame dan false untuk mengubah setelan sebelumnya menjadi salah (false). Menetapkan setelan ini ke false jika tidak ditentukan sebelumnya, tidak akan mengubah apa pun.

Hasil
PubAdsService	Objek layanan tempat fungsi dipanggil.

---

setLocation

setLocation(address: string): PubAdsService

Meneruskan informasi lokasi dari situs sehingga Anda dapat menargetkan item baris secara geografis ke lokasi tertentu.

Contoh

JavaScript

// Postal code:
googletag.pubads().setLocation("10001,US");

JavaScript (lama)

// Postal code:
googletag.pubads().setLocation("10001,US");

TypeScript

// Postal code:
googletag.pubads().setLocation("10001,US");

Parameter
address: string	Alamat berformat bebas.

Hasil
PubAdsService	Objek layanan tempat metode dipanggil.

---

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Memungkinkan konfigurasi semua setelan privasi dari satu API menggunakan objek konfigurasi.

Contoh

JavaScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

JavaScript (lama)

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

TypeScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

Lihat juga

• Mengonfigurasi setelan privasi
• Menampilkan iklan terbatas

Parameter
privacySettings: PrivacySettingsConfig	Objek yang berisi konfigurasi setelan privasi.

Hasil
PubAdsService	Objek layanan tempat fungsi dipanggil.

---

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

Menetapkan nilai untuk ID yang diberikan penayang.

Contoh

JavaScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

JavaScript (lama)

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

Lihat juga

• Tentang ID yang diberikan penayang

Parameter
ppid: string	ID alfanumerik yang diberikan oleh penayang. Harus berisi antara 32 dan 150 karakter.

Hasil
PubAdsService	Objek layanan tempat metode dipanggil.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

Menetapkan preferensi tingkat halaman untuk konfigurasi SafeFrame. Kunci apa pun yang tidak dikenal dalam objek konfigurasi akan diabaikan. Seluruh konfigurasi akan diabaikan jika nilai yang tidak valid diteruskan untuk kunci yang dikenali.

Preferensi tingkat halaman ini akan diganti oleh preferensi tingkat slot, jika ditentukan.

Contoh

JavaScript

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (lama)

googletag.pubads().setForceSafeFrame(true);

var pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Lihat juga

• Merender materi iklan menggunakan SafeFrame

Parameter
config: SafeFrameConfig	Objek konfigurasi.

Hasil
PubAdsService	Objek layanan tempat metode dipanggil.

---

setTargeting

setTargeting(key: string, value: string | string[]): PubAdsService

Menetapkan parameter penargetan kustom untuk kunci tertentu yang berlaku untuk semua slot iklan layanan Iklan Penayang. Memanggil ini beberapa kali untuk kunci yang sama akan menimpa nilai lama. Kunci ini ditentukan di akun Google Ad Manager Anda.

Contoh

JavaScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

JavaScript (lama)

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

TypeScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

Lihat juga

• Penargetan nilai kunci

Parameter
key: string	Kunci parameter penargetan.
value: string | string[]	Nilai parameter penargetan atau array nilai.

Hasil
PubAdsService	Objek layanan tempat metode dipanggil.

---

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void

Menetapkan informasi konten video yang akan dikirim bersama dengan permintaan iklan untuk tujuan penargetan dan pengecualian konten. Iklan video akan otomatis diaktifkan saat metode ini dipanggil. Untuk videoContentId dan videoCmsId, gunakan nilai yang diberikan ke layanan penyerapan konten Google Ad Manager.

Lihat juga

• Parameter URL tag iklan VAST

Parameter
videoContentId: string	ID konten video.
videoCmsId: string	ID CMS video.

---

updateCorrelator

updateCorrelator(): PubAdsService

Mengubah korelator yang dikirim dengan permintaan iklan, yang secara efektif memulai kunjungan halaman baru. Korelator ini sama untuk semua permintaan iklan yang berasal dari satu kunjungan halaman, dan bersifat unik di seluruh kunjungan halaman. Hanya berlaku untuk mode asinkron.

Catatan: hal ini tidak memengaruhi tampilan halaman berumur panjang GPT, yang secara otomatis mencerminkan iklan yang sebenarnya ada di halaman dan tidak memiliki waktu habis masa berlaku.

Contoh

JavaScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

JavaScript (lama)

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

TypeScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

Hasil
PubAdsService	Objek layanan tempat fungsi dipanggil.

---

googletag.ResponseInformation

Objek yang mewakili satu respons iklan.

Properti
advertiserId	ID pengiklan.
campaignId	ID kampanye.
creativeId	ID materi iklan.
creativeTemplateId	ID template iklan.
lineItemId	ID item baris.

Lihat juga

• Slot.getResponseInformation

Properti

---

advertiserId

advertiserId: null | number

ID pengiklan.

---

campaignId

campaignId: null | number

ID kampanye.

---

creativeId

creativeId: null | number

ID materi iklan.

---

creativeTemplateId

creativeTemplateId: null | number

ID template iklan.

---

lineItemId

lineItemId: null | number

ID item baris.

---

googletag.RewardedPayload

Objek yang mewakili reward yang terkait dengan iklan reward

Properti
amount	Jumlah item yang disertakan dalam reward.
type	Jenis item yang disertakan dalam reward (misalnya, "koin").

Lihat juga

• Menampilkan iklan reward

Properti

---

amount

amount: number

Jumlah item yang disertakan dalam reward.

---

type

type: string

Jenis item yang disertakan dalam reward (misalnya, "koin").

---

googletag.SafeFrameConfig

Objek konfigurasi untuk penampung SafeFrame.

Properti
allowOverlayExpansion?	Apakah SafeFrame harus mengizinkan konten iklan diperluas dengan menempatkan konten halaman.
allowPushExpansion?	Apakah SafeFrame harus mengizinkan konten iklan diperluas dengan mendorong konten halaman.
sandbox?	Apakah SafeFrame harus menggunakan atribut sandbox HTML5 untuk mencegah navigasi tingkat atas tanpa interaksi pengguna.
useUniqueDomain?	Tidak digunakan lagi. Apakah SafeFrame harus menggunakan subdomain acak untuk materi iklan Reservasi.

Lihat juga

• PubAdsService.setSafeFrameConfig

Properti

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Apakah SafeFrame harus mengizinkan konten iklan diperluas dengan menempatkan konten halaman di atasnya.

---

Optional allowPushExpansion

allowPushExpansion?: boolean

Apakah SafeFrame harus mengizinkan konten iklan diperluas dengan mendorong konten halaman.

---

Optional sandbox

sandbox?: boolean

Apakah SafeFrame harus menggunakan atribut sandbox HTML5 untuk mencegah navigasi tingkat atas tanpa interaksi pengguna. Satu-satunya nilai yang valid adalah true (tidak dapat dipaksa ke false). Perhatikan bahwa atribut sandbox menonaktifkan plugin (misalnya, Flash).

---

Optional useUniqueDomain

useUniqueDomain?: null | boolean

Apakah SafeFrame harus menggunakan subdomain acak untuk materi iklan Reservasi. Teruskan null untuk menghapus nilai yang disimpan.

Catatan: fitur ini diaktifkan secara default.

Tidak digunakan lagi: Anda tidak dapat lagi menonaktifkan fitur ini. Menetapkan useUniqueDomain tidak akan berpengaruh.

Lihat juga

• Merender materi iklan menggunakan SafeFrame

---

googletag.Service

Class layanan dasar yang berisi metode yang umum untuk semua layanan.

Metode
addEventListener	Mendaftarkan pemroses yang memungkinkan Anda menyiapkan dan memanggil fungsi JavaScript saat peristiwa GPT tertentu terjadi di halaman.
getSlots	Dapatkan daftar slot yang terkait dengan layanan ini.
removeEventListener	Menghapus pemroses yang terdaftar sebelumnya.

Metode

---

addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service

Mendaftarkan pemroses yang memungkinkan Anda menyiapkan dan memanggil fungsi JavaScript saat peristiwa GPT tertentu terjadi di halaman. Peristiwa berikut didukung:

• events.GameManualInterstitialSlotClosedEvent
• events.GameManualInterstitialSlotReadyEvent
• events.ImpressionViewableEvent
• events.RewardedSlotClosedEvent
• events.RewardedSlotGrantedEvent
• events.RewardedSlotReadyEvent
• events.SlotOnloadEvent
• events.SlotRenderEndedEvent
• events.SlotRequestedEvent
• events.SlotResponseReceived
• events.SlotVisibilityChangedEvent

Objek dari jenis peristiwa yang sesuai akan diteruskan ke pemroses saat dipanggil.

Contoh

JavaScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (lama)

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", function (event) {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

Lihat juga

• Pemroses peristiwa iklan

Parameter
eventType: K	String yang mewakili jenis peristiwa yang dihasilkan oleh GPT. Jenis peristiwa peka huruf besar/kecil.
listener: ((arg: EventTypeMap[K]) => void)	Fungsi yang menggunakan satu argumen objek peristiwa.

Hasil
Service	Objek layanan tempat metode dipanggil.

---

getSlots

getSlots(): Slot[]

Dapatkan daftar slot yang terkait dengan layanan ini.

Hasil
Slot[]	Slot sesuai urutan penambahannya ke layanan.

---

removeEventListener

removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void

Menghapus pemroses yang terdaftar sebelumnya.

Contoh

JavaScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

JavaScript (lama)

googletag.cmd.push(function () {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  var onViewableListener = function (event) {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(function () {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

TypeScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag
    .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
    .addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

Parameter
eventType: K	String yang mewakili jenis peristiwa yang dihasilkan oleh GPT. Jenis peristiwa peka huruf besar/kecil.
listener: ((event: EventTypeMap[K]) => void)	Fungsi yang menggunakan satu argumen objek peristiwa.

---

googletag.SizeMappingBuilder

Builder untuk objek spesifikasi pemetaan ukuran. Builder ini disediakan untuk membantu membuat spesifikasi ukuran dengan mudah.

Metode
addSize	Menambahkan pemetaan dari array ukuran tunggal (yang mewakili area pandang) ke array ukuran tunggal atau multi-ukuran yang mewakili slot.
build	Membuat spesifikasi peta ukuran dari pemetaan yang ditambahkan ke builder ini.

Lihat juga

• Ukuran iklan: Iklan responsif

Metode

---

addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder

Menambahkan pemetaan dari array ukuran tunggal (mewakili area pandang) ke array ukuran tunggal atau multi-ukuran yang mewakili slot.

Contoh

JavaScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

JavaScript (lama)

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

TypeScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

Parameter
viewportSize: SingleSizeArray	Ukuran area pandang untuk entri pemetaan ini.
slotSize: GeneralSize	Ukuran slot untuk entri pemetaan ini.

Hasil
SizeMappingBuilder	Referensi ke builder ini.

---

build

build(): null | SizeMappingArray

Membuat spesifikasi peta ukuran dari pemetaan yang ditambahkan ke builder ini.

Jika ada pemetaan yang tidak valid yang telah diberikan, metode ini akan menampilkan null. Jika tidak, metode ini akan menampilkan spesifikasi dalam format yang benar untuk diteruskan ke Slot.defineSizeMapping.

Catatan: perilaku builder setelah memanggil metode ini tidak ditentukan.

Hasil
null | SizeMappingArray	Hasil yang dibuat oleh builder ini. Dapat berupa null jika pemetaan ukuran yang tidak valid diberikan.

---

googletag.Slot

Slot adalah objek yang mewakili satu slot iklan di halaman.

Metode
addService	Menambahkan Layanan ke slot ini.
clearCategoryExclusions	Menghapus semua label pengecualian kategori iklan tingkat slot untuk slot ini.
clearTargeting	Menghapus parameter penargetan tingkat slot kustom tertentu atau semua parameter untuk slot ini.
defineSizeMapping	Menetapkan array pemetaan dari ukuran area pandang minimum ke ukuran slot untuk slot ini.
get	Menampilkan nilai untuk atribut AdSense yang terkait dengan kunci yang diberikan untuk slot ini.
getAdUnitPath	Menampilkan jalur lengkap unit iklan, dengan kode jaringan dan jalur unit iklan.
getAttributeKeys	Menampilkan daftar kunci atribut yang ditetapkan di slot ini.
getCategoryExclusions	Menampilkan label pengecualian kategori iklan untuk slot ini.
getResponseInformation	Menampilkan informasi respons iklan.
getSlotElementId	Menampilkan ID slot div yang diberikan saat slot ditentukan.
getTargeting	Menampilkan parameter penargetan kustom tertentu yang ditetapkan di slot ini.
getTargetingKeys	Menampilkan daftar semua kunci penargetan kustom yang ditetapkan di slot ini.
set	Menetapkan nilai untuk atribut AdSense di slot iklan ini.
setCategoryExclusion	Menetapkan label pengecualian kategori iklan tingkat slot pada slot ini.
setClickUrl	Menetapkan URL klik yang akan menjadi tujuan pengguna setelah mengklik iklan.
setCollapseEmptyDiv	Menetapkan apakah slot div harus disembunyikan jika tidak ada iklan di slot.
setConfig	Menetapkan opsi konfigurasi umum untuk slot ini.
setForceSafeFrame	Mengonfigurasi apakah iklan di slot ini harus dipaksa untuk dirender menggunakan penampung SafeFrame.
setSafeFrameConfig	Menetapkan preferensi tingkat slot untuk konfigurasi SafeFrame.
setTargeting	Menetapkan parameter penargetan kustom untuk slot ini.
updateTargetingFromMap	Menetapkan parameter penargetan kustom untuk slot ini, dari peta kunci:nilai dalam objek JSON.

Metode

---

addService

addService(service: Service): Slot

Menambahkan Layanan ke slot ini.

Contoh

JavaScript

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

JavaScript (lama)

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());

Lihat juga

• Memulai Tag Google Publisher
• Menampilkan iklan pengujian

Parameter
service: Service	Layanan yang akan ditambahkan.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

clearCategoryExclusions

clearCategoryExclusions(): Slot

Menghapus semua label pengecualian kategori iklan tingkat slot untuk slot ini.

Contoh

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.

JavaScript (lama)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

clearTargeting

clearTargeting(key?: string): Slot

Menghapus parameter penargetan tingkat slot kustom tertentu atau semua parameter untuk slot ini.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

Lihat juga

• Penargetan nilai kunci

Parameter
Optional key: string	Kunci parameter penargetan. Kunci bersifat opsional; semua parameter penargetan akan dihapus jika tidak ditentukan.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Menetapkan array pemetaan dari ukuran area pandang minimum ke ukuran slot untuk slot ini.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

var mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping!);

Lihat juga

• Ukuran iklan: Iklan responsif

Parameter
sizeMapping: SizeMappingArray	Array pemetaan ukuran. Anda dapat menggunakan SizeMappingBuilder untuk membuatnya. Setiap pemetaan ukuran adalah array dari dua elemen: SingleSizeArray dan GeneralSize.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

get

get(key: string): null | string

Menampilkan nilai untuk atribut AdSense yang terkait dengan kunci yang diberikan untuk slot ini. Untuk melihat atribut tingkat layanan yang diwarisi oleh slot ini, gunakan PubAdsService.get.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

Lihat juga

• Atribut AdSense

Parameter
key: string	Nama atribut yang akan dicari.

Hasil
null | string	Nilai saat ini untuk kunci atribut, atau null jika kunci tidak ada.

---

getAdUnitPath

getAdUnitPath(): string

Menampilkan jalur lengkap unit iklan, dengan kode jaringan dan jalur unit iklan.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

Hasil
string	Jalur unit iklan.

---

getAttributeKeys

getAttributeKeys(): string[]

Menampilkan daftar kunci atribut yang ditetapkan di slot ini. Untuk melihat kunci atribut tingkat layanan yang diwarisi oleh slot ini, gunakan PubAdsService.getAttributeKeys.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

Hasil
string[]	Array kunci atribut. Pengurutan tidak ditentukan.

---

getCategoryExclusions

getCategoryExclusions(): string[]

Menampilkan label pengecualian kategori iklan untuk slot ini.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

Hasil
string[]	Label pengecualian kategori iklan untuk slot ini, atau array kosong jika tidak ada yang ditetapkan.

---

getResponseInformation

getResponseInformation(): null | ResponseInformation

Menampilkan informasi respons iklan. Hal ini didasarkan pada respons iklan terakhir untuk slot. Jika dipanggil saat slot tidak memiliki iklan, null akan ditampilkan.

Hasil
null | ResponseInformation	Informasi respons iklan terbaru, atau null jika slot tidak memiliki iklan.

---

getSlotElementId

getSlotElementId(): string

Menampilkan ID slot div yang diberikan saat slot ditentukan.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

Hasil
string	ID slot div.

---

getTargeting

getTargeting(key: string): string[]

Menampilkan parameter penargetan kustom tertentu yang ditetapkan di slot ini. Parameter penargetan tingkat layanan tidak disertakan.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

Parameter
key: string	Kunci penargetan yang akan dicari.

Hasil
string[]	Nilai yang terkait dengan kunci ini, atau array kosong jika tidak ada kunci tersebut.

---

getTargetingKeys

getTargetingKeys(): string[]

Menampilkan daftar semua kunci penargetan kustom yang ditetapkan di slot ini. Kunci penargetan tingkat layanan tidak disertakan.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

Hasil
string[]	Array kunci penargetan. Pengurutan tidak ditentukan.

---

set

set(key: string, value: string): Slot

Menetapkan nilai untuk atribut AdSense di slot iklan ini. Tindakan ini akan mengganti nilai apa pun yang ditetapkan di tingkat layanan untuk kunci ini.

Memanggil metode ini lebih dari sekali untuk kunci yang sama akan mengganti nilai yang ditetapkan sebelumnya untuk kunci tersebut. Semua nilai harus ditetapkan sebelum memanggil display atau refresh.

Contoh

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

JavaScript (lama)

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

Lihat juga

• Atribut AdSense

Parameter
key: string	Nama atribut.
value: string	Nilai atribut.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

Menetapkan label pengecualian kategori iklan tingkat slot di slot ini.

Contoh

JavaScript

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

JavaScript (lama)

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

Lihat juga

• Label khusus untuk memblokir iklan

Parameter
categoryExclusion: string	Label pengecualian kategori iklan yang akan ditambahkan.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

setClickUrl

setClickUrl(value: string): Slot

Menetapkan URL klik yang akan menjadi tujuan pengalihan pengguna setelah mengklik iklan.

Server Google Ad Manager tetap mencatat klik meskipun URL klik diganti. Setiap URL halaman landing yang terkait dengan materi iklan yang ditayangkan akan ditambahkan ke nilai yang diberikan. Panggilan berikutnya akan menimpa nilai. Hal ini hanya berfungsi untuk permintaan non-SRA.

Contoh

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());

JavaScript (lama)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());

Parameter
value: string	URL klik yang akan ditetapkan.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot

Menetapkan apakah slot div harus disembunyikan jika tidak ada iklan di slot. Tindakan ini akan menggantikan setelan tingkat layanan.

Contoh

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

JavaScript (lama)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

Lihat juga

• Menciutkan slot iklan kosong
• Meminimalkan pergeseran tata letak

Parameter
collapse: boolean	Apakah akan menciutkan slot jika tidak ada iklan yang ditampilkan.
Optional collapseBeforeAdFetch: boolean	Apakah akan menciutkan slot bahkan sebelum iklan diambil. Diabaikan jika collapse bukan true.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): void

Menetapkan opsi konfigurasi umum untuk slot ini.

Parameter
slotConfig: SlotSettingsConfig	Objek konfigurasi.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Mengonfigurasi apakah iklan di slot ini harus dipaksa untuk dirender menggunakan penampung SafeFrame.

Perhatikan hal-hal berikut saat menggunakan API ini:

• Setelan ini hanya akan berlaku untuk permintaan iklan berikutnya yang dibuat untuk slot masing-masing.
• Setelan tingkat slot, jika ditentukan, akan selalu menggantikan setelan tingkat halaman.
• Jika ditetapkan ke true (di tingkat slot atau tingkat halaman), iklan akan selalu dirender menggunakan penampung SafeFrame, terlepas dari pilihan yang dibuat di UI Google Ad Manager.
• Namun, jika ditetapkan ke false atau tidak ditentukan, iklan akan dirender menggunakan penampung SafeFrame, bergantung pada jenis materi iklan dan pilihan yang dibuat di UI Google Ad Manager.
• API ini harus digunakan dengan hati-hati karena dapat memengaruhi perilaku materi iklan yang mencoba keluar dari iFrame-nya atau mengandalkan materi iklan yang dirender langsung di halaman penayang.

Contoh

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

JavaScript (lama)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

Lihat juga

• Merender materi iklan menggunakan SafeFrame

Parameter
forceSafeFrame: boolean	true untuk memaksa semua iklan di slot ini dirender dalam SafeFrame dan false untuk memilih tidak ikut setelan tingkat halaman (jika ada). Menetapkan setelan ini ke false jika tidak ditentukan di tingkat halaman tidak akan mengubah apa pun.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

setSafeFrameConfig

setSafeFrameConfig(config: null | SafeFrameConfig): Slot

Menetapkan preferensi tingkat slot untuk konfigurasi SafeFrame. Kunci apa pun yang tidak dikenal dalam objek konfigurasi akan diabaikan. Seluruh konfigurasi akan diabaikan jika nilai yang tidak valid diteruskan untuk kunci yang dikenali.

Preferensi tingkat slot ini, jika ditentukan, akan menggantikan preferensi tingkat halaman.

Contoh

JavaScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (lama)

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Lihat juga

• Merender materi iklan menggunakan SafeFrame

Parameter
config: null | SafeFrameConfig	Objek konfigurasi.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

setTargeting

setTargeting(key: string, value: string | string[]): Slot

Menetapkan parameter penargetan kustom untuk slot ini. Memanggil metode ini beberapa kali untuk kunci yang sama akan menimpa nilai lama. Nilai yang ditetapkan di sini akan menimpa parameter penargetan yang ditetapkan di tingkat layanan. Kunci ini ditentukan di akun Google Ad Manager Anda.

Contoh

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);

JavaScript (lama)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);

Lihat juga

• Penargetan nilai kunci

Parameter
key: string	Kunci parameter penargetan.
value: string | string[]	Nilai parameter penargetan atau array nilai.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot

Menetapkan parameter penargetan kustom untuk slot ini, dari peta kunci:nilai dalam objek JSON. Hal ini sama dengan memanggil Slot.setTargeting untuk semua nilai kunci objek. Kunci ini ditentukan di akun Google Ad Manager Anda.

Catatan:

• Jika terjadi penggantian, hanya nilai terakhir yang akan disimpan.
• Jika nilainya berupa array, nilai sebelumnya akan ditimpa, bukan digabungkan.
• Nilai yang ditetapkan di sini akan menimpa parameter penargetan yang ditetapkan di tingkat layanan.

Contoh

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

JavaScript (lama)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

Parameter
map: {   [adUnitPath: string]: string | string[]; }	Peta nilai kunci parameter penargetan.

Hasil
Slot	Objek slot tempat metode dipanggil.

---

googletag.config

Antarmuka konfigurasi utama untuk setelan tingkat halaman.

Antarmuka
AdExpansionConfig	Setelan untuk mengontrol perluasan iklan.
ComponentAuctionConfig	Objek yang mewakili satu lelang komponen dalam lelang iklan di perangkat.
InterstitialConfig	Objek yang menentukan perilaku satu slot iklan interstisial.
PageSettingsConfig	Antarmuka konfigurasi utama untuk setelan tingkat halaman.
PrivacyTreatmentsConfig	Setelan untuk mengontrol perlakuan privasi penayang.
PublisherProvidedSignalsConfig	Objek konfigurasi sinyal yang diberikan penayang (PPS).
SlotSettingsConfig	Antarmuka konfigurasi utama untuk setelan tingkat slot.
TaxonomyData	Objek yang berisi nilai untuk satu Taksonomi.

Alias Jenis
InterstitialTrigger	Pemicu iklan interstisial yang didukung.
PrivacyTreatment	Perlakuan privasi penayang yang didukung.
Taxonomy	Taksonomi yang didukung untuk sinyal yang diberikan penayang (PPS).

Alias Jenis

---

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"

Pemicu iklan interstisial yang didukung.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Perlakuan privasi penayang yang didukung.

---

Taksonomi

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Taksonomi yang didukung untuk sinyal yang diberikan penayang (PPS).

Lihat juga

• Taksonomi Audiens IAB 1.1
• Taksonomi Konten IAB 2.2

---

googletag.config.AdExpansionConfig

Setelan untuk mengontrol perluasan iklan.

Properti
enabled?	Apakah perluasan iklan diaktifkan atau dinonaktifkan.

Contoh

JavaScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

JavaScript (lama)

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

Properti

---

Optional diaktifkan

enabled?: null | boolean

Apakah perluasan iklan diaktifkan atau dinonaktifkan.

Menetapkan nilai ini akan menggantikan setelan default yang dikonfigurasi di Google Ad Manager.

Lihat juga

• Memperluas iklan di desktop dan tablet
• Memperluas iklan di web seluler (layar sebagian)

---

googletag.config.ComponentAuctionConfig

Objek yang mewakili satu lelang komponen dalam lelang iklan di perangkat.

Properti
auctionConfig	Objek konfigurasi lelang untuk lelang komponen ini.
configKey	Kunci konfigurasi yang terkait dengan lelang komponen ini.

Lihat juga

• Panduan Penjual Protected Audience API: menjalankan lelang iklan

Properti

---

auctionConfig

auctionConfig: null | {
  auctionSignals?: unknown;
  decisionLogicURL: string;
  interestGroupBuyers?: string[];
  perBuyerExperimentGroupIds?: {
    [buyer: string]: number;
  };
  perBuyerGroupLimits?: {
    [buyer: string]: number;
  };
  perBuyerSignals?: {
    [buyer: string]: unknown;
  };
  perBuyerTimeouts?: {
    [buyer: string]: number;
  };
  seller: string;
  sellerExperimentGroupId?: number;
  sellerSignals?: unknown;
  sellerTimeout?: number;
  trustedScoringSignalsURL?: string;
}

Objek konfigurasi lelang untuk lelang komponen ini.

Jika nilai ini ditetapkan ke null, konfigurasi yang ada untuk configKey yang ditentukan akan dihapus.

Contoh

JavaScript

const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

JavaScript (lama)

var componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

TypeScript

const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

Lihat juga

• Protected Audience API: Memulai Lelang di Perangkat

---

configKey

configKey: string

Kunci konfigurasi yang terkait dengan lelang komponen ini.

Nilai ini tidak boleh kosong dan harus unik. Jika dua objek ComponentAuctionConfig memiliki nilai configKey yang sama, objek terakhir yang ditetapkan akan menimpa konfigurasi sebelumnya.

---

googletag.config.InterstitialConfig

Objek yang menentukan perilaku satu slot iklan interstisial.

Properti
requireStorageAccess?	Apakah izin penyimpanan lokal diperlukan untuk menampilkan iklan interstisial ini.
triggers?	Konfigurasi pemicu interstisial untuk iklan interstisial ini.

Properti

---

Optional requireStorageAccess

requireStorageAccess?: null | boolean

Apakah izin penyimpanan lokal diperlukan untuk menampilkan iklan interstisial ini.

GPT menggunakan penyimpanan lokal untuk menerapkan pembatasan frekuensi untuk iklan interstisial. Namun, pengguna yang belum memberikan izin penyimpanan lokal masih memenuhi syarat untuk menerima iklan interstisial. Menetapkan properti ini ke true akan memilih untuk tidak menggunakan perilaku default, dan memastikan iklan interstisial hanya ditampilkan kepada pengguna yang telah memberikan izin penyimpanan lokal.

Contoh

JavaScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

JavaScript (lama)

// Opt out of showing interstitials to users
// without local storage consent.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

TypeScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

Lihat juga

• Memproses interstisial web

---

Optional pemicu

triggers?: null | Partial<Record<InterstitialTrigger, boolean>>

Konfigurasi pemicu interstisial untuk iklan interstisial ini.

Menetapkan nilai pemicu interstisial ke true akan mengaktifkannya dan false akan menonaktifkannya. Tindakan ini akan mengganti nilai default yang dikonfigurasi di Google Ad Manager.

Contoh

JavaScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

JavaScript (lama)

// Define a GPT managed web interstitial ad slot.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
var enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

TypeScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

Lihat juga

• Menampilkan iklan interstisial web

---

googletag.config.PageSettingsConfig

Antarmuka konfigurasi utama untuk setelan tingkat halaman.

Memungkinkan penetapan beberapa fitur dengan satu panggilan API.

Semua properti yang tercantum di bawah ini adalah contoh dan tidak mencerminkan fitur sebenarnya yang menggunakan setConfig. Untuk kumpulan fitur, lihat kolom dalam jenis PageSettingsConfig di bawah.

Contoh:

• Hanya fitur yang ditentukan dalam panggilan googletag.setConfig yang diubah.

    // Configure feature alpha.
    googletag.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    googletag.setConfig({
       bravo: {...}
    });

• Semua setelan untuk fitur tertentu diperbarui dengan setiap panggilan ke googletag.setConfig.

    // Configure feature charlie to echo = 1, foxtrot = true.
    googletag.setConfig({
        charlie: {
            echo: 1,
            foxtrot: true,
        }
    });
  
    // Update feature charlie to echo = 2. Since foxtrot was not specified,
    // the value is cleared.
    googletag.setConfig({
        charlie: {
            echo: 2
        }
    });

• Semua setelan untuk fitur dapat dihapus dengan meneruskan null.

    // Configure features delta, golf, and hotel.
    googletag.setConfig({
        delta: {...},
        golf: {...},
        hotel: {...},
    });
  
    // Feature delta and hotel are cleared, but feature golf remains set.
    googletag.setConfig({
        delta: null,
        hotel: null,
    });

Properti
adExpansion?	Setelan untuk mengontrol perluasan iklan.
adYield?	Tidak digunakan lagi.
pps?	Setelan untuk mengontrol sinyal yang diberikan penayang (PPS).
privacyTreatments?	Setelan untuk mengontrol perlakuan privasi penayang.
threadYield?	Setelan untuk mengontrol apakah GPT harus menghasilkan thread JS saat merender materi iklan.

Properti

---

Optional adExpansion

adExpansion?: null | AdExpansionConfig

Setelan untuk mengontrol perluasan iklan.

---

Optional adYield

adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

Tidak digunakan lagi: Gunakan threadYield sebagai gantinya. Fitur ini akan dihapus dalam waktu dekat.

---

Optional pps

pps?: null | PublisherProvidedSignalsConfig

Setelan untuk mengontrol sinyal yang diberikan penayang (PPS).

---

Optional privacyTreatments

privacyTreatments?: null | PrivacyTreatmentsConfig

Setelan untuk mengontrol perlakuan privasi penayang.

---

Optional threadYield

threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

Setelan untuk mengontrol apakah GPT harus menghasilkan thread JS saat merender materi iklan.

GPT hanya akan menghasilkan thread untuk browser yang mendukung Scheduler.postTask atau Scheduler.yield API.

Nilai yang didukung:

• null (default): GPT akan menghasilkan thread JS untuk slot di luar area pandang.
• ENABLED_ALL_SLOTS: GPT akan menghasilkan thread JS untuk semua slot, terlepas dari apakah slot berada dalam area pandang atau tidak.
• DISABLED: GPT tidak akan menghasilkan thread JS.

Contoh

JavaScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

JavaScript (lama)

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

TypeScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

Lihat juga

• Scheduler

---

googletag.config.PrivacyTreatmentsConfig

Setelan untuk mengontrol perlakuan privasi penayang.

Properti
treatments	Array perlakuan privasi penayang yang akan diaktifkan.

Properti

---

treatments

treatments: null | "disablePersonalization"[]

Array perlakuan privasi penayang yang akan diaktifkan.

Contoh

JavaScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

JavaScript (lama)

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

TypeScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

---

googletag.config.PublisherProvidedSignalsConfig

Objek konfigurasi sinyal yang diberikan penayang (PPS).

Properti
taxonomies	Objek yang berisi pemetaan Taksonomi.

Contoh

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

JavaScript (lama)

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

Lihat juga

• Tentang sinyal yang diberikan penayang (Beta)
• Taksonomi Audiens IAB 1.1
• Taksonomi Konten IAB 2.2

Properti

---

taksonomi

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Objek yang berisi pemetaan Taksonomi.

---

googletag.config.SlotSettingsConfig

Antarmuka konfigurasi utama untuk setelan tingkat slot.

Memungkinkan penetapan beberapa fitur dengan satu panggilan API untuk satu slot.

Semua properti yang tercantum di bawah ini adalah contoh dan tidak mencerminkan fitur sebenarnya yang menggunakan setConfig. Untuk kumpulan fitur, lihat kolom dalam jenis SlotSettingsConfig di bawah.

Contoh:

• Hanya fitur yang ditentukan dalam panggilan Slot.setConfig yang diubah.

    const slot = googletag.defineSlot("/1234567/example", [160, 600]);
  
    // Configure feature alpha.
    slot.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    slot.setConfig({
       bravo: {...}
    });

• Semua setelan untuk fitur tertentu diperbarui dengan setiap panggilan ke Slot.setConfig.

    // Configure feature charlie to echo = 1, foxtrot = true.
    slot.setConfig({
        charlie: {
            echo: 1,
            foxtrot: true,
        }
    });
  
    // Update feature charlie to echo = 2. Since foxtrot was not specified,
    // the value is cleared.
    slot.setConfig({
        charlie: {
            echo: 2
        }
    });

• Semua setelan untuk fitur dapat dihapus dengan meneruskan null.

    // Configure features delta, golf, and hotel.
    slot.setConfig({
        delta: {...},
        golf: {...},
        hotel: {...},
    });
  
    // Feature delta and hotel are cleared, but feature golf remains set.
    slot.setConfig({
        delta: null,
        hotel: null,
    });

Properti
adExpansion?	Setelan untuk mengontrol perluasan iklan.
componentAuction?	Array lelang komponen yang akan disertakan dalam lelang iklan di perangkat.
interstitial?	Setelan yang mengontrol perilaku slot iklan interstisial.

Properti

---

Optional adExpansion

adExpansion?: null | AdExpansionConfig

Setelan untuk mengontrol perluasan iklan.

---

Optional componentAuction

componentAuction?: null | ComponentAuctionConfig[]

Array lelang komponen yang akan disertakan dalam lelang iklan di perangkat.

---

Optional interstisial

interstitial?: null | InterstitialConfig

Setelan yang mengontrol perilaku slot iklan interstisial.

---

googletag.config.TaxonomyData

Objek yang berisi nilai untuk satu Taksonomi.

Properti
values	Daftar nilai Taksonomi.

Properti

---

values

values: string[]

Daftar nilai Taksonomi.

---

googletag.enums

Ini adalah namespace yang digunakan GPT untuk jenis enum.

Enumerasi
OutOfPageFormat	Format di luar halaman yang didukung oleh GPT.
TrafficSource	Sumber traffic yang didukung oleh GPT.

Enumerasi

---

OutOfPageFormat

OutOfPageFormat

Format di luar halaman yang didukung oleh GPT.

Lihat juga

• defineOutOfPageSlot

Anggota Enumerasi
BOTTOM_ANCHOR	Format anchor tempat slot menempel ke bagian bawah area pandang.
GAME_MANUAL_INTERSTITIAL	Format interstisial manual game. Catatan: Interstisial manual game adalah format dengan akses terbatas.
INTERSTITIAL	Format materi iklan interstisial web.
LEFT_SIDE_RAIL	Format kolom samping kiri.
REWARDED	Format reward.
RIGHT_SIDE_RAIL	Format kolom samping kanan.
TOP_ANCHOR	Format anchor dengan slot yang menempel di bagian atas area pandang.

---

TrafficSource

TrafficSource

Sumber traffic yang didukung oleh GPT.

Lihat juga

• PrivacySettingsConfig.trafficSource

Anggota Enumerasi
ORGANIC	Entri URL langsung, penelusuran situs, atau download aplikasi.
PURCHASED	Traffic dialihkan dari properti selain yang dimiliki (aktivitas yang diperoleh atau dengan insentif).

---

googletag.events

Ini adalah namespace yang digunakan GPT untuk Peristiwa. Kode Anda dapat bereaksi terhadap peristiwa ini menggunakan Service.addEventListener.

Antarmuka
Event	Antarmuka Dasar untuk semua peristiwa GPT.
EventTypeMap	Ini adalah pseudo-jenis yang memetakan nama peristiwa ke jenis objek peristiwa yang sesuai untuk Service.addEventListener dan Service.removeEventListener.
GameManualInterstitialSlotClosedEvent	Peristiwa ini diaktifkan saat slot interstisial manual game telah ditutup oleh pengguna.
GameManualInterstitialSlotReadyEvent	Peristiwa ini diaktifkan saat slot interstisial manual game siap ditampilkan kepada pengguna.
ImpressionViewableEvent	Peristiwa ini diaktifkan saat tayangan iklan dapat dilihat, sesuai dengan kriteria Tampilan Aktif.
RewardedSlotClosedEvent	Peristiwa ini diaktifkan saat slot iklan reward ditutup oleh pengguna.
RewardedSlotGrantedEvent	Peristiwa ini diaktifkan saat reward diberikan untuk melihat iklan reward.
RewardedSlotReadyEvent	Peristiwa ini diaktifkan saat iklan reward siap ditampilkan.
SlotOnloadEvent	Peristiwa ini dipicu saat iframe materi iklan memicu peristiwa pemuatan.
SlotRenderEndedEvent	Peristiwa ini dipicu saat kode materi iklan dimasukkan ke dalam slot.
SlotRequestedEvent	Peristiwa ini dipicu saat iklan telah diminta untuk slot tertentu.
SlotResponseReceived	Peristiwa ini dipicu saat respons iklan telah diterima untuk slot tertentu.
SlotVisibilityChangedEvent	Peristiwa ini dipicu setiap kali persentase area slot iklan di layar berubah.

---

googletag.events.Event

Antarmuka Dasar untuk semua peristiwa GPT. Semua peristiwa GPT di bawah akan memiliki kolom berikut.

Properti
serviceName	Nama layanan yang memicu peristiwa.
slot	Slot yang memicu peristiwa.

Lihat juga

• Pemroses peristiwa iklan

Properti

---

serviceName

serviceName: string

Nama layanan yang memicu peristiwa.

---

slot

slot: Slot

Slot yang memicu peristiwa.

---

googletag.events.EventTypeMap

Ini adalah pseudo-jenis yang memetakan nama peristiwa ke jenis objek peristiwa yang sesuai untuk Service.addEventListener dan Service.removeEventListener. Ini didokumentasikan hanya untuk tujuan referensi dan keamanan jenis.

Properti
gameManualInterstitialSlotClosed	Alias untuk events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	Alias untuk events.GameManualInterstitialSlotReadyEvent.
impressionViewable	Alias untuk events.ImpressionViewableEvent.
rewardedSlotClosed	Alias untuk events.RewardedSlotClosedEvent.
rewardedSlotGranted	Alias untuk events.RewardedSlotGrantedEvent.
rewardedSlotReady	Alias untuk events.RewardedSlotReadyEvent.
slotOnload	Alias untuk events.SlotOnloadEvent.
slotRenderEnded	Alias untuk events.SlotRenderEndedEvent.
slotRequested	Alias untuk events.SlotRequestedEvent.
slotResponseReceived	Alias untuk events.SlotResponseReceived.
slotVisibilityChanged	Alias untuk events.SlotVisibilityChangedEvent.

Properti

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Alias untuk events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Alias untuk events.GameManualInterstitialSlotReadyEvent.

---

impressionViewable

impressionViewable: ImpressionViewableEvent

Alias untuk events.ImpressionViewableEvent.

---

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Alias untuk events.RewardedSlotClosedEvent.

---

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

Alias untuk events.RewardedSlotGrantedEvent.

---

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

Alias untuk events.RewardedSlotReadyEvent.

---

slotOnload

slotOnload: SlotOnloadEvent

Alias untuk events.SlotOnloadEvent.

---

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

Alias untuk events.SlotRenderEndedEvent.

---

slotRequested

slotRequested: SlotRequestedEvent

Alias untuk events.SlotRequestedEvent.

---

slotResponseReceived

slotResponseReceived: SlotResponseReceived

Alias untuk events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Alias untuk events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

Memperluas Event

Peristiwa ini diaktifkan saat slot interstisial manual game ditutup oleh pengguna.

Catatan: Interstisial manual game adalah format dengan akses terbatas.

Properti
serviceName	Nama layanan yang memicu peristiwa. Diwariskan dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwariskan dari Event.slot

Contoh

JavaScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (lama)

// This listener is called when a game manual interstitial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) {
    var slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Lihat juga

• Pemroses peristiwa iklan
• Menampilkan iklan interstisial manual game

---

googletag.events.GameManualInterstitialSlotReadyEvent

Memperluas Event

Peristiwa ini diaktifkan saat slot interstisial manual game siap ditampilkan kepada pengguna.

Catatan: Interstisial manual game adalah format dengan akses terbatas.

Properti
serviceName	Nama layanan yang memicu peristiwa. Diwariskan dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwariskan dari Event.slot

Metode
makeGameManualInterstitialVisible	Menampilkan iklan interstisial manual game kepada pengguna.

Contoh

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (lama)

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) {
    var slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    var displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Lihat juga

• Pemroses peristiwa iklan
• Menampilkan iklan interstisial manual game

Metode

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void

Menampilkan iklan interstisial manual game kepada pengguna.

---

googletag.events.ImpressionViewableEvent

Memperluas Event

Peristiwa ini diaktifkan saat tayangan iklan dapat dilihat, sesuai dengan kriteria Tampilan Aktif.

Properti
serviceName	Nama layanan yang memicu peristiwa. Diwariskan dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwariskan dari Event.slot

Contoh

JavaScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (lama)

// This listener is called when an impression becomes viewable.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", function (event) {
  var slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Lihat juga

• Pemroses peristiwa iklan

---

googletag.events.RewardedSlotClosedEvent

Memperluas Event

Peristiwa ini diaktifkan saat slot iklan reward ditutup oleh pengguna. Peristiwa ini dapat diaktifkan sebelum atau setelah reward diberikan. Untuk menentukan apakah reward telah diberikan, gunakan events.RewardedSlotGrantedEvent.

Properti
serviceName	Nama layanan yang memicu peristiwa. Diwarisi dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwarisi dari Event.slot

Contoh

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (lama)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
    var slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Lihat juga

• Pemroses peristiwa iklan
• Menampilkan iklan reward

---

googletag.events.RewardedSlotGrantedEvent

Memperluas Event

Peristiwa ini diaktifkan saat reward diberikan untuk melihat iklan reward. Jika iklan ditutup sebelum kriteria untuk memberikan reward terpenuhi, peristiwa ini tidak akan diaktifkan.

Properti
payload	Objek yang berisi informasi tentang reward yang diberikan.
serviceName	Nama layanan yang memicu peristiwa. Diwarisi dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwarisi dari Event.slot

Contoh

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (lama)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
    var _a, _b;
    var slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
    console.log(
      "Reward amount:",
      (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount,
    );
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Lihat juga

• Pemroses peristiwa iklan
• Menampilkan iklan reward

Properti

---

payload

payload: null | RewardedPayload

Objek yang berisi informasi tentang reward yang diberikan.

---

googletag.events.RewardedSlotReadyEvent

Memperluas Event

Peristiwa ini diaktifkan saat iklan reward siap ditampilkan. Penayang bertanggung jawab untuk memberikan opsi kepada pengguna untuk melihat iklan sebelum menampilkannya.

Properti
serviceName	Nama layanan yang memicu peristiwa. Diwarisi dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwarisi dari Event.slot

Metode
makeRewardedVisible	Menampilkan iklan reward.

Contoh

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    const userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (lama)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
    var slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    var userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    const userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Lihat juga

• Pemroses peristiwa iklan
• Menampilkan iklan reward

Metode

---

makeRewardedVisible

makeRewardedVisible(): void

Menampilkan iklan reward. Metode ini tidak boleh dipanggil hingga pengguna mengizinkan untuk melihat iklan.

---

googletag.events.SlotOnloadEvent

Memperluas Event

Peristiwa ini dipicu saat iframe materi iklan memicu peristiwa pemuatan. Saat merender iklan multimedia dalam mode rendering sinkron, tidak ada iframe yang digunakan sehingga tidak ada SlotOnloadEvent yang akan diaktifkan.

Properti
serviceName	Nama layanan yang memicu peristiwa. Diwarisi dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwariskan dari Event.slot

Contoh

JavaScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (lama)

// This listener is called when a creative iframe load event fires.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  var slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Lihat juga

• Pemroses peristiwa iklan

---

googletag.events.SlotRenderEndedEvent

Memperluas Event

Peristiwa ini dipicu saat kode materi iklan dimasukkan ke dalam slot. Peristiwa ini akan terjadi sebelum resource materi iklan diambil, sehingga materi iklan mungkin belum terlihat. Jika Anda perlu mengetahui kapan semua resource materi iklan untuk slot selesai dimuat, pertimbangkan events.SlotOnloadEvent.

Properti
advertiserId	ID pengiklan iklan yang dirender.
campaignId	ID kampanye iklan yang dirender.
companyIds	ID perusahaan yang mengajukan bid pada iklan pengisian ulang yang dirender.
creativeId	ID materi iklan dari iklan reservasi yang dirender.
creativeTemplateId	ID template materi iklan dari iklan reservasi yang dirender.
isBackfill	Apakah iklan adalah iklan pengisian ulang.
isEmpty	Apakah iklan ditampilkan untuk slot.
labelIds	Tidak digunakan lagi.
lineItemId	ID item baris iklan reservasi yang dirender.
serviceName	Nama layanan yang memicu peristiwa. Diwariskan dari Event.serviceName
size	Menunjukkan ukuran piksel materi iklan yang dirender.
slot	Slot yang memicu peristiwa. Diwarisi dari Event.slot
slotContentChanged	Apakah konten slot diubah dengan iklan yang dirender.
sourceAgnosticCreativeId	ID materi iklan pemesanan atau iklan pengisian ulang yang dirender.
sourceAgnosticLineItemId	ID item baris dari iklan pengisian ulang atau reservasi yang dirender.
yieldGroupIds	ID grup hasil untuk iklan pengisian ulang yang dirender.

Contoh

JavaScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (lama)

// This listener is called when a slot has finished rendering.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", function (event) {
  var slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Lihat juga

• Pemroses peristiwa iklan

Properti

---

advertiserId

advertiserId: null | number

ID pengiklan iklan yang dirender. Nilainya adalah null untuk slot kosong, iklan pengisian ulang, dan materi iklan yang dirender oleh layanan selain PubAdsService.

---

campaignId

campaignId: null | number

ID kampanye iklan yang dirender. Nilainya adalah null untuk slot kosong, iklan pengisian ulang, dan materi iklan yang dirender oleh layanan selain PubAdsService.

---

companyIds

companyIds: null | number[]

ID perusahaan yang mengajukan bid pada iklan pengisian ulang yang dirender. Nilainya adalah null untuk slot kosong, iklan reservasi, dan materi iklan yang dirender oleh layanan selain PubAdsService.

---

creativeId

creativeId: null | number

ID materi iklan dari iklan reservasi yang dirender. Nilainya adalah null untuk slot kosong, iklan pengisian ulang, dan materi iklan yang dirender oleh layanan selain PubAdsService.

---

creativeTemplateId

creativeTemplateId: null | number

ID template materi iklan dari iklan reservasi yang dirender. Nilainya adalah null untuk slot kosong, iklan pengisian ulang, dan materi iklan yang dirender oleh layanan selain PubAdsService.

---

isBackfill

isBackfill: boolean

Apakah iklan adalah iklan pengisian ulang. Nilainya adalah true jika iklan adalah iklan pengisian ulang, false jika tidak.

---

isEmpty

isEmpty: boolean

Apakah iklan ditampilkan untuk slot. Nilainya adalah true jika tidak ada iklan yang ditampilkan, false jika ada.

---

labelIds

labelIds: null | number[]

Tidak digunakan lagi: Kolom ini tidak lagi diisi.

---

lineItemId

lineItemId: null | number

ID item baris iklan reservasi yang dirender. Nilainya adalah null untuk slot kosong, iklan pengisian ulang, dan materi iklan yang dirender oleh layanan selain PubAdsService.

---

size

size: null | string | number[]

Menunjukkan ukuran piksel materi iklan yang dirender. Contoh: [728, 90]. Nilainya adalah null untuk slot iklan kosong.

---

slotContentChanged

slotContentChanged: boolean

Apakah konten slot diubah dengan iklan yang dirender. Nilainya adalah true jika konten diubah, false jika tidak.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: null | number

ID materi iklan pemesanan atau iklan pengisian ulang yang dirender. Nilainya adalah null jika iklan bukan merupakan reservasi atau pengisian ulang item baris, atau materi iklan dirender oleh layanan selain PubAdsService.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: null | number

ID item baris dari iklan pengisian ulang atau reservasi yang dirender. Nilainya adalah null jika iklan bukan merupakan reservasi atau pengisian ulang item baris, atau materi iklan dirender oleh layanan selain PubAdsService.

---

yieldGroupIds

yieldGroupIds: null | number[]

ID grup hasil untuk iklan pengisian ulang yang dirender. Nilainya adalah null untuk slot kosong, iklan reservasi, dan materi iklan yang dirender oleh layanan selain PubAdsService.

---

googletag.events.SlotRequestedEvent

Memperluas Event

Peristiwa ini dipicu saat iklan telah diminta untuk slot tertentu.

Properti
serviceName	Nama layanan yang memicu peristiwa. Diwarisi dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwariskan dari Event.slot

Contoh

JavaScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (lama)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", function (event) {
  var slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Lihat juga

• Pemroses peristiwa iklan

---

googletag.events.SlotResponseReceived

Memperluas Event

Peristiwa ini dipicu saat respons iklan telah diterima untuk slot tertentu.

Properti
serviceName	Nama layanan yang memicu peristiwa. Diwariskan dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwarisi dari Event.slot

Contoh

JavaScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (lama)

// This listener is called when an ad response has been received
// for a slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", function (event) {
  var slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Lihat juga

• Pemroses peristiwa iklan

---

googletag.events.SlotVisibilityChangedEvent

Memperluas Event

Peristiwa ini dipicu setiap kali persentase area slot iklan di layar berubah. Peristiwa ini dibatasi dan tidak akan diaktifkan lebih sering dari sekali setiap 200 md.

Properti
inViewPercentage	Persentase area iklan yang terlihat.
serviceName	Nama layanan yang memicu peristiwa. Diwarisi dari Event.serviceName
slot	Slot yang memicu peristiwa. Diwarisi dari Event.slot

Contoh

JavaScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (lama)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Lihat juga

• Pemroses peristiwa iklan

Properti

---

inViewPercentage

inViewPercentage: number

Persentase area iklan yang terlihat. Nilai adalah angka antara 0 dan 100.

---

googletag.secureSignals

Ini adalah namespace yang digunakan GPT untuk mengelola sinyal aman.

Antarmuka
BidderSignalProvider	Menampilkan sinyal aman untuk bidder tertentu.
PublisherSignalProvider	Menampilkan sinyal aman untuk penayang tertentu.
SecureSignalProvidersArray	Antarmuka untuk mengelola sinyal aman.

Alias Jenis
SecureSignalProvider	Antarmuka untuk menampilkan sinyal aman bagi bidder atau penyedia tertentu.

Alias Jenis

---

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

Antarmuka untuk menampilkan sinyal aman bagi bidder atau penyedia tertentu. Salah satu dari id atau networkCode harus diberikan, tetapi jangan keduanya.

---

googletag.secureSignals.BidderSignalProvider

Menampilkan sinyal aman untuk bidder tertentu.

Penyedia sinyal aman bidder terdiri dari 2 bagian:

1. Fungsi kolektor, yang menampilkan Promise yang di-resolve ke sinyal aman.
2. id yang mengidentifikasi bidder yang terkait dengan sinyal.

Untuk menampilkan sinyal aman bagi penayang, gunakan secureSignals.PublisherSignalProvider.

Properti
collectorFunction	Fungsi yang menampilkan Promise yang me-resolve ke sinyal aman.
id	ID unik untuk pengumpulan yang terkait dengan sinyal aman ini, seperti yang terdaftar di Google Ad Manager.

Contoh

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (lama)

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

Lihat juga

• Membagikan sinyal aman kepada bidder

Properti

---

collectorFunction

collectorFunction: (() => Promise<string>)

Fungsi yang menampilkan Promise yang me-resolve ke sinyal aman.

---

id

id: string

ID unik untuk pengumpulan yang terkait dengan sinyal aman ini, seperti yang terdaftar di Google Ad Manager.

---

googletag.secureSignals.PublisherSignalProvider

Menampilkan sinyal aman untuk penayang tertentu.

Penyedia sinyal penayang terdiri dari 2 bagian:

1. Fungsi kolektor, yang menampilkan Promise yang di-resolve ke sinyal aman.
2. networkCode yang mengidentifikasi penayang yang terkait dengan sinyal.

Untuk menampilkan sinyal aman bagi bidder, gunakan secureSignals.BidderSignalProvider.

Properti
collectorFunction	Fungsi yang menampilkan Promise yang me-resolve ke sinyal aman.
networkCode	Kode jaringan (seperti yang terlihat di jalur unit iklan) untuk penayang yang terkait dengan sinyal aman ini.

Contoh

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (lama)

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// networkCode is provided
googletag.secureSignalProviders!.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

Lihat juga

• Membagikan sinyal aman kepada bidder

Properti

---

collectorFunction

collectorFunction: (() => Promise<string>)

Fungsi yang menampilkan Promise yang me-resolve ke sinyal aman.

---

networkCode

networkCode: string

Kode jaringan (seperti yang terlihat di jalur unit iklan) untuk penayang yang terkait dengan sinyal aman ini.

---

googletag.secureSignals.SecureSignalProvidersArray

Antarmuka untuk mengelola sinyal aman.

Metode
clearAllCache	Menghapus semua sinyal untuk semua kolektor dari cache.
push	Menambahkan secureSignals.SecureSignalProvider baru ke array penyedia sinyal dan memulai proses pembuatan sinyal.

Metode

---

clearAllCache

clearAllCache(): void

Menghapus semua sinyal untuk semua pengumpulan dari cache.

Memanggil metode ini dapat mengurangi kemungkinan sinyal disertakan dalam permintaan iklan untuk kunjungan halaman saat ini dan kemungkinan nanti. Oleh karena itu, metode ini hanya boleh dipanggil saat perubahan status yang signifikan terjadi, seperti peristiwa yang menunjukkan pengguna baru (login, logout, mendaftar, dll.).

---

push

push(provider: SecureSignalProvider): void

Menambahkan secureSignals.SecureSignalProvider baru ke array penyedia sinyal dan memulai proses pembuatan sinyal.

Parameter
provider: SecureSignalProvider	Objek secureSignals.SecureSignalProvider yang akan ditambahkan ke array.