前提条件

本文档介绍了您在编写第一个客户端应用之前应该做的事情。

获取 Google 帐号

您需要拥有 Google 帐号才能使用此 API。您的帐号必须对给定资源拥有相应的 Search Console 权限,才能对该资源调用该方法。例如,要运行 searchAnalytics.query,您需要对该属性的读取权限。

试用 Google Search Console

本 API 文档假定您使用过 Google Search Console,并且熟悉网络编程概念和网络数据格式。

如果您尚未使用过 Google Search Console,请先尝试使用界面,然后再开始编码。 每个 API 代表 Search Console 中报告的一项功能。在使用 API 之前,您应该阅读等效报告的文档,以了解您收到的数据。

为客户端创建项目和凭据

您需要先将客户端告知 Google 并激活对 API 的访问权限,然后才能向 Google Search Console 发送请求。为此,您可以使用 Google API 控制台创建一个项目,该项目是设置和 API 访问信息的命名集合,然后注册您的应用。

除 Testing Tools API 之外的所有 Search Console API 都需要 OAuth2 凭据。 Python 和 Java 快速入门指南详细介绍了如何为客户端创建项目并获取凭据。

了解 REST 基础知识

您可以通过以下两种方式调用 Admin API:

  • 发送 HTTP 请求并解析响应。
  • 使用客户端库

如果您决定不使用客户端库,则将需要了解 REST 的基础知识。

REST 基础知识

REST 是一种软件架构样式,可提供便捷且一致的方法用于请求和修改数据。

术语 REST 是“具象状态传输”的简称。在 Google API 的上下文中,指的是使用 HTTP 谓词来检索和修改由 Google 存储的数据的表示法。

在 RESTful 系统中,资源存储在数据存储区中;在客户端发送要求服务器执行特定操作(例如创建、检索、更新或删除资源)的请求之后,服务器便会执行该操作并发送响应,此响应的格式通常为所指定资源的表示法。

在 Google 的 REST API 中,客户端会使用 HTTP 动词(如 POSTGETPUTDELETE)指定操作。它通过以下形式的全局唯一 URI 指定资源:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

由于所有 API 资源都具有 HTTP 可访问的唯一 URI,因此 REST 启用了数据缓存,而且经过优化以与网络的分布式基础架构一起使用。

您可能会发现 HTTP 1.1 标准文档中的方法定义十分有用;这些定义中包含了 GETPOSTPUTDELETE 的规范。

Google Search Console API 中的 REST

Google Search Console API 操作会直接映射到 REST HTTP 动词。

大多数 Google Search Console API URI 的格式如下所示:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

Google Search Console API 参考文档中提供了每种方法使用的完整 URI 和动词集。

了解 JSON 基础知识

Google Search Console API 会返回 JSON 格式的数据。

JSON(JavaScript 对象表示法)是一种与语言无关的常见数据格式,可通过简单的文本来表示任意数据结构。如需了解详情,请参阅 json.org