通过 OAuth 进行账号关联

OAuth 关联类型支持两种业界标准 OAuth 2.0 流程，即隐式和授权代码流程。

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

  • The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
  • The token exchange endpoint, which is responsible for two types of exchanges:
    1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
    2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

实现 OAuth 账号关联

配置项目

如需将项目配置为使用 OAuth 关联，请按以下步骤操作：

  1. 打开 Actions 控制台，然后选择您要使用的项目。
  2. 点击开发标签页，然后选择帐号关联。
  3. 启用帐号关联旁边的开关。
  4. 在帐号创建部分，选择不，我只允许在我的网站上创建帐号。

  5. 在关联类型中，依次选择 OAuth 和隐式。

  6. 在客户信息中：

    • 为您的 Actions 向 Google 发出的客户端 ID 分配一个值，以标识来自 Google 的请求。
    • 插入授权端点和令牌交换端点的网址。
  1. 点击保存。

实现 OAuth 服务器

为了支持 OAuth 2.0 隐式流程，您的服务会进行授权 端点。此端点负责 就数据访问征得用户同意。授权端点 向尚未登录的用户显示登录界面，并记录 同意所请求的访问。

当您的 Action 需要调用您的某项授权的 API 时，Google 会使用 此端点来获得用户许可，以在其上调用这些 API 。

由 Google 发起的典型 OAuth 2.0 隐式流会话具有以下特征： 以下流程：

  1. Google 会在用户的浏览器中打开您的授权端点。通过 如果用户尚未登录，则可以登录，并且授予 Google 访问 通过您的 API 访问其数据（如果尚未授予权限）。
  2. 您的服务会创建一个访问令牌并将其返回给 通过使用访问令牌将用户的浏览器重定向回 Google， 附件。
  3. Google 调用您的服务的 API，并使用 。您的服务会验证访问令牌是否向 Google 授予 访问 API 的授权，然后完成 API 调用。

处理授权请求

当您的 Action 需要通过 OAuth 2.0 隐式流程执行账号关联时， Google 会通过包含以下内容的请求将用户发送到您的授权端点： 以下参数：

授权端点参数
client_id 您分配给 Google 的客户 ID。
redirect_uri 此请求的响应发送到的网址。
state 将一个在 重定向 URI。
response_type 要在响应中返回的值的类型。对于 OAuth 2.0 隐式 则响应类型始终为 token。

例如，如果您的授权端点可通过 https://myservice.example.com/auth 访问， 请求可能如下所示：

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

为了让授权端点能够处理登录请求，请执行以下步骤：

  1. 验证 client_id 和 redirect_uri 值， 防止向意外或配置错误的客户端应用授予访问权限：

    • 确认 client_id 是否与您的客户端 ID 匹配 分配给 Google。
    • 确认 redirect_uri 指定的网址 参数的格式如下： 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      YOUR_PROJECT_ID 是项目设置页面上的 ID Actions 控制台界面。

  2. 检查用户是否已登录您的服务。如果用户未登录 中，完成服务的登录或注册流程。

  3. 生成 Google 将用于访问您的 API 的访问令牌。通过 访问令牌可以是任何字符串值，但必须唯一地表示 令牌对应的用户和客户端，且不得被猜到。

  4. 发送 HTTP 响应，将用户浏览器重定向到相应网址 由 redirect_uri 参数指定。添加所有 以下参数：

    • access_token：您刚刚生成的访问令牌
    • token_type：字符串 bearer
    • state：原始状态的未修改状态值 请求 以下是生成的网址示例： 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google 的 OAuth 2.0 重定向处理程序将收到访问令牌并确认 state 值没有更改。在 Google 获得 访问令牌，则 Google 会将该令牌附加到后续调用 作为 AppRequest 的一部分添加到您的 Action。

为身份验证流程设计语音界面

检查用户是否已通过验证，并启动账号关联流程

  1. 在 Actions 控制台中打开您的 Actions Builder 项目。
  2. 创建一个新场景，以开始在您的 Action 中关联帐号：
    1. 点击 Scenes。
    2. 点击添加 (+) 图标以添加新场景。
  3. 在新创建的场景中，点击条件对应的添加 图标。
  4. 添加一个条件，用于检查与对话关联的用户是否为经过验证的用户。如果检查失败，您的 Action 无法在对话期间执行帐号关联，而应回退以提供对不需要帐号关联的功能的访问权限。
    1. 在条件下的 Enter new expression 字段中，输入以下逻辑：user.verificationStatus != "VERIFIED"
    2. 在 Transition 下，选择不需要帐号关联的场景，或选择访客专享功能的入口点。

  1. 点击条件对应的添加 图标。
  2. 添加一个条件，以便在用户没有关联的身份时触发帐号关联流程。
    1. 在条件下的 Enter new expression 字段中，输入以下逻辑：user.verificationStatus == "VERIFIED"
    2. 在转换下，选择帐号关联系统场景。
    3. 点击保存。

保存后，系统会将一个名为 <SceneName>_AccountLinking 的新帐号关联系统场景添加到您的项目中。

自定义账号关联场景

  1. 在 Scenes 下，选择帐号关联系统场景。
  2. 点击发送提示并添加一小句话，向用户说明该 Action 为何需要访问其身份（例如“保存您的偏好设置”）。
  3. 点击保存。

  1. 在条件下，点击如果用户成功完成帐号关联。
  2. 配置当用户同意关联其账号时该流程应如何处理。 例如，调用网络钩子以处理所需的任何自定义业务逻辑，并转换回原始场景。
  3. 点击保存。

  1. 在条件下方，点击如果用户取消或忽略帐号关联。
  2. 配置如果用户不同意关联其帐号，相应流程应如何处理。例如，发送确认消息并重定向到提供无需进行帐号关联的功能的场景。
  3. 点击保存。

  1. 在条件下方，点击如果出现系统或网络错误。
  2. 配置帐号关联流程因系统或网络错误而无法完成时应采取的流程。例如，发送确认消息并重定向到提供无需进行帐号关联的功能的场景。
  3. 点击保存。

处理数据访问请求

如果 Google 助理请求包含访问令牌，请先检查访问令牌是否有效（且未过期），然后从数据库中检索关联的用户帐号。