Vinculação de contas com a vinculação "simplificada" do Login do Google com base em OAuth

O tipo de vinculação "simplificada" do Login do Google baseada em OAuth adiciona o Login do Google à vinculação de contas baseada em OAuth. Isso oferece uma vinculação por voz perfeita para usuários do Google e também permite a vinculação de contas para usuários que se inscreveram no seu serviço com uma identidade que não é do Google.

Esse tipo de vinculação começa com o Login do Google, que permite verificar se as informações do perfil do usuário no Google existem no seu sistema. Se as informações do usuário não forem encontradas no seu sistema, um fluxo OAuth padrão será iniciado. O usuário também pode criar uma conta com as informações do perfil do Google.

Figura 1: depois que sua ação tiver acesso ao perfil do Google do usuário, você poderá usá-lo para encontrar uma correspondência no seu sistema de autenticação.

Para fazer a vinculação de contas com o tipo simplificado, siga estas etapas gerais:

1. Primeiro, peça ao usuário para dar consentimento de acesso ao perfil do Google dele.
2. Use as informações no perfil para identificar o usuário.
3. Se não for possível encontrar uma correspondência para o usuário do Google no seu sistema de autenticação, o fluxo vai continuar dependendo de como você configurou o projeto do Actions no console do Actions para permitir a criação de contas de usuário por voz ou apenas no seu site.
   • Se você permitir a criação de contas por voz, valide o token de ID recebido do Google. Em seguida, você pode criar um usuário com base nas informações do perfil contidas no token de ID.
   • Se você não permitir a criação de contas por voz, o usuário será transferido para um navegador em que poderá carregar sua página de autorização e concluir o fluxo de criação de usuário.

Figura 2. Uma representação visual do fluxo de OAuth e Login do Google quando as informações de um usuário não são encontradas no seu sistema.

Criar contas de suporte por voz

Se você permitir a criação de contas de usuário por voz, o Google Assistente vai perguntar se o usuário quer fazer o seguinte:

• Crie uma conta no seu sistema usando as informações da Conta do Google dela ou
• Faça login no sistema de autenticação com outra conta, se ela tiver uma conta que não seja do Google.

Recomendamos permitir a criação de contas por voz se você quiser minimizar o atrito do fluxo de criação de contas. O usuário só precisa sair do fluxo de voz se quiser fazer login usando uma conta que não seja do Google.

Não permitir a criação de contas por voz

Se você não permitir a criação de contas de usuário por voz, o Google Assistente vai abrir o URL do site que você forneceu para autenticação do usuário. Se a interação estiver acontecendo em um dispositivo sem tela, o Google Assistente vai direcionar o usuário para um smartphone para continuar o fluxo de vinculação de contas.

Recomendamos desativar a criação se:

• Você não quer permitir que usuários com contas que não são do Google criem uma nova conta de usuário e quer que eles vinculem as contas de usuário atuais ao seu sistema de autenticação. Por exemplo, se você oferece um programa de fidelidade, talvez queira garantir que o usuário não perca os pontos acumulados na conta atual.

• Você precisa ter controle total do fluxo de criação de contas. Por exemplo, é possível impedir a criação se você precisar mostrar os Termos de Serviço ao usuário durante a criação da conta.

Observação: selecione uma das opções de fluxo abaixo para saber mais sobre a implementação do fluxo selecionado. Se necessário, o conteúdo do guia será atualizado para se adaptar à sua escolha.

Permitir a criação de contas por voz Não permitir a criação de contas por voz

Implementar a vinculação "simplificada" do login do Google baseada em OAuth

As contas são vinculadas com fluxos OAuth 2.0 padrão do setor. O Actions on Google é compatível com os fluxos implícito e de código de autorização.

Observação: se você estiver implementando a vinculação de contas para processar informações financeiras, outras políticas poderão ser aplicadas à sua ação. Pode levar até seis semanas para analisarmos uma ação com vinculação de conta para informações financeiras. Portanto, considere esse tempo ao planejar seu cronograma de lançamento. Para facilitar o processo de análise, verifique se você está em conformidade com as políticas de serviços financeiros antes de enviar sua ação para análise.

在隐式代码流程中，Google 会在用户浏览器中打开您的授权端点。成功登录后，系统会向 Google 返回长期访问令牌。现在，从 Google 助理向你的 Action 发送的每个请求中都包含此访问令牌。

在授权代码流程中，您需要两个端点：

• 授权端点，该端点负责向尚未登录的用户显示登录界面，并以短期授权代码的形式记录所请求的访问。
• 令牌交换端点，负责两种类型的交换：
  1. 将授权代码交换为长期刷新令牌和短期访问令牌。用户完成帐号关联流程后，系统会进行这种交换。
  2. 将长期刷新令牌换成短期访问令牌。Google 需要新访问令牌时，由于此令牌已过期，因此会进行此交换。

虽然隐式代码流程的实现更简单，但 Google 建议通过隐式流程发出的访问令牌永远不会过期，因为将令牌过期与隐式流程一起使用会强制用户再次关联其帐号。如果出于安全考虑需要令牌到期，强烈建议您考虑使用身份验证代码流程。

注意 ：请选择您希望实施的 OAuth 2.0 流程。如果需要，本指南的内容会根据您的选择重新加载。

身份验证代码 隐式流程

Configurar o projeto

Para configurar seu projeto para usar a vinculação simplificada, siga estas etapas:

1. Abra o console do Actions e selecione o projeto que você quer usar.
2. Clique na guia Desenvolver e escolha Vinculação de contas.
3. Ative a chave ao lado de Vinculação de contas.
4. Na seção Criação de conta, selecione Sim.

5. Em Tipo de vinculação, selecione OAuth e Login do Google e Implícito.

   

6. Em Informações do cliente, faça o seguinte:

   • Atribua um valor a ID do cliente emitido pelo Actions on Google para identificar solicitações do Google.
   • Insira os URLs dos endpoints de autorização e troca de token.

7. Clique em Salvar.

Implementar seu servidor 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.

Processar a criação de contas pelo Login do Google

Quando um usuário precisa criar uma conta no seu serviço, o Google solicitação ao seu endpoint de troca de token que especifica intent=create, como no exemplo abaixo:

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]

O parâmetro assertion contém um JSON Web Token (JWT) que fornece uma declaração assinada da identidade do usuário do Google. O JWT contém informações incluindo o ID, o nome e o endereço de e-mail da Conta do Google do usuário, que você pode usar para criar uma nova conta no serviço.

Para responder a solicitações de criação de conta, seu endpoint de troca de token precisa: o seguinte:

验证和解码 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。

Valide as informações do usuário e crie uma nova conta

Verifique se uma das condições a seguir é verdadeira:

• O ID da Conta do Google, encontrado no campo sub da declaração, está no seu banco de dados de usuários.
• O endereço de e-mail na declaração corresponde a um usuário no seu banco de dados de usuários.

Se uma das condições for verdadeira, solicite que o usuário vincule a conta atual dele com sua Conta do Google respondendo à solicitação com um erro HTTP 401, especificando error=linking_error e o endereço de e-mail do usuário como login_hint, como no exemplo a seguir:

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

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

Se nenhuma das condições for verdadeira, crie uma nova conta de usuário usando as informações. fornecidos no JWT. Em geral, novas contas não têm uma senha definida. É recomendamos que você adicione o Login do Google a outras plataformas para permitir que os usuários façam login pelo Google em todas as plataformas do seu aplicativo. Também é possível enviar ao usuário um link por e-mail que inicie seu fluxo de recuperação de senha para permitir que ele defina uma senha para fazer login em outras plataformas.

Quando a criação for concluída, emita um token de acesso e retorna os valores em um objeto JSON o corpo da sua resposta HTTPS, como no exemplo a seguir:

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

Projetar a interface de usuário de voz para o fluxo de autenticação

Aviso:não peça aos usuários para vincular uma conta no início da conversa com sua ação. Em vez disso, ofereça aos usuários não autenticados um fluxo de convidados para mostrar como sua ação funciona e só peça a vinculação de contas se for necessário para continuar. Se os usuários estiverem abandonando a ação de forma consistente devido a problemas de vinculação de conta, o Google não vai promover ativamente a ação, o que pode diminuir o tráfego de usuários dela.

Observação: você precisa usar o Actions Builder para criar uma ação que implemente a vinculação de contas.

Verificar se o usuário está verificado e iniciar o fluxo de vinculação da conta

1. Abra seu projeto do Actions Builder no Console do Actions.
2. Crie uma nova cena para iniciar a vinculação de contas na sua ação:
   1. Clique em Cenas.
   2. Clique no ícone de adição (+) para adicionar uma nova cena.
3. Na cena recém-criada, clique no ícone de adição para Condições.
4. Adicione uma condição que verifique se o usuário associado à conversa é um usuário verificado. Se a verificação falhar, a Ação não poderá vincular contas durante a conversa e precisará oferecer acesso a funcionalidades que não exigem vinculação de contas.
   1. No campo Enter new expression em Condição, insira a seguinte lógica: user.verificationStatus != "VERIFIED"
   2. Em Transição, selecione uma cena que não exija vinculação de conta ou uma cena que seja o ponto de entrada para a funcionalidade somente para convidados.

1. Clique no ícone de adição em Condições.
2. Adicione uma condição para acionar um fluxo de vinculação de contas se o usuário não tiver uma identidade associada.
   1. No campo Enter new expression em Condição, insira a seguinte lógica: user.verificationStatus == "VERIFIED"
   2. Em Transição, selecione a cena do sistema Vinculação de conta.
   3. Clique em Salvar.

Depois de salvar, uma nova cena do sistema de vinculação de contas chamada <SceneName>_AccountLinking será adicionada ao seu projeto.

Personalizar a cena de vinculação de conta

1. Em Cenas, selecione a cena do sistema de vinculação de contas.
2. Clique em Enviar solicitação e adicione uma frase curta para descrever ao usuário por que a ação precisa acessar a identidade dele (por exemplo, "Para salvar suas preferências").
3. Clique em Salvar.

1. Em Condições, clique em Se o usuário concluir a vinculação de contas.
2. Configure como o fluxo vai prosseguir se o usuário concordar em vincular a conta. Por exemplo, chame o webhook para processar qualquer lógica de negócios personalizada necessária e volte para a cena de origem.
3. Clique em Salvar.

1. Em Condições, clique em Se o usuário cancelar ou dispensar a vinculação de contas.
2. Configure como o fluxo deve prosseguir se o usuário não concordar em vincular a conta. Por exemplo, envie uma mensagem de confirmação e redirecione para cenas que oferecem funcionalidades que não exigem vinculação de contas.
3. Clique em Salvar.

1. Em Condições, clique em Se ocorrer um erro de sistema ou de rede.
2. Configure como o fluxo deve prosseguir se a vinculação de conta não puder ser concluída devido a erros de sistema ou de rede. Por exemplo, envie uma mensagem de confirmação e redirecione para cenas que oferecem funcionalidades que não exigem vinculação de contas.
3. Clique em Salvar.

Processar solicitações de acesso a dados

Se a solicitação do Google Assistente contiver um token de acesso, primeiro verifique se o token é válido e não expirou. Depois, recupere do banco de dados da conta de usuário a conta associada ao token.