适用于 TV 应用和受限输入设备应用的 OAuth 2.0

本文档介绍了如何实现 OAuth 2.0 授权，以便通过在电视、游戏机和打印机等设备上运行的应用访问 Google API。更具体地说，此流程适用于既没有设备访问权限的设备， 或输入功能有限。

OAuth 2.0 允许用户与应用共享特定数据，同时 用户名、密码和其他隐私信息 例如，电视应用可以使用 OAuth 2.0 来获得 选择存储在 Google 云端硬盘中的文件。

由于使用此流程的应用会分发到各个设备，因此假定这些应用无法保密。它们可以在用户 或当应用在后台运行时

替代方案

如果您要针对 Android、iOS、macOS、Linux 或 Windows 等平台编写应用 （包括通用 Windows 平台），可以访问浏览器和完整输入 请使用适用于移动设备的 OAuth 2.0 流程 和桌面应用。（即使您的应用是没有图形界面的命令行工具，也应使用该流程。）

如果您只希望让用户使用其 Google 账号登录并使用 JWT ID 令牌，用于获取基本用户个人资料信息。 请参阅登录 视频。

前提条件

为您的项目启用 API

任何调用 Google API 的应用都需要在 API Console中启用这些 API。

如需为您的项目启用该 API，请按以下步骤操作：

1. Google API Console中的Open the API Library 。
2. If prompted, select a project, or create a new one.
3. API Library 列出了所有可用的 API（按产品分组） 家庭和受欢迎程度。如果列表中没有显示您要启用的 API，请使用搜索功能 找到，或在产品系列中点击查看全部。
4. 选择您要启用的 API，然后点击启用按钮。
5. If prompted, enable billing.
6. If prompted, read and accept the API's Terms of Service.

创建授权凭据

任何使用 OAuth 2.0 访问 Google API 的应用都必须具有授权凭据，以向 Google 的 OAuth 2.0 服务器表明应用的身份。以下步骤介绍了如何为项目创建凭据。然后，您的应用便可使用这些凭据访问您为该项目启用的 API。

1. Go to the Credentials page.
2. 依次点击创建凭据 > OAuth 客户端 ID。
3. 选择电视和受限输入设备应用类型。
4. 为您的 OAuth 2.0 客户端命名，然后点击创建。

确定访问权限范围

范围让您的应用可以仅请求访问所需的资源，同时 让用户能够控制他们向您的应用授予的访问权限大小。因此， 请求的范围数量与可能性 征得用户同意。

在开始实现 OAuth 2.0 授权之前，我们建议您确定范围 您的应用需要获取访问权限的请求。

请参阅已安装的应用或设备的允许的范围列表。

获取 OAuth 2.0 访问令牌

即使您的应用在输入功能有限的设备上运行，用户也必须拥有对输入功能更丰富的设备的单独访问权限，才能完成此授权流程。 该流程包含以下步骤：

1. 您的应用向 Google 授权服务器发送请求以识别相关范围 您的应用将请求访问权限。
2. 服务器会响应并返回一些信息，以供后续步骤使用，例如设备代码和用户代码。
3. 您可以显示用户可以在其他设备上输入的信息，以便授权您的应用。
4. 您的应用会开始轮询 Google 的授权服务器，以确定用户是否已授权您的应用。
5. 用户切换到输入功能更丰富的设备，启动网络浏览器，前往第 3 步中显示的网址，然后输入第 3 步中显示的代码。然后，用户可以授予（或拒绝）对应用的访问权限。
6. 对轮询请求的下一个响应包含应用需要授权的令牌 代表用户发出请求。（如果用户拒绝访问您的应用，则响应 不包含词元。）

下图展示了此流程：

以下部分将详细介绍这些步骤。考虑到功能和运行时长的范围 设备可能具有的环境，本文档中显示的示例使用的是 curl 命令行实用程序。这些示例应该可以轻松移植到各种语言和运行时。

第 1 步：请求设备和用户代码

在此步骤中，您的设备会向 Google 的授权服务器 (https://oauth2.googleapis.com/device/code) 发送 HTTP POST 请求，其中包含您的应用以及您的应用想要代表用户访问的访问范围。您应使用 device_authorization_endpoint 元数据值从发现文档检索此网址。包含以下 HTTP 请求 参数：

示例

以下代码段显示了一个示例请求：

POST /device/code HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=client_id&scope=email%20profile

以下示例展示了用于发送相同请求的 curl 命令：

curl -d "client_id=client_id&scope=email%20profile" \
     https://oauth2.googleapis.com/device/code

第 2 步：处理授权服务器响应

授权服务器将返回以下响应之一：

成功响应

如果请求有效，您的响应将是一个包含以下属性的 JSON 对象：

以下代码段显示了一个示例响应：

{
  "device_code": "4/4-GMMhmHCXhWEzkobqIHGG_EnNYYsAkukHspeYUk9E8",
  "user_code": "GQVQ-JKEC",
  "verification_url": "https://www.google.com/device",
  "expires_in": 1800,
  "interval": 5
}

“已超出配额”响应

如果您的设备代码请求已超出与您的客户端 ID 关联的配额，您将需要 收到包含以下错误的 403 响应：

{
  "error_code": "rate_limit_exceeded"
}

在这种情况下，请使用退避策略来降低请求速率。

第 3 步：显示用户代码

向用户显示在第 2 步中获取的 verification_url 和 user_code。这两个值可以包含 US-ASCII 字符集中的任何可打印字符。内容 应指示用户导航至 在另一台设备上输入 verification_url，然后输入 user_code。

设计界面时，请遵循以下规则：

• user_code
  • user_code 必须显示在可处理 15“W”值的字段中尺码 字符。也就是说，如果您可以将代码 WWWWWWWWWWWWWWW 正确，则您的 UI 是有效的，因此我们建议您在测试 user_code 会显示在您的界面中。
  • user_code 区分大小写，不应以任何方式进行修改，例如 更改大小写或插入其他格式字符。
• verification_url
  • 用于显示 verification_url 的空间必须足够宽，才能处理长度为 40 个字符的网址字符串。
  • 您不得以任何方式修改 verification_url，但可以选择移除要显示的架构。如果您确实出于显示原因计划从网址中剥离 Scheme（例如 https://），请确保您的应用可以同时处理 http 和 https 变体。

第 4 步：轮询 Google 的授权服务器

由于用户将使用单独的设备导航到 verification_url 并授予（或拒绝）访问权限，则当用户请求访问 Cookie 时，系统不会自动通知 对访问请求做出响应因此，发出请求的设备需要轮询 Google 的授权服务器，以确定用户何时响应了请求。

发出请求的设备应继续发送轮询请求，直到收到响应 表示用户已响应访问请求，或直到 device_code 在 中获得了 [user_code] 第 2 步已过期。第 2 步中返回的 interval 指定了请求之间等待的时间（以秒为单位）。

要轮询的端点的网址为 https://oauth2.googleapis.com/token。轮询请求 包含以下参数：

示例

以下代码段显示了一个示例请求：

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=client_id&
client_secret=client_secret&
device_code=device_code&
grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code

以下示例展示了用于发送同一请求的 curl 命令：

curl -d "client_id=client_id&client_secret=client_secret& \
         device_code=device_code& \
         grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code" \
         -H "Content-Type: application/x-www-form-urlencoded" \
         https://oauth2.googleapis.com/token

第 5 步：用户响应访问权限请求

下图显示了一个页面，这个页面与用户导航到 verification_url（在第 3 步中显示）：

进入 user_code 并登录 Google（如果尚未登录），用户会看到如下所示的意见征求界面：

第 6 步：处理对轮询请求的响应

Google 的授权服务器会使用以下某种响应来响应每个轮询请求：

已授予访问权限

如果用户向设备授予了访问权限（通过点击同意屏幕上的 Allow）， 则响应包含访问令牌和刷新令牌。这些令牌可让您的设备 代表用户访问 Google API。（响应中的 scope 属性决定了设备可以访问哪些 API。）

在这种情况下，API 响应包含以下字段：

以下代码段显示了一个示例响应：

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
  "token_type": "Bearer",
  "refresh_token": "1/xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
}

访问令牌的生命周期有限。如果您的应用需要长时间访问某个 API 在一段时间内，它可以使用刷新令牌来获取新的访问权限 令牌。如果您的应用需要此类访问权限，则应存储刷新令牌以供日后使用。

访问遭拒

如果用户拒绝授予对设备的访问权限，则服务器响应将包含 403 HTTP 响应状态代码 (Forbidden)。响应包含以下错误：

{
  "error": "access_denied",
  "error_description": "Forbidden"
}

待授权

如果用户尚未完成授权流程，则服务器会返回 428 HTTP 响应状态代码 (Precondition Required)。响应 包含以下错误：

{
  "error": "authorization_pending",
  "error_description": "Precondition Required"
}

轮询过于频繁

如果设备发送轮询请求的频率过高，则服务器会返回 403 HTTP 响应状态代码 (Forbidden)。响应包含以下错误：

{
  "error": "slow_down",
  "error_description": "Forbidden"
}

其他错误

如果轮询请求缺少任何必需，则授权服务器也会返回错误。 或参数值不正确。这些请求通常具有 400 (Bad Request) 或 401 (Unauthorized) HTTP 响应状态代码。这些错误包括：

调用 Google API

在您的应用获得访问令牌后，您就可以使用该令牌调用 Google 代表指定的 用户账号（如果已授予 API 所需的访问权限范围）。为此，请添加 通过添加 access_token 查询来获取对 API 的请求中的访问令牌 参数或 Authorization HTTP 标头 Bearer 值。请尽可能使用 HTTP 标头，因为查询字符串通常会显示在服务器日志中。在大多数情况下，您可以使用客户端库设置对 Google API 的调用（例如，调用 Drive Files API 时）。

您可以在 OAuth 2.0 Playground 中试用所有 Google API 并查看其范围。

HTTP GET 示例

使用 Authorization: Bearer HTTP 标头调用 drive.files 端点（即云端硬盘文件 API）的代码可能如下所示。请注意，您需要指定自己的访问令牌：

GET /drive/v2/files HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

以下是使用 access_token 查询字符串参数对已验证用户调用同一 API 的示例：

GET https://www.googleapis.com/drive/v2/files?access_token=access_token

curl 示例

您可以使用 curl 命令行应用测试这些命令。这里有 使用 HTTP 标头选项的示例（首选）：

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files

或者，也可以使用查询字符串参数选项：

curl https://www.googleapis.com/drive/v2/files?access_token=access_token

刷新访问令牌

访问令牌会定期过期，并成为相关 API 请求的无效凭据。如果您请求离线访问与令牌关联的范围，则可以刷新访问令牌，而不提示用户授予权限（包括在用户不存在的情况下）。

如需刷新访问令牌，您的应用会向 Google 的授权服务器 (https://oauth2.googleapis.com/token) 发送包含以下参数的 HTTPS POST 请求：

以下代码段显示了一个示例请求：

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=your_client_id&
client_secret=your_client_secret&
refresh_token=refresh_token&
grant_type=refresh_token

只要用户未撤消向应用授予的访问权限，令牌服务器就会返回包含新访问令牌的 JSON 对象。以下代码段显示了示例响应：

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "https://www.googleapis.com/auth/drive.metadata.readonly",
  "token_type": "Bearer"
}

请注意，发出的刷新令牌有数量限制；每个上限 客户/用户组合，以及另一个针对所有客户端的每位用户。您应将刷新令牌保存在长期存储空间中，并在其有效期间继续使用。如果您的应用 请求过多刷新令牌，可能会受到这些限制，在这种情况下，较旧的刷新令牌 将停止运行。

撤消令牌

在某些情况下，用户可能希望撤消授予应用的访问权限。用户可以访问账号设置来撤消访问权限。请参阅 删除 第三方网站和应用的“网站或应用访问权限”部分有权访问您账号的应用 支持文档。

应用还可以通过程序化方式撤消授予给它的访问权限。 在用户取消订阅、移除应用或应用所需的 API 资源发生重大变化的情况下，程序化撤消非常重要。换言之， 移除流程的必要步骤可能包括 API 请求， 授予该应用的权限。

要以编程方式撤销令牌，您的应用会向 https://oauth2.googleapis.com/revoke，并以参数的形式添加令牌：

curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
        https://oauth2.googleapis.com/revoke?token={token}

令牌可以是访问令牌，也可以是刷新令牌。如果令牌是访问令牌，且具有 相应的刷新令牌，相应刷新令牌也会被撤消。

如果撤消操作成功处理，则响应的 HTTP 状态代码为 200。对于错误情况，系统会随同返回 HTTP 状态代码 400 以及错误代码。

允许的范围

只有以下范围支持针对设备的 OAuth 2.0 流程：