Nesta página, explicamos como criar um app de chat HTTP. Há maneiras diferentes de implementar essa arquitetura. No Google Cloud, é possível usar o Cloud Functions, o Cloud Run e o App Engine. Neste guia de início rápido, você escreverá e implantará uma função do Cloud que o app do Chat usa para responder à mensagem de um usuário.
Com essa arquitetura, você configura o Chat para integração com o Google Cloud ou um servidor local usando HTTP, conforme mostrado no diagrama a seguir:
No diagrama anterior, um usuário que interage com um app de chat HTTP tem o seguinte fluxo de informações:
- Um usuário envia uma mensagem no Chat para um app do Chat em uma mensagem direta ou em um espaço do Chat.
- Uma solicitação HTTP é enviada para um servidor da Web que é um sistema em nuvem ou no local que contém a lógica do app do Chat.
- Opcionalmente, a lógica do app do Chat pode se integrar aos serviços do Google Workspace (como Agenda e Planilhas), outros Serviços do Google (como Maps, YouTube e Vertex AI) ou outros serviços da Web (como um sistema de gerenciamento de projetos ou ferramenta de emissão de tíquetes).
- O servidor da Web envia uma resposta HTTP de volta ao serviço de app do Chat no Chat.
- A resposta é entregue ao usuário.
- O app do Chat também pode chamar a API Chat para postar mensagens de forma assíncrona ou realizar outras operações.
Essa arquitetura oferece flexibilidade para usar bibliotecas e componentes que já existem no seu sistema, porque esses apps do Chat podem ser projetados com diferentes linguagens de programação.
Objetivos
- Configurar o ambiente.
- Criar e implantar uma função do Cloud
- Publique o app no Chat.
- Teste o app.
Pré-requisitos
- Uma conta do Google Workspace com acesso ao Google Chat e ao Google Cloud Functions.
- Um projeto do Google Cloud.
- Ative o faturamento do seu projeto do Cloud. Saiba como verificar o status de faturamento dos projetos.
Configure o ambiente
Antes de usar as APIs do Google, você precisa ativá-las em um projeto do Google Cloud. É possível ativar uma ou mais APIs em um único projeto do Google Cloud.No console do Google Cloud, ative as APIs Google Chat, Cloud Build, Cloud Functions, Cloud Pub/Sub, Cloud Logging, Artifact Registry e Cloud Run.
Crie e implemente uma Função do Cloud
Crie e implante uma função do Cloud que gere um cartão do Chat com o nome de exibição e a imagem de avatar do remetente. Quando o app do Chat recebe uma mensagem, ele executa a função e responde com o cartão.
Para criar e implantar a função para seu app do Chat, conclua as seguintes etapas:
Node.js
No console do Google Cloud, acesse a página Cloud Functions:
Verifique se o projeto do seu app do Chat está selecionado.
Clique em
Criar função.Na página "Criar função", configure sua função:
- Em Ambiente, selecione 2a geração.
- Em Nome da função, insira
QuickStartChatApp
. - Em Região, selecione uma região.
- Em "Autenticação", selecione Autenticação necessária.
- Clique em Próxima.
Em Ambiente de execução, selecione a versão mais recente do Node.js.
Em Código-fonte, selecione Editor in-line.
Em Ponto de entrada, exclua o texto padrão e digite
helloChat
.Substitua o conteúdo de
index.js
pelo seguinte código:Selecione Implantar.
Python
No console do Google Cloud, acesse a página Cloud Functions:
Verifique se o projeto do seu app do Chat está selecionado.
Clique em
Criar função.Na página "Criar função", configure sua função:
- Em Ambiente, selecione 2a geração.
- Em Nome da função, insira
QuickStartChatApp
. - Em Região, selecione uma região.
- Em "Autenticação", selecione Autenticação necessária.
- Clique em Próxima.
Em Ambiente de execução, selecione a versão mais recente do Python.
Em Código-fonte, selecione Editor in-line.
Em Ponto de entrada, exclua o texto padrão e digite
hello_chat
.Substitua o conteúdo de
main.py
pelo seguinte código:Selecione Implantar.
Java
No console do Google Cloud, acesse a página Cloud Functions:
Verifique se o projeto do seu app do Chat está selecionado.
Clique em
Criar função.Na página "Criar função", configure sua função:
- Em Ambiente, selecione 2a geração.
- Em Nome da função, insira
QuickStartChatApp
. - Em Região, selecione uma região.
- Em "Autenticação", selecione Autenticação necessária.
- Clique em Próxima.
Em Ambiente de execução, selecione a versão mais recente do Java.
Em Código-fonte, selecione Editor in-line.
Em Ponto de entrada, exclua o texto padrão e digite
HelloChat
.O
src/main/java/com/example/Example.java
foi renomeado comosrc/main/java/HelloChat.java
.Substitua o conteúdo de
HelloChat.java
pelo seguinte código:Substitua o conteúdo de
pom.xml
pelo seguinte código:Selecione Implantar.
A página de detalhes do Cloud Functions é aberta e sua função aparece com dois indicadores de progresso: um para a versão e outro para o serviço. Quando os dois indicadores de progresso desaparecerem e forem substituídos por uma marca de seleção, a função será implantada e estará pronta.
Autorizar o Google Chat a invocar sua função
Para autorizar o Google Chat a invocar sua função, adicione a conta de serviço do Google Chat com o papel Cloud Run Invocador.
No console do Google Cloud, acesse a página do Cloud Run:
Na lista de serviços do Cloud Run, marque a caixa de seleção ao lado da função de recebimento. (Não clique na função em si.)
Clique em Permissões. O painel Permissões será aberto.
Clique em Adicionar principal.
Em Novos principais, digite
chat@system.gserviceaccount.com
.Em Selecionar papel, selecione Cloud Run > Chamador do Cloud Run.
Clique em Salvar.
Publicar o app no Google Chat
Depois que a função do Cloud for implantada, siga estas etapas para transformá-la em um app do Google Chat:
No console do Google Cloud, clique em Menu > Cloud Functions.
Verifique se o projeto em que você ativou o Cloud Functions está selecionado.
Na lista de funções, clique em QuickStartChatApp.
Clique na guia Gatilhos.
Em HTTPS, copie o URL.
Pesquise "API Google Chat", clique em API Google Chat e em Gerenciar.
Clique em Configuração e configure o app Google Chat:
- Em Nome do app, digite
Quickstart App
. - No URL do avatar, digite
https://developers.google.com/chat/images/quickstart-app-avatar.png
. - Em Descrição, digite
Quickstart app
. - Em Funcionalidade, selecione Receber mensagens individuais e Participar de espaços e conversas em grupo.
- Em Configurações de conexão, selecione URL do app e cole o URL do gatilho da função do Cloud na caixa.
- Em Público-alvo de autenticação, selecione URL do app.
- Em Visibilidade, selecione Disponibilizar este app do Google Chat para pessoas e grupos específicos no domínio e digite seu endereço de e-mail.
- Em Registros, selecione Registrar erros no Logging.
- Em Nome do app, digite
Clique em Salvar.
O app do Chat está pronto para receber e responder a mensagens no Chat.
Testar o app do Chat
Para testar seu app do Chat, abra um espaço de mensagem direta com o app do Chat e envie uma mensagem:
Abra o Google Chat usando a conta do Google Workspace que você forneceu ao se adicionar como trusted tester.
- Clique em Nova conversa.
- No campo Adicionar uma ou mais pessoas, digite o nome do seu app do Chat.
Selecione seu app do Chat nos resultados. Uma mensagem direta será aberta.
- Na nova mensagem direta com o app, digite
Hello
e pressioneenter
.
A resposta do app do Chat contém uma mensagem de card que mostra o nome do remetente e a imagem do avatar, conforme demonstrado na imagem a seguir:
Para adicionar trusted testers e saber mais sobre como testar recursos interativos, consulte Testar recursos interativos para apps do Google Chat.
Resolver problemas
Quando um app ou card do Google Chat retorna um erro, a interface do Chat mostra uma mensagem dizendo "Algo deu errado". ou "Não foi possível processar sua solicitação". Às vezes, a interface do Chat não exibe nenhuma mensagem de erro, mas o app ou card produz um resultado inesperado. Por exemplo, uma mensagem de card pode não aparecer.
Embora uma mensagem de erro possa não ser exibida na interface do Chat, mensagens de erro descritivas e dados de registro estão disponíveis para ajudar você a corrigir erros quando a geração de registros de erros para apps do Chat está ativada. Se precisar de ajuda para visualizar, depurar e corrigir erros, consulte Resolver problemas e corrigir erros do Google Chat.
Limpar
Para evitar cobranças na sua conta do Google Cloud pelos recursos usados neste tutorial, recomendamos excluir o projeto do Cloud.
- No Console do Google Cloud, acesse a página Gerenciar recursos. Clique em Menu > IAM e administrador > Gerenciar recursos.
- Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir .
- Na caixa de diálogo, digite o ID do projeto e clique em Encerrar para excluí-lo.
Temas relacionados
Para adicionar mais recursos ao seu app do Chat, consulte: