Vinculación de cuentas con la vinculación "optimizada" del Acceso con Google basado en OAuth

El tipo de vinculación "Optimizado" del Acceso con Google basado en OAuth agrega el Acceso con Google sobre la vinculación de cuentas basada en OAuth. Esto proporciona una vinculación fluida basada en la voz para los usuarios de Google y, al mismo tiempo, habilita la vinculación de cuentas para los usuarios que se registraron en tu servicio con una identidad que no es de Google.

Este tipo de vinculación comienza con el Acceso con Google, que te permite verificar si la información del perfil de Google del usuario existe en tu sistema. Si no se encuentra la información del usuario en tu sistema, se inicia un flujo de OAuth estándar. El usuario también puede optar por crear una cuenta nueva con la información de su perfil de Google.

Figura 1: Después de que tu Acción obtenga acceso al perfil de Google del usuario, puedes usarlo para encontrar una coincidencia para el usuario en tu sistema de autenticación.

Para realizar la vinculación de cuentas con el tipo de vinculación simplificada, sigue estos pasos generales:

1. Primero, pídele al usuario que otorgue su consentimiento para acceder a su perfil de Google.
2. Usar la información de su perfil para identificar al usuario
3. Si no encuentras una coincidencia para el usuario de Google en tu sistema de autenticación, el flujo continuará según si configuraste tu proyecto de Actions en la consola de Actions para permitir la creación de cuentas de usuario por voz o solo en tu sitio web.
   • Si permites la creación de cuentas por voz, valida el token de ID que recibiste de Google. Luego, puedes crear un usuario en función de la información del perfil que se incluye en el token de ID.
   • Si no permites la creación de cuentas por voz, se transferirá al usuario a un navegador en el que podrá cargar tu página de autorización y completar el flujo de creación de usuarios.

Figura 2: Representación visual del flujo de OAuth y Acceso con Google cuando no se encuentra la información de un usuario en tu sistema.

Admite la creación de cuentas por voz

Si permites la creación de cuentas de usuario por voz, Asistente le preguntará al usuario si quiere hacer lo siguiente:

• Crear una cuenta nueva en tu sistema con la información de la Cuenta de Google del usuario
• Accede a tu sistema de autenticación con otra cuenta si tiene una cuenta existente que no sea de Google.

Se recomienda permitir la creación de cuentas por voz si deseas minimizar la fricción del flujo de creación de cuentas. El usuario solo debe abandonar el flujo de voz si quiere acceder con una cuenta existente que no sea de Google.

No permitir la creación de cuentas por voz

Si no permitiste la creación de cuentas de usuario por voz, Asistente abrirá la URL del sitio web que proporcionaste para la autenticación del usuario. Si la interacción se produce en un dispositivo que no tiene pantalla, Asistente dirige al usuario a un teléfono para que continúe con el flujo de vinculación de cuentas.

Se recomienda no permitir la creación en los siguientes casos:

• No quieres permitir que los usuarios que tienen cuentas que no son de Google creen una cuenta de usuario nueva y, en cambio, quieres que se vinculen a sus cuentas de usuario existentes en tu sistema de autenticación. Por ejemplo, si ofreces un programa de lealtad, es posible que quieras asegurarte de que el usuario no pierda los puntos acumulados en su cuenta existente.

• Debes tener el control total del flujo de creación de la cuenta. Por ejemplo, puedes inhabilitar la creación si necesitas mostrarle al usuario tus condiciones del servicio durante la creación de la cuenta.

Nota: Selecciona una de las opciones de flujo que se muestran a continuación para obtener más información sobre la implementación del flujo seleccionado. Si es necesario, el contenido de la guía se volverá a cargar para adaptarse a tu elección.

Permitir la creación de cuentas por voz No permitir la creación de cuentas por voz

Implementa la vinculación "optimizada" de Acceder con Google basada en OAuth

Las cuentas se vinculan con flujos de OAuth 2.0 estándares de la industria. Actions on Google admite los flujos de código de autorización y los implícitos.

Nota: Si implementas la vinculación de cuentas para controlar la información financiera, ten en cuenta que es posible que se apliquen políticas adicionales a tu Acción. La revisión de una acción con vinculación de cuentas para obtener información financiera puede tardar hasta seis semanas, por lo que debes tener en cuenta ese tiempo cuando planifiques tu cronograma de lanzamiento. Para facilitar el proceso de revisión, asegúrate de cumplir con las políticas de servicios financieros antes de enviar tu Acción para su revisión.

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

Configura el proyecto

Para configurar tu proyecto de modo que use la vinculación simplificada, sigue estos pasos:

1. Abre la consola de Actions y selecciona el proyecto que deseas usar.
2. Haz clic en la pestaña Desarrollar y elige Vinculación de la cuenta.
3. Habilita el interruptor junto a Vinculación de cuentas.
4. En la sección Creación de cuenta, selecciona Sí.

5. En Tipo de vinculación, selecciona OAuth y acceso con Google y Implícito.

   

6. En Client Information, haz lo siguiente:

   • Asigna un valor a Client ID issued by your Actions to Google para identificar las solicitudes provenientes de Google.
   • Inserta las URLs de tus extremos de autorización y de intercambio de tokens.

7. Haz clic en Guardar.

Implementa tu servidor de 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。

Handle automatic linking

After the user gives your Action consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.

If the corresponding Google account is already present in your authentication system, your token exchange endpoint returns a token for the user. If the Google account doesn't match an existing user, your token exchange endpoint returns a user_not_found error.

The request has the following form:

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

Your token exchange endpoint must be able to handle the following parameters:

Token endpoint parameters
grant_type	The type of token being exchanged. For these requests, this parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer.
intent	For these requests, the value of this parameter is `get`.
assertion	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.
consent_code	Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes.
scope	Optional: Any scopes you configured Google to request from users.

When your token exchange endpoint receives the linking request, it should do the following:

验证和解码 JWT 断言

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

注意 ：不得对键进行硬编码。而应按照 OpenID Connect Discovery 协议 并检查 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。

Check if the Google account is already present in your authentication system

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, the user has already signed up and you can issue an access token.

If neither the Google Account ID nor the email address specified in the assertion matches a user in your database, the user hasn't signed up yet. In this case, your token exchange endpoint should reply with a HTTP 401 error, that specifies error=user_not_found, as in the following example:

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

{
  "error":"user_not_found",
}

When Google receives the 401 error response with a user_not_found error, Google calls your token exchange endpoint with the value of the intent parameter set to create and sending an ID token that contains the user's profile information with the request.

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 协议 并检查 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
}

Diseña la interfaz de usuario por voz para el flujo de autenticación

Advertencia: No les muestres a los usuarios un mensaje obligatorio de vinculación de cuentas al inicio de la conversación con tu Acción. En cambio, ofrece a los usuarios no autenticados un flujo de invitado para mostrar cómo funciona tu Acción y, luego, solo solicita la vinculación de la cuenta si es necesario para continuar. Si los usuarios abandonan la Acción de forma constante debido a problemas de vinculación de la cuenta, Google no promocionará la Acción de forma activa, lo que puede reducir el tráfico de usuarios de la Acción.

Nota: Debes usar Actions Builder para crear una Acción que implemente la vinculación de cuentas.

Verifica si el usuario está verificado y comienza el flujo de vinculación de cuentas

1. Abre tu proyecto de Actions Builder en la Consola de Actions.
2. Crea una escena nueva para iniciar la vinculación de cuentas en tu Acción:
   1. Haz clic en Scenes.
   2. Haz clic en el ícono de agregar (+) para agregar una escena nueva.
3. En la escena recién creada, haz clic en el ícono de agregar para Condiciones.
4. Agrega una condición que verifique si el usuario asociado a la conversación es un usuario verificado. Si la verificación falla, tu Acción no podrá realizar la vinculación de cuentas durante la conversación y deberá recurrir a proporcionar acceso a la funcionalidad que no requiere la vinculación de cuentas.
   1. En el campo Enter new expression en Condición, ingresa la siguiente lógica: user.verificationStatus != "VERIFIED"
   2. En Transición, selecciona una escena que no requiera la vinculación de la cuenta o una escena que sea el punto de entrada a la funcionalidad solo para invitados.

1. Haz clic en el ícono de agregar para Condiciones.
2. Agrega una condición para activar un flujo de vinculación de cuentas si el usuario no tiene una identidad asociada.
   1. En el campo Enter new expression de Condición, ingresa la siguiente lógica: user.verificationStatus == "VERIFIED"
   2. En Transition, selecciona la escena del sistema Account Linking.
   3. Haz clic en Guardar.

Después de guardar, se agregará a tu proyecto una nueva escena del sistema de vinculación de cuentas llamada <SceneName>_AccountLinking.

Personaliza la escena de vinculación de cuentas

1. En Scenes, selecciona la escena del sistema de vinculación de cuentas.
2. Haz clic en Enviar mensaje y agrega una oración breve para describirle al usuario por qué la acción necesita acceder a su identidad (por ejemplo, "Para guardar tus preferencias").
3. Haz clic en Guardar.

1. En Condiciones, haz clic en Si el usuario completa correctamente la vinculación de la cuenta.
2. Configura cómo debe continuar el flujo si el usuario acepta vincular su cuenta. Por ejemplo, llama al webhook para procesar cualquier lógica empresarial personalizada que se requiera y volver a la escena de origen.
3. Haz clic en Guardar.

1. En Condiciones, haz clic en Si el usuario cancela o descarta la vinculación de la cuenta.
2. Configura cómo debe continuar el flujo si el usuario no acepta vincular su cuenta. Por ejemplo, envía un mensaje de confirmación y redirecciona a escenas que proporcionan funcionalidad que no requiere la vinculación de la cuenta.
3. Haz clic en Guardar.

1. En Condiciones, haz clic en Si se produce un error del sistema o de la red.
2. Configura cómo debe continuar el flujo si no se puede completar el flujo de vinculación de cuentas debido a errores del sistema o de red. Por ejemplo, envía un mensaje de confirmación y redirecciona a escenas que proporcionan funcionalidad que no requiere la vinculación de la cuenta.
3. Haz clic en Guardar.

Cómo controlar las solicitudes de acceso a los datos

Si la solicitud del Asistente contiene un token de acceso, primero verifica que el token de acceso sea válido y no haya vencido, y, luego, recupera de la base de datos de tu cuenta de usuario la cuenta de usuario asociada al token.