Привязка аккаунта с помощью OAuth

Тип связи OAuth поддерживает два стандартных потока OAuth 2.0: неявный поток и поток кода авторизации .

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.

Примечание. Если вы применяете привязку учетных записей для обработки финансовой информации, обратите внимание, что к вашему действию могут применяться дополнительные правила. Рассмотрение действия с привязкой аккаунта на предмет финансовой информации может занять до шести недель, поэтому учтите это время при планировании графика выпуска. Чтобы облегчить процесс проверки, убедитесь, что вы соблюдаете политику финансовых услуг, прежде чем отправлять свое действие на проверку.

Настроить проект

Чтобы настроить проект для использования связи OAuth, выполните следующие действия:

1. Откройте консоль действий и выберите проект, который вы хотите использовать.
2. Откройте вкладку «Разработка» и выберите «Связывание учетной записи» .
3. Включите переключатель рядом с пунктом «Привязка учетной записи» .
4. В разделе «Создание учетной записи» выберите «Нет, я хочу разрешить создание учетной записи только на своем веб-сайте» .

5. В поле «Тип связи » выберите «OAuth и неявное» .

   

6. В информации о клиенте :

   • Присвойте значение идентификатору клиента, выданному вашими действиями Google, чтобы идентифицировать запросы, поступающие от Google.
   • Вставьте URL-адреса конечных точек авторизации и обмена токенами.

Примечание. Если вы хотите, чтобы ваш идентификатор клиента отправлялся в виде строки в кодировке Base64, щелкните стрелку раскрывающегося списка рядом с пунктом «Настроить клиента» (необязательно) и установите флажок «Google передавать clientID и секрет через базовый заголовок аутентификации HTTP» .

6. Нажмите Сохранить .

Внедрите свой сервер OAuth

为了支持 OAuth 2.0 隐式流程，您的服务会进行授权 端点。此端点负责 就数据访问征得用户同意。授权端点 向尚未登录的用户显示登录界面，并记录 同意所请求的访问。

当您的 Action 需要调用您的某项授权的 API 时，Google 会使用 此端点来获得用户许可，以在其上调用这些 API 。

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

1. Google 会在用户的浏览器中打开您的授权端点。通过 如果用户尚未登录，则可以登录，并且授予 Google 访问 通过您的 API 访问其数据（如果尚未授予权限）。
2. 您的服务会创建一个访问令牌并将其返回给 通过使用访问令牌将用户的浏览器重定向回 Google， 附件。
3. Google 调用您的服务的 API，并使用 。您的服务会验证访问令牌是否向 Google 授予 访问 API 的授权，然后完成 API 调用。

处理授权请求

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

授权端点参数
client_id	您分配给 Google 的客户 ID。
redirect_uri	此请求的响应发送到的网址。
state	将一个在 重定向 URI。
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 是否与您的客户端 ID 匹配 分配给 Google。
   • 确认 redirect_uri 指定的网址 参数的格式如下：

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

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

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

Разработайте голосовой пользовательский интерфейс для процесса аутентификации.

Предупреждение. Не давайте пользователям запрос на привязку учетной записи в начале разговора с вашим действием. Вместо этого предоставьте неаутентифицированным пользователям гостевой поток, чтобы показать, как работает ваше действие, а затем запрашивайте привязку учетной записи только в том случае, если это необходимо для продолжения. Если пользователи постоянно покидают действие из-за проблем с привязкой учетных записей, Google не будет активно продвигать действие, что может снизить пользовательский трафик действия.

Примечание. Для создания действия, реализующего связывание учетных записей, необходимо использовать Actions Builder .

Проверьте, подтвержден ли пользователь, и запустите процесс привязки учетной записи.

1. Откройте проект Actions Builder в консоли Actions .
2. Создайте новую сцену, чтобы начать привязку учетной записи в своем действии:
   1. Нажмите «Сцены» .
   2. Нажмите значок добавления (+), чтобы добавить новую сцену.
3. Во вновь созданной сцене щелкните значок « для «Условия» .
4. Добавьте условие, которое проверяет, является ли пользователь, связанный с беседой, проверенным пользователем. Если проверка не пройдена, ваше действие не сможет выполнить привязку учетной записи во время разговора и должно вернуться к предоставлению доступа к функциям, которые не требуют привязки учетной записи.
   1. В поле Enter new expression в разделе «Условие » введите следующую логику: user.verificationStatus != "VERIFIED"
   2. В разделе «Переход » выберите сцену, которая не требует привязки учетной записи, или сцену, которая является точкой входа в функции, доступные только для гостей.

1. Нажмите значок « для «Условия» .
2. Добавьте условие для запуска процесса связывания учетной записи, если у пользователя нет связанного удостоверения.
   1. В поле Enter new expression в разделе «Условие » введите следующую логику: user.verificationStatus == "VERIFIED"
   2. В разделе «Переход» выберите системную сцену «Связывание учетных записей» .
   3. Нажмите Сохранить .

После сохранения в ваш проект добавляется новая сцена системы связывания учетных записей под названием <SceneName>_AccountLinking .

Настройте сцену привязки учетной записи

1. В разделе «Сцены» выберите сцену системы привязки учетной записи.
2. Нажмите «Отправить запрос» и добавьте короткое предложение, описывающее пользователю, почему Действию необходим доступ к его личности (например, «Чтобы сохранить ваши настройки»).
3. Нажмите Сохранить .

1. В разделе «Условия» нажмите «Если пользователь успешно завершил привязку учетной записи» .
2. Настройте, как должен действовать поток, если пользователь соглашается связать свою учетную запись. Например, вызовите веб-перехватчик для обработки любой необходимой пользовательской бизнес-логики и возврата к исходной сцене.
3. Нажмите Сохранить .

1. В разделе «Условия» выберите «Если пользователь отменяет или отклоняет привязку учетной записи» .
2. Настройте порядок действий, если пользователь не согласен связать свою учетную запись. Например, отправьте подтверждающее сообщение и перенаправьте на сцены, которые предоставляют функциональные возможности, не требующие привязки учетной записи.
3. Нажмите Сохранить .

1. В разделе «Условия» выберите «При возникновении системной или сетевой ошибки» .
2. Настройте, как должен действовать процесс, если процесс связывания учетных записей не может быть завершен из-за системных или сетевых ошибок. Например, отправьте подтверждающее сообщение и перенаправьте на сцены, которые предоставляют функциональные возможности, не требующие привязки учетной записи.
3. Нажмите Сохранить .

Обработка запросов на доступ к данным

Если запрос Ассистента содержит токен доступа , сначала убедитесь, что токен доступа действителен (и не истек), а затем извлеките связанную учетную запись пользователя из своей базы данных.