本文將協助您熟悉 Custom Search JSON API 及其用途。
事前準備
建立程式化搜尋引擎
呼叫 API 時，使用者會針對現有的 Programmable Search Engine 執行個體發出要求。因此，您必須先在控制台中建立一個，才能使用 API。請參閱教學課程，進一步瞭解各種設定選項。建立完成後，您可以在「總覽」頁面的「基本」部分找到搜尋引擎 ID。這是 API 使用的 cx 參數。
使用 API 金鑰向 Google 識別應用程式
Custom Search JSON API 必須使用 API 金鑰。API 金鑰可向 Google 識別您的用戶端。
取得 API 金鑰後，您的應用程式可以將查詢參數 key=yourAPIKey 附加到所有的要求網址。API 金鑰可以安全地嵌入網址中，不需任何編碼。
API 總覽
API 作業
Custom Search JSON API 只有一種叫用方法：
| 作業 | 說明 | REST HTTP 對應 |
|---|---|---|
| list | 從程式化搜尋引擎傳回要求的搜尋結果。 | GET |
API 資料模型
對 Custom Search JSON API 提出搜尋查詢後，系統會傳回 JSON 物件，其中包含三種資料：
- 描述所要求搜尋的中繼資料 (可能也包括相關搜尋要求)
- 描述程式化搜尋引擎的中繼資料
- 搜尋結果
詳情請參閱「使用 REST」一文的「回應資料」一節。
資料模型以 OpenSearch 1.1 規格為準。除了標準的 OpenSearch 屬性，Custom Search JSON API 還定義了兩項自訂屬性和兩項自訂查詢角色：
- 自訂屬性
cx：程式化搜尋引擎的 ID。safe：用於篩除傳回結果的安全搜尋等級說明。
- 自訂查詢角色
nextPage：角色，指出查詢是否可用於存取下一頁的邏輯結果 (如有)。previousPage：角色，指出查詢是否可用於存取前一個邏輯頁面的結果 (如有)。
立即體驗
如想試試看 API 可發揮哪些實用功能，但不想編寫任何程式碼，請造訪「Try this API」(試用這個 API) 工具。
如需參數的完整說明，請參閱 cse.list 參考資料。
如要瞭解如何透過 HTTP 要求使用 API，請繼續參閱「使用 REST」。