使用 OAuth 2.0 访问 Google API

Google API 使用 OAuth 2.0 协议进行身份验证和授权。Google 支持常见的 OAuth 2.0 用例，如网络服务器、客户端、已安装的应用和限制输入的设备应用。

首先，从 获取 OAuth 2.0 客户端凭据。然后，您的客户端应用会从 Google 授权服务器请求访问令牌，从响应中提取令牌，然后将此令牌发送到您要访问的 Google API。如需查看将 OAuth 2.0 与 Google 结合使用的交互式演示（包括使用您自己的客户端凭据的选项），请试用 OAuth 2.0 Playground。

本页简要介绍了 Google 支持的 OAuth 2.0 授权场景，并提供了指向更详细内容的链接。如需详细了解如何使用 OAuth 2.0 进行身份验证，请参阅 OpenID Connect。

基本步骤

所有应用在使用 OAuth 2.0 访问 Google API 时都遵循基本模式。概括来讲，您需要执行以下五个步骤：

1. 从 获取 OAuth 2.0 凭据。

访问 以获取 OAuth 2.0 凭据，例如 Google 和您的应用都知道的客户端 ID 和客户端密钥。这组值因您要构建的应用类型而异。例如，JavaScript 应用不需要密钥，但 Web 服务器应用需要密钥。

您必须创建适用于应用将在其上运行的平台的 OAuth 客户端，例如：

2. 从 Google 授权服务器获取访问令牌。

您的应用必须先获取用于授予该 API 访问权限的访问令牌，才可以使用 Google API 访问非公开数据。一个访问令牌可以向多个 API 授予不同程度的访问权限。一个名为 scope 的可变形参用于控制访问令牌允许的一组资源和操作。在请求访问令牌期间，您的应用在 scope 参数中发送一个或多个值。

您可以通过多种方式发出此请求，具体取决于您要构建的应用类型。例如，JavaScript 应用可能会使用重定向到 Google 的浏览器请求访问令牌，而安装在没有浏览器的设备上的应用则使用 Web 服务请求。

某些请求需要用户使用其 Google 账号登录的身份验证步骤。登录后，系统会询问用户是否愿意授予您的应用请求的一项或多项权限。此过程称为用户同意。

如果用户授予至少一项权限，Google 授权服务器会向您的应用发送访问令牌（或您的应用可用于获取访问令牌的授权代码）以及该令牌授予的访问范围列表。如果用户未授予权限，服务器会返回错误。

通常，最佳做法是在需要访问权限时逐步请求相应范围，而不是提前请求。例如，如果应用支持将活动保存到日历，则在用户按下“添加到日历”按钮之前，不应请求 Google 日历访问权限；请参阅增量授权。

3. 检查用户授予的访问权限范围。

将访问令牌响应中包含的范围与访问应用的功能和相关 Google API 所需的范围进行比较。停用应用中无法在未访问相关 API 的情况下运行的所有功能。

即使用户已授予所有请求的范围，请求中包含的范围也可能与响应中包含的范围不一致。如需了解访问所需的范围，请参阅每个 Google API 的文档。API 可以将多个范围字符串值映射到单个访问范围，并针对请求中允许的所有值返回相同的范围字符串。 示例：当应用请求用户授权 https://www.google.com/m8/feeds/ 范围时，Google People API 可能会返回 https://www.googleapis.com/auth/contacts 范围；Google People API 方法 people.updateContact 需要授予 https://www.googleapis.com/auth/contacts 范围。

4. 将访问令牌发送到 API。

应用获取访问令牌后，会在 HTTP 授权请求标头中将令牌发送到 Google API。 您可以将令牌作为 URI 查询字符串参数发送，但我们不建议这样做，因为 URI 参数最终可能会出现在安全性不完全可靠的日志文件中。此外，避免创建不必要的 URI 参数名称也是 REST 的良好实践。

访问令牌仅对令牌请求的 scope 中所述的一组操作和资源有效。例如，如果为 Google 日历 API 签发了访问令牌，则该令牌不会授予对 Google 通讯录 API 的访问权限。不过，您可以多次将该访问令牌发送到 Google 日历 API，以执行类似操作。

5. 如有必要，请刷新访问令牌。

访问令牌的生命周期是有限的。如果您的应用需要在单个访问令牌的生命周期之外访问 Google API，则可以获取刷新令牌。借助刷新令牌，您的应用可以获取新的访问令牌。

场景

Web 服务器应用

Google OAuth 2.0 端点支持使用 PHP、Java、Go、Python、Ruby 和 ASP.NET 等语言和框架的 Web 服务器应用。

当您的应用将浏览器重定向到 Google 网址时，授权序列即告开始；该网址包含用于指示请求的访问类型的查询参数。 Google 会处理用户身份验证、会话选择和用户意见征求。结果是授权代码，应用可以使用此代码来换取访问令牌和刷新令牌。

应用应存储刷新令牌以备日后使用，并使用访问令牌访问 Google API。访问令牌过期后，应用会使用刷新令牌获取新的访问令牌。

您的应用会向 Google 授权服务器发送令牌请求，接收授权代码，将代码换取令牌，然后使用该令牌调用 Google API 端点。

如需了解详情，请参阅针对网络服务器应用使用 OAuth 2.0。

已安装的应用

Google OAuth 2.0 端点支持安装在计算机、移动设备和平板电脑等设备上的应用。通过 创建客户端 ID 时，请指定这是已安装的应用，然后选择 Android、Chrome 应用、iOS、通用 Windows 平台 (UWP) 或桌面应用作为应用类型。

该过程会生成客户端 ID，在某些情况下还会生成客户端密钥，您需要将这些信息嵌入到应用的源代码中。（在这种情况下，客户端密钥显然不会被视为 Secret。）

当您的应用将浏览器重定向到 Google 网址时，授权序列即告开始；该网址包含用于指示请求的访问类型的查询参数。 Google 会处理用户身份验证、会话选择和用户意见征求。结果是授权代码，应用可以使用此代码来换取访问令牌和刷新令牌。

应用应存储刷新令牌以备日后使用，并使用访问令牌访问 Google API。访问令牌过期后，应用会使用刷新令牌获取新的访问令牌。

您的应用会向 Google 授权服务器发送令牌请求，接收授权代码，将代码换取令牌，然后使用该令牌调用 Google API 端点。

如需了解详情，请参阅 为已安装的应用使用 OAuth 2.0。

客户端 (JavaScript) 应用

Google OAuth 2.0 端点支持在浏览器中运行的 JavaScript 应用。

当您的应用将浏览器重定向到 Google 网址时，授权序列即告开始；该网址包含用于指示请求的访问类型的查询参数。 Google 会处理用户身份验证、会话选择和用户意见征求。

结果是访问令牌，客户端应先对其进行验证，然后再将其包含在 Google API 请求中。令牌过期后，应用会重复此过程。

您的 JS 应用会向 Google 授权服务器发送令牌请求，接收令牌，验证令牌，然后使用该令牌调用 Google API 端点。

如需了解详情，请参阅为客户端应用使用 OAuth 2.0。

输入受限的设备上的应用

Google OAuth 2.0 端点支持在输入有限的设备（例如游戏机、摄像头和打印机）上运行的应用。

授权序列从应用向 Google 网址发出 Web 服务请求以获取授权代码开始。响应包含多个参数，包括网址和应用向用户显示的代码。

用户从设备获取网址和代码，然后切换到具有更丰富输入功能的其他设备或计算机。用户启动浏览器，前往指定网址，登录并输入代码。

与此同时，应用会按指定的时间间隔轮询 Google 网址。用户批准访问权限后，Google 服务器的响应中会包含访问令牌和刷新令牌。应用应存储刷新令牌以备日后使用，并使用访问令牌访问 Google API。访问令牌过期后，应用会使用刷新令牌获取新的访问令牌。

用户在具有浏览器的其他设备上登录

如需了解详情，请参阅针对设备使用 OAuth 2.0。

服务账号

Prediction API 和 Google Cloud Storage 等 Google API 可以代表您的应用执行操作，而无需访问用户信息。在这些情况下，您的应用需要向 API 证明自己的身份，但无需征得用户同意。同样，在企业场景中，您的应用可以请求对某些资源的委托访问权限。

对于此类服务器间互动，您需要使用服务账号，服务账号属于您的应用，而不是某个最终用户。您的应用会代表服务账号调用 Google API，并且无需征得用户同意。（在非服务账号场景中，您的应用代表最终用户调用 Google API，有时需要征得用户同意。）

服务账号的凭据（您可以从 获取）包括一个生成的唯一电子邮件地址、一个客户 ID 和至少一个公钥/私钥对。您可以使用客户端 ID 和一个私钥创建已签名的 JWT，并以适当的格式构建访问令牌请求。 然后，您的应用会将令牌请求发送到 Google OAuth 2.0 授权服务器，后者会返回访问令牌。应用使用该令牌访问 Google API。令牌过期后，应用会重复此过程。

您的服务器应用使用 JWT 从 Google 授权服务器请求令牌，然后使用该令牌调用 Google API 端点。不涉及任何最终用户。

如需了解详情，请参阅 服务账号文档。

令牌大小

令牌的大小可大可小，但不得超过以下限制：

  • 授权代码：256 字节
  • 访问令牌：2048 字节
  • 刷新令牌：512 字节

Google Cloud 的 Security Token Service API 返回的访问令牌的结构与 Google API OAuth 2.0 访问令牌类似，但令牌大小限制不同。如需了解详情，请参阅 API 文档。

Google 保留在这些限制范围内更改令牌大小的权利，并且您的应用必须相应地支持可变令牌大小。

刷新令牌过期

您必须在编写代码时预料到已授予的刷新令牌可能会失效。刷新令牌可能会因以下原因之一而停止工作：

如果 Google Cloud 平台项目为外部用户类型配置了 OAuth 意见征求页面，并且发布状态为“测试”，则系统会为其颁发有效期为 7 天的刷新令牌，除非请求的唯一 OAuth 范围是名称、电子邮件地址和用户个人资料的一部分（通过 userinfo.email, userinfo.profile, openid 范围或其 OpenID Connect 等效项）。

目前，每个 Google 账号的每个 OAuth 2.0 客户端 ID 的刷新令牌数量上限为 100 个。 如果您达到此上限，则当您创建新刷新令牌时，最旧的刷新令牌会自动失效，且系统不会显示警告。此限制不适用于服务账号。

此外，用户账号或服务账号在所有客户端中可以拥有的刷新令牌总数也有更大的上限。大多数普通用户不会超过此上限，但用于测试实现的开发者账号可能会超过此上限。

如果您需要为多个程序、计算机或设备授权，一种解决方法是将每个 Google 账号授权的客户端数量限制为 15 个或 20 个。如果您是 Google Workspace 管理员，则可以创建其他具有管理员权限的用户，并使用这些用户授权某些客户端。

处理 Google Cloud Platform (GCP) 组织的会话控制政策

GCP 组织的管理员可能会要求用户在使用 Google Cloud 会话控制功能访问 GCP 资源时，经常重新进行身份验证。此政策会影响对 Google Cloud 控制台、Google Cloud SDK（也称为 gcloud CLI）以及需要 Cloud Platform 权限范围的任何第三方 OAuth 应用的访问权限。如果用户已实施会话控制政策，那么在会话时长到期后，您的 API 调用将会出错，就像刷新令牌被撤消时会发生的情况一样 - 调用将失败并返回错误类型 invalid_grant；error_subtype 字段可用于区分已撤消的令牌和因会话控制政策（例如 "error_subtype": "invalid_rapt"）而导致的失败。由于会话时长可能非常有限（介于 1 小时到 24 小时之间），因此必须通过重启身份验证会话来妥善处理此场景。

同样，您不得使用或鼓励使用用户凭据进行服务器到服务器部署。如果用户凭据部署在服务器上用于长时间运行的作业或操作，并且客户对此类用户应用会话控制政策，则服务器应用将会失败，因为在会话时长到期时将无法重新对用户进行身份验证。

如需详细了解如何帮助客户部署此功能，请参阅这篇以管理员为中心的帮助文章。

客户端库

以下客户端库可与热门框架集成，从而简化 OAuth 2.0 的实现。我们会不断在这些库中添加更多功能。