使用 OAuth 2.0 访问 Google API

Google API 使用 OAuth 2.0 协议进行身份验证和授权。Google 支持常见的 OAuth 2.0 场景,例如 Web 服务器应用、客户端应用、已安装应用和输入受限的应用场景。

首先,从 Google API Console 获取 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. 从 Google API Console获取 OAuth 2.0 凭据。

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

您必须创建适合您的应用将在其上运行的平台的 OAuth 客户端,例如:

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

您的应用必须先获取用于授予对该 API 的访问权限的访问令牌,然后才能使用 Google API 访问私有数据。单个访问令牌可授予对多个 API 的不同级别的访问权限。一个名为 scope 的变量参数用于控制访问令牌允许的资源和操作集。在访问令牌请求期间,您的应用会在 scope 参数中发送一个或多个值。

有多种方法可以发出此请求,这些方法因您正在构建的应用类型而异。例如,JavaScript 应用可能会使用浏览器重定向到 Google 来请求访问令牌,而安装在没有浏览器的设备上的应用则会使用网络服务请求。

某些请求需要用户通过其 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 Authorization 请求标头中将令牌发送到 Google API。您可以将令牌作为 URI 查询字符串参数发送,但我们不建议这样做,因为 URI 参数最终可能会出现在并非完全安全的日志文件中。此外,在 REST 方法中建议您避免创建不必要的 URI 参数名称。

访问令牌仅对令牌请求的 scope 中描述的一组操作和资源有效。例如,如果为 Google 日历 API 颁发了访问令牌,则它不会授予对 Google Contacts API 的访问权限。但是,您可以将该访问令牌多次发送到 Google Calendar 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 端点支持安装在计算机、移动设备和平板电脑等设备上的应用。当您通过 Google API Console 创建客户端 ID 时,请指定这是已安装的应用,然后选择 Android、Chrome 应用、iOS、通用 Windows 平台 (UWP) 或桌面应用作为应用类型。

该过程会生成一个客户端 ID,在某些情况下还会生成客户端密钥,您应将其嵌入应用的源代码中。(在这种情况下,客户端密钥显然不被视为密钥。)

当您的应用将浏览器重定向到某个 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,有时需要征得用户同意。)

服务帐号的凭据(您可以从 Google API Console获取)包含一个生成的唯一电子邮件地址、客户端 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 Platform 项目配置了 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 组织的管理员在用户访问 GCP 资源时,可能需要频繁地使用 Google Cloud 会话控制功能重新进行身份验证。此政策会影响对 Google Cloud 控制台、Google Cloud SDK(也称为 gcloud CLI)以及任何需要 Cloud Platform 范围的第三方 OAuth 应用的访问。如果用户设置了会话控制政策,那么在会话时长到期时,您的 API 调用将出错,类似于刷新令牌被撤消时发生的情况 - 调用将失败并返回 invalid_grant 错误类型;error_subtype 字段可用于区分被撤消的令牌和由于会话控制政策导致的失败(例如,"error_subtype": "invalid_rapt")。由于会话时长必须在 4 小时以内,因此可以在 4 小时内妥善处理。

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

如需详细了解如何帮助客户部署此功能,请参阅这篇面向管理员的帮助文章

客户端库

以下客户端库与热门框架集成,这使得实现 OAuth 2.0 变得更加简单。我们会陆续将更多功能添加到库中。