API Reference

Search Console API 提供下列服務：

  • 搜尋分析：查詢網站的車流量資料。
  • Sitemap：列出所有 Sitemap、要求提供特定 Sitemap 的資訊，以及將 Sitemap 提交給 Google。
  • 協作平台 - 在您的 Search Console 帳戶中列出/新增/移除資源。
  • 網址檢查：檢查 Google 索引中的網頁狀態 (相當於 Search Console 中的網址檢查功能)。

搜尋分析

如要進一步瞭解 Search Analytics (分析) 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/webmasters/v3 的 URI，除非另有說明
查詢 POST  /sites/siteUrl/searchAnalytics/query

使用您定義的篩選器和參數，查詢搜尋流量資料。這個方法會傳回零或多個資料列，並以您定義的列鍵 (維度) 進行分組。您必須將日期範圍定義為一或多天。

日期為維度之一時，結果清單中會省略所有不含資料的日期。若要瞭解哪幾天的資料有其可用，請針對符合日期範圍的日期範圍發出不含篩選器的查詢。

結果是按點擊次數遞減排序。如果兩列的點擊次數相同，則會以任意方式排序。

請參閱 python 範例，瞭解如何呼叫這個方法。

JSON POST 範例： 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

Sitemap

如需 Sitemap 資源的詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/webmasters/v3 的 URI，除非另有說明
刪除 DELETE  /sites/siteUrl/sitemaps/feedpath 從此網站刪除 Sitemap。
get GET  /sites/siteUrl/sitemaps/feedpath 擷取特定 Sitemap 的相關資訊。
清單 GET  /sites/siteUrl/sitemaps 列出您為這個網站提交的 Sitemap 項目，或包含在 Sitemap 索引檔中 (如果要求中指定了 sitemapIndex)。
提交 PUT  /sites/siteUrl/sitemaps/feedpath 提交網站的 Sitemap。

Google 協作平台

如需協作平台資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/webmasters/v3 的 URI，除非另有說明
add PUT  /sites/siteUrl 將網站新增至 Search Console 中使用者的網站集。
刪除 DELETE  /sites/siteUrl 從使用者的 Search Console 網站集中移除網站。
get GET  /sites/siteUrl 擷取特定網站的相關資訊。
清單 GET  /sites 列出使用者的 Search Console 網站。

網址檢查

如要進一步瞭解網址檢查資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://searchconsole.googleapis.com/v1 的 URI
index.inspect POST /urlInspection/index:inspect

您提供的網址在 Google 索引中的相關資訊。

JSON POST 範例： 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}