透過 OAuth 連結帳戶

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

在隐式代码流程中，Google 会在用户浏览器中打开您的授权端点。成功登录后，系统会向 Google 返回长期访问令牌。现在，从 Google 助理向你的 Action 发送的每个请求中都包含此访问令牌。

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

• 授权端点，该端点负责向尚未登录的用户显示登录界面，并以短期授权代码的形式记录所请求的访问。
• 令牌交换端点，负责两种类型的交换：
  1. 将授权代码交换为长期刷新令牌和短期访问令牌。用户完成帐号关联流程后，系统会进行这种交换。
  2. 将长期刷新令牌换成短期访问令牌。Google 需要新访问令牌时，由于此令牌已过期，因此会进行此交换。

虽然隐式代码流程的实现更简单，但 Google 建议通过隐式流程发出的访问令牌永远不会过期，因为将令牌过期与隐式流程一起使用会强制用户再次关联其帐号。如果出于安全考虑需要令牌到期，强烈建议您考虑使用身份验证代码流程。

注意 ：请选择您希望实施的 OAuth 2.0 流程。如果需要，本指南的内容会根据您的选择重新加载。

身份验证代码 隐式流程

實作 OAuth 帳戶連結

注意： 如果您實作帳戶連結來處理財務資訊，請注意，您的動作可能適用其他政策。如果動作會連結帳戶以取得財務資訊，我們最多可能需要六週的時間審查，因此請在規劃發布時間表時將這段時間納入考量。為簡化審查程序，請務必先遵守金融服務政策，再將動作送交審查。

設定專案

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

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

5. 在「連結類型」中，選取「OAuth」和「授權碼」。

   

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

   • 為「Google 簽發給動作的用戶端 ID」指派值，以識別來自 Google 的要求。
   • 請記下 Google 為 Actions 核發的 Client ID 值；
   • 插入授權和權杖交換端點的網址。

注意： 如要以 Base64 編碼字串傳送用戶端 ID 和密鑰，請按一下「設定用戶端 (選用)」旁的下拉式箭頭，然後勾選「Google 會透過 HTTP 基本驗證標頭傳輸 clientID 和密鑰」方塊。

6. 按一下 [儲存]。

導入 OAuth 伺服器

授权代码流程的 OAuth 2.0 服务器实现包括 两个端点，您的服务会通过 HTTPS 提供这两个端点。第一个端点 是授权端点，负责查找或获取 就数据访问征求用户意见。授权端点显示登录 尚未登录的用户的界面，并记录同意 请求的访问权限。第二个端点是令牌交换端点， 用于获取名为令牌（用于向 Action 用户授权）的加密字符串 以访问您的服务。

当您的 Action 需要调用您的某项服务的 API 时，Google 会使用这些 API 端点一起获取用户许可，以便在他们的 。

Google 发起的 OAuth 2.0 身份验证代码流程会话包含以下流程：

1. Google 会在用户的浏览器中打开您的授权端点。如果流 用户通过纯语音设备启动 Action，Google 会将 将代码执行到手机上

2. 用户登录（如果尚未登录）并授予 Google 以下权限： 通过您的 API 访问其数据。

   注意 ：您必须告知用户账号已与 Google 关联， 而不是特定的 Google 产品，例如 Google Home 或 Google 助理。

3. 您的服务会创建授权代码，并通过以下方式返回给 Google： 使用授权代码将用户的浏览器重定向回 Google 附件。

4. Google 会将授权代码发送到您的令牌交换端点， 验证代码的真实性并返回访问令牌和 刷新令牌。访问令牌是一个短期有效的令牌 作为访问 API 的凭据。刷新令牌长期有效 Google 可以存储该令牌，以便在用户首次访问该令牌时， 过期。

5. 在用户完成账号关联流程后， 从 Google 助理发送到您的 fulfillment webhook 的请求包含 访问令牌。

处理授权请求

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

授权端点参数
client_id	您在 Google 注册的 Google 客户端 ID。
redirect_uri	此请求的响应发送到的网址。
state	将一个在 重定向 URI。
scope	可选：一组以空格分隔的范围字符串，用于指定 Google 请求授权的数据
response_type	字符串 code。

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

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

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

1. 验证 client_id 与您注册的 Google 客户端 ID 是否一致 并且 redirect_uri 与 Google 提供的重定向网址相匹配 。这些检查对于防止向 意外或配置错误的客户端应用

   如果您支持多个 OAuth 2.0 流程，也请确认 response_type 为 code。

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

3. 生成 Google 将用于访问您的 API 的授权代码。 授权代码可以是任何字符串值，但它必须是唯一的 代表用户、令牌对应的客户端以及代码的有效期 而且不可猜测出来。您通常需要进行授权 会在大约 10 分钟后过期。

4. 确认 redirect_uri 参数指定的网址 采用以下格式：

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID

   YOUR_PROJECT_ID 是项目设置页面上的 ID Actions 控制台界面。

5. 将用户的浏览器重定向到 redirect_uri 参数。添加您在 以及您在重定向时返回未经修改的原始状态值 方法是附加 code 和 state 参数。下面是一个示例 结果网址：

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

处理令牌交换请求

您的服务的令牌交换端点负责处理两种令牌 广告交易平台：

• 交换访问令牌和刷新令牌的授权代码
• 用刷新令牌换取访问令牌

令牌交换请求包含以下参数：

令牌交换端点参数
client_id	用于将请求来源标识为 Google 的字符串。此字符串必须 在您的系统中注册为 Google 的唯一标识符。
client_secret	您在 Google 中为您的服务注册的密钥字符串。
grant_type	所交换的令牌的类型。两者之一 authorization_code 或 refresh_token。
code	当 grant_type=authorization_code 时，代码 Google 从您的登录端点或令牌交换端点接收验证码。
redirect_uri	如果值为 grant_type=authorization_code，则此参数为 初始授权请求中使用的网址。
refresh_token	如果值为 grant_type=refresh_token，则刷新令牌 Google 从令牌交换端点接收的令牌

交换访问令牌和刷新令牌的授权代码

用户登录且您的授权端点返回短期授权后 代码，Google 就会向您的令牌交换端点发送请求， 访问令牌和刷新令牌的授权码。

对于这些请求，grant_type 的值为 authorization_code，值 code 是您先前向 Google 授予的授权代码的值。 以下是使用授权代码交换 访问令牌和刷新令牌：

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

要将授权代码交换为访问令牌和刷新令牌，您的 令牌交换端点响应执行以下步骤的 POST 请求：

1. 验证 client_id 是否将请求来源标识为已获授权的来源。 并且 client_secret 与预期值匹配。
2. 请验证以下内容： <ph type="x-smartling-placeholder">
   </ph>
   • 授权代码有效且未过期，且客户端 请求中指定的 ID 与 授权代码。
   • redirect_uri 参数指定的网址完全相同 初始授权请求中使用的值。
3. 如果您无法验证上述所有条件，则返回 HTTP 正文为 {"error": "invalid_grant"} 的 400 Bad Request 错误。
4. 否则，使用授权代码中的用户 ID 生成刷新 令牌和访问令牌。这些标记可以是任何字符串值，但它们必须 唯一代表令牌的用户和客户端，不得 更容易被猜到。对于访问令牌，请记录令牌的到期时间 （通常在您发放令牌一小时后）。刷新令牌不会过期。
5. 在 HTTPS 响应的正文中返回以下 JSON 对象：

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "refresh_token": "REFRESH_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

Google 会存储用户的访问令牌和刷新令牌，并记录 访问令牌的过期日期。访问令牌过期后，Google 会使用刷新 令牌，从令牌交换端点获取新的访问令牌。

用刷新令牌换取访问令牌

访问令牌过期后，Google 会向您的令牌交换端点发送请求 将刷新令牌交换为新的访问令牌。

对于这些请求，grant_type 的值为 refresh_token，值 refresh_token 是您之前授予 Google 的刷新令牌的值。 以下是用刷新令牌交换 访问令牌：

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

如需将刷新令牌交换为访问令牌，令牌交换端点 对执行以下步骤的 POST 请求做出响应：

1. 验证 client_id 是否将请求来源标识为 并且 client_secret 与预期 值。
2. 请确认刷新令牌有效，以及在 请求与刷新令牌所关联的客户端 ID 相匹配。
3. 如果您无法验证上述所有条件，则返回 HTTP 正文为 {"error": "invalid_grant"} 的 400 Bad Request 错误。
4. 否则，请使用刷新令牌中的用户 ID 来生成访问权限 令牌。这些标记可以是任何字符串值，但它们必须唯一地表示 令牌对应的用户和客户端，并且不得被猜到。 对于访问令牌，请记录令牌的到期时间 （通常在您发放令牌一小时后）。
5. 在 HTTPS 的正文中返回以下 JSON 对象 回答：

   {
   "token_type": "不记名",
   "access_token": "ACCESS_TOKEN",
   “expires_in”：SECONDS_TO_EXPIRATION
   }

。

注意： 您可以选择在响应中返回新的 refresh_token。对于 如需详细了解何时首选返回新的 refresh_token，请参阅 使用令牌。

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

警告：請勿在使用者與動作開始對話時，提示使用者連結帳戶。請改為提供訪客流程，向未通過驗證的使用者說明動作的運作方式，然後只在必要時要求連結帳戶。如果使用者因帳戶連結問題而持續離開動作，Google 就不會主動宣傳動作，這可能會導致動作的使用者流量減少。

注意： 您必須使用 Actions Builder 建構實作帳戶連結的動作。

檢查使用者是否已通過驗證，然後開始帳戶連結流程

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 助理要求包含存取權杖，請先檢查存取權杖是否有效 (未過期)，然後從資料庫中擷取相關聯的使用者帳戶。