Neste tutorial, mostramos como criar um app do Google Chat que ajuda os usuários do Google Chat a gerenciar contatos pessoais e comerciais. Para coletar informações, o app Chat pede que os usuários preencham um formulário de contato em mensagens de cards e caixas de diálogo.
Confira o app Chat em ação:
-
Figura 1. O app Chat responde ao comando de barra /aboutcom uma mensagem de texto e um botão que abre um formulário de contato. -
Figura 2. O app Chat abre uma caixa de diálogo em que os usuários podem inserir informações sobre um contato. -
Figura 3. O app Chat retorna uma caixa de diálogo de confirmação para que os usuários possam revisar e confirmar as informações antes de enviar. -
Figura 4. Depois que o usuário envia o formulário, o app Chat envia uma mensagem de texto particular para confirmar o envio. -
Figura 5. O app Chat também pede que os usuários adicionem um contato de um card em uma mensagem.
Pré-requisitos
- Uma conta do Google Workspace Business ou Enterprise com acesso ao Google Chat.
- Crie um projeto do Google Cloud.
Objetivos
- Projete e crie interfaces do usuário (IUs)
como objetos
carde mostre as IUs em mensagens e caixas de diálogo. - Receber e processar informações enviadas pelos usuários usando widgets de entrada de formulário.
- Responda a comandos com mensagens que contêm texto, cards e widgets de acessórios.
Arquitetura
O app Chat é integrado ao
Google Apps Script (como um complemento do Google Workspace que
estende o Google Chat) e responde a
interações do usuário (onMessage,
onAppCommand e cliques em botões que invocam openInitialDialog,
openConfirmationDialog e submitForm) para processar e responder aos
usuários do Chat.
Confira a seguir como um usuário normalmente interage com o app Chat:
Um usuário abre uma mensagem direta com o app Chat ou adiciona o app Chat a um espaço.
O app Chat pede que o usuário adicione um contato criando e mostrando um formulário de contato como um objeto
card. Para apresentar o formulário de contato, o app Chat responde aos usuários das seguintes maneiras:- Responde a @menções e mensagens diretas (
onMessage) com uma mensagem de card que contém o formulário de contato. - Responde ao comando de barra
/addContact(onAppCommand) abrindo uma caixa de diálogo com o formulário de contato. - Responde ao comando de barra
/about(onAppCommand) com uma mensagem de texto que tem um botão Adicionar um contato. Os usuários podem clicar nele para invocaropenInitialDialoge abrir uma caixa de diálogo com o formulário de contato.
- Responde a @menções e mensagens diretas (
Ao receber o formulário de contato, o usuário insere informações de contato nos seguintes campos e widgets:
- Nome e sobrenome: um widget
textInputque aceita strings. - Data de nascimento: um widget
dateTimePickerque aceita apenas datas. - Tipo de contato: um widget
selectionInputde botões de opção que permite aos usuários selecionar e enviar um único valor de string (PersonalouWork). - Botão Analisar e enviar: uma
matriz
buttonListcom um widgetbuttonem que o usuário clica para enviar os valores inseridos.
- Nome e sobrenome: um widget
O app Google Chat invoca
openConfirmationDialogpara processar os valores inseridos pelo usuário e os mostra em um card de confirmação.O usuário analisa o card de confirmação e clica no botão Enviar para invocar
submitForme finalizar as informações de contato.O app Google Chat envia uma mensagem de texto particular confirmando o envio.
Prepare o ambiente
Esta seção mostra como configurar um projeto na nuvem do Google Cloud para o app Chat.
Abra seu projeto na nuvem no Console de APIs do Google.
Se ele ainda não estiver aberto, abra o projeto na nuvem que você pretende usar para esta amostra:
- No console de APIs do Google, acesse a página Selecionar um projeto.
- Selecione o projeto do Google Cloud que você quer usar. Ou clique em Criar projeto e siga as instruções na tela. Se você criar um projeto do Google Cloud, talvez seja necessário ativar o faturamento dele.
Configurar a autenticação e a autorização
Os apps do Google Chat exigem que você configure uma tela de permissão OAuth para que os usuários possam autorizar seu app nos aplicativos do Google Workspace, incluindo o Google Chat.
Neste tutorial, você vai implantar um app do Chat apenas para testes e uso interno. Por isso, não há problema em usar informações de marcador de posição na tela de permissão. Antes de publicar o app do Chat, substitua todas as informações de marcador de posição por informações reais.
No console de APIs do Google, acesse Menu > Plataforma de autenticação do Google > Branding.
Se você já configurou a plataforma de autenticação do Google, é possível configurar as seguintes configurações da tela de permissão OAuth em Branding, Público-alvo e Acesso a dados. Se você vir uma mensagem informando que A plataforma Auth do Google ainda não está configurada, clique em Começar:
- Em Informações do app, em Nome do app, digite
Contact Manager. - Em E-mail para suporte do usuário, selecione seu endereço de e-mail ou um grupo do Google adequado.
- Clique em Próxima.
- Em Público-alvo, selecione Interno. Se não for possível selecionar Interno, escolha Externo.
- Clique em Próxima.
- Em Informações de contato, insira um endereço de e-mail onde você possa receber notificações sobre mudanças no projeto.
- Clique em Próxima.
- Em Concluir, revise a Política de dados do usuário dos serviços de API do Google e, se concordar, selecione Concordo com a Política de dados do usuário dos serviços de API do Google.
- Clique em Continuar.
- Clique em Criar.
- Se você selecionou Externo como o tipo de usuário, adicione usuários de teste:
- Clique em Público-alvo.
- Em Usuários de teste, clique em Adicionar usuários.
- Insira seu endereço de e-mail e os outros usuários de teste autorizados. Depois, clique em Salvar.
- Em Informações do app, em Nome do app, digite
Criar e implantar o app do Chat
Na seção a seguir, você vai criar e atualizar um projeto do Apps Script com o código do aplicativo (Code.gs e appsscript.json) para seu app do Chat.
Se quiser, confira o projeto inteiro no GitHub.
Confira uma visão geral de cada arquivo:
Code.gsProcessa toda a lógica do app, incluindo interações do usuário (
onMessage,onAppCommand,openInitialDialog,openConfirmationDialogesubmitForm) e os widgets de entrada de formulário mostrados em cards em mensagens e caixas de diálogo.Ver o código
Code.gsappsscript.jsonO manifesto do Apps Script que define e configura o projeto do Apps Script para o app do Chat.
Ver o código
appsscript.json
Criar o projeto do Apps Script
Para criar um projeto do Apps Script com base nos arquivos Code.gs e
appsscript.json:
- Acesse Google Apps Script e clique em Novo projeto.
Nomeie seu projeto do Apps Script:
Clique em Projeto sem título.
Em Título do projeto, digite
Contact Manager - Google Chat app.Clique em Renomear.
Substitua o conteúdo de
Code.gspelo exemplo de códigoCode.gsacima.Clique em Configurações do projeto
e selecione Mostrar arquivo de manifesto "appsscript.json" no editor.
Volte ao Editor e substitua o conteúdo de
appsscript.jsonpelo código do manifestoappsscript.jsonacima. Depois, salve o projeto.
No futuro, se você quiser usar determinadas APIs do Google ou publicar seu app, será necessário associar seu projeto na nuvem ao projeto do Apps Script. Para este guia, não é necessário fazer isso. Para saber mais, consulte o guia de projetos do Google Cloud.
Criar uma implantação do Apps Script
Agora que todo o código está no lugar, implante o projeto do Apps Script. Você usa o ID de implantação ao configurar o app Chat no Google Cloud.
No Apps Script, abra o projeto do app Chat.
Clique em Implantar > Nova implantação.
Se Complemento ainda não estiver selecionado, ao lado de Selecionar tipo, clique em tipos de implantação
e selecione Complemento.
Em Descrição, insira uma descrição para esta versão, como
Test of Contact Manager.Clique em Implantar. O Apps Script informa que a implantação foi concluída e fornece um ID de implantação.
Clique em Copiar para copiar o ID da implantação e clique em Concluído.
Configurar o app Chat no console de APIs do Google
Esta seção mostra como configurar a API Google Chat no console de APIs do Google com informações sobre seu app Chat, incluindo o ID da implantação que você acabou de criar no projeto do Apps Script.
No console de APIs do Google, clique em Menu > APIs e serviços > APIs e serviços ativados > API Google Chat > Configuração.
Em Nome do app, digite
Contact Manager.Em URL do avatar, digite
https://developers.google.com/chat/images/contact-icon.png.Em Descrição, digite
Manage your personal and business contacts.Clique no botão Ativar recursos interativos para a posição ativada.
Em Funcionalidade, selecione Participar de espaços e conversas em grupo.
Em Configurações de conexão, selecione Apps Script.
Em ID de implantação, cole o ID de implantação do Apps Script que você copiou na seção anterior ao criar a implantação do Apps Script.
Em Gatilhos, configure as funções que respondem às interações do usuário:
- No gatilho Mensagem, insira
onMessage. - Para o gatilho Comando do app, insira
onAppCommand.
- No gatilho Mensagem, insira
Em Comandos, configure os comandos de barra
/aboute/addContact:- Clique em Adicionar um comando para configurar o primeiro comando de barra.
- Em ID do comando, digite
1. - Em Descrição, digite
Learn how to use this Chat app to manage your contacts. - Em Tipo de comando, selecione
Slash command. - Em Nome do comando de barra, digite
/about. - Clique em Concluído.
- Clique em Adicionar um comando para configurar outro comando de barra.
- Em ID do comando, digite
2. - Em Descrição, digite
Submit information about a contact. - Em Tipo de comando, selecione
Slash command. - Em Nome do comando de barra, digite
/addContact. - Selecione Abre uma caixa de diálogo.
- Clique em Concluído.
Em Visibilidade, marque a caixa de seleção Disponibilize o app de chat para pessoas e grupos específicos em YOUR DOMAIN e digite seu endereço de e-mail.
Em Registros, selecione Registrar erros no Logging.
Clique em Salvar. Uma mensagem de configuração salva aparece.
O app Chat está pronto para ser instalado e testado no Chat.
Teste o app do Chat
Para testar o 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ê informou ao se adicionar como trusted tester.
- Clique em Novo chat.
- No campo Adicionar uma ou mais pessoas, digite o nome do seu app de chat.
Selecione seu app de chat nos resultados. Uma mensagem direta é aberta.
Na nova mensagem direta com o app Chat, digite
/addContacte pressione Enter.Na caixa de diálogo exibida, insira as informações de contato:
- No campo de texto Nome e sobrenome, digite um nome.
- No seletor de data Data de nascimento, selecione uma data.
- Em Tipo de contato, selecione o botão de opção Trabalho ou Pessoal.
Clique em Revisar e enviar.
Na caixa de diálogo de confirmação, revise as informações enviadas e clique em Enviar. O app Chat responde com uma mensagem de texto que diz
✅ CONTACT NAME has been added to your contacts..Também é possível testar e enviar o formulário de contato das seguintes maneiras:
- Use o comando de barra
/about. O app de chat responde com uma mensagem de texto e um botão de widget de acessório que dizAdd a contact. Clique no botão para abrir uma caixa de diálogo com o formulário de contato. - Envie uma mensagem direta para o app Chat sem um
comando de barra, como
Hello. O app Chat responde com um texto e um card que contém o formulário de contato.
- Use o comando de barra
Limpar
Para evitar cobranças na sua conta do Google Cloud pelos recursos usados neste tutorial, recomendamos que você exclua o projeto na nuvem.
- No console de APIs do Google, acesse a página Gerenciar recursos. Clique em Menu > IAM e admin > Gerenciar recursos.
- Na lista de projetos, selecione o 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
- Responder a comandos
- Coletar e processar informações de usuários do Google Chat
- Abrir caixas de diálogo interativas
- Conheça outras amostras de apps do Google Chat
Apps de chat que não são complementos: gerenciar contatos do Google Chat
As instruções e os exemplos de código a seguir se aplicam a um app de chat que não é um complemento do Google Workspace (Conferir no GitHub).
Arquivos do Apps Script
main.gsProcessa toda a lógica do app, incluindo eventos de interação sobre quando os usuários enviam mensagens para o app Chat, clicam em botões de uma mensagem do app Chat ou abrem e fecham caixas de diálogo.
contactForm.gsContém os widgets que recebem dados de formulários dos usuários. Esses widgets de entrada de formulário são mostrados em cards que aparecem em mensagens e caixas de diálogo.
appsscript.jsonO manifesto do Apps Script que define e configura o projeto do Apps Script para o app do Chat que não é um complemento.
Criar e configurar o projeto do Apps Script
- Abra o projeto do Apps Script Gerenciar contatos no Google Chat para um app do Chat que não seja um complemento e faça uma cópia.
- Ao configurar a API Chat no Console de APIs do Google: Desmarque a opção Criar este app do Chat como um complemento do Google Workspace. Uma caixa de diálogo vai pedir para você confirmar. Na caixa de diálogo, clique em Desativar.