透過 OAuth 連結帳戶

OAuth 連結類型支援兩種符合業界標準的 OAuth 2.0 流程，分別是隱含和授權碼流程。

在隱式程式碼流程中，Google 會在使用者的瀏覽器中開啟您的授權端點。成功登入後，系統會將長期存取權杖傳回 Google。從現在起，每次透過 Google 助理傳送給您動作的要求中，都會包含這個存取權杖。

在授權碼流程中，您需要兩個端點：

  • 授權端點，該端點負責將登入 UI 提供給未登入的使用者，並以簡碼授權代碼的形式，記錄使用者要求的存取權。
  • 權杖交換端點，負責以下兩種交換類型：
    1. 交換長期更新權杖的授權碼和短期存取權杖。這項交換作業會在使用者完成帳戶連結流程時進行。
    2. 對短期存取權杖交換交換憑證。當 Google 需要新的存取權杖，因為更新權杖已過期時，就會發生此交換行為。

雖然隱含程式碼流程的實作方式較簡單，但 Google 建議使用隱含流程發布的存取權杖不會過期，因為若權杖與隱含流程搭配使用，就會強制使用者重新連結帳戶。如果基於安全考量而需要權杖過期，您應該考慮改用授權碼流程。

實作 OAuth 帳戶連結

設定專案

如要設定專案以使用 OAuth 連結，請按照下列步驟操作：

  1. 開啟 Actions 管理中心，然後選取要使用的專案。
  2. 按一下「開發」分頁，然後選擇「帳戶連結」。
  3. 啟用「帳戶連結」旁的切換鈕。
  4. 在「帳戶建立」部分，選取「否，我只想允許在我的網站上建立帳戶」。

  5. 在「連結類型」中，選取「OAuth」和「隱含」。

  6. 在「用戶端資訊」中：

    • 為「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 Console 中開啟 Actions Builder 專案。
  2. 在動作中建立新場景，開始連結帳戶：
    1. 按一下「場景」。
    2. 按一下「新增」 (+) 圖示，即可新增場景。
  3. 在新建立的場景中，按一下「條件」的「新增」圖示 。
  4. 新增條件，檢查與對話相關聯的使用者是否為已驗證使用者。如果檢查失敗，動作就無法在對話期間執行帳戶連結，且應改為提供不需要帳戶連結的功能存取權。
    1. 在「條件」下方的 Enter new expression 欄位中，輸入下列邏輯： user.verificationStatus != "VERIFIED"
    2. 在「轉場效果」下方，選取不需要連結帳戶的場景，或是僅限訪客使用的功能進入點場景。

  1. 按一下「條件」的「新增」圖示。
  2. 新增條件，在使用者沒有相關聯的身分時觸發帳戶連結流程。
    1. 在「條件」下方的 Enter new expression 欄位中，輸入下列邏輯： user.verificationStatus == "VERIFIED"
    2. 在「Transition」下方，選取「Account Linking」系統場景。
    3. 按一下 [儲存]。

儲存後，專案中會新增名為「<SceneName>_AccountLinking」的帳戶連結系統場景。

自訂帳戶連結場景

  1. 在「場景」下方，選取帳戶連結系統場景。
  2. 按一下「傳送提示」，並新增簡短句子，向使用者說明動作為何需要存取身分識別資訊 (例如「儲存偏好設定」)。
  3. 按一下 [儲存]。

  1. 按一下「條件」下方的「如果使用者成功完成帳戶連結」。
  2. 設定使用者同意連結帳戶時，流程應如何繼續進行。 舉例來說，呼叫 Webhook 來處理任何必要的自訂商業邏輯，然後返回原始場景。
  3. 按一下 [儲存]。

  1. 在「條件」下方，按一下「如果使用者取消或關閉帳戶連結」。
  2. 設定使用者不同意連結帳戶時，流程應如何進行。舉例來說，傳送確認訊息，然後重新導向至不需要帳戶連結的功能場景。
  3. 按一下 [儲存]。

  1. 在「條件」下方，按一下「如果發生系統或網路錯誤」。
  2. 設定帳戶連結流程因系統或網路錯誤而無法完成時，流程應如何繼續。舉例來說，傳送確認訊息，然後重新導向至不需要帳戶連結的功能場景。
  3. 按一下 [儲存]。

處理資料存取要求

如果Google 助理要求包含存取權杖，請先檢查存取權杖是否有效 (未過期)，然後從資料庫中擷取相關聯的使用者帳戶。