将 Google 帐号关联至 OAuth

账号关联采用行业标准 OAuth 2.0 隐式和授权代码流程。

适用于代理的 OAuth 2.1 和 PKCE

对于无状态 AI 代理和多模态流水线，建议强制执行 OAuth 2.1。

  • PKCE（用于代码交换的证明密钥）：必须用于保护授权代码流程，防止拦截攻击。
  • 无隐式流程：隐式流程会在网址中公开访问令牌，这对于代理环境而言是一种安全风险。

您的服务必须支持符合 OAuth 2.0/2.1 标准的授权和令牌交换端点。

在 隐式 流程中，Google 会在用户的浏览器中打开您的授权端点。成功登录后，您会向 Google 返回长期有效的访问令牌。此访问令牌现在包含在 Google 发送的每个请求中。

在 授权代码 流程中，您需要两个端点：

  • 授权 端点，用于向尚未登录的用户显示登录界面。授权端点还会创建一个短期有效的授权代码，以记录用户对所请求访问权限的同意情况。

  • 令牌交换 端点，负责两种类型的交换：

    1. 将授权代码交换为长期有效的刷新令牌和短期有效的访问令牌。当用户完成账号关联流程时，会发生此交换。
    2. 将长期有效的刷新令牌交换为短期有效的访问令牌。 当 Google 需要新的访问令牌（因为其拥有的访问令牌已过期）时，会发生此交换。

选择 OAuth 2.0 流程

虽然 隐式 流程的实现较为简单，但 Google 建议通过隐式流程颁发的访问令牌永不过期。这是因为，如果令牌通过隐式流程过期，用户就必须再次关联其账号。如果您出于安全原因需要令牌过期，我们强烈建议您改用 授权代码 流程。

设计准则

本部分介绍了您为 OAuth 关联流程托管的用户界面的设计要求和建议。在 Google 的应用调用后，您的平台会向用户显示“登录 Google”页面和账号关联同意屏幕。用户同意关联账号后，系统会将用户重定向回 Google 的应用。

此图显示了用户将其 Google 账号与您的身份验证系统相关联的步骤。第一个屏幕截图显示了用户从您的平台发起的关联。第二张图片显示了用户登录 Google 的界面，第三张图片显示了用户同意并确认将自己的 Google 账号与您的应用相关联的界面。最后一张屏幕截图显示了 Google 应用中成功关联的用户账号。
图 1.账号关联用户登录 Google 和同意屏幕。

要求

  1. 您必须说明，用户的账号将与 Google 关联， 而不是与 Google Home 或 Google 助理等特定 Google 产品关联。

建议

建议您执行以下操作：

  1. 显示 Google 的隐私权政策。在权限请求页面上添加指向 Google 的隐私权政策 的链接。

  2. 要共享的数据。 使用清晰简洁的语言告知用户 Google 需要哪些数据及其原因。

  3. 明确的号召性用语。 在同意屏幕上添加明确的号召性用语，例如“同意并关联”。 这是因为用户需要了解他们需要与 Google 共享哪些数据才能关联其账号。

  4. 能够取消。 为用户提供返回或取消的方式（如果他们选择不关联）。

  5. 清晰的登录流程。 确保用户有清晰的 Google 账号登录方法，例如用户名和密码字段，或 “使用 Google 账号登录”。

  6. 能够取消关联。 为用户提供取消关联的机制，例如指向您平台上账号设置的网址。或者，您可以 添加指向 Google 账号的链接，用户 可以在其中管理其关联的账号。

  7. 能够更改用户账号。 为用户提供切换账号的方法。如果用户倾向于拥有多个账号，这一点尤其有用。

    • 如果用户必须关闭权限请求页面才能切换账号，请向 Google 发送可恢复的错误，以便用户可以使用 OAuth 关联 和 隐式 流程登录所选账号。

  8. 添加您的徽标。 在权限请求页面上显示您的公司徽标。请按照您的样式指南放置徽标。如果您想要或需要 同时显示 Google 的徽标，请参阅 徽标和商标。

创建项目

如需创建项目以使用账号关联，请执行以下操作：

  1. 前往 Google API 控制台。
  2. 点击 Create project 。
  3. 输入名称或接受生成的建议。
  4. 确认或修改任何剩余字段。
  5. 点击创建 。

如需查看项目 ID，请执行以下操作：

  1. 前往 Google API 控制台。
  2. 在着陆页的表格中找到您的项目。项目 ID 会显示在 ID 列中。

Google 账号关联过程包含一个权限请求页面，该页面会告知用户请求访问其数据的应用、应用请求的数据类型以及适用的条款。您需要先配置 OAuth 权限请求页面，然后才能生成 Google API 客户端 ID。

  1. 打开 Google API 控制台的 OAuth 权限请求页面 页面。
  2. 如果系统提示您选择项目，请选择您刚刚创建的项目。

  3. 在“OAuth 权限请求页面”上，填写表单，然后点击“保存”按钮。

    应用名称 ：向用户征求同意的应用的名称。该名称应准确反映您的应用，并且与用户在其他位置看到的应用名称保持一致。应用名称将显示在账号关联权限请求页面上。

    应用徽标：权限请求页面上显示的一张图片，用以让用户认出您的应用。徽标会显示在账号关联权限请求页面和账号设置中

    支持邮箱 ：用户用于针对其同意问题与您联系的邮箱。

    Google API 的范围 ：范围允许您的应用访问用户的私有 Google 数据。对于 Google 账号关联用例，默认范围（邮箱、个人资料、openid）就足够了，您无需添加任何敏感范围。通常，最佳做法是在需要访问权限时逐步请求范围，而不是提前请求。了解详情。

    已获授权的网域 ：为了保护您和您的用户，Google 只允许使用 OAuth 进行身份验证的应用使用已获授权的网域。您应用的链接必须托管在已获授权的网域上。了解详情。

    应用首页链接 ：应用的首页。必须托管在已获授权的网域上。

    应用隐私权政策链接 ：显示在 Google 账号关联权限请求页面上。必须托管在已获授权的网域上。

    应用服务条款链接（可选） ：必须托管在已获授权的网域上。

    图 1. 虚构应用 Tunery 的 Google 账号关联权限请求页面

  4. 查看“验证状态”，如果您的应用需要验证，请点击“提交以进行验证”按钮，提交应用以进行验证。如需了解详情，请参阅 OAuth 验证要求。

实现 OAuth 服务器

验证您的实现

您可以使用 OAuth 2.0 Playground 工具验证您的实现。

在该工具中，执行以下步骤：

  1. 点击配置 以打开“OAuth 2.0 配置”窗口。
  2. 在 OAuth flow（OAuth 流程）字段中，选择 Client-side（客户端）。
  3. 在 OAuth Endpoints 字段中，选择 Custom。
  4. 在相应字段中指定您的 OAuth 2.0 端点以及您分配给 Google 的客户端 ID。
  5. 在第 1 步部分中，请勿选择任何 Google 范围。请将此字段留空，或输入适用于您服务器的范围（如果您不使用 OAuth 范围，则输入任意字符串）。完成后，点击 Authorize APIs。
  6. 在第 2 步和第 3 步部分中，完成 OAuth 2.0 流程，并验证每个步骤是否按预期运行。

您可以使用 Google 账号关联演示工具验证您的实现。

在该工具中，执行以下步骤：

  1. 点击使用 Google 账号登录按钮。
  2. 选择您要关联的账号。
  3. 输入服务 ID。
  4. （可选）输入您将请求访问的一个或多个范围。
  5. 点击开始演示。
  6. 当系统提示时，请确认您可以同意或拒绝关联请求。
  7. 确认您已重定向到相应平台。