Search Console API 的更新

2020 年 12 月 9 日,星期三

几个月前,我们宣布要升级 API 基础架构,以提升 Search Console API 的性能,从而应对日益增长的需求。今天我们非常高兴地宣布,我们还将推出更多更新:

  • Search Console API 中新增了新鲜数据功能和新闻过滤条件
  • Sitemaps API 现已支持网域资源
  • 提供了有关如何迁移 Google 探索文档的指南

如果您自行调用该 API,请阅读下文。

Search Console API 中的新鲜数据功能和新闻过滤条件

先前,效果报告已支持显示过去一天内的新鲜数据。现在,您可以通过该 API 访问此数据,方法是传递请求参数 dataState,并将其值设为 all。您使用此值获取的数据还将包含尚未最终确定的新鲜数据。如果您只想获取最终数据,可以传递此参数并将其值设为 final,或者根本不传递此参数,这样您将默认地只能获取最终数据。

几个月前,我们在效果报告中添加了 Google 搜索“新闻”标签页过滤条件。现在,该 API 中也会提供此信息。您可以在请求中将 searchType 参数的值设为 news 来访问此信息。

Sitemaps API 现已支持网域资源

现在,Sitemaps API 也和其他 Search Console API 一样支持网域资源了。您可以在网域资源上查询、添加和删除站点地图,例如:

GET https://www.googleapis.com/webmasters/v3/sites/sc-domain:example.com/sitemaps

探索文档迁移

我们将不再支持 Webmasters 探索文档。如果您使用外部 API 库查询 Search Console API,或直接查询 Webmasters API 探索文档,将需要更新 API 调用以包含以下更改。

API 库变更

如需了解关于 API 库变更的最新资讯,请参阅 Java 和 Python 快速入门指南,获取更新后的 API 使用指南。

Java

对于所有与 Webmasters 服务相关的导入,请将 webmasters 软件包更改为 searchconsole.v1 软件包,将服务名称 Webmasters 更改为 SearchConsole。示例:

  • 导入 API 服务:

    import com.google.api.services.webmasters.Webmasters;

    import com.google.api.services.searchconsole.v1.SearchConsole;

  • 导入响应对象:

    import com.google.api.services.webmasters.model.WmxSite;

    import com.google.api.services.searchconsole.v1.model.WmxSite;

请注意,除了服务对象之外,其他 API 对象都与之前完全一样,只有软件包发生更改。

Python

构建 Webmasters 服务对象时,请做出以下更改:

webmasters_service = build('webmasters', 'v3', http=http)

webmasters_service = build('searchconsole', 'v1', http=http)

同样,对象的行为方式没有任何变化。

直接查询探索文档

探索文档查询更改包括:

  • 网址更改

    https://www.googleapis.com/discovery/v1/apis/webmasters/v3/rest

    https://searchconsole.googleapis.com/$discovery/rest

  • 内容更改
    • name 字段已从 webmasters 更改为 searchconsole。
    • version 字段已从 v3 更改为 v1。

如果您有任何疑问,可以在搜索中心社区或 Twitter 上提问。