OAuth によるアカウント リンク

OAuth リンクタイプは、業界標準の OAuth 2.0 フローであるインプリミティブ フローと認可コードフローの 2 つをサポートしています。

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.

Note: Please choose which OAuth 2.0 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

OAuth によるアカウント リンクを実装する

注: 財務情報を処理するためにアカウント リンクを実装する場合は、アクションに追加のポリシーが適用される場合があります。財務情報に関してアカウント リンクを使用するアクションの審査には最大 6 週間かかるため、この点を考慮してリリース スケジュールを計画してください。審査プロセスを簡単にするため、審査のためにアクションを送信する前に、金融サービスに関するポリシーに準拠していることを確認してください。

プロジェクトを構成する

OAuth リンクを使用するようにプロジェクトを構成する手順は次のとおりです。

1. アクション コンソールを開き、使用するプロジェクトを選択します。
2. [Develop]（開発）タブをクリックして、[Account linking]（アカウント リンク）を選択します。
3. [アカウントのリンク] の横にあるスイッチを有効にします。
4. [Account creation]（アカウントの作成）セクションで、[No, I only want to allow account creation on my website]（いいえ、自分のウェブサイトでのアカウントの作成のみを許可します）を選択します。

5. [Linking type] で、[OAuth] と [Implicit]（インプリシット）を選択します。

   

6. [クライアント情報] で、次の操作を行います。

   • [Actions to Google に発行するクライアント ID] に値を割り当てます。これは、Google からのリクエストを識別する値です。
   • 認可エンドポイントとトークン交換エンドポイントの URL を挿入します。

注: クライアント ID を base64 エンコード文字列として送信する場合は、[クライアントの構成（省略可）] の横にあるプルダウン矢印をクリックし、[Google が clientID とシークレットを HTTP 基本認証ヘッダー経由で送信する] チェックボックスをオンにします。

6. [保存] をクリックします。

OAuth サーバーを実装する

为了支持 OAuth 2.0 隐式流程，您的服务会通过 HTTPS 提供授权端点。此端点负责验证数据访问并从用户那里获得同意。授权端点会向尚未登录的用户呈现登录界面，并记录用户同意所请求的访问。

当您的 Action 需要调用某项服务的已授权 API 时，Google 会使用此端点从您的用户处获取权限，以便代表他们调用这些 API。

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

1. Google 会在用户的浏览器中打开您的授权端点。用户如果尚未登录，则登录；如果用户尚未授予权限，则授予 Google 使用您的 API 访问其数据的权限。
2. 您的服务会创建访问令牌，并使用附加到请求的访问令牌将用户的浏览器重定向回 Google，从而将其返回给 Google。
3. Google 会调用您的服务的 API，并为每个请求附加访问令牌。您的服务会验证访问令牌是否授予 Google 访问 API 的授权，然后完成 API 调用。

处理授权请求

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

授权端点参数
client_id	您分配给 Google 的客户端 ID。
redirect_uri	您要将该请求的响应发送到的网址。
state	在重定向 URI 中原封不动地传回 Google 的簿记值。
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 与您分配给 Google 的客户端 ID 匹配。
   • 确认 redirect_uri 参数指定的网址采用以下格式：

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

     YOUR_PROJECT_ID 是在 Actions 控制台的 Project settings 页面上找到的 ID。

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 为您的服务获取访问令牌后，会将该令牌作为 AppRequest 的一部分附加到对您的 Action 的后续调用。

認証フローの音声ユーザー インターフェースを設計する

警告: アクションとの会話の開始時に、必須のアカウント リンク プロンプトをユーザーに表示しないでください。代わりに、認証されていないユーザーにゲストフローを与えてアクションの動作を説明し、次に進むために必要な場合にのみアカウントのリンクを要求します。アカウント リンクの問題が原因でユーザーがアクションを絶えず終了する場合、Google はそのアクションを積極的に推奨しないため、アクションのユーザー トラフィックが減少する可能性があります。

注: アカウントのリンクを実装するアクションを作成するには、アクション ビルダーを使用する必要があります。

本人確認が完了しているかどうか確認してアカウントのリンクのフローを開始する

1. Actions Console で Actions Builder プロジェクトを開きます。
2. 新しいシーンを作成し、アクションでアカウントのリンクを開始します。
   1. [Scenes]（シーン）をクリックします。
   2. 追加（+）アイコンをクリックして新しいシーンを追加します。
3. 新しく作成したシーンで、[Conditions] の追加アイコン アイコンをクリックします。
4. 会話に関連付けられたユーザーが確認済みユーザーかどうかを確認する条件を追加します。チェックが失敗した場合、アクションは会話中にアカウント リンクを実行できないため、アカウント リンクを必要としない機能にアクセスできるようにフォールバックする必要があります。
   1. [Condition] の Enter new expression フィールドに、次のロジックを入力します。 user.verificationStatus != "VERIFIED"
   2. [Transition] で、アカウントのリンクが不要なシーン、またはゲスト専用機能のエントリ ポイントとなるシーンを選択します。

1. [Conditions] の追加アイコン をクリックします。
2. ユーザーに ID が関連付けられていない場合に、アカウントのリンクのフローをトリガーする条件を追加します。
   1. [Condition] の Enter new expression フィールドに、次のロジックを入力します。 user.verificationStatus == "VERIFIED"
   2. [移行] で、[アカウントのリンク] システムシーンを選択します。
   3. [保存] をクリックします。

保存後、<SceneName>_AccountLinking という新しいアカウント リンク システムシーンがプロジェクトに追加されます。

アカウントのリンクのシーンをカスタマイズする

1. [Scenes]（シーン）で、アカウント リンクのシステムシーンを選択します。
2. [プロンプトを送信] をクリックし、アクションが ID にアクセスする必要がある理由をユーザーに説明する短い文を追加します（「設定を保存するため」など）。
3. [保存] をクリックします。

1. [条件] で [ユーザーがアカウントのリンクを正常に完了した場合] をクリックします。
2. ユーザーがアカウントのリンクに同意した場合のフローの動作を設定します。 たとえば、Webhook を呼び出して必要なカスタム ビジネス ロジックを処理し、元のシーンに戻ります。
3. [保存] をクリックします。

1. [条件] で、[ユーザーがアカウントのリンクをキャンセルまたは拒否した場合] をクリックします。
2. ユーザーがアカウントのリンクに同意しなかった場合にフローがどのように進むかを構成します。たとえば、確認応答メッセージを送信し、アカウント リンクを必要としない機能を提供するシーンにリダイレクトします。
3. [保存] をクリックします。

1. [条件] で [システムエラーまたはネットワーク エラーが発生した場合] をクリックします。
2. システムエラーまたはネットワーク エラーが原因でアカウント リンクのフローを完了できない場合のフローの構成。たとえば、確認応答メッセージを送信し、アカウント リンクを必要としない機能を提供するシーンにリダイレクトします。
3. [保存] をクリックします。

データアクセス リクエストを処理する

アシスタントのリクエストにアクセス トークンが含まれている場合は、まずそのアクセス トークンが有効で期限切れになっていないことを確認してから、関連付けられているユーザー アカウントをデータベースから取得します。