Referensi

Parameter

Deskripsi Parameter Tingkat Halaman

Parameter ini hanya perlu ditentukan sekali per halaman. Pengaruh tersebut memengaruhi semua unit di halaman.

Wajib

Parameter Deskripsi dan Contoh
adPage Diperlukan saat pengguna membuka halaman hasil berikutnya atau halaman hasil sebelumnya.

Parameter adPage menentukan tempat iklan halaman hasil ditampilkan. Parameter ini digunakan saat pengguna membuka halaman setelah halaman pertama hasil penelusuran. Misalnya, jika lima iklan diminta, dan parameter adPage ditetapkan ke 2, iklan yang ditampilkan akan menjadi halaman kedua dari lima iklan.

pubId Wajib
Ini adalah client ID AdSense Anda. pubId Anda adalah bagian dari client-ID yang muncul setelah 'partner-'. Misalnya, jika client-ID Anda adalah 'partner-test-property', pubId Anda adalah 'test-property'. Ini adalah protokol standar untuk CSA.

Contoh:

'pubId' : 'test-property'

query Wajib, kecuali di halaman Konten Penelusuran Terkait.
Ini adalah kueri penelusuran yang dimasukkan oleh pengguna. Nilai parameter kueri tidak boleh dienkode.

Catatan: Menggunakan parameter ini di Penelusuran Terkait di halaman Konten akan menyebabkan hasil yang tidak diharapkan.

Contoh:

'query' : 'flowers'
'query' : 'black & decker'
'query' : myQuery // myQuery is a variable containing the search query

resultsPageBaseUrl Wajib diisi jika ada unit penelusuran terkait di halaman.
Menentukan URL halaman hasil penelusuran tempat kueri penelusuran merupakan istilah penelusuran terkait yang diklik pengguna. resultsPageBaseUrl dapat menyertakan parameternya sendiri, kecuali kueri penelusuran yang akan ditambahkan secara otomatis.

Contoh:

'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2'

styleId Wajib
Menentukan ID gaya penelusuran khusus yang akan diterapkan ke iklan atau unit penelusuran terkait di halaman. Pelajari lebih lanjut cara menggunakan gaya penelusuran kustom. Perhatikan bahwa jika styleId ditetapkan untuk sebuah permintaan, iklan atau penelusuran terkait akan dirender dengan gaya tersebut, dan parameter gaya lama akan diabaikan. Jika styleId tidak ditentukan dalam permintaan, gaya default sistem akan dirender.

Contoh:

'styleId': '1234567890'

Opsional

Parameter Deskripsi dan Contoh
linkTarget Opsional
Menentukan apakah klik pada iklan akan terbuka di jendela yang sama atau jendela baru. Defaultnya adalah '_top'. Parameter ini juga dapat digunakan di tingkat unit.
  • '_top' Terbuka di jendela yang sama.
  • '_blank' Terbuka di jendela baru.

Contoh:

'linkTarget' : '_blank'

maxTermLength Opsional
Menentukan jumlah karakter maksimum dari istilah penelusuran terkait termasuk spasi. Tidak ada jumlah maksimum jika tidak ditetapkan.

Contoh:

'maxTermLength' : 50

referrerAdCreative Opsional
Jika pengguna membuka halaman konten Anda yang berisi unit Penelusuran Terkait untuk Konten dengan mengklik iklan atau link di situs lain, dan iklan atau link tersebut berada di bawah kontrol Anda, parameter ini harus ditetapkan ke teks materi iklan dari iklan atau link tersebut kata demi kata.

Panduan berikut berlaku untuk penggunaan parameter ini:

  • Parameter hanya boleh diberikan pada permintaan Penelusuran Terkait untuk Konten, dan akan diabaikan pada semua permintaan lainnya.
  • Solusi ini hanya boleh digunakan pada traffic yang sengaja Anda ambil dari situs lain, dan tidak boleh digunakan pada traffic organik.
  • Harus menyertakan baris judul dan/atau deskripsi iklan atau materi iklan link.
  • Menyertakan nilai yang bukan bagian dari materi iklan link atau iklan dianggap melanggar petunjuk tertulis ini.
  • Tidak peka huruf besar/kecil.
  • Metode ini menerima encoding UTF-8 yang valid; karakter unicode / diakritik didukung.
  • Google dapat menggunakan atau mengabaikan parameter yang Anda kirimkan. Jika digunakan, atribut ini dapat memengaruhi pemilihan dan peringkat istilah.

Catatan: Parameter ini wajib saat menggunakan parameter terms.

Contoh:

'referrerAdCreative': 'search for ads related to dental implants'

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'

resultsPageQueryParam Opsional
Menentukan nama parameter URL untuk kueri penelusuran di halaman hasil penelusuran. Jika tidak ditentukan, setelan default-nya adalah 'q'.

Contoh:

'resultsPageQueryParam' : 'query'

terms Opsional
Parameter ini memungkinkan Anda memberikan daftar istilah penelusuran terkait Anda sendiri yang dipisahkan koma untuk ditampilkan bersama permintaan penelusuran terkait, meskipun Google mungkin atau mungkin tidak menggunakan istilah yang disediakan di sini.

Catatan: Saat menggunakan parameter ini, referrerAdCreative juga diperlukan.

Contoh:

'terms' : 'cars rental, flight ticket'

ignoredPageParams Opsional
Menentukan daftar parameter URL untuk halaman konten dengan unit Penelusuran Terkait untuk Konten yang dapat diabaikan dengan aman tanpa memengaruhi konten inti atau pengalaman pengguna.

Catatan: Produk Penelusuran Terkait di Konten mengandalkan sistem crawling konten Google untuk mengindeks halaman dan membuat istilah penelusuran yang relevan. URL halaman konten yang berisi parameter kueri seperti variabel pelacakan, ID pengguna, ID sesi, atau ID dinamis lainnya dapat mengganggu kemampuan crawler untuk menilai konten inti halaman dan dapat menyebabkan istilah penelusuran terkait yang tidak akurat atau tidak relevan. Parameter halaman ini menginstruksikan crawler Google untuk mengabaikan parameter yang tidak penting ini, memastikan pengindeksan konten yang tepat dan mengurangi beban crawling yang tidak perlu. Hal ini memungkinkan Google mengenali halaman sebagai telah di-crawl dan mulai menampilkan istilah yang disarankan (baik Google maupun partner, jika memenuhi syarat).

Panduan berikut berlaku untuk penggunaan parameter ini:

  • Parameter hanya boleh diberikan pada permintaan Penelusuran Terkait untuk Konten, dan akan diabaikan pada semua permintaan lainnya.
  • Nilai parameter ini harus berupa daftar parameter URL yang dipisahkan koma dan dapat muncul saat pengguna membuka halaman konten.
  • Hal ini bersifat peka huruf besar atau kecil.
  • Jika parameter URL apa pun dari daftar ini dihapus dari URL halaman konten, konten, tampilan, atau pengalaman pengguna halaman tidak akan terpengaruh secara signifikan.
  • Penyertaan parameter URL yang berdampak signifikan pada konten halaman, tampilan, atau pengalaman pengguna dianggap sebagai pelanggaran terhadap petunjuk tertulis ini.
  • Google akan secara berkala memverifikasi dampak pengabaian parameter URL yang diberikan.

Contoh:
Pengguna mengunjungi halaman konten dan tempat URL-nya berada:

http://example.com/content?utm_medium=social&page_id=123&click_id=456
Memberikan parameter URL yang dapat diabaikan berikut:
'ignoredPageParams' : 'utm_medium,click_id,session_ref'
Akan memperlakukan URL halaman konten sebagai:
http://example.com/content?page_id=123

Setelan Konfigurasi

Parameter Deskripsi dan Contoh
adsafe Opsional
Menentukan aturan pemfilteran yang harus diterapkan Google pada iklan yang cocok dengan kueri penelusuran. Berikut adalah setelan valid untuk adsafe dan dampak dari setiap nilai pada iklan yang ditampilkan:
  • 'high' Menampilkan iklan yang cocok bagi keluarga. Tidak menampilkan iklan yang tidak cocok bagi keluarga atau yang berisi konten seksual dewasa.
  • 'medium' Menampilkan iklan yang cocok bagi keluarga dan yang tidak cocok bagi keluarga. Tidak menampilkan iklan konten seksual dewasa.
  • 'low' Menampilkan semua jenis iklan.

Secara default, adsafe ditetapkan ke tinggi.

Contoh:

'adsafe': 'medium'

adtest Opsional
Parameter adtest digunakan untuk menunjukkan bahwa permintaan untuk iklan adalah sebuah pengujian. Jika parameter adtest memiliki nilai on, Google akan memperlakukan permintaan tersebut sebagai pengujian dan tidak menghitung tayangan iklan atau melacak hasil klik-tayang.

Jika parameter adtest memiliki nilai on, Anda tidak menghasilkan pendapatan apa pun.

Gunakan parameter ini saat melakukan pengujian, tetapi jangan gunakan parameter ini dalam sistem produksi, atau Anda tidak akan dibayar untuk iklan yang Anda tampilkan.

Nilai adtest default nonaktif.

Contoh:

'adtest' : 'on'

channel Opsional
Anda dapat menyertakan saluran AdSense untuk Penelusuran untuk melacak performa berbagai halaman. Gunakan ID channel unik yang dibuat di akun AdSense atau oleh Manajer Akun Teknis Anda. Pelajari channel lebih lanjut di sini.

Beberapa saluran harus dipisahkan dengan simbol '+'.

Contoh:

'channel' :  'testA'  
'channel' :  'testA+testB'  

hl Opsional
Parameter ini mengidentifikasi bahasa yang harus ditarget oleh iklan yang diminta atau penelusuran terkait. Nilai defaultnya adalah en.

Google mendukung semua kode bahasa AdWords API.

Catatan: Pengiklan menentukan bahasa yang ditargetkan iklannya. Jika Anda menyertakan parameter ini dalam permintaan Anda, Google hanya menampilkan iklan yang ditargetkan untuk bahasa tersebut atau untuk semua bahasa, tetapi tidak menjamin bahwa teks iklan akan menggunakan bahasa yang ditentukan.

Biasanya, Anda harus menetapkan parameter hl ke bahasa utama halaman asal parameter ini dikirim.

Contoh:

'hl' : 'es'

ie Opsional

Parameter ie menetapkan skema encoding karakter yang harus digunakan untuk menafsirkan string kueri.

Nilai ie default adalah utf-8.

Nilai Nama standar Bahasa Terkait yang Didukung
latin1 ISO-8859-1 Eropa Barat (Katala, Denmark, Belanda, Inggris, Finlandia, Prancis, Jerman, Indonesia, Italia, Norwegia, Portugis, Spanyol, Swedia)
latin2 ISO-8859-2 Eropa Timur (Kroasia, Ceko, Hungaria, Polandia, Rumania, Serbia, Slovakia, Slovenia)
latin3 ISO-8859-3  
latin4 ISO-8859-4 Baltik (Estonia, Latvia, Lituania)
sirilik ISO-8859-5 Bulgaria, Rusia
arab ISO-8859-6  
Yunani ISO-8859-7 Yunani
ibrani ISO-8859-8 Ibrani
latin5 ISO-8859-9  
latin6 ISO-8859-10 Islan
euc-jp EUC-JP Jepang
euc-kr EUC-KR Korea
sjis Shift_JIS Jepang
big5 Big5 China Aks. Tradisional
gb GB2312 China Aksara Sederhana
utf-8 UTF-8 Semua
oe Opsional

Parameter oe menetapkan skema encoding karakter yang harus digunakan Google untuk mengenkode teks iklan. Meskipun secara teknis bersifat opsional, sebaiknya teruskan nilai untuk parameter ini.

Nilai oe default adalah utf-8.

Nilai Nama standar Bahasa Terkait yang Didukung
latin1 ISO-8859-1 Eropa Barat (Katala, Denmark, Belanda, Inggris, Finlandia, Prancis, Jerman, Indonesia, Italia, Norwegia, Portugis, Spanyol, Swedia)
latin2 ISO-8859-2 Eropa Timur (Kroasia, Ceko, Hungaria, Polandia, Rumania, Serbia, Slovakia, Slovenia)
latin3 ISO-8859-3  
latin4 ISO-8859-4 Baltik (Estonia, Latvia, Lituania)
sirilik ISO-8859-5 Bulgaria, Rusia
arab ISO-8859-6  
Yunani ISO-8859-7 Yunani
ibrani ISO-8859-8 Ibrani
latin5 ISO-8859-9  
latin6 ISO-8859-10 Islan
euc-jp EUC-JP Jepang
euc-kr EUC-KR Korea
sjis Shift_JIS Jepang
gb GB2312 China Aksara Sederhana
utf-8 UTF-8 Semua
ivt Opsional
Parameter ini memungkinkan Anda memberikan boolean yang memberi tahu Google bahwa Anda ingin mengizinkan iklan yang menggunakan penyimpanan lokal & cookie khusus traffic tidak valid pada traffic yang diberi izin dan tanpa izin.
  • true Jika parameter ini tidak ada atau Anda menetapkannya ke "true", kami akan menetapkan cookie khusus traffic tidak valid dan menggunakan penyimpanan lokal hanya pada traffic yang diizinkan.
  • false Jika Anda menetapkan parameter ini ke "false", kami akan menetapkan cookie khusus traffic tidak valid dan menggunakan penyimpanan lokal pada traffic yang diberi izin dan tanpa izin.

Secara default, IVT ditetapkan ke true (benar).

Contoh:

'ivt': false

Deskripsi Parameter Tingkat Unit

Parameter berikut memengaruhi cara unit iklan individual di halaman ditampilkan kepada pengguna. Setiap parameter dapat ditetapkan satu per satu untuk masing-masing unit iklan.

Wajib

Parameter Deskripsi dan Contoh
container Wajib
ID penampung iklan yang kosong <div> tempat iklan akan muncul.

Contoh:

'container' : 'afscontainer1'

maxTop Wajib jika unit iklan berada di atas hasil penelusuran.

Gunakan parameter ini untuk menentukan jumlah iklan yang akan ditampilkan di unit iklan atas.

Catatan: Parameter ini digunakan sebagai pengganti parameter 'number'. Unit iklan ini harus cukup lebar agar baris pertama iklan tidak melebihi batas. Menggunakan parameter maxTop pada penempatan lain di halaman tersebut merupakan pelanggaran kebijakan.

Contoh:

'maxTop' : 4
width Wajib
Menentukan lebar iklan atau unit penelusuran terkait dalam piksel.

Contoh:

'width' : '700px'
'width' : 700

Setelan Konfigurasi

Parameter Deskripsi dan Contoh
adLoadedCallback Opsional
Menentukan fungsi JavaScript yang akan dipanggil saat iklan atau penelusuran terkait telah dimuat atau saat tidak ada iklan atau penelusuran terkait yang ditayangkan. Parameter ini harus ditetapkan ke fungsi callback JavaScript yang Anda terapkan yang memungkinkan tindakan dilakukan saat panggilan iklan selesai.

Fungsi callback mengambil parameter berikut:

containerName Nama penampung iklan atau unit penelusuran terkait.
adsLoaded Tetapkan ke true jika setidaknya ada satu iklan atau istilah penelusuran terkait yang akan ditampilkan, dan false jika tidak ada iklan atau penelusuran terkait yang ditampilkan.
isExperimentVariant Tetapkan ke true jika eksperimen gaya kustom sedang berjalan dan varian eksperimen dipilih untuk merender iklan.
callbackOptions Objek JSON yang berisi kolom berikut:
termPositions: Untuk blok penelusuran terkait, berisi peta<string,int> dari istilah yang diberikan penayang ke posisi indeks nol untuk istilah tersebut dalam respons. Jika istilah diberikan tetapi tidak ditampilkan, istilah tersebut tidak akan muncul di peta.

Catatan: Uji fungsi callback Anda untuk memastikan bahwa fungsi ini tidak menghasilkan error, terutama yang dapat mengganggu pemuatan halaman Anda.

Contoh callback JavaScript:

var adblock1 = {
  'container' : 'adblock1_div_id',
  'adLoadedCallback' : function(containerName, adsLoaded,
    isExperimentVariant, callbackOptions) {
    if (adsLoaded) {
       try {
         // most likely do nothing
       } catch (e) {
         alert ("Error in callback function");
         // Do something to handle error gracefully
       }
    } else {
       // as you always do when there is no ad coverage from Google
    }
  }
};
      

number Opsional
Jumlah iklan yang akan ditampilkan di unit ini. Nilai defaultnya adalah 2.

Contoh:

'number' : 4

relatedSearches Opsional
Jumlah penelusuran terkait yang akan muncul di unit ini. Jika tidak ditentukan, defaultnya adalah 0.

Contoh:

'relatedSearches' : 4