针对移动应用和桌面应用的 OAuth 2.0

本文档介绍了安装在手机、平板电脑和计算机等设备上的应用如何使用 Google 的 OAuth 2.0 端点来授权访问 YouTube Analytics API 或 YouTube Reporting API。

OAuth 2.0 可让用户与应用共享特定数据，同时保持其用户名、密码和其他信息的私密性。例如，应用可以使用 OAuth 2.0 获取检索频道的 YouTube 数据分析数据的权限。

已安装的应用会分发到各个设备，并且假定这些应用无法保密。在用户使用应用时或应用在后台运行时，它们可以访问 Google API。

此授权流程与用于网站服务器应用的流程类似。主要区别在于，已安装的应用必须打开系统浏览器并提供本地重定向 URI，以处理来自 Google 授权服务器的响应。

替代方案

对于移动应用，您可能更倾向于使用 Android 版或 iOS 版 Google 登录。Google 登录客户端库可处理身份验证和用户授权，并且实现起来可能比此处所述的较低级别协议更简单。

对于在不支持系统浏览器或输入功能受限的设备（例如电视、游戏机、摄像头或打印机）上运行的应用，请参阅适用于电视和设备的 OAuth 2.0 或在电视和输入受限的设备上登录。

库和示例

我们建议您使用以下库和示例来帮助您实现本文档中介绍的 OAuth 2.0 流程：

• 适用于 Android 的 AppAuth 库
• 适用于 iOS 的 AppAuth 库
• 适用于应用的 OAuth：Windows 示例

前提条件

为您的项目启用 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. 使用“库”页面查找并启用 YouTube Analytics API 和 YouTube Reporting API。许多用于检索 YouTube 数据分析数据的应用还会与 YouTube Data API 交互。找到您的应用将使用的任何其他 API，并将其也启用。

创建授权凭据

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

1. Go to the Credentials page.
2. 依次点击创建凭据 > OAuth 客户端 ID。
3. 以下部分介绍了 Google 授权服务器支持的客户端类型。选择为您的应用推荐的客户端类型，为您的 OAuth 客户端命名，并根据需要设置表单中的其他字段。

确定访问权限范围

有了这一范围，您不但可以让应用仅请求访问所需的资源，而且还可以让用户控制其向您的应用授予的访问权限大小。因此，请求的范围数量与获得用户同意的可能性之间可能存在反比关系。

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

YouTube Analytics API 使用以下范围：

YouTube Reporting API 使用以下作用域：

OAuth 2.0 API 范围文档包含您可能用来访问 Google API 的完整范围列表。

获取 OAuth 2.0 访问令牌

以下步骤展示了您的应用如何与 Google 的 OAuth 2.0 服务器交互，以便征得用户同意代表用户执行 API 请求。您的应用必须先征得用户同意，然后才能执行需要用户授权的 Google API 请求。

第 1 步：生成代码验证器和质询

Google 支持用于代码交换的证明密钥 (PKCE) 协议，以提高已安装应用的流程安全性。系统会为每个授权请求创建一个唯一的代码验证器，并将其转换后的值（称为“code_challenge”）发送到授权服务器以获取授权代码。

创建代码验证器

code_verifier 是一种高熵加密随机字符串，使用未预留的字符 [A-Z] / [a-z] / [0-9] / “-”/“.”/“_”/“~”，长度不得低于 43 个字符，不得高于 128 个字符。

代码验证器应具有足够的熵，以使猜测其值变得不可行。

创建代码挑战

支持通过两种方法创建代码验证。

code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier)))

code_challenge = code_verifier

第 2 步：向 Google 的 OAuth 2.0 服务器发送请求

如需获取用户授权，请向 Google 的授权服务器 https://accounts.google.com/o/oauth2/v2/auth 发送请求。此端点用于处理有效会话查询、对用户进行身份验证并征得用户同意。该端点只能通过 SSL 访问，并且拒绝 HTTP（非 SSL）连接。

授权服务器支持为已安装的应用提供以下查询字符串参数：

授权网址示例

以下标签页显示了不同重定向 URI 选项的授权网址示例。

除了 redirect_uri 参数的值外，这两个网址完全相同。网址还包含必需的 response_type 和 client_id 参数以及可选的 state 参数。为了便于阅读，每个网址都包含换行符和空格。

https://accounts.google.com/o/oauth2/v2/auth?
 scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyt-analytics.readonly&
 response_type=code&
 state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foauth2.example.com%2Ftoken&
 redirect_uri=com.example.app%3A/oauth2redirect&
 client_id=client_id

https://accounts.google.com/o/oauth2/v2/auth?
 scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyt-analytics.readonly&
 response_type=code&
 state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foauth2.example.com%2Ftoken&
 redirect_uri=http%3A//127.0.0.1%3A9004&
 client_id=client_id

第 3 步：Google 提示用户同意

在此步骤中，用户决定是否向您的应用授予所请求的访问权限。在此阶段，Google 会显示一个意见征求窗口，其中显示应用的名称，以及请求权限来使用用户授权凭据进行访问的 Google API 服务，以及要授予的访问范围摘要。然后，用户可以同意授予对应用请求的一个或多个范围的访问权限，也可以拒绝该请求。

在此阶段，您的应用无需执行任何操作，只需等待 Google 的 OAuth 2.0 服务器的响应，以确定是否已授予任何访问权限。下一步将介绍该响应。

第 4 步：处理 OAuth 2.0 服务器响应

应用接收授权响应的方式取决于其使用的重定向 URI 架构。无论采用哪种方案，响应都将包含授权代码 (code) 或错误 (error)。例如，error=access_denied 表示用户拒绝了请求。

如果用户授予对应用的访问权限，您可以将授权代码换成访问令牌和刷新令牌，如下一步所述。

第 5 步：使用授权代码换取刷新令牌和访问令牌

如需使用授权代码交换访问令牌，请调用 https://oauth2.googleapis.com/token 端点并设置以下参数：

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

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

code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&
client_id=your_client_id&
client_secret=your_client_secret&
redirect_uri=http://127.0.0.1:9004&
grant_type=authorization_code

Google 会通过返回包含短时有效访问令牌和刷新令牌的 JSON 对象来响应此请求。

响应包含以下字段：

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

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "token_type": "Bearer",
  "scope": "https://www.googleapis.com/auth/yt-analytics.readonly https://www.googleapis.com/auth/calendar.readonly",
  "refresh_token": "1//xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
}

第 6 步：查看用户授予了哪些权限范围

同时请求多个范围时，用户可能不会授予您的应用请求的所有范围。 您的应用应始终检查用户授予了哪些镜重范围，并通过停用相关功能来处理任何镜重范围被拒的情况。如需了解详情，请参阅如何处理精细权限。

如需检查用户是否已向您的应用授予对特定范围的访问权限，请检查访问令牌响应中的 scope 字段。access_token 授予的访问范围，表示为以空格分隔且区分大小写的字符串列表。

例如，以下访问令牌响应示例表明，用户已向您的应用授予对只读 Drive 活动和日历活动权限的访问权限：

  {
    "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
    "expires_in": 3920,
    "token_type": "Bearer",
    "scope": "https://www.googleapis.com/auth/yt-analytics.readonly https://www.googleapis.com/auth/calendar.readonly",
    "refresh_token": "1//xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
  }

调用 Google API

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

请注意，YouTube Analytics API 不支持服务账号流程。YouTube 报告 API 仅支持拥有和管理多个 YouTube 频道的 YouTube 内容所有者的服务账号，例如唱片公司和电影制片公司。

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

HTTP GET 示例

使用 Authorization: Bearer HTTP 标头调用 reports.query 端点（YouTube Analytics API）的代码可能如下所示。请注意，您需要指定自己的访问令牌：

GET /youtube/analytics/v1/reports?ids=channel%3D%3DMINE&start-date=2016-05-01&end-date=2016-06-30&metrics=views HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

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

GET https://www.googleapis.com/youtube/analytics/v1/reports?access_token=access_token&ids=channel%3D%3DMINE&start-date=2016-05-01&end-date=2016-06-30&metrics=views

curl 示例

您可以使用 curl 命令行应用测试这些命令。下面是一个使用 HTTP 标头选项（首选）的示例：

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/youtube/analytics/v1/reports?ids=channel%3D%3DMINE&start-date=2016-05-01&end-date=2016-06-30&metrics=views

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

curl https://www.googleapis.com/youtube/analytics/v1/reports?access_token=access_token&ids=channel%3D%3DMINE&start-date=2016-05-01&end-date=2016-06-30&metrics=views

刷新访问令牌

访问令牌会定期过期，并成为相关 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 https://www.googleapis.com/auth/calendar.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 以及错误代码。

应用重定向方法

保护您的应用

延伸阅读

IETF 现行最佳实践 OAuth 2.0 for Native Apps 中规定了本文档中记录的许多最佳实践。