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 | 
 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: 
 | 
| cr | 
 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: 
 Lihat halaman Nilai Parameter Negara untuk melihat daftar nilai yang valid untuk parameter ini. | 
| cx | 
 ID Programmable Search Engine yang akan digunakan untuk permintaan ini. | 
| dateRestrict | 
 Membatasi hasil ke URL berdasarkan tanggal. Nilai yang didukung meliputi: 
 | 
| exactTerms | 
 Mengidentifikasi frasa yang harus berisi semua dokumen dalam hasil penelusuran. | 
| excludeTerms | 
 Mengidentifikasi kata atau frasa yang tidak boleh muncul di dokumen apa pun di hasil penelusuran. | 
| fileType | 
 Membatasi hasil ke file dengan ekstensi tertentu. Daftar jenis file yang dapat diindeks oleh Google dapat ditemukan di Pusat Bantuan Search Console. | 
| filter | 
 Kontrol untuk mengaktifkan atau menonaktifkan filter konten duplikat. 
 Nilai yang dapat diterima: 
 | 
| gl | 
 Geolokasi pengguna akhir. 
 | 
| googlehost | 
 Tidak digunakan lagi. Gunakan parameter  Domain Google lokal (misalnya, google.com, google.de, atau google.fr) yang akan digunakan untuk melakukan penelusuran. | 
| highRange | 
 Menentukan nilai akhir untuk rentang penelusuran. 
 | 
| hl | 
 Menyetel bahasa antarmuka pengguna. 
 | 
| hq | 
 Menambahkan istilah kueri tertentu ke kueri, seolah-olah istilah tersebut dikombinasikan dengan operator AND logis. | 
| imgColorType | 
 Menampilkan gambar hitam putih, hitam putih, transparan, atau berwarna. Nilai yang dapat diterima: 
 | 
| imgDominantColor | 
 Menampilkan gambar dengan warna dominan tertentu. Nilai yang dapat diterima: 
 | 
| imgSize | 
 Menampilkan gambar dengan ukuran yang ditentukan. Nilai yang dapat diterima: 
 | 
| imgType | 
 Menampilkan gambar berjenis. Nilai yang dapat diterima: 
 | 
| linkSite | 
 Menentukan bahwa semua hasil penelusuran harus berisi link ke URL tertentu. | 
| lowRange | 
 Menentukan nilai awal untuk rentang penelusuran. Gunakan  | 
| lr | 
 Membatasi penelusuran pada dokumen yang ditulis dalam bahasa tertentu (mis.,  Nilai yang dapat diterima: 
 | 
| num | 
 Jumlah hasil penelusuran yang akan ditampilkan. 
 | 
| orTerms | 
 Memberikan istilah penelusuran tambahan untuk diperiksa dalam dokumen, dan setiap dokumen dalam hasil penelusuran harus berisi setidaknya salah satu istilah penelusuran tambahan. | 
| q | 
 Kueri | 
| relatedSite | 
 Tidak digunakan lagi. | 
| rights | 
 Filter berdasarkan pemberian lisensi. Nilai yang didukung mencakup:  | 
| safe | 
 Tingkat keamanan penelusuran. Nilai yang dapat diterima: 
 | 
| searchType | 
 Menentukan jenis penelusuran:  Nilai yang dapat diterima: 
 | 
| siteSearch | 
 Menentukan situs tertentu yang harus selalu disertakan atau dikecualikan dari hasil (lihat parameter  | 
| siteSearchFilter | 
 Mengontrol apakah akan menyertakan atau mengecualikan hasil dari situs yang disebutkan dalam parameter  Nilai yang dapat diterima: 
 | 
| sort | 
 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 | 
 Indeks hasil pertama yang akan ditampilkan. Jumlah hasil default per halaman adalah 10, sehingga  | 
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.