API Reference

Search Console API 提供下列服務：

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

搜尋分析

如需搜尋 Analytics (分析) 資源的詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/webmasters/v3 的 URI，除非另有說明
query 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 列出針對這個網站提交的 Sitemaps-entries，或是包含在 Sitemap 索引檔案中 (如果在要求中指定了 sitemapIndex)。
提交 PUT  /sites/siteUrl/sitemaps/feedpath 為網站提交 Sitemap。

網站

如要進一步瞭解協作平台資源，請參閱資源表示法網頁。

方法 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"}