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

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 授权请求标头中将该令牌发送到 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、Universal Windows Platform (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 网址发送授权代码网络服务请求开始。响应包含多个参数,包括网址和应用向用户显示的代码。

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

同时,该应用按指定的时间间隔轮询 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 天后过期。

目前,每个 OAuth 2.0 客户端 ID 最多只能有 50 个刷新令牌。 如果达到上限,则创建新的刷新令牌会自动让最旧的刷新令牌失效,且系统不会显示警告。此限制不适用于服务帐号

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

如果您需要对多个程序、计算机或设备进行授权,一种解决方法是将您为每个 Google 帐号授权的客户端数量限制为 15 或 20 个。如果您是 Google Workspace 管理员,您可以创建拥有管理员权限的其他用户,并使用他们向部分客户端授权。

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

GCP 组织的管理员可能需要在用户访问 GCP 资源时,频繁使用 Google Cloud 会话控制功能重新进行身份验证。此政策会影响对 Google Cloud Console、Google Cloud SDK(也称为 gcloud CLI)以及任何需要 Cloud Platform 范围的第三方 OAuth 应用的访问权限。如果用户设置了会话控制政策,那么会话时长到期后,您的 API 调用会出错,就像刷新令牌被撤消时一样 - 调用会失败,并显示错误类型 invalid_token;子错误类型可用于区分撤消令牌和会话控制政策导致的失败。由于会话时长可能非常有限(介于 1 小时到 24 小时之间),因此必须通过重启身份验证会话妥善处理这种情况。

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

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

客户端库

以下客户端库与热门框架集成,简化了 OAuth 2.0 的实现过程。我们将逐步为库添加更多功能。