OAuth ベースの Google ログイン「効率的な」リンクによるアカウント リンク

OAuth ベースの Google ログインの「効率的なリンク」タイプは、OAuth ベースのアカウント リンクの上に Google ログインを追加します。これにより、Google ユーザーには音声ベースのシームレスなリンクが提供されます。また、Google 以外の ID でサービスに登録したユーザーに対しては、アカウントのリンクが有効になります。

このリンクタイプは Google ログインから始まります。Google ログインを使用すると、ユーザーの Google プロフィール情報がシステムに存在するかどうかを確認できます。ユーザーの情報がシステムで見つからなかった場合は、標準の OAuth フローが開始されます。ユーザーは、Google プロフィール情報を使用して新しいアカウントを作成することを選択することもできます。

図 1: アクションがユーザーの Google プロフィールにアクセスできるようになると、そのプロフィールを使用して認証システムでユーザーに一致するものを見つけることができます。

「合理化されたリンクタイプ」を使用してアカウント リンクを実行する一般的な手順は次のとおりです。

1. まず、ユーザーの Google プロフィールにアクセスすることについてユーザーに同意を求めます。
2. プロフィールの情報を使用してユーザーを識別します。
3. 認証システムで Google ユーザーに一致するユーザーが見つからない場合は、Actions Console で Actions プロジェクトを構成し、音声によるユーザー アカウントの作成を許可する構成か、ウェブサイトでのユーザー アカウントの作成のみを許可する構成であるかによってフローが進められます。
   • 音声によるアカウントの作成を許可する場合は、Google から受け取った ID トークンを検証します。その後、ID トークンに含まれるプロフィール情報に基づいてユーザーを作成できます。
   • 音声によるアカウントの作成を許可しない場合、ユーザーはブラウザに転送され、そこで認証ページを読み込み、ユーザー作成フローを完了できます。

図 2. ユーザーの情報がシステムで見つからない場合の OAuth と Google のログインフローを視覚的に表した図。

音声によるアカウント作成を許可する

音声によるユーザー アカウントの作成を許可すると、アシスタントはユーザーに次のことを行うかどうかを確認します。

• Google アカウント情報を使用してシステムに新しいアカウントを作成する。
• Google 以外のアカウントがすでにある場合は、別のアカウントで認証システムにログインする。

アカウント作成フローをスムーズに進めたい場合は、音声によるアカウント作成を許可することをおすすめします。ユーザーは Google 以外の既存のアカウントを使用してログインする場合のみ、音声フローから離れます。

音声によるアカウント作成を許可しない

音声によるユーザー アカウントの作成を許可しない場合、アシスタントはユーザー認証用に指定したウェブサイトの URL を開きます。画面のないデバイスで操作が行われている場合、アシスタントはユーザーをスマートフォンに誘導し、アカウント リンクのフローを続行します。

次の場合はアカウント作成を許可しないことをおすすめします。

• Google 以外のアカウントを持つユーザーが新しいユーザー アカウントを作成することを許可せず、代わりにそのユーザーを認証システム内の既存のユーザー アカウントにリンクさせる場合。たとえば、ポイント プログラムを提供していて、ユーザーが既存のアカウントで獲得したポイントを失わないように配慮する必要がある場合などです。

• アカウント作成フローを完全に制御する場合。たとえば、アカウントの作成中に利用規約をユーザーに表示する必要がある場合に、アカウントの作成を許可しないようにできます。

注: 以下のフロー オプションのいずれかを選択して、選択したフローの実装の詳細を確認してください。必要に応じて、ガイドの内容が選択に合わせて再読み込みされます。

音声でのアカウントの作成を許可する 音声でのアカウントの作成を許可しない

OAuth ベースの Google ログインの「合理化された」リンクを実装する

アカウントは、業界標準の OAuth 2.0 フローでリンクされます。Actions on Google は、暗黙的なコードフローと認可コードフローをサポートしています。

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

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

プロジェクトを構成する

合理化されたリンクを使用するようにプロジェクトを設定する手順は次のとおりです。

1. Actions Console を開き、使用するプロジェクトを選択します。
2. [Develop]（開発）タブをクリックして、[Account linking]（アカウント リンク）を選択します。
3. [アカウントのリンク] の横にあるスイッチを有効にします。
4. [Account creation] で、[Yes] を選択します。

5. [Linking type] で、[OAuth & Google Sign In]（OAuth および Google ログイン）と [Implicit]（インプリシット）を選択します。

   

6. [Client Information] で、次の操作を行います。

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

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

OAuth サーバーを実装する

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

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

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

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

認可リクエストの処理

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

認可エンドポイントのパラメータ
client_id	Google に割り当てたクライアント ID。
redirect_uri	このリクエストに対するレスポンスを送信する URL。
state	リダイレクト URL で変更されずに 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 パラメータで指定された URL が次の形式になっていることを確認します。

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

     YOUR_PROJECT_ID は、Actions Console の [プロジェクトの設定] ページに表示されている ID です。

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

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

4. redirect_uri パラメータで指定された URL にユーザーのブラウザをリダイレクトする HTTP レスポンスを送信します。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 の一部として後続のアクションの呼び出しに追加します。

处理自动关联

用户同意您的 Action 访问其 Google 个人资料后，Google 会发送一个请求，其中包含已签署的 Google 用户身份断言。该断言包含用户的 Google 帐号 ID、姓名和电子邮件地址等信息。您为项目配置的令牌交换端点会处理该请求。

如果您的身份验证系统中已存在相应的 Google 帐号，则令牌交换端点为用户返回一个令牌。如果 Google 帐号与现有用户不匹配，则令牌交换端点会返回 user_not_found 错误。

该请求的格式如下：

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

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES

您的令牌交换端点必须能够处理以下参数：

令牌端点参数
grant_type	要交换的令牌的类型。对于这些请求，此参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer。
intent	对于这些请求，此参数的值为 `get`。
assertion	一个 JSON Web 令牌 (JWT)，可提供 Google 用户身份的已签名断言。JWT 包含用户的 Google 帐号 ID、名称和电子邮件地址等信息。
consent_code	可选：如果存在，这是一个一次性代码，用于表明用户已同意您的 Action 访问指定范围。
scope	可选：您已配置 Google 向用户请求的任何范围。

当您的令牌交换端点收到关联请求时，应执行以下操作：

验证和解码 JWT 断言

您可以使用适合您的语言的 JWT 解码库来验证和解码 JWT 断言。使用 Google 的公钥（以 JWK 或 PEM 格式提供）来验证令牌的签名。

注意 ：键不应采用硬编码。而应按照 OpenID connect Discovery Protocol 并检查 cache-control 标头，以确定应将密钥缓存多长时间。

解码后，JWT 断言如下所示：

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

除了验证令牌的签名之外，请验证断言的颁发者（iss 字段）是否为 https://accounts.google.com，以及目标对象群组（aud 字段）是否为分配给您的 Action 的客户端 ID。

检查您的身份验证系统中是否已经存在相关 Google 账号

检查是否满足以下任一条件：

• Google 帐号 ID（可在断言的 sub 字段中找到）位于您的用户数据库中。
• 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足任一条件，则表示用户已完成注册，您可以颁发访问令牌。

如果 Google 帐号 ID 和断言中指定的电子邮件地址均与您数据库中的用户不匹配，则表示该用户尚未注册。在这种情况下，您的令牌交换端点应回复 HTTP 401 错误，该错误会指定 error=user_not_found，如以下示例所示：

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"user_not_found",
}

当 Google 收到包含 user_not_found 错误的 401 错误响应时，Google 会调用您的令牌交换端点，将 intent 参数的值设为 create，并通过请求发送一个包含用户个人资料信息的 ID 令牌。

Handle account creation via Google Sign-In

When a user needs to create an account on your service, Google makes a request to your token exchange endpoint that specifies intent=create, as in the following example:

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

response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

The assertion parameter contains A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address, which you can use to create a new account on your service.

To respond to account creation requests, your token exchange endpoint must do the following:

验证和解码 JWT 断言

您可以使用适合您的语言的 JWT 解码库来验证和解码 JWT 断言。使用 Google 的公钥（以 JWK 或 PEM 格式提供）来验证令牌的签名。

注意 ：键不应采用硬编码。而应按照 OpenID connect Discovery Protocol 并检查 cache-control 标头，以确定应将密钥缓存多长时间。

解码后，JWT 断言如下所示：

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

除了验证令牌的签名之外，请验证断言的颁发者（iss 字段）是否为 https://accounts.google.com，以及目标对象群组（aud 字段）是否为分配给您的 Action 的客户端 ID。

Validate user information and create new account

Check whether either of the following conditions are true:

• The Google Account ID, found in the assertion's sub field, is in your user database.
• The email address in the assertion matches a user in your user database.

If either condition is true, prompt the user to link their existing account with their Google Account by responding to the request with an HTTP 401 error, specifying error=linking_error and the user's email address as the login_hint, as in the following example:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"[e-mail]"
}

If neither condition is true, create a new user account using the information provided in the JWT. New accounts do not typically have a password set. It is recommended that you add Google Sign In to other platforms to enable users to log in via Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password for signing in on other platforms.

When the creation is completed, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example:

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

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

警告: アクションとの会話の開始時に、必須のアカウント リンク プロンプトをユーザーに表示しないでください。代わりに、認証されていないユーザーにゲストフローを与えてアクションの動作を説明し、次に進むために必要な場合にのみアカウントのリンクを要求します。アカウント リンクの問題が原因でユーザーがアクションを絶えず終了する場合、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. [保存] をクリックします。

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

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