使用 OAuth 2.0 访问 Google API

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

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

首先,从 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 以获取 Google 和您的应用均已知的 OAuth 2.0 凭据,例如客户端 ID 和客户端密钥。这组值因您正在构建的应用类型而异。例如,JavaScript 应用不需要密钥,但网络服务器应用需要密钥。

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 参数名称。

访问令牌仅对令牌请求的 scope 中所述的一组操作和资源有效。例如,如果针对 Google Calendar API 发出访问令牌,则不会授予对 Google Contacts API 的访问权限。不过,您可以将类似访问令牌多次发送给 Google Calendar API 来执行类似操作。

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

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

场景

Web 服务器应用

Google OAuth 2.0 端点支持使用语言和框架(如 PHP、Java、Python、Ruby 和 ASP.NET)的网络服务器应用。

当您的应用将浏览器重定向到 Google 网址时,授权序列就会开始;该网址包含查询参数,用于指明所请求的访问类型。 Google 会处理用户身份验证、会话选择和用户意见征求。最终得到一个授权代码,应用可用该代码交换访问令牌和刷新令牌。

应用应存储刷新令牌以供将来使用,并使用访问令牌来访问 Google API。访问令牌到期后,应用会使用刷新令牌获取新令牌。

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

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

已安装的应用

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

该过程会生成客户端 ID,在某些情况下还会生成客户端密钥,您可以将其嵌入应用的源代码中。(在这种情况下,客户端 Secret 显然不会被视为 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 网址发出授权代码网络服务请求。响应包含多个参数,包括网址和供用户向用户显示的代码。

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

同时,应用程序按指定的间隔轮询 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 保留更改这些限制中的令牌大小的权利,且您的应用必须支持相应的可变令牌大小。

刷新令牌过期

您必须编写代码以预测授予的刷新令牌可能失效的可能性。刷新令牌可能会因以下某种原因而停止运行:

  • 用户已撤消应用的访问权限
  • 刷新令牌已六个月未使用。
  • 用户更改了密码,并且刷新令牌包含 Gmail 范围。
  • 该用户帐号已超过已授予(实时)的刷新令牌数上限。
  • 用户所属 Google Cloud Platform 单位已实施会话控制政策。

如果 Google Cloud Platform 项目的 OAuth 同意屏幕配置为外部用户类型,且发布状态为“正在测试”,则颁发的刷新令牌将在 7 天后过期。

目前,每个 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_token;子错误类型可用于区分撤消令牌和会话控制政策失败的原因。由于会话时长可能非常有限(1 小时至 24 小时),因此必须通过重启身份验证会话妥善处理此情景。

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

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

客户端库

以下客户端库与热门框架集成,可让您更轻松地实现 OAuth 2.0。我们将逐步为库添加更多功能。