Nesta página, explicamos como criar um app de chat HTTP. Há maneiras diferentes de implementar essa arquitetura. No Google Cloud, pode usar o Cloud Functions, o Cloud Run e o App Engine. Neste guia de início rápido, gravar e implantar um Função do Cloud que o app do Chat usa para responder à mensagem de um usuário.
Com esta arquitetura, você configura o Chat para integração Google Cloud ou um servidor local usando HTTP, conforme diagrama a seguir:
No diagrama anterior, um usuário interagindo com uma interface HTTP O app do Chat tem o seguinte fluxo de informações:
- Um usuário envia uma mensagem no Chat para App do Chat, seja em mensagem direta ou em uma Espaço do Chat.
- Uma solicitação HTTP é enviada para um servidor da Web que é uma nuvem ou sistema local que contém o app do Chat lógica.
- Opcionalmente, a lógica do app do Chat pode se integrar 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 projeto sistema de gerenciamento de projetos ou ferramenta de tiquetagem).
- O servidor da Web envia uma resposta HTTP Serviço de app do Chat no Chat.
- A resposta é entregue ao usuário.
- Opcionalmente, o app do Chat pode chamar a função a API Chat para postar mensagens de forma assíncrona ou realizar outras as operações.
Essa arquitetura oferece flexibilidade para usar bibliotecas e recursos componentes que já existem no sistema, porque eles Os apps de chat podem ser projetados com diferentes linguagens de programação.
Objetivos
- Configurar o ambiente.
- Crie e implante uma função do Cloud.
- Publique o app no Chat.
- Teste o app.
Pré-requisitos
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Ter um projeto do Google Cloud com o faturamento ativado. Para verificar se o faturamento está ativado em um projeto, consulte Verificar o status de faturamento dos seus projetos. Para criar um projeto e configurar o faturamento, consulte Criar um projeto do Google Cloud.
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 e Cloud Functions. API Cloud Pub/Sub, API Cloud Logging, API Artifact Registry e API Cloud Run.
Crie e implemente uma Função do Cloud
Crie e implante uma função do Cloud que gere uma card de chat com o nome de exibição e a imagem do avatar do remetente. Quando o O app do Chat recebe uma mensagem, executa a função responde com o card.
Para criar e implantar a função no app de chat, siga estas etapas:
Node.js
No console do Google Cloud, acesse a página Cloud Functions:
Verifique se o projeto do app de chat está selecionado.
Clique em
Criar função.Na página "Criar função", configure sua função:
- Em Ambiente, selecione 2ª geração.
- Em Nome da função, insira
QuickStartChatApp
. - Em Região, selecione uma região.
- Em "Autenticação", selecione Exigir autenticação.
- 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 insira
avatarApp
.Substitua o conteúdo de
index.js
pelo seguinte código:Clique em Implantar.
Python
No console do Google Cloud, acesse a página Cloud Functions:
Verifique se o projeto do app de chat está selecionado.
Clique em
Criar função.Na página "Criar função", configure sua função:
- Em Ambiente, selecione 2ª geração.
- Em Nome da função, insira
QuickStartChatApp
. - Em Região, selecione uma região.
- Em "Autenticação", selecione Exigir autenticação.
- 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
avatar_app
.Substitua o conteúdo de
main.py
pelo seguinte código:Clique em Implantar.
Java
No console do Google Cloud, acesse a página Cloud Functions:
Verifique se o projeto do seu app do Chat está selecionados.
Clique em
Criar função.Na página "Criar função", configure sua função:
- Em Ambiente, selecione 2ª geração.
- Em Nome da função, insira
QuickStartChatApp
. - Em Região, selecione uma região.
- Em "Autenticação", selecione Exigir autenticação.
- 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 insira
App
.O
src/main/java/com/example/Example.java
foi renomeado comosrc/main/java/App.java
.Substitua o conteúdo de
App.java
pelo seguinte código:Substitua o conteúdo de
pom.xml
pelo seguinte código:Clique em Implantar.
A página de detalhes do Cloud Functions é aberta, e sua função aparece com dois indicadores de progresso: um para o build e outro para o serviço. Quando os dois indicadores de progresso desaparecerem e serão substituídos por uma marca de seleção, sua função está implantado e pronto.
Autorizar o Google Chat a invocar sua função
Para autorizar o Google Chat a invocar sua função, adicione a API conta de serviço com o papel Invocador do Cloud Run.
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, escolha Cloud Run > Invocador 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 para 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, insira
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 endpoint HTTP e cole o URL do gatilho da função do Cloud na caixa.
- Em Segmento de autenticação, selecione URL do endpoint HTTP.
- Em Visibilidade, selecione Disponibilizar este app do Google Chat para pessoas e grupos no seu domínio e digite o 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 mensagens no Chat.
Testar o app Chat
Para testar o app do Chat, abra um espaço de mensagem direta com o app e envie uma mensagem:
Abra o Google Chat usando a conta do Google Workspace que você fornecido quando você se adicionou como trusted tester.
- Clique em Nova conversa.
- No campo Adicionar uma ou mais pessoas, digite o nome da sua App Chat.
Selecione seu app do Chat nos resultados. Uma mensagem direta é aberta.
- Na nova mensagem direta com o app, digite
Hello
e pressioneenter
.
A resposta do app Chat contém uma mensagem em card que mostra o nome e a imagem do avatar do remetente, conforme demonstrado na imagem a seguir:
Para adicionar trusted testers e saber mais sobre como testar recursos interativos, consulte Teste os recursos interativos do Apps do Google Chat
Resolver problemas
Quando um app ou card retornar um erro, o A interface do chat mostra a mensagem "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 do Chat ou produz um resultado inesperado; por exemplo, uma mensagem de cartão pode não aparecer.
Embora uma mensagem de erro possa não aparecer na interface do Chat, mensagens de erro descritivas e dados de registro estão disponíveis para ajudar a corrigir erros quando o registro de erros para apps de chat estiver ativado. Para receber ajuda com a visualização, depurar e corrigir erros, consulte Resolver problemas e corrigir erros do Google Chat.
Limpar
Para evitar cobranças na sua conta do Google Cloud pelo recursos usados neste tutorial, recomendamos que você exclua os do Google Cloud.
- No console do Google Cloud, acesse a página Gerenciar recursos. Clique em Cardápio > 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 excluir o projeto.
Temas relacionados
Para adicionar mais recursos ao seu app de chat, consulte o seguinte: