必備條件

本文件將說明在編寫第一個用戶端應用程式前應完成的事項。

建立 Google 帳戶

您必須擁有 Google 帳戶才能使用這個 API。您的帳戶必須具備特定資源的相關 Search Console 權限,才能針對該資源呼叫該方法。舉例來說,您必須具備該資源的讀取權限,才能執行 searchAnalytics.query

試用 Google Search Console

這份 API 說明文件假設您使用過 Google Search Console,且熟悉網路程式設計概念和網路資料格式。

如果您尚未使用過 Google Search Console,請先測試使用者介面,再開始編寫程式碼。每個 API 都代表 Search Console 中的報表功能。使用 API 前,請先 參閱同類報表的說明文件,瞭解您收到的資料。

為用戶端建立專案和憑證

將要求傳送至 Google Search Console 之前,您必須先向 Google 提供用戶端相關資訊並啟用 API 存取權。您可以使用 Google API 控制台建立「專案」,專案為一組具名的設定和 API 存取權資訊,並註冊應用程式。

除了 Testing Tools API 外,所有 Search Console API 都需要 OAuth2 憑證。Python 和 Java 快速入門指南提供了有關如何建立專案及取得用戶端憑證的詳細資訊。

瞭解 REST 基本概念

您可以透過下列兩種方式叫用 API:

如果您決定不使用用戶端程式庫,則必須瞭解 REST 的基本概念。

REST 是一種軟體架構,可提供簡便且一致的資料要求及修改方法。

REST 為 Representational State Transfer (具象狀態傳輸) 的簡稱。在 Google 的 API 中,這是指使用 HTTP 動詞來擷取及修改 Google 儲存的資料表示法。

在符合 REST 樣式的系統中,資源會儲存在資料儲存庫中。用戶端向伺服器發出執行特定動作 (例如建立、擷取、更新或刪除資源) 的要求後,伺服器就會執行指定動作並傳回回應 (大多採用指定資源表示法的形式)。

在 Google 的 RESTful API 中,用戶端會使用 POSTGETPUTDELETE 等 HTTP 動詞來指定動作,它會使用全域唯一的 URI 來指定資源,其格式如下:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

由於所有 API 資源都有可供 HTTP 存取的專屬 URI,因此 REST 不僅能夠支援資料快取,也非常適合與網路的分散式基礎架構搭配運作。

您可以在 HTTP 1.1 標準說明文件中找到實用的方法定義,這些定義包含 GETPOSTPUTDELETE 的規格。

Google Search Console API 中的 REST

Google Search Console API 作業與 REST HTTP 動詞直接對應。

大多數 Google Search Console API URI 的格式如下:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

如要瞭解每種方法使用的完整 URI 和動詞,請參閱 Google Search Console API 參考資料總覽。

瞭解 JSON 基本概念

Google Search Console API 會以 JSON 格式傳回資料。

JSON (JavaScript Object Notation) 是一種不涉及語言的常用資料格式,可透過簡單的文字呈現多種資料結構。詳情請參閱 json.org