Referensi GPT

Referensi ini menggunakan notasi TypeScript untuk menjelaskan jenis. Tabel berikut memberikan penjelasan singkat melalui contoh.

Ekspresi jenis
string Jenis string primitif.
string[] Jenis array, di mana nilai-nilainya hanya berupa string.
number | string Jenis union, dengan nilai dapat berupa angka atau string.
Array<number | string> Jenis array, dengan nilai adalah jenis kompleks (union).
[number, string] Tipe tuple, di mana nilai adalah array dua elemen yang harus berisi angka dan string dalam urutan tersebut.
Slot Jenis objek, dengan nilainya 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 Panduan TypeScript .

Anotasi Type

Titik dua setelah variabel, nama parameter, nama properti, atau tanda tangan fungsi menunjukkan anotasi jenis. Anotasi jenis menjelaskan jenis yang dapat diterima atau ditampilkan oleh elemen di sebelah kiri titik dua. 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 jika ditentukan. Sintaksis ini digunakan untuk parameter dan properti.
...params: Array<() => void> Menunjukkan bahwa params adalah parameter lainnya yang menerima fungsi. Parameter istirahat menerima jumlah nilai yang tidak terbatas dari jenis yang ditentukan.

Definisi Jenis

Jenis
SingleSize | MultiSize

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

Daftar satu ukuran yang valid.
"fluid" | ["fluid"]

Ukuran yang telah diberi nama dan dapat dimiliki slot. Di kebanyakan kasus, ukuran adalah persegi panjang ukuran tetap, tetapi ada beberapa kasus di mana kita memerlukan jenis spesifikasi ukuran lainnya. Hanya berikut ini yang merupakan ukuran bernama yang valid:

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

Satu ukuran yang valid untuk slot.
[number, number]

Array dua angka yang mewakili [lebar, tinggi].
[SingleSizeArray, GeneralSize]

Pemetaan ukuran area pandang terhadap ukuran iklan. Digunakan untuk iklan responsif.
SizeMapping[]

Daftar pemetaan ukuran.
"unhideWindow" | "navBar"

Pemicu iklan interstisial yang didukung.
"disablePersonalization"

Penanganan privasi penayang yang didukung.
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Taksonomi yang didukung untuk sinyal yang diberikan penayang (PPS).
BidderSignalProvider | PublisherSignalProvider

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

Jenis Enum

Enum
googletag.enums.OutOfPageFormat
Format di luar halaman yang didukung oleh GPT.
googletag.enums.TrafficSource
Sumber traffic yang didukung oleh GPT.

googletag.enums.OutOfPageFormat

  • Format di luar halaman yang didukung oleh GPT.

  • Lihat juga
  • Nilai
    BOTTOM_ANCHOR
    Format anchor dengan slot menempel di bagian bawah area pandang.
    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 menempel di bagian atas area pandang.

googletag.enums.TrafficSource

  • Sumber traffic yang didukung oleh GPT.

  • Lihat juga
  • Nilai
    ORGANIC
    Entri URL langsung, penelusuran situs, atau download aplikasi.
    PURCHASED
    Traffic yang dialihkan dari properti selain yang dimiliki (aktivitas yang diperoleh atau berinsentif).

googletag

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

Ringkasan Variabel
apiReady
Tanda yang menunjukkan bahwa GPT API telah dimuat dan siap dipanggil.
cmd
Rujukan ke antrean perintah global untuk eksekusi asinkron panggilan terkait GPT.
pubadsReady
Tanda yang menunjukkan bahwa PubAdsService telah diaktifkan, dimuat, dan beroperasi penuh.
secureSignalProviders
Referensi ke array penyedia sinyal aman.
Ringkasan Fungsi
companionAds
Menampilkan referensi ke CompanionAdsService.
defineOutOfPageSlot
Membuat slot iklan di luar halaman dengan jalur unit iklan yang ditentukan.
defineSlot
Membuat slot iklan dengan jalur dan ukuran unit iklan tertentu dan mengaitkannya dengan ID elemen div di halaman yang akan berisi iklan.
destroySlots
Menghancurkan slot yang ditentukan, menghapus semua objek terkait dan referensi slot tersebut dari GPT.
disablePublisherConsole
Menonaktifkan Konsol Google Publisher.
display
Instruksikan 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, dari sini dan seterusnya.
setConfig
Menetapkan opsi konfigurasi umum untuk halaman.
sizeMapping
Membuat SizeMappingBuilder baru.

googletag.apiReady

  • apiReady: boolean | undefined

  • Tanda yang menunjukkan bahwa GPT API telah dimuat dan siap dipanggil. Properti ini akan menjadi undefined saja 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 dijamin akan dijalankan setelah API disiapkan.

  • Contoh

    JavaScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    JavaScript (lama)

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    TypeScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

googletag.cmd

  • cmd: Array<(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 tersebut kemudian 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());
});

googletag.pubadsReady

  • pubadsReady: boolean | undefined

  • Tanda yang menunjukkan bahwa PubAdsService telah diaktifkan, dimuat, dan beroperasi penuh. Properti ini hanya akan menjadi undefined hingga enableServices dipanggil dan PubAdsService dimuat dan diinisialisasi.

googletag.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 yang menghasilkan sinyal agar 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

googletag.companionAds

googletag.defineOutOfPageSlot

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

  • Membuat slot iklan di luar halaman dengan jalur unit iklan tertentu.

    Untuk iklan di luar halaman kustom, div adalah ID dari elemen div yang akan berisi iklan. Lihat artikel tentang materi iklan di luar halaman untuk 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
  • Parameter
    adUnitPath: string
    Jalur unit iklan lengkap dengan kode jaringan dan kode unit iklan.
    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.

googletag.defineSlot

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

  • Membuat slot iklan dengan jalur dan ukuran unit iklan tertentu dan 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
  • 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.
    div?: string
    ID div yang akan berisi unit iklan ini.
  • Hasil
    Slot | null
    Slot yang baru dibuat, atau null jika slot tidak dapat dibuat.

googletag.destroySlots

  • destroySlots(slots?: Slot[]): boolean

  • Menghancurkan slot yang ditentukan, menghapus semua objek terkait dan referensi slot tersebut dari GPT. API ini tidak mendukung slot passback dan slot pengiring.

    Memanggil API ini pada 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 belum mengosongkan memori yang terkait dengan slot tersebut jika referensi ke slot tersebut dikelola oleh halaman penerbit. Jika API ini dipanggil, div yang terkait dengan slot tersebut akan tersedia untuk digunakan kembali.

    Secara khusus, penghancuran slot akan menghapus iklan dari kunjungan halaman berdurasi panjang GPT, sehingga permintaan berikutnya tidak akan terpengaruh oleh iklan roadblock atau pengecualian kompetitif yang melibatkan iklan ini. Kegagalan memanggil fungsi ini sebelum menghapus div slot dari halaman akan menghasilkan 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
    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.

googletag.disablePublisherConsole

googletag.display

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

  • Instruksikan layanan slot untuk merender slot. Masing-masing slot iklan hanya boleh ditampilkan sekali per halaman. Semua slot harus ditentukan dan memiliki layanan yang terkait dengannya sebelum ditampilkan. Panggilan tampilan tidak boleh terjadi sampai elemen ada di DOM. Cara umum untuk mencapainya adalah dengan menempatkannya di dalam blok skrip dalam elemen div yang disebutkan dalam panggilan metode.

    Jika arsitektur permintaan tunggal (SRA) 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.

  • Contoh

    JavaScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});

    JavaScript (lama)

    googletag.cmd.push(function () {
  googletag.display("div-1");
});

    TypeScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});
    Lihat juga
  • Parameter
    divOrSlot: string | Element | Slot
    Dapat berupa ID elemen div yang berisi slot iklan atau elemen div, atau objek slot. Jika elemen div diberikan, elemen tersebut harus memiliki atribut 'id' yang cocok dengan ID yang diteruskan ke defineSlot.

googletag.enableServices

  • enableServices(): void

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

googletag.getVersion

  • getVersion(): string

  • Menampilkan versi GPT saat ini.

  • Lihat juga
  • Hasil
    string
    String versi GPT yang sedang dijalankan.

googletag.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
  • Parameter
    div?: string
    ID div slot iklan. Nilai ini bersifat opsional. Jika disediakan, Konsol Publisher akan mencoba membuka dengan menampilkan detail slot iklan yang ditentukan.

googletag.pubads

googletag.setAdIframeTitle

  • setAdIframeTitle(title: string): void

  • Menetapkan judul untuk semua iframe penampung iklan yang dibuat oleh PubAdsService, dari sini 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.

googletag.setConfig

googletag.sizeMapping

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.

Ringkasan Metode
push
Mengeksekusi urutan fungsi yang ditentukan dalam argumen secara berurutan.

push

  • push(...f: Array<(this: typeof globalThis) => void>): number

  • Mengeksekusi 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
    ...f: Array<(this: typeof globalThis) => void>
    Fungsi JavaScript yang akan dieksekusi. Binding runtime akan selalu globalThis. Sebaiknya teruskan fungsi panah untuk mempertahankan nilai this konteks leksikal yang disertakan.
  • Hasil
    number
    Jumlah perintah yang diproses sejauh ini. Nilai ini kompatibel dengan nilai yang ditampilkan Array.push (panjang array saat ini).

googletag.CompanionAdsService

Meluaskan Service

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

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

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 isi ulang. Hanya slot yang juga terdaftar dengan PubAdsService yang akan diisi ulang. Karena pembatasan kebijakan, metode ini tidak didesain 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 otomatis mengisi ulang slot yang tidak terisi, false agar tidak berubah.

googletag.PrivacySettingsConfig

Objek konfigurasi untuk setelan privasi.

Ringkasan Properti
childDirectedTreatment
Menunjukkan apakah halaman harus diperlakukan sebagai ditujukan untuk anak-anak.
limitedAds
Memungkinkan penayangan berjalan dalam mode iklan terbatas guna membantu memenuhi kebutuhan kepatuhan terhadap peraturan penayang.
nonPersonalizedAds
Memungkinkan penayangan berjalan dalam mode iklan yang tidak dipersonalisasi untuk membantu memenuhi kebutuhan kepatuhan terhadap 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 permintaan iklan akan ditandai sebagai berasal dari pengguna di bawah usia dewasa.
Lihat juga

childDirectedTreatment

limitedAds

  • limitedAds: boolean

  • Memungkinkan penayangan berjalan dalam mode iklan terbatas guna membantu memenuhi kebutuhan kepatuhan terhadap peraturan penayang. Jika diaktifkan, library GPT itu sendiri dapat diminta secara opsional dari URL iklan terbatas tanpa cookie.

  • Lihat juga

nonPersonalizedAds

  • nonPersonalizedAds: boolean

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

restrictDataProcessing

  • restrictDataProcessing: boolean

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

trafficSource

  • trafficSource: TrafficSource

  • Menunjukkan apakah permintaan mewakili traffic yang dibeli atau organik. Nilai ini mengisi dimensi Sumber traffic di pelaporan Ad Manager. Jika tidak disetel, 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,
});

underAgeOfConsent

  • underAgeOfConsent: null | boolean

  • Menunjukkan apakah permintaan iklan akan ditandai sebagai berasal dari pengguna di bawah usia dewasa. Setel ke null untuk menghapus konfigurasi.

googletag.PubAdsService

Meluaskan Service

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

Ringkasan Metode
addEventListener
Mendaftarkan pemroses yang memungkinkan Anda menyiapkan dan memanggil fungsi JavaScript saat peristiwa GPT tertentu terjadi di halaman.
clear
Menghapus iklan dari slot tertentu 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 slot agar tidak memakan ruang di halaman saat tidak ada konten iklan untuk ditampilkan.
disableInitialLoad
Menonaktifkan permintaan iklan saat pemuatan halaman, tetapi mengizinkan iklan untuk diminta dengan panggilan PubAdsService.refresh.
display
Membuat dan menampilkan slot iklan dengan jalur dan ukuran unit iklan yang ditentukan.
enableLazyLoad
Mengaktifkan pemuatan lambat di GPT seperti yang ditentukan oleh objek konfigurasi.
enableSingleRequest
Mengaktifkan mode permintaan tunggal untuk mengambil beberapa iklan sekaligus.
enableVideoAds
Memberikan sinyal ke GPT bahwa iklan video akan ditayangkan di halaman.
get
Menampilkan nilai untuk atribut AdSense yang terkait dengan kunci yang diberikan.
getAttributeKeys
Menampilkan kunci atribut yang telah ditetapkan pada layanan ini.
getSlots
Mendapatkan daftar slot yang terkait dengan layanan ini.
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 tertentu atau semua slot di halaman.
removeEventListener
Menghapus pemroses yang terdaftar sebelumnya.
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 tertentu.
setCentering
Mengaktifkan dan menonaktifkan posisi tengah horizontal iklan.
setForceSafeFrame
Mengonfigurasi apakah semua iklan di halaman harus dipaksa 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
Menyetel 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 bersama permintaan iklan, yang secara efektif memulai kunjungan halaman baru.

clear

  • clear(slots?: Slot[]): boolean

  • Menghapus iklan dari slot tertentu dan menggantinya dengan konten kosong. Slot akan ditandai sebagai belum diambil.

    Secara khusus, menghapus slot akan menghapus iklan dari kunjungan halaman berdurasi panjang GPT, sehingga permintaan berikutnya tidak akan terpengaruh oleh iklan roadblock 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
    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
  • 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
  • Parameter
    key?: string
    Kunci parameter penargetan. Kunci ini bersifat opsional; semua parameter penargetan akan dihapus jika tidak ditentukan.
  • Hasil
    PubAdsService
    Objek layanan tempat metode dipanggil.

collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

  • Mengaktifkan penciutan slot agar tidak memakan ruang di halaman saat tidak ada konten iklan untuk ditampilkan. Mode ini harus ditetapkan sebelum layanan diaktifkan.

  • Lihat juga
  • Parameter
    collapseBeforeAdFetch?: boolean
    Apakah slot akan diciutkan bahkan sebelum iklan diambil. Parameter ini bersifat opsional; jika tidak diberikan, false akan digunakan sebagai nilai default.
  • Hasil
    boolean
    Menampilkan true jika mode penciutan div diaktifkan dan false jika tidak memungkinkan untuk mengaktifkan mode penciutan karena metode ini dipanggil setelah layanan diaktifkan.

disableInitialLoad

display

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

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

    Catatan: Saat metode ini dipanggil, snapshot status slot dan halaman akan dibuat untuk memastikan konsistensi saat mengirim permintaan iklan dan merender respons. Setiap perubahan yang dibuat pada status slot atau halaman setelah metode ini dipanggil (termasuk penargetan, setelan privasi, force 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
  • Parameter
    adUnitPath: string
    Jalur unit iklan slot yang akan dirender.
    size: GeneralSize
    Lebar dan tinggi slot.
    div?: string | Element
    Baik ID div yang berisi slot atau elemen div itu sendiri.
    clickUrl?: string
    URL klik yang akan digunakan pada 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
  • Parameter
    config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
    Objek konfigurasi memungkinkan penyesuaian perilaku lambat. Konfigurasi yang dihilangkan akan menggunakan setelan default oleh Google yang akan disesuaikan seiring waktu. Untuk menonaktifkan setelan tertentu, seperti margin pengambilan, setel nilai ke -1.
    • fetchMarginPercent

      Jarak minimum slot dari area pandang saat ini harus sebelum kita mengambil iklan sebagai persentase ukuran area pandang. Nilai 0 berarti "saat slot memasuki area pandang", 100 berarti "saat iklan berada sejauh 1 area pandang", dan seterusnya.
    • renderMarginPercent

      Jarak minimum slot dari area pandang saat ini harus sebelum kita merender iklan. Hal ini memungkinkan pengambilan data iklan, tetapi menunggu untuk merender dan mendownload subresource lainnya. Nilainya berfungsi seperti fetchMarginPercent sebagai persentase area tampilan.
    • mobileScaling

      Pengganda diterapkan pada margin di perangkat seluler. Hal ini memungkinkan margin yang berbeda-beda di perangkat seluler vs. desktop. Misalnya, nilai 2,0 akan mengalikan semua margin dengan 2 pada perangkat seluler, sehingga meningkatkan jarak minimum slot sebelum pengambilan dan rendering.

enableSingleRequest

  • enableSingleRequest(): boolean

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

  • Lihat juga
  • Hasil
    boolean
    Menampilkan true jika mode permintaan tunggal diaktifkan, dan false jika tidak mungkin mengaktifkan mode permintaan tunggal karena metode ini dipanggil setelah layanan diaktifkan.

enableVideoAds

  • enableVideoAds(): void

  • Memberikan sinyal ke GPT bahwa iklan video akan ditayangkan di halaman. Tindakan ini akan mengaktifkan 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
  • 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 pada 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 pada 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 harus 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

refresh

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

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

    Untuk perilaku yang sesuai di semua browser, pemanggilan refresh harus diawali dengan panggilan ke display slot iklan. Jika panggilan ke display dihilangkan, pemuatan ulang mungkin menampilkan perilaku yang tidak terduga. Jika diinginkan, metode PubAdsService.disableInitialLoad dapat digunakan untuk menghentikan display agar tidak mengambil iklan.

    Memperbarui slot akan menghapus iklan lama dari kunjungan halaman berdurasi panjang GPT, sehingga permintaan berikutnya tidak akan terpengaruh oleh iklan roadblock 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
  • Parameter
    slots?: null | Slot[]
    Slot yang akan dimuat ulang. Array bersifat opsional; semua slot akan dimuat ulang jika tidak ditentukan.
    options?: { changeCorrelator: boolean }
    Opsi konfigurasi yang terkait dengan panggilan pembaruan ini.
    • changeCorrelator

      Menentukan apakah korelator baru akan dibuat untuk mengambil iklan atau tidak. Server iklan kami mempertahankan nilai korelator ini sebentar (saat ini selama 30 detik, tetapi dapat berubah sewaktu-waktu), sehingga permintaan dengan korelator yang sama yang diterima berdekatan akan dianggap sebagai kunjungan halaman tunggal. Secara default, korelator baru dihasilkan untuk setiap pemuatan ulang.

      Catatan: opsi ini tidak berpengaruh pada kunjungan halaman berdurasi panjang di GPT, yang 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.

    Memanggil 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

    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
  • 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 tertentu.

  • 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
  • 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 posisi tengah horizontal iklan. Pemusatan dinonaktifkan secara default. Dalam 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 menempatkan iklan di tengah, false untuk meratakannya ke kiri.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

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

    Perhatikan hal-hal berikut saat menggunakan API ini:

    • Setelan ini hanya akan berlaku untuk permintaan iklan berikutnya yang dibuat untuk masing-masing slot.
    • Setelan tingkat slot, jika ditentukan, akan selalu mengganti 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 API ini 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
  • Parameter
    forceSafeFrame: boolean
    true untuk memaksa semua iklan di halaman dirender di SafeFrame dan false mengubah setelan sebelumnya ke salah (false). Menyetel 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

  • Mengizinkan 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
  • 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
  • Parameter
    ppid: string
    ID alfanumerik yang diberikan oleh penayang. Harus berisi 32 hingga 150 karakter.
  • Hasil
    PubAdsService
    Objek layanan tempat metode dipanggil.

setSafeFrameConfig

  • setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

  • Menyetel preferensi tingkat halaman untuk konfigurasi SafeFrame. Kunci 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
  • 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 ditetapkan 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
  • Parameter
    key: string
    Kunci parameter penargetan.
    value: string | string[]
    Menargetkan nilai parameter 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 diaktifkan secara otomatis saat metode ini dipanggil. Untuk videoContentId dan videoCmsId, gunakan nilai yang diberikan ke layanan penyerapan konten Google Ad Manager.

  • Lihat juga
  • Parameter
    videoContentId: string
    ID konten video.
    videoCmsId: string
    ID CMS video.

updateCorrelator

  • updateCorrelator(): PubAdsService

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

    Catatan: ini tidak memengaruhi kunjungan halaman berdurasi panjang GPT, yang otomatis mencerminkan iklan sebenarnya 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.

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

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

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

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.

Ringkasan Properti
allowOverlayExpansion
Apakah SafeFrame akan mengizinkan konten iklan untuk diperluas dengan menempatkan konten halaman.
allowPushExpansion
Apakah SafeFrame akan mengizinkan konten iklan untuk diperluas dengan mengirim 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

allowOverlayExpansion

  • allowOverlayExpansion: boolean

  • Apakah SafeFrame akan mengizinkan konten iklan untuk diperluas dengan menempatkan konten halaman.

allowPushExpansion

  • allowPushExpansion: boolean

  • Apakah SafeFrame akan mengizinkan konten iklan untuk diperluas dengan mengirim konten halaman.

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).

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.

  • Lihat juga

googletag.Service

Class layanan dasar yang berisi metode umum untuk semua layanan.

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

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:

    Objek dengan 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
  • 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 argumen objek peristiwa tunggal.
  • Hasil
    Service
    Objek layanan tempat metode dipanggil.

getSlots

  • getSlots(): Slot[]

  • Mendapatkan 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 argumen objek peristiwa tunggal.

googletag.SizeMappingBuilder

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

Ringkasan Metode
addSize
Menambahkan pemetaan dari array ukuran tunggal (mewakili area tampilan) ke array satu atau beberapa ukuran yang mewakili slot.
build
Membuat spesifikasi peta ukuran dari pemetaan yang ditambahkan ke builder ini.
Lihat juga

addSize

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

  • Menambahkan pemetaan dari array ukuran tunggal (mewakili area tampilan) ke array satu atau beberapa 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 untuk builder ini.

build

  • build(): null | SizeMappingArray

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

    Jika ada pemetaan yang tidak valid yang 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. Boleh null jika pemetaan ukuran yang tidak valid diberikan.

googletag.Slot

Slot adalah objek yang mewakili satu slot iklan pada halaman.

Ringkasan Metode
addService
Menambahkan Service ke slot ini.
clearCategoryExclusions
Menghapus semua label pengecualian kategori iklan tingkat slot untuk slot ini.
clearTargeting
Menghapus parameter penargetan tingkat slot tertentu atau semua kustom untuk slot ini.
defineSizeMapping
Menetapkan array pemetaan dari ukuran area pandang minimum ke ukuran slot untuk slot ini.
get
Menampilkan nilai 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 disetel pada 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 pada slot ini.
getTargetingKeys
Menampilkan daftar semua kunci penargetan khusus yang ditetapkan pada slot ini.
set
Menetapkan nilai untuk atribut AdSense pada slot iklan ini.
setCategoryExclusion
Menetapkan label pengecualian kategori iklan tingkat slot pada slot ini.
setClickUrl
Menetapkan URL klik tempat pengguna akan dialihkan setelah mengklik iklan.
setCollapseEmptyDiv
Menetapkan apakah slot div harus disembunyikan jika tidak ada iklan dalam slot.
setConfig
Menetapkan opsi konfigurasi umum untuk slot ini.
setForceSafeFrame
Mengonfigurasi apakah iklan dalam slot ini harus dirender secara paksa menggunakan penampung SafeFrame.
setSafeFrameConfig
Menyetel preferensi tingkat slot untuk konfigurasi SafeFrame.
setTargeting
Menetapkan parameter penargetan kustom untuk slot ini.
updateTargetingFromMap
Menetapkan parameter penargetan kustom untuk slot ini, dari peta key:value dalam objek JSON.

addService

  • addService(service: Service): Slot

  • Menambahkan Service 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
  • 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 tertentu atau semua kustom 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
  • Parameter
    key?: string
    Kunci parameter penargetan. Kunci ini 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
  • Parameter
    sizeMapping: SizeMappingArray
    Array pemetaan ukuran. Anda dapat menggunakan SizeMappingBuilder untuk membuatnya. Setiap pemetaan ukuran merupakan array dari dua elemen: SingleSizeArray dan GeneralSize.
  • Hasil
    Slot
    Objek slot tempat metode dipanggil.

get

  • get(key: string): null | string

  • Menampilkan nilai 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
  • 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 disetel pada 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 ini 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-1'.

    JavaScript (lama)

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

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

    TypeScript

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

slot.getSlotElementId();
// Returns 'div-1'.
  • Hasil
    string
    ID slot div.

getTargeting

  • getTargeting(key: string): string[]

  • Menampilkan parameter penargetan kustom tertentu yang ditetapkan pada 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 harus 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 khusus yang ditetapkan pada 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 pada slot iklan ini. Tindakan ini akan mengganti nilai apa pun yang disetel pada 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
  • 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 pada 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
  • Parameter
    categoryExclusion: string
    Label pengecualian kategori iklan yang akan ditambahkan.
  • Hasil
    Slot
    Objek slot tempat metode dipanggil.

setClickUrl

  • setClickUrl(value: string): Slot

  • Menyetel 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 ditambahkan ke nilai yang diberikan. Panggilan berikutnya akan menimpa nilai tersebut. 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 dalam slot. Tindakan ini akan mengganti 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
  • Parameter
    collapse: boolean
    Apakah slot akan diciutkan jika tidak ada iklan yang ditampilkan.
    collapseBeforeAdFetch?: boolean
    Apakah slot akan diciutkan bahkan sebelum iklan diambil. Diabaikan jika penciutan bukan true.
  • Hasil
    Slot
    Objek slot tempat metode dipanggil.

setConfig

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): Slot

  • Mengonfigurasi apakah iklan dalam slot ini harus dipaksa dirender menggunakan penampung SafeFrame.

    Perhatikan hal-hal berikut saat menggunakan API ini:

    • Setelan ini hanya akan berlaku untuk permintaan iklan berikutnya yang dibuat untuk masing-masing slot.
    • Setelan tingkat slot, jika ditentukan, akan selalu mengganti 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 API ini 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
  • Parameter
    forceSafeFrame: boolean
    true untuk memaksa semua iklan dalam slot ini dirender di SafeFrame dan false untuk memilih tidak menggunakan setelan tingkat halaman (jika ada). Menyetel ini ke false saat tidak ditentukan di tingkat halaman tidak akan mengubah apa pun.
  • Hasil
    Slot
    Objek slot tempat metode dipanggil.

setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig): Slot

  • Menyetel preferensi tingkat slot untuk konfigurasi SafeFrame. Kunci 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 apa pun.

  • 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
  • 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 pada tingkat layanan. Kunci ini ditetapkan 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
  • Parameter
    key: string
    Kunci parameter penargetan.
    value: string | string[]
    Menargetkan nilai parameter 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 key:value dalam objek JSON. Ini sama dengan memanggil Slot.setTargeting untuk semua nilai kunci objek. Kunci ini ditetapkan di akun Google Ad Manager Anda.

    Catatan:

    • Jika terjadi penimpaan, hanya nilai terakhir yang akan dipertahankan.
    • Jika nilai adalah array, nilai sebelumnya akan ditimpa, bukan digabungkan.
    • Nilai yang ditetapkan di sini akan menimpa parameter penargetan yang ditetapkan pada 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[] }
    Parameter penargetan key:value map.
  • Hasil
    Slot
    Objek slot tempat metode dipanggil.

googletag.config.AdExpansionConfig

Setelan untuk mengontrol perluasan iklan.

Ringkasan 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 },
});

enabled

googletag.config.ComponentAuctionConfig

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

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

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

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, konfigurasi terakhir yang ditetapkan akan menimpa konfigurasi sebelumnya.

googletag.config.InterstitialConfig

Objek yang menentukan perilaku satu slot iklan interstisial.

Ringkasan Properti
triggers
Konfigurasi pemicu interstisial untuk iklan interstisial ini.

triggers

  • triggers: Partial<Record<InterstitialTrigger, boolean>>

  • Konfigurasi pemicu interstisial untuk iklan interstisial ini.

    Menetapkan nilai pemicu interstisial ke true akan mengaktifkannya dan false akan menonaktifkannya. 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

googletag.config.PageSettingsConfig

Antarmuka konfigurasi utama untuk setelan tingkat halaman.

Memungkinkan setelan beberapa fitur dengan satu panggilan API.

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

Contoh:

  • Hanya fitur yang ditentukan dalam panggilan 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 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,
  });

Ringkasan Properti
adExpansion
Setelan untuk mengontrol perluasan iklan.
pps
Setelan untuk mengontrol sinyal yang diberikan penayang (PPS).
privacyTreatments
Setelan untuk mengontrol perlakuan privasi penayang.

adExpansion

pps

privacyTreatments

googletag.config.PrivacyTreatmentsConfig

Setelan untuk mengontrol perlakuan privasi penayang.

Ringkasan Properti
treatments
Array perlakuan privasi penayang untuk mengaktifkan.

treatments

  • treatments: "disablePersonalization"[]

  • Array perlakuan privasi penayang untuk mengaktifkan.

  • 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).

Ringkasan Properti
taxonomies
Objek yang berisi pemetaan Taksonomi.
Contoh

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '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 | 18-20'
      // '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 | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
Lihat juga

taxonomies

googletag.config.SlotSettingsConfig

Antarmuka konfigurasi utama untuk setelan tingkat slot.

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

Semua properti yang tercantum di bawah ini adalah contoh dan tidak mencerminkan fitur aktual 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,
  });

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

adExpansion

componentAuction

  • componentAuction: ComponentAuctionConfig[]

  • Rangkaian lelang komponen yang akan disertakan dalam lelang iklan di perangkat.

interstitial

  • interstitial: InterstitialConfig

  • Setelan yang mengontrol perilaku slot iklan interstisial.

googletag.config.TaxonomyData

Objek yang berisi nilai untuk Taksonomi tunggal.

Ringkasan Properti
values
Daftar nilai Taksonomi.

values

googletag.events.Event

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

Ringkasan Properti
serviceName
Nama layanan yang memicu peristiwa.
slot
Slot yang memicu peristiwa.
Lihat juga

serviceName

  • serviceName: string

  • Nama layanan yang memicu peristiwa.

slot

  • slot: Slot

  • Slot yang memicu peristiwa.

googletag.events.EventTypeMap

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

Ringkasan Properti
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
slotOnload
Alias untuk events.SlotOnloadEvent.
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotVisibilityChanged

googletag.events.ImpressionViewableEvent

Meluaskan Event

Peristiwa ini diaktifkan saat tayangan terlihat, sesuai dengan kriteria Tampilan Aktif.

Ringkasan Properti
serviceName
Nama layanan yang memicu peristiwa.
slot
Slot yang memicu peristiwa.
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

googletag.events.RewardedSlotClosedEvent

Meluaskan Event

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

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

JavaScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

googletag.events.RewardedSlotGrantedEvent

Meluaskan Event

Peristiwa ini diaktifkan saat reward diberikan karena telah melihat iklan reward. Jika iklan ditutup sebelum kriteria pemberian reward terpenuhi, peristiwa ini tidak akan diaktifkan.

Ringkasan Properti
payload
Objek yang berisi informasi tentang reward yang diberikan.
serviceName
Nama layanan yang memicu peristiwa.
slot
Slot yang memicu peristiwa.
Contoh

JavaScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

payload

  • payload: null | RewardedPayload

  • Objek yang berisi informasi tentang reward yang diberikan.

googletag.events.RewardedSlotReadyEvent

Meluaskan Event

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

Ringkasan Properti
serviceName
Nama layanan yang memicu peristiwa.
slot
Slot yang memicu peristiwa.
Ringkasan Metode
makeRewardedVisible
Menampilkan iklan reward.
Contoh

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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.defineSlot("/1234567/example", [160, 600]);
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.defineSlot("/1234567/example", [160, 600]);
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

makeRewardedVisible

  • makeRewardedVisible(): void

  • Menampilkan iklan reward. Metode ini tidak boleh dipanggil sampai pengguna memberikan izin untuk melihat iklan.

googletag.events.SlotOnloadEvent

Meluaskan Event

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

Ringkasan Properti
serviceName
Nama layanan yang memicu peristiwa.
slot
Slot yang memicu peristiwa.
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

googletag.events.SlotRenderEndedEvent

Meluaskan Event

Peristiwa ini akan diaktifkan 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 referensi materi iklan untuk slot telah selesai dimuat, pertimbangkan events.SlotOnloadEvent.

Ringkasan Properti
advertiserId
ID Pengiklan dari 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 merupakan iklan pengisian ulang.
isEmpty
Apakah iklan ditampilkan untuk slot.
labelIds
ID label iklan yang dirender.
lineItemId
ID item baris dari iklan reservasi yang dirender.
serviceName
Nama layanan yang memicu peristiwa.
size
Menunjukkan ukuran piksel materi iklan yang dirender.
slot
Slot yang memicu peristiwa.
slotContentChanged
Apakah konten slot diubah dengan iklan yang dirender.
sourceAgnosticCreativeId
ID materi iklan iklan reservasi atau pengisian ulang yang dirender.
sourceAgnosticLineItemId
ID item baris iklan reservasi atau pengisian ulang 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("Label IDs:", event.labelIds);
  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("Label IDs:", event.labelIds);
  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("Label IDs:", event.labelIds);
  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

advertiserId

  • advertiserId: null | number

  • ID Pengiklan dari iklan yang dirender. Nilai 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. Nilai 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. Nilai 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. Nilai 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. Nilai adalah null untuk slot kosong, iklan pengisian ulang, dan materi iklan yang dirender oleh layanan selain PubAdsService.

isBackfill

  • isBackfill: boolean

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

isEmpty

  • isEmpty: boolean

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

labelIds

  • labelIds: null | number[]

  • ID label iklan yang dirender. Nilai adalah null untuk slot kosong, iklan pengisian ulang, dan materi iklan yang dirender oleh layanan selain PubAdsService.

lineItemId

  • lineItemId: null | number

  • ID item baris dari iklan reservasi yang dirender. Nilai 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 yang kosong.

slotContentChanged

  • slotContentChanged: boolean

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

sourceAgnosticCreativeId

  • sourceAgnosticCreativeId: null | number

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

sourceAgnosticLineItemId

  • sourceAgnosticLineItemId: null | number

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

yieldGroupIds

  • yieldGroupIds: null | number[]

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

googletag.events.SlotRequestedEvent

Meluaskan Event

Peristiwa ini aktif saat iklan telah diminta untuk slot tertentu.

Ringkasan Properti
serviceName
Nama layanan yang memicu peristiwa.
slot
Slot yang memicu peristiwa.
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

googletag.events.SlotResponseReceived

Meluaskan Event

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

Ringkasan Properti
serviceName
Nama layanan yang memicu peristiwa.
slot
Slot yang memicu peristiwa.
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

googletag.events.SlotVisibilityChangedEvent

Meluaskan Event

Peristiwa ini diaktifkan setiap kali persentase area slot iklan di layar berubah. Peristiwa ini di-throttle dan tidak akan aktif lebih dari sekali setiap 200 md.

Ringkasan Properti
inViewPercentage
Persentase area iklan yang terlihat.
serviceName
Nama layanan yang memicu peristiwa.
slot
Slot yang memicu peristiwa.
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

inViewPercentage

  • inViewPercentage: number

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

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 menjadi sinyal aman.
  2. id yang mengidentifikasi bidder yang terkait dengan sinyal.
Untuk menampilkan sinyal aman bagi penayang, gunakan secureSignals.PublisherSignalProvider.

Ringkasan Properti
collectorFunction
.
id
ID unik untuk kolektor 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

collectorFunction

  • collectorFunction: () => Promise<string>

id

  • id: string

  • ID unik untuk kolektor 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 menjadi sinyal aman.
  2. networkCode yang mengidentifikasi penayang yang terkait dengan sinyal.
Untuk menampilkan sinyal aman bagi bidder, gunakan secureSignals.BidderSignalProvider.

Ringkasan Properti
collectorFunction
.
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

collectorFunction

  • collectorFunction: () => Promise<string>

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.

Ringkasan Metode
clearAllCache
Menghapus semua sinyal yang di-cache dari penyimpanan lokal.
push
Menambahkan secureSignals.SecureSignalProvider baru ke array penyedia sinyal dan memulai proses pembuatan sinyal.

clearAllCache

  • clearAllCache(): void

  • Menghapus semua sinyal yang di-cache dari penyimpanan lokal.

push