API Reference

Search Console API 提供以下服务:

  • Search Analytics - 查询您网站的流量数据。
  • 站点地图 - 列出您的所有站点地图、请求获取特定站点地图的相关信息,以及向 Google 提交站点地图。
  • 协作平台 - 在您的 Search Console 帐号中列出/添加/移除资源。
  • 网址检查 - 检查网页在 Google 索引中的状态(相当于 Search Console 中的网址检查)。

搜索 Google Analytics(分析)

有关 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"]
}

站点地图

如需详细了解站点地图资源,请参阅资源表示形式页面。

方法 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)。
提交 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.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"}