Conectar um app do Chat a outros serviços e ferramentas

Nesta página, descrevemos como conectar um app do Google Chat a um serviço ou ferramenta que está fora do Google Chat. Embora os apps de chat sejam poderosos por si só, eles geralmente funcionam em conjunto com outros sistemas e exigem que aplicativos complementares conectem contas, autorizem o acesso a dados, exibam mais dados ou configurem preferências do usuário.

Solicitar a configuração do app do Chat de um usuário

Se a solicitação exigir uma configuração adicional que não possa ser concluída diretamente no app do Chat, retorne um URL de configuração para o usuário em uma resposta normal ou apresente-o de maneira particular no seguinte formato:

{
  "actionResponse": {
    "type": "REQUEST_CONFIG",
    "url": "CONFIGURATION_URL"
  }
}

Isso informa ao Google Chat para apresentar ao usuário uma solicitação particular, em que CONFIGURATION_URL é um link que o usuário pode acessar para autenticação, autorização ou configuração. Uma resposta REQUEST_CONFIG é mutuamente exclusiva com uma mensagem de resposta normal. Textos, cards ou outros atributos são ignorados.

Concluir a solicitação de configuração

Todo evento de interação MESSAGE que o app do Chat recebe também inclui um parâmetro configCompleteRedirectUrl. Esse URL precisa ser codificado no URL de configuração para ser usado na conclusão do processo. O redirecionamento para este URL indica ao Google Chat que a solicitação de configuração foi atendida.

Quando seu app do Chat é iniciado, o fluxo depende da mensagem específica recebida. Em resposta a uma mensagem como @app help, um app do Chat precisa responder com uma mensagem sem exigir configuração adicional.

Quando um usuário é redirecionado para o configCompleteRedirectUrl fornecido na mensagem original, o Google Chat realiza as seguintes etapas:

  1. Apaga a solicitação exibida ao usuário iniciante.
  2. Converta a mensagem original em pública, deixando-a visível para outros participantes do espaço.
  3. Envie a mensagem original para o mesmo app do Chat uma segunda vez.

Acessar um configCompleteRedirectUrl afeta apenas uma mensagem do usuário. Se um usuário tiver tentado enviar mensagens a um app do Chat várias vezes e, como resultado, receber várias solicitações, clicar em uma solicitação específica e concluir o processo de autenticação e configuração só afetará essa mensagem específica. Outras mensagens não são alteradas.

Quando um evento de interação MESSAGE é reenviado, ele precisa ser idêntico ao original. No entanto, há algumas situações em que os eventos de interação MESSAGE podem ser diferentes. Por exemplo, quando uma mensagem menciona os apps do Chat A e B, o usuário pode editar a mensagem se o app do Chat A responder com uma mensagem normal antes de autenticar com o app do Chat B. Nesse caso, o app do Chat B recebe o texto da mensagem editada depois que o usuário conclui a autenticação e a configuração.

Autenticar o usuário do Chat fora do Chat

Em alguns casos, como a solicitação de autorização OAuth para uma API, o app precisa ser vinculado a um URL fora do Chat sem alterar a identidade do usuário. A melhor maneira de identificar o usuário nesses casos é proteger o app de destino com o Login do Google.

Use o token de identidade emitido durante o login para conseguir o ID do usuário. A declaração sub contém o ID exclusivo do usuário e pode ser correlacionada ao ID do usuário do Google Chat.

Embora os dois IDs não sejam exatamente idênticos, eles podem ser forçados. Para coagir o valor da declaração sub a um users/{user} do Google Chat, inclua users/ no início do valor. Por exemplo, o valor da declaração de 123 é equivalente ao nome de usuário users/123 em mensagens para o app do Chat.