API Reference

Search Console API 提供以下服务：

  • 搜索分析 - 查询您网站的流量数据。
  • 站点地图 - 列出您的所有站点地图，请求获取特定站点地图的相关信息，并向 Google 提交站点地图。
  • 网站 - 列出/添加/移除 Search Console 帐号中的资源。
  • 网址检查 - 检查网页在 Google 索引中的状态（等同于 Search Console 中的网址检查）。

搜索分析

要详细了解“搜索分析”资源，请参阅资源表示形式页面。

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

站点地图

有关站点地图资源的详细信息，请参阅资源表示方法页。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/webmasters/v3 的 URI
delete DELETE  /sites/siteUrl/sitemaps/feedpath 从此网站中删除站点地图。
get GET  /sites/siteUrl/sitemaps/feedpath 检索特定站点地图的相关信息。
list GET  /sites/siteUrl/sitemaps 列出为此网站提交的或包含在站点地图索引文件中（如果在请求中指定了 sitemapIndex）的 sitemaps-entries。
提交 PUT  /sites/siteUrl/sitemaps/feedpath 提交网站的站点地图。

网站

如需详细了解 协作平台资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/webmasters/v3 的 URI
添加 PUT  /sites/siteUrl 将某个网站添加到 Search Console 中用户的网站集合中。
delete DELETE  /sites/siteUrl 将某个网站从用户的 Search Console 网站组中移除。
get GET  /sites/siteUrl 检索有关特定网站的信息。
list GET  /sites 列出用户的 Search Console 网站。

网址检查

如需详细了解网址检查资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
相对于 https://searchconsole.googleapis.com/v1 的 URI
index.inspectindex.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"}