Method: cse.list

Menampilkan metadata tentang penelusuran yang dilakukan, metadata tentang mesin yang digunakan untuk penelusuran, serta hasil penelusuran.

Permintaan HTTP

GET https://customsearch.googleapis.com/customsearch/v1

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
c2coff

string

Mengaktifkan atau menonaktifkan Penelusuran China Aksara Sederhana dan Tradisional.

Nilai default untuk parameter ini adalah 0 (nol), yang berarti bahwa fitur tersebut diaktifkan. Nilai yang didukung adalah:

  • 1: Nonaktif

  • 0: Diaktifkan (default)

cr

string

Membatasi hasil penelusuran pada dokumen yang berasal dari negara tertentu. Anda dapat menggunakan operator Boolean dalam nilai parameter cr.

Google Penelusuran menentukan negara dokumen dengan menganalisis:

  • domain level teratas (TLD) dari URL dokumen

  • lokasi geografis dari alamat IP server Web

Lihat halaman Nilai Parameter Negara untuk melihat daftar nilai yang valid untuk parameter ini.

cx

string

ID Programmable Search Engine yang akan digunakan untuk permintaan ini.

dateRestrict

string

Membatasi hasil ke URL berdasarkan tanggal. Nilai yang didukung meliputi:

  • d[number]: meminta hasil dari jumlah hari terakhir yang ditentukan.

  • w[number]: meminta hasil dari jumlah yang ditentukan dalam beberapa minggu terakhir.

  • m[number]: meminta hasil dari jumlah yang ditentukan dalam beberapa bulan terakhir.

  • y[number]: meminta hasil dari jumlah yang ditentukan dalam beberapa tahun sebelumnya.

exactTerms

string

Mengidentifikasi frasa yang harus berisi semua dokumen dalam hasil penelusuran.

excludeTerms

string

Mengidentifikasi kata atau frasa yang tidak boleh muncul di dokumen apa pun di hasil penelusuran.

fileType

string

Membatasi hasil ke file dengan ekstensi tertentu. Daftar jenis file yang dapat diindeks oleh Google dapat ditemukan di Pusat Bantuan Search Console.

filter

string

Kontrol untuk mengaktifkan atau menonaktifkan filter konten duplikat.

  • Lihat Pemfilteran Otomatis untuk informasi lebih lanjut tentang filter hasil penelusuran Google. Perhatikan bahwa pemfilteran kerumunan host hanya berlaku untuk penelusuran multisitus.

  • Secara default, Google menerapkan pemfilteran ke semua hasil penelusuran untuk meningkatkan kualitas hasil tersebut.

Nilai yang dapat diterima:

  • 0: Menonaktifkan filter konten duplikat.

  • 1: Mengaktifkan filter konten duplikat.

gl

string

Geolokasi pengguna akhir.

  • Nilai parameter gl adalah kode negara dua huruf. Parameter gl meningkatkan hasil penelusuran yang negara asalnya cocok dengan nilai parameter. Lihat halaman Kode Negara untuk melihat daftar nilai yang valid.

  • Menentukan nilai parameter gl akan memberikan hasil yang lebih relevan. Hal ini terutama berlaku untuk pelanggan internasional dan, bahkan lebih spesifik, untuk pelanggan di negara-negara berbahasa Inggris selain Amerika Serikat.

googlehost

string

Tidak digunakan lagi. Gunakan parameter gl untuk efek serupa.

Domain Google lokal (misalnya, google.com, google.de, atau google.fr) yang akan digunakan untuk melakukan penelusuran.

highRange

string

Menentukan nilai akhir untuk rentang penelusuran.

  • Gunakan lowRange dan highRange untuk menambahkan rentang penelusuran inklusif lowRange...highRange ke kueri.
hl

string

Menyetel bahasa antarmuka pengguna.

hq

string

Menambahkan istilah kueri tertentu ke kueri, seolah-olah istilah tersebut dikombinasikan dengan operator AND logis.

imgColorType

enum (ImgColorType)

Menampilkan gambar hitam putih, hitam putih, transparan, atau berwarna. Nilai yang dapat diterima:

  • "color"

  • "gray"

  • "mono": hitam dan putih

  • "trans": latar belakang transparan

imgDominantColor

enum (ImgDominantColor)

Menampilkan gambar dengan warna dominan tertentu. Nilai yang dapat diterima:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"

imgSize

enum (ImgSize)

Menampilkan gambar dengan ukuran yang ditentukan. Nilai yang dapat diterima:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"

imgType

enum (ImgType)

Menampilkan gambar berjenis. Nilai yang dapat diterima:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"

lowRange

string

Menentukan nilai awal untuk rentang penelusuran. Gunakan lowRange dan highRange untuk menambahkan rentang penelusuran inklusif lowRange...highRange ke kueri.

lr

string

Membatasi penelusuran pada dokumen yang ditulis dalam bahasa tertentu (mis., lr=lang_ja).

Nilai yang dapat diterima:

  • "lang_ar": Arab

  • "lang_bg": Bulgaria

  • "lang_ca": Katalan

  • "lang_cs": Ceko

  • "lang_da": Denmark

  • "lang_de": Jerman

  • "lang_el": Yunani

  • "lang_en": Inggris

  • "lang_es": Spanyol

  • "lang_et": Estonia

  • "lang_fi": Finlandia

  • "lang_fr": Prancis

  • "lang_hr": Kroasia

  • "lang_hu": Hungaria

  • "lang_id": Indonesia

  • "lang_is": Islandia

  • "lang_it": Italia

  • "lang_iw": Ibrani

  • "lang_ja": Jepang

  • "lang_ko": Korea

  • "lang_lt": Lituania

  • "lang_lv": Latvi

  • "lang_nl": Belanda

  • "lang_no": Norwegia

  • "lang_pl": Polandia

  • "lang_pt": Portugis

  • "lang_ro": Rumania

  • "lang_ru": Rusia

  • "lang_sk": Slovakia

  • "lang_sl": Slovenia

  • "lang_sr": Serbia

  • "lang_sv": Swedia

  • "lang_tr": Turki

  • "lang_zh-CN": China (Aksara Sederhana)

  • "lang_zh-TW": China (Aksara Tradisional)

num

integer

Jumlah hasil penelusuran yang akan ditampilkan.

  • Nilai yang valid adalah bilangan bulat antara 1 dan 10, inklusif.
orTerms

string

Memberikan istilah penelusuran tambahan untuk diperiksa dalam dokumen, dan setiap dokumen dalam hasil penelusuran harus berisi setidaknya salah satu istilah penelusuran tambahan.

q

string

Kueri

relatedSite
(deprecated)

string

Tidak digunakan lagi.

rights

string

Filter berdasarkan pemberian lisensi. Nilai yang didukung mencakup: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived, dan kombinasinya. Lihat kombinasi standar.

safe

enum (Safe)

Tingkat keamanan penelusuran. Nilai yang dapat diterima:

  • "active": Mengaktifkan pemfilteran SafeSearch.

  • "off": Menonaktifkan pemfilteran SafeSearch. (default)

searchType

enum (SearchType)

Menentukan jenis penelusuran: image. Jika tidak ditentukan, hasil akan dibatasi pada halaman web.

Nilai yang dapat diterima:

  • "image": penelusuran gambar kustom.
siteSearchFilter

enum (SiteSearchFilter)

Mengontrol apakah akan menyertakan atau mengecualikan hasil dari situs yang disebutkan dalam parameter siteSearch.

Nilai yang dapat diterima:

  • "e": mengecualikan

  • "i": mencakup

sort

string

Ekspresi pengurutan yang akan diterapkan ke hasil. Parameter pengurutan menentukan bahwa hasil diurutkan berdasarkan ekspresi yang ditentukan, yaitu mengurutkan berdasarkan tanggal. Contoh: sort=date.

start

integer (uint32 format)

Indeks hasil pertama yang akan ditampilkan. Jumlah hasil default per halaman adalah 10, sehingga &start=11 akan dimulai di bagian atas halaman kedua hasil penelusuran. Catatan: JSON API tidak akan pernah menampilkan lebih dari 100 hasil, meskipun lebih dari 100 dokumen cocok dengan kueri. Jadi, menetapkan jumlah start + num ke angka yang lebih besar dari 100 akan menghasilkan error. Perhatikan juga bahwa nilai maksimum untuk num adalah 10.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi instance Search.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/cse

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.