Custom Search JSON API：簡介

本文件可協助您熟悉 Custom Search JSON API 及其用途。

事前準備

建立程式化搜尋引擎

透過呼叫 API 使用者，針對程式化搜尋引擎的現有執行個體發出要求。因此，您必須先在控制台中建立 API，才能使用這個 API。請參閱教學課程，進一步瞭解不同的設定選項。建立完畢後，您可以在「Overview」(總覽) 頁面的「Basic」(基本) 區段中找到搜尋引擎 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。