Custom Search JSON API: Pengantar

Dokumen ini akan membantu Anda memahami Custom Search JSON API dan penggunaannya.

Sebelum memulai

Membuat Programmable Search Engine

Dengan memanggil pengguna API, permintaan akan dibuat terhadap instance Programmable Search Engine yang ada. Oleh karena itu, sebelum menggunakan API, Anda perlu membuatnya di Control Panel . 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 pada Google dengan kunci API

Custom Search JSON API memerlukan penggunaan kunci API. Kunci API adalah cara untuk mengidentifikasi klien Anda ke Google.

Setelah Anda memiliki kunci API, aplikasi Anda dapat menambahkan parameter kueri key=yourAPIKey ke semua URL permintaan. Kunci API ini aman untuk disematkan dalam URL, dan tidak memerlukan encoding apa pun.

Ringkasan API

Operasi API

Hanya ada satu metode untuk 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 dalam Menggunakan REST untuk detail selengkapnya.

Model data didasarkan pada Spesifikasi OpenSearch 1.1. Selain properti OpenSearch standar, Custom Search JSON API menentukan dua properti khusus dan dua peran kueri khusus:

  • Properti kustom
    • cx: ID Programmable Search Engine.
    • safe: Deskripsi tingkat penelusuran aman untuk memfilter hasil yang ditampilkan.
  • Peran kueri kustom
    • nextPage: Peran yang menunjukkan kueri dapat digunakan untuk mengakses halaman logis hasil berikutnya, jika ada.
    • previousPage: Peran yang menunjukkan kueri dapat digunakan untuk mengakses halaman logis hasil sebelumnya, jika ada.

Cobalah

Untuk mencoba-coba dan melihat kemampuan API, tanpa perlu menulis kode apa pun, buka alat"Coba API ini".

Untuk mengetahui deskripsi lengkap parameter, buka referensi cse.list.

Untuk mempelajari cara menggunakan API melalui permintaan HTTP, lanjutkan ke Menggunakan REST.