Search Console API 驗證規定
您的應用程式傳送至 Google Search Console API 的每項請求都必須包含授權權杖。這個憑證也可讓 Google 識別您的應用程式。
關於授權通訊協定
您的應用程式必須使用 OAuth 2.0 對要求進行授權，系統不支援其他授權通訊協定。如果您的應用程式採用使用 Google 帳戶登入功能，系統會為您處理部分授權事項。
使用 OAuth 2.0 對要求進行授權
所有向 Google Search Console API 發出的要求都必須由通過驗證的使用者進行授權。
OAuth 2.0 授權程序 (或「流程」) 的細節會根據您編寫的應用程式類型而有所不同。下列一般程序適用於所有應用程式類型：
- 建立應用程式後，請透過 Google API 控制台註冊應用程式。接著 Google 會向您提供稍後需要的資訊，例如用戶端 ID 和用戶端密碼。
- 在 Google API 主控台中啟用 Google Search Console API。(如果 API 控制台裡沒有列出該 API，則可略過這個步驟)。
- 當應用程式需要存取使用者資料時，會向 Google 要求特定的存取範圍。
- Google 會向使用者顯示同意畫面，請對方授權您的應用程式要求部分資料。
- 如果使用者同意，Google 即會授予短期存取憑證給您的應用程式。
- 您的應用程式向使用者要求資料，並且在要求中附上存取憑證。
- 如果 Google 判定您的要求與憑證有效，便會傳回您要求的資料。
部分流程包含額外步驟，例如使用「更新憑證」來取得新的存取憑證。如要進一步瞭解各類應用程式的流程，請參閱 Google 的 OAuth 2.0 說明文件。
以下是 Google Search Console API 的 OAuth 2.0 範圍資訊：
| 範圍 | 意義 |
|---|---|
https://www.googleapis.com/auth/webmasters |
讀取/寫入權限。 |
https://www.googleapis.com/auth/webmasters.readonly |
唯讀權限。 |
如要透過 OAuth 2.0 要求存取權，您的應用程式需要範圍資訊，以及 Google 在您註冊應用程式時提供的資訊 (例如用戶端 ID 和用戶端密鑰)。
提示：Google API 用戶端程式庫可以為您處理部分授權程序，且適用於多種程式設計語言；詳情請參閱程式庫和範例頁面。
Search Console Testing Tools API 驗證規定
取得及使用 API 金鑰
向 Search Console 公開資料 API 提出公開資料的請求時，必須同時附上一組 ID，可以是 API 金鑰或存取憑證。
要取得 API 金鑰：
- 在 API 控制台中開啟「憑證」頁面。
-
這個 API 支援兩種憑證。為專案建立任何適用的憑證：
-
OAuth 2.0：每當您的應用程式要求取得私人使用者資料時，都必須一併傳送 OAuth 2.0 權杖和要求。您的應用程式會先傳送用戶端 ID，並可能會傳送用戶端密鑰來取得憑證。您可以為網路應用程式、服務帳戶或已安裝的應用程式產生 OAuth 2.0 憑證。
詳情請參閱 OAuth 2.0 說明文件。
-
API 金鑰： 如果要求未提供 OAuth 2.0 憑證，則必須傳送 API 金鑰。 該金鑰可用來識別您的專案，並提供 API 存取權、配額和報表。
API 支援數種類型的 API 金鑰限制。如果所需的 API 金鑰不存在，請在主控台中依序按一下 [建立憑證] > [API 金鑰]，建立 API 金鑰。您可以先在實際工作環境中使用金鑰來限制金鑰，方法是按一下 [限制金鑰]，然後選取其中一個「限制」。
-
為確保您 API 金鑰的安全，請遵循安全使用 API 金鑰的最佳做法。
建立 API 金鑰後，您的應用程式可將查詢參數 key=yourAPIKey 附加至所有要求網址。
API 金鑰可以安全地嵌入網址中，不需任何編碼。