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

OAuth リンクタイプは、インプリシット フローと認可コードフローの 2 通りの業界標準 OAuth 2.0 フローをサポートします。

インプリシット コードフローでは、Google がユーザーのブラウザで認可エンドポイントを開きます。ログインに成功すると、長期間有効なアクセス トークンが Google に返されます。このアクセス トークンは、アシスタントからアクションに送信されるすべてのリクエストに含まれるようになりました。

認可コードフローでは、次の 2 つのエンドポイントが必要になります。

• 認可エンドポイント。まだログインしていないユーザーにログイン用の UI を表示し、リクエストされたアクセスへの同意を短期の認可コードの形式で記録します。
• トークン交換エンドポイント。次の 2 種類の交換を行います。
  1. 長期の更新トークンと短期のアクセス トークンの認可コードを交換します。この処理は、ユーザーがアカウントのリンクフローを行ったときに発生します。
  2. 長期の更新トークンを短期のアクセス トークンと交換します。この処理は、トークンが期限切れになり、新しいアクセス トークンが必要になった場合に発生します。

暗黙的コードフローは実装が簡単ですが、暗黙的フローで発行されたアクセス トークンに有効期限を設定しないことをおすすめします。暗黙的フローでトークンの有効期限を設定すると、ユーザーは再びアカウントをリンクする必要があります。セキュリティ上の理由によりトークンの有効期限が必要な場合は、代わりに認証コードフローの使用を検討してください。

注: 実装する OAuth 2.0 フローを選択してください。必要に応じて、このガイドの内容が選択に合わせて再読み込みされます。

認可コード 暗黙的フロー

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. [Client Information]（クライアント情報）で、次のことを行います。

   • [Client ID issued by your Actions to Google] に、Google からのリクエストを識別する値を割り当てます。
   • 認可エンドポイントとトークン交換エンドポイントの URL を挿入します。

注: クライアント ID を base64 エンコードされた文字列として送信する場合は、[Configure your client (optional)]（クライアントを構成する（省略可））の横にあるプルダウン矢印をクリックし、[Google to transmit clientID and secret via HTTP basic auth header]（Google が HTTP 基本認証ヘッダーを介してクライアント ID とシークレットを送信する）ボックスをオンにします。

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

OAuth サーバーを実装する

OAuth 2.0 暗黙的フローをサポートするために、サービスは 使用できます。このエンドポイントは、認証と認可を担当します。 データアクセスについてユーザーから同意を得る。認可エンドポイントは、ログインしていないユーザーにログイン用の UI を表示し、リクエストされたアクセスへの同意を記録します。

アクションからサービスの API を呼び出す必要がある場合、Google はこのエンドポイントを使用して、API の呼び出し許可をユーザーから取得します。

通常、Google が開始する OAuth 2.0 インプリシット フローのセッションは次のような流れになります。

1. Google がユーザーのブラウザで認可エンドポイントを開きます。ユーザーがログインし（ログインしていない場合）、Google が API を使用してデータにアクセスすることを承諾します（まだ許可していない場合）。
2. サービスがアクセス トークンを作成します。そのトークンを含むリクエストを送信して、ユーザーのブラウザを Google にリダイレクトし、Google にアクセス トークンを返します。
3. Google がサービスの API を呼び出し、リクエストごとにアクセス トークンを関連付けます。サービスは、アクセス トークンによって API へのアクセスが Google に許可されていることを確認し、API 呼び出しを完了します。

認可リクエストの処理

アクションが OAuth 2.0 暗黙的フローを介してアカウント リンクを実行する必要がある場合、 Google は、次を含むリクエストでユーザーを認可エンドポイントに送信します。 次のパラメータを指定します。

認可エンドポイントのパラメータ
client_id	Google に割り当てたクライアント ID。
redirect_uri	このリクエストに対するレスポンスを送信する URL。
state	リダイレクト URL で変更されずに Google に返される会計上の値。
response_type	レスポンスで返される値のタイプ。OAuth 2.0 暗黙の API では、 レスポンス タイプは常に 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 と一致することを確認します。 割り当てられています
   • redirect_uri で指定された URL を確認します。 パラメータの形式は次のとおりです。

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

     YOUR_PROJECT_ID は、[プロジェクトの設定] ページにある ID です。 確認できます。

2. ユーザーがサービスにログインしているかどうか確認します。ユーザーがログインしていない場合は、サービスのログインまたは登録フローを完了します。

3. Google が API へのアクセスで使用するアクセス トークンを生成します。アクセス トークンには任意の文字列値を設定できますが、トークンを使用するユーザーとクライアントを一意に表し、簡単に推測されない文字列にする必要があります。

4. ユーザーのブラウザを URL にリダイレクトする HTTP レスポンスを送信する redirect_uri パラメータで指定します。URL フラグメントに次のパラメータをすべて含めます。

   • access_token: 生成したアクセス トークン
   • token_type: 文字列 bearer
   • state: 元の状態から変更されていない状態の値 リクエスト 結果の URL の例を次に示します。

     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 の一部としてアクションに渡します。

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

警告: アカウント リンクの必須のプロンプトを、ユーザーがアクションとの会話を開始したときに表示することは避けてください。代わりに、認証されていないユーザーには、アクションの動作を示すゲストフローを提供し、先に進むために必要な場合にのみアカウント リンクの同意を求めてください。アカウント リンクの問題が原因でユーザーがアクションを一貫して回避している場合、Google はそのアクションを積極的に推奨しません。これにより、アクションのユーザー トラフィックが減少するおそれがあります。

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

ユーザーが確認済みかどうかを確認し、アカウントのリンクフローを開始する

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

1. [条件] の追加アイコン をクリックします。
2. ユーザーに関連付けられた ID がない場合にアカウント リンクフローをトリガーする条件を追加します。
   1. [条件] の 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. [保存] をクリックします。

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

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