Dokumen ini akan membantu Anda memahami Custom Search JSON API dan penggunaannya.
Sebelum memulai
Membuat Programmable Search Engine
Dengan memanggil API, pengguna mengirimkan permintaan terhadap instance Mesin Telusur yang Dapat Diprogram yang ada. Oleh karena itu, sebelum menggunakan API, Anda perlu membuat
satu di Panel
Kontrol . Ikuti
tutorial untuk mempelajari lebih lanjut
berbagai opsi konfigurasi. Setelah dibuat, Anda dapat menemukan ID Mesin
Telusur di bagian Dasar pada halaman Ringkasan. Ini adalah parameter cx
yang digunakan oleh API.
Mengidentifikasi aplikasi Anda ke Google dengan kunci API
Custom Search JSON API memerlukan penggunaan kunci API. Kunci API adalah cara untuk mengidentifikasi klien Anda ke Google.
Setelah memiliki kunci API, aplikasi Anda dapat menambahkan parameter kueri
key=yourAPIKey ke semua URL permintaan. Kunci API aman untuk disematkan di URL,
tidak memerlukan encoding apa pun.
Ringkasan API
Operasi API
Hanya ada satu metode yang dapat dipanggil di Custom Search JSON API:
| Operasi | Deskripsi | Pemetaan HTTP REST |
|---|---|---|
| list | Menampilkan hasil penelusuran yang diminta dari Programmable Search Engine. | GET |
Model data API
Hasil kueri penelusuran ke Custom Search JSON API adalah objek JSON yang mencakup tiga jenis data:
- Metadata yang menjelaskan penelusuran yang diminta (dan, mungkin, permintaan penelusuran terkait)
- Metadata yang menjelaskan Programmable Search Engine
- Hasil penelusuran
Lihat bagian Data respons di Menggunakan REST untuk mengetahui detail selengkapnya.
Model data didasarkan pada Spesifikasi OpenSearch 1.1. Selain properti OpenSearch standar, Custom Search JSON API menentukan dua properti kustom dan dua peran kueri kustom:
- Properti kustom
cx: ID Programmable Search Engine.safe: Deskripsi tingkat penelusuran aman untuk memfilter hasil yang ditampilkan.
- Peran kueri kustom
nextPage: Peran yang menunjukkan bahwa kueri dapat digunakan untuk mengakses halaman hasil logis berikutnya, jika ada.previousPage: Peran yang menunjukkan bahwa kueri dapat digunakan untuk mengakses halaman hasil logis sebelumnya, jika ada.
Coba
Untuk menguji coba dan melihat apa yang dapat dilakukan API, tanpa perlu menulis kode apa pun, buka alat"Try this API".
Untuk mengetahui deskripsi lengkap parameter, buka referensi cse.list.
Untuk mempelajari cara menggunakan API melalui permintaan HTTP, lanjutkan ke Menggunakan REST.