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] と [Authorization code]（認可コード）を選択します。

   

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

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

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

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

OAuth サーバーを実装する

An OAuth 2.0 server implementation of the authorization code flow consists of two endpoints, which your service makes available by HTTPS. The first endpoint is the authorization endpoint, which is responsible for finding or obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access. The second endpoint is the token exchange endpoint, which is used to obtain encrypted strings called tokens that authorize the Action user to access your service.

When your Action needs to call one of your service's APIs, Google uses these endpoints together to get permission from your users to call these APIs on their behalf.

OAuth 2.0 auth code flow session initiated by Google has the following flow:

1. Google opens your authorization endpoint in the user's browser. If the flow started on a voice-only device for an Action, Google would transfer the execution to a phone.

2. The user signs in (if not signed in already) and grants Google permission to access their data with your API if they haven't already granted permission.

   Note: You must communicate that the user’s account is being linked to Google, not to a specific Google product, such as Google Home or Google Assistant.

3. Your service creates an authorization code and returns it to Google by redirecting the user's browser back to Google with the authorization code attached to the request.

4. Google sends the authorization code to your token exchange endpoint, which verifies the authenticity of the code and returns an access token and a refresh token. The access token is a short-lived token that your service accepts as credentials to access APIs. The refresh token is a long-lived token that Google can store and use to acquire new access tokens when they expire.

5. After the user has completed the account linking flow, every subsequent request sent from the Assistant to your fulfillment webhook contains an access token.

Handle authorization requests

When your Action needs to perform account linking via an OAuth 2.0 authorization code flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id	The Google client ID you registered with Google.
redirect_uri	The URL to which you send the response to this request.
state	A bookkeeping value that is passed back to Google unchanged in the redirect URI.
scope	Optional: A space-delimited set of scope strings that specify the data Google is requesting authorization for.
response_type	The string code.

For example, if your authorization endpoint is available at https://myservice.example.com/auth, a request might look like:

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

For your authorization endpoint to handle sign-in requests, do the following steps:

1. Verify that the client_id matches the Google client ID you registered with Google, and that the redirect_uri matches the redirect URL provided by Google for your service. These checks are important to prevent granting access to unintended or misconfigured client apps.

   If you support multiple OAuth 2.0 flows, also confirm that the response_type is code.

2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

3. Generate an authorization code that Google will use to access your API. The authorization code can be any string value, but it must uniquely represent the user, the client the token is for, and the code's expiration time, and it must not be guessable. You typically issue authorization codes that expire after approximately 10 minutes.

4. Confirm that the URL specified by the redirect_uri parameter has the following form:

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

   YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.

5. Redirect the user's browser to the URL specified by the redirect_uri parameter. Include the authorization code you just generated and the original, unmodified state value when you redirect by appending the code and state parameters. The following is an example of the resulting URL:

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

Handle token exchange requests

Your service's token exchange endpoint is responsible for two kinds of token exchanges:

• Exchange authorization codes for access tokens and refresh tokens
• Exchange refresh tokens for access tokens

Token exchange requests include the following parameters:

Token exchange endpoint parameters
client_id	A string that identifies the request origin as Google. This string must be registered within your system as Google's unique identifier.
client_secret	A secret string that you registered with Google for your service.
grant_type	The type of token being exchanged. Either authorization_code or refresh_token.
code	When grant_type=authorization_code, the code Google received from either your sign-in or token exchange endpoint.
redirect_uri	When grant_type=authorization_code, this parameter is the URL used in the initial authorization request.
refresh_token	When grant_type=refresh_token, the refresh token Google received from your token exchange endpoint.

Exchange authorization codes for access tokens and refresh tokens

After the user signs in and your authorization endpoint returns a short-lived authorization code to Google, Google sends a request to your token exchange endpoint to exchange the authorization code for an access token and a refresh token.

For these requests, the value of grant_type is authorization_code, and the value of code is the value of the authorization code you previously granted to Google. The following is an example of a request to exchange an authorization code for an access token and a refresh token:

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

To exchange authorization codes for an access token and a refresh token, your token exchange endpoint responds to POST requests executing the following steps:

1. Verify that the client_id identifies the request origin as an authorized origin, and that the client_secret matches the expected value.
2. Verify the following:
   • The authorization code is valid and not expired, and the client ID specified in the request matches the client ID associated with the authorization code.
   • The URL specified by the redirect_uri parameter is identical to the value used in the initial authorization request.
3. If you cannot verify all of the above criteria, return an HTTP 400 Bad Request error with {"error": "invalid_grant"} as the body.
4. Otherwise, using the user ID from the authorization code, generate a refresh token and an access token. These tokens can be any string value, but they must uniquely represent the user and the client the token is for, and they must not be guessable. For access tokens, also record the expiration time of the token (typically an hour after you issue the token). Refresh tokens do not expire.
5. Return the following JSON object in the body of the HTTPS response:

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

Google stores the access token and the refresh token for the user and records the expiration of the access token. When the access token expires, Google uses the refresh token to get a new access token from your token exchange endpoint.

Exchange refresh tokens for access tokens

When an access token expires, Google sends a request to your token exchange endpoint to exchange a refresh token for a new access token.

For these requests, the value of grant_type is refresh_token, and the value of refresh_token is the value of the refresh token you previously granted to Google. The following is an example of a request to exchange a refresh token for an access token:

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

To exchange a refresh token for an access token, your token exchange endpoint responds to POST requests executing the following steps:

1. Verify that the client_id identifies the request origin as Google, and that the client_secret matches the expected value.
2. Verify that the refresh token is valid, and that the client ID specified in the request matches the client ID associated with the refresh token.
3. If you cannot verify all of the above criteria, return an HTTP 400 Bad Request error with {"error": "invalid_grant"} as the body.
4. Otherwise, use the user ID from the refresh token to generate an access token. These tokens can be any string value, but they must uniquely represent the user and the client the token is for, and they must not be guessable. For access tokens, also record the expiration time of the token (typically an hour after you issue the token).
5. Return the following JSON object in the body of the HTTPS response:

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

Note: You can optionally return a new refresh_token in your response. For more information about when returning a new refresh_token is preferred, see Working with tokens.

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

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

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

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