Search Console API 身份验证要求
您的应用向 Google Search Console API 发送的每个请求都必须包含授权令牌。Google 也可通过此令牌识别您的应用。
关于授权协议
您的应用必须使用 OAuth 2.0 向请求授权，其他任何授权协议均不受支持。如果您的应用使用使用 Google 帐号登录，系统会代您执行授权方面的某些操作。
使用 OAuth 2.0 向请求授权
向 Google Search Console API 发出的所有请求都必须由经过身份验证的用户授权。
根据您所编写的应用的类型，OAuth 2.0 的具体授权流程可能会有所不同。下面是适用于所有应用类型的大致流程：
- 开发应用时，您需要使用 Google API 控制台注册该应用。然后，Google 会提供您稍后需要用到的信息，例如客户端 ID 和客户端密钥。
- 在 Google API 控制台中激活 Google Search Console API。（如果 API 控制台中未列出该 API，请跳过这一步。）
- 当您的应用需要访问用户数据时，它会请求 Google 提供特定范围的访问权限。
- Google 会向相应用户显示权限请求页面，让用户授权您的应用请求他们的某些数据。
- 待该用户同意后，Google 会为您的应用提供一个时效很短的访问令牌。
- 您的应用会请求获取用户数据，并在请求中附上该访问令牌。
- 如果 Google 确定您的请求及令牌有效，就会返回您所请求的数据。
有些流程还包含其他步骤，例如使用刷新令牌获取新的访问令牌。如需详细了解适用于各类应用的不同流程，请参阅 Google 的 OAuth 2.0 文档。
以下是 Google Search Console API 的 OAuth 2.0 范围信息：
| 范围 | 含义 |
|---|---|
https://www.googleapis.com/auth/webmasters |
读取/写入权限。 |
https://www.googleapis.com/auth/webmasters.readonly |
只读权限。 |
要通过 OAuth 2.0 请求访问权限，您的应用既需要范围信息，也需要在您注册应用时 Google 提供的相关信息（如客户端 ID 和客户端密钥）。
提示：Google API 客户端库可帮您处理部分授权流程，并且支持多种编程语言；有关详情，请参阅库和示例页面。
Search Console Testing Tools API 身份验证要求
获取和使用 API 密钥
针对公开数据向 Search Console Testing Tools API 发出的请求必须附带标识符，该标识符可以是 API 密钥或访问令牌。
要获取 API 密钥，请执行以下操作：
- 打开 API 控制台中的“凭据”页面。
-
此 API 支持两种类型的凭据。创建适合您的项目的凭据：
-
OAuth 2.0：当您的应用请求非公开用户数据时，该应用必须将 OAuth 2.0 令牌随请求一起发送。要获取令牌，您的应用应先发送客户端 ID（也可能需要发送客户端密钥）。您可以为网页应用、服务帐号或已安装应用生成 OAuth 2.0 凭据。
如需了解详情，请参阅 OAuth 2.0 文档。
-
API 密钥：未提供 OAuth 2.0 令牌的请求必须发送 API 密钥。 该密钥用于标识您的项目，并提供 API 访问权限、配额和报告。
此 API 支持多种类型的 API 密钥限制。如果您需要的 API 密钥尚未存在，请在控制台中创建 API 密钥，方法是：点击创建凭据 > API 密钥。您可以先对密钥设定相关限制，然后再在生产环境中使用密钥，方法是：点击限制密钥，然后选择某个限制。
-
为保障 API 密钥的安全，请遵循以安全的方式使用 API 密钥的最佳做法。
在您获得 API 密钥后，您的应用便可在所有请求网址后附加查询参数 key=yourAPIKey。
API 密钥可以安全地嵌入网址中，而无需进行任何编码。