必要條件

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

建立 Google 帳戶

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

試用 Google Search Console

本 API 說明文件假設您已採用 Google Search Console,並熟悉網路程式設計概念和網路資料格式。

如果您不曾使用 Google Search Console,請先試用使用者介面,再開始撰寫程式碼。 每個 API 都代表 Search Console 報表的功能。使用 API 之前,請先參閱對等報表的說明文件,以瞭解您收到的資料。

為用戶端建立專案和憑證

您必須先向 Google 通知您的用戶端,並啟用該 API 的存取權,您才能將要求傳送至 Google Search Console。方法是使用 Google API 控制台建立「專案」,這是一個已命名的設定和 API 存取權資訊集合,並註冊您的應用程式。

除了測試工具 API 之外,所有 Search Console API 都必須使用 OAuth2 憑證。 Python 和 Java 的快速入門指南將詳細說明如何建立專案並取得用戶端憑證。

瞭解 REST 的基本概念

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

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

REST 基本概念

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

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

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

在 Google 的 RESTful API 中,用戶端會使用 HTTP 動詞指定動作,例如 POSTGETPUTDELETE。並由下列格式的全域唯一 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

Google Search Console API 參考資料總覽提供了各種方法的完整 URI 和動詞。

瞭解 JSON 基本概念

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

JSON (JavaScript 物件標記法) 是一種常見的語言專用資料格式,可透過簡單的文字表示任意資料結構。詳情請參閱 json.org