透過 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 Console」，然後選取要使用的專案。
  2. 按一下「開發」分頁標籤，然後選擇「帳戶連結」。
  3. 啟用「帳戶連結」旁的切換鈕。
  4. 在「建立帳戶」部分中，選取「否，我只想允許在我的網站上建立帳戶」。

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

  6. 在「客戶資訊」部分中：

    • 將值指派給「Actions to Google」的用戶端 ID，即可識別來自 Google 的要求。
    • 插入授權和權杖交換端點的網址。
  1. 點按「儲存」。

實作 OAuth 伺服器

為支援 OAuth 2.0 隱含流程，您的服務會進行授權 並可透過 HTTPS 存取端點這個端點會負責驗證 徵得使用者同意，才能存取資料。授權端點 為使用者提供未登入並記錄登入的登入使用者介面 同意授予請求的存取權。

當您的動作需要呼叫服務的其中一個已授權 API 時，Google 會使用 以取得使用者授權，讓他們能在自己的

由 Google 發起的一般 OAuth 2.0 隱含流程工作階段，是 下列流程：

  1. Google 會在使用者的瀏覽器中開啟授權端點。 使用者登入後，並授權 Google 存取 並透過您的 API 取得資料。
  2. 您的服務會建立存取權杖，並傳回給 將使用者的瀏覽器重新導向回 Google，取得存取權杖 附加在要求中
  3. Google 會呼叫服務的 API，並將存取權杖附加至 每個要求您的服務會確認存取權杖是否已授予 Google 授權存取 API，然後完成 API 呼叫。

處理授權要求

當您的動作需要透過 OAuth 2.0 隱含流程進行帳戶連結時， Google 會在要求中附加以下內容，將使用者傳送到您的授權端點 分別是

授權端點參數
client_id 您指派給 Google 的用戶端 ID。
redirect_uri 您傳送回應到這項要求的網址。
state 傳回給 Google 的記帳金額，值維持不變 重新導向 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 的一部分動作。

設計驗證流程的語音使用者介面

檢查使用者是否已通過驗證，並啟動帳戶連結流程

  1. 在 Actions 主控台中開啟 Actions Builder 專案。
  2. 建立新的場景，以便在動作中開始連結帳戶：
    1. 按一下「Scenes」。
    2. 按一下「add」圖示 (+) 即可新增場景。
  3. 在新建立的場景中，按一下「Conditions」(條件) 圖示 。
  4. 新增條件，檢查與對話相關聯的使用者是否為已驗證的使用者。如果檢查失敗，您的動作就無法在對話期間執行帳戶連結，而是應改回提供不需要帳戶連結的功能。
    1. 在「Condition」(條件) 下方的 Enter new expression 欄位中，輸入下列邏輯：user.verificationStatus != "VERIFIED"
    2. 在「轉換」下方，選取不需要連結帳戶的場景，或不需要訪客專屬功能的進入點。

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

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

自訂帳戶連結情境

  1. 在「場景」下方，選取帳戶連結系統場景。
  2. 按一下「Send 提示」，然後新增簡短句子，說明動作需要存取其身分的原因 (例如「如要儲存偏好設定」)。
  3. 點按「儲存」。

  1. 在「條件」下方，按一下「如果使用者成功完成帳戶連結」。
  2. 設定使用者同意連結帳戶時，流程的後續步驟。 舉例來說，呼叫 Webhook 以處理任何所需的自訂商業邏輯，然後切換回原始場景。
  3. 點按「儲存」。

  1. 在「條件」下方，按一下「如果使用者取消或關閉帳戶連結」。
  2. 如果使用者不同意連結帳戶，請設定流程。例如，傳送已確認的訊息，然後重新導向至提供不需要連結帳戶的功能的場景。
  3. 點按「儲存」。

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

處理資料存取要求

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