Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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:
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".
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Informasi yang saya butuhkan tidak ada","missingTheInformationINeed","thumb-down"],["Terlalu rumit/langkahnya terlalu banyak","tooComplicatedTooManySteps","thumb-down"],["Sudah usang","outOfDate","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Masalah kode / contoh","samplesCodeIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-08-31 UTC."],[[["\u003cp\u003eThis guide introduces the Custom Search JSON API and provides instructions for its use.\u003c/p\u003e\n"],["\u003cp\u003eBefore using the API, you need to create a Programmable Search Engine and obtain an API key.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows you to retrieve search results from your Programmable Search Engine using a single \u003ccode\u003elist\u003c/code\u003e operation.\u003c/p\u003e\n"],["\u003cp\u003eThe API returns results in JSON format containing search metadata, engine details, and the search results themselves.\u003c/p\u003e\n"],["\u003cp\u003eYou can experiment with the API using the provided "Try this API" tool or learn more through detailed documentation and examples.\u003c/p\u003e\n"]]],[],null,["# Custom Search JSON API: Introduction\n\nThis document will help you to get familiar with Custom Search JSON API and its usage.\n\nBefore you start\n----------------\n\n### Create Programmable Search Engine\n\nBy calling the API user issues requests against an existing instance of\nProgrammable Search Engine.\nTherefore, before using the API, you need to create one in the\n[Control Panel](https://programmablesearchengine.google.com/controlpanel/create)\n. Follow the [tutorial](/custom-search/docs/tutorial/creatingcse)\nto learn more about different configuration options.\nOnce it is created, you can find the **Search Engine ID** in the **Overview**\npage's **Basic** section. This is the `cx` parameter used by the API.\n\n### Identify your application to Google with API key\n\nCustom Search JSON API requires the use of an API key. An API key is a way to identify your client to Google.\n\n- [Programmable Search Engine](https://cse.google.com/) (free edition) users: Get a Key\n\nAfter you have an API key, your application can append the query parameter\n`key=yourAPIKey` to all request URLs. The API key is safe for embedding in URLs,\nit doesn't need any encoding.\n\nAPI overview\n------------\n\n### API operations\n\nThere is only one method to invoke in the Custom Search JSON API:\n\n| Operation | Description | REST HTTP mapping |\n|------------------------------------------------------|-------------------------------------------------------------------------|-------------------|\n| [list](/custom-search/v1/reference/rest/v1/cse/list) | Returns the requested search results from a Programmable Search Engine. | `GET` |\n\n### API data model\n\nThe result of a search query to the Custom Search JSON API is a JSON object that includes three types of data:\n\n- Metadata describing the requested search (and, possibly, related search requests)\n- Metadata describing the Programmable Search Engine\n- Search results\n\nSee the Response data section of [Using REST](/custom-search/v1/using_rest#response_data) for more details.\n\nThe data model is based on the OpenSearch 1.1 Specification. In addition to the standard OpenSearch properties, the Custom Search JSON API defines two custom properties and two custom query roles:\n\n- Custom properties\n - `cx`: The identifier of the Programmable Search Engine.\n - `safe`: A description of the safe search level for filtering the returned results.\n- Custom query roles\n - `nextPage`: A role that indicates the query can be used to access the next logical page of results, if any.\n - `previousPage`: A role that indicates the query can be used to access the previous logical page of results, if any.\n\nTry it\n------\n\nTo play around and see what the API can do, without writing any code, visit the\n[\"Try this API\" tool](/custom-search/v1/reference/rest/v1/cse/list?apix=true).\n\nFor a full description of parameters visit the\n[cse.list reference](/custom-search/v1/reference/rest/v1/cse/list).\n\nTo learn how to use the API via HTTP requests, continue to\n[Using REST](/custom-search/v1/using_rest)."]]
