Criar um app do Google Chat com o Google Apps Script

Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Esta página explica como criar um complemento do Google Workspace que funciona no Google Chat usando o Google Apps Script. No Google Chat, os complementos aparecem para os usuários como apps do Google Chat. Para saber mais, consulte a Visão geral do Extend Google Chat.

O app Chat permite enviar mensagens diretas e responder ecoando suas mensagens.

O diagrama a seguir mostra a arquitetura e o padrão de mensagens:

No diagrama anterior, um usuário que interage com um app do Chat do Apps Script tem o seguinte fluxo de informações:

1. Um usuário envia uma mensagem para um app do Chat, em uma mensagem direta ou em um espaço do Chat.
2. A lógica do app Chat implementada no Apps Script, que fica no Google Cloud, recebe e processa a mensagem.
3. Opcionalmente, a lógica do app de chat pode ser integrada a serviços do Google Workspace, como Agenda ou Planilhas, ou outros serviços do Google, como o Google Maps ou o YouTube.
4. A lógica do app do Chat envia uma resposta de volta para o serviço do app do Chat.
5. A resposta é enviada ao usuário.

Objetivos

• Prepare o ambiente.
• Configure o script.
• Configure um complemento do Google Workspace para o app Chat.
• Teste o app Chat.

Pré-requisitos

• Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
• Um projeto do Google Cloud. Para criar um, consulte Criar um projeto do Google Cloud.

Configurar o ambiente

Abra seu projeto do Cloud no console do Google Cloud

Se ainda não estiver aberto, abra o projeto do Cloud que você pretende usar para este exemplo:

1. No console do Google Cloud, acesse a página Selecionar um projeto.

   Selecionar um projeto do Cloud

2. 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.

Ativar a API Chat

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 a API Google Chat.

  Ativar a API

Configurar a tela de permissão OAuth

Todos os apps que usam o OAuth 2.0 exigem uma configuração de tela de consentimento. A configuração da tela de consentimento do OAuth define o que é mostrado para usuários e revisores de apps e registra o app para que você possa publicá-lo mais tarde.

1. No console do Google Cloud, acesse Menu > APIs e serviços > Tela de consentimento do OAuth.

   Acessar a tela de permissão OAuth

2. Em Tipo de usuário, selecione Interno e clique em Criar.
3. Preencha o formulário de registro do app e clique em Salvar e continuar.

4. Por enquanto, você pode pular a adição de escopos e clicar em Salvar e continuar. No futuro, ao criar um app para uso fora da sua organização do Google Workspace, você precisará mudar o Tipo de usuário para Externo e, em seguida, adicionar os escopos de autorização necessários para o app.

5. Analise o resumo do registro do app. Para fazer alterações, clique em Editar. Se o registro do app estiver correto, clique em Voltar ao painel.

Configurar o script

Para configurar o script, faça uma cópia do projeto de início rápido e defina seu projeto do Cloud no Apps Script.

Fazer uma cópia do projeto de início rápido

1. Clique no botão a seguir para abrir o projeto do Apps Script Add-on in Google Chat.
   Abrir o projeto
2. Clique em Visão geral.
3. Na página de visão geral, clique em Fazer uma cópia.

4. Nomeie sua cópia do projeto do Apps Script:

   1. Clique em Copiar o app de chat complementar.

   2. Em Título do projeto, digite Add-on Chat app.

   3. Clique em Renomear.

Copiar o número do projeto do Cloud

1. No console do Google Cloud, acesse Menu > IAM e administrador > Configurações.

   Acessar as configurações de IAM e administrador

2. No campo Número do projeto, copie o valor.

Definir o projeto do Cloud do Apps Script

1. No projeto do Apps Script do app Chat, clique em Configurações do projeto .
2. Em Projeto do Google Cloud Platform (GCP), clique em Mudar projeto.
3. Em Número do projeto do GCP, cole o número do projeto do Google Cloud.
4. Clique em Configurar projeto.

Agora você tem um código de app funcional que pode testar (conforme descrito nas próximas etapas) e personalizar para atender aos seus requisitos.

Verifique se você fez login na Conta do Google correta ao abrir o projeto do Apps Script. Às vezes, a conta atual pode mudar para a padrão sem que você perceba.

Criar uma implantação de teste

Você precisa de um ID de implantação para este projeto do Apps Script, para que ele possa ser usado na próxima etapa.

Para conferir o ID da implantação principal, faça o seguinte:

1. No projeto do Apps Script do app de chat, clique em Implantar > Testar implantações.
2. Copie o ID da implantação principal para usar em uma etapa posterior e clique em Concluído.

Configurar o complemento

Usando a implantação do Apps Script, siga estas etapas para criar um complemento e implantar o app Google Chat:

1. No console, pesquise Google Chat API e clique em API Google Chat.
2. Clique em Gerenciar.

3. Clique em Configuração e configure o app Chat:

   1. No campo Nome do app, digite Add-on Chat app.
   2. No campo URL do avatar, insira https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. No campo Descrição, use Add-on Chat app.
   4. Em Funcionalidade, selecione Receber mensagens individuais e Participar de espaços e conversas em grupo.
   5. Em "Configurações de conexão", selecione Projeto do Apps Script.
   6. No campo Deployment ID, cole o ID de implantação do Head que você copiou anteriormente.
   7. Em "Visibilidade", selecione Pessoas e grupos específicos do seu domínio e digite seu e-mail.

4. Clique em Salvar.

O app Chat está pronto para responder a mensagens.

Teste 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:

1. Abra o Google Chat usando a conta do Google Workspace que você informou ao se adicionar como um testador confiável.

   Acessar o Google Chat

2. Clique em Nova conversa.
3. No campo Adicionar uma ou mais pessoas, digite o nome do seu app Chat.

4. Selecione o app Chat nos resultados. Uma mensagem direta é aberta.

   Observação:se o app de chat não aparecer na lista de resultados, verifique se você incluiu sua conta do Google Workspace nas configurações de Visibilidade da página Configuração da API Chat no console do Google Cloud.

5. Na nova mensagem direta com o app, digite Hello e pressione enter.

   O app Chat agradece a adição e repete sua mensagem.

Para adicionar testadores confiáveis e saber mais sobre como testar recursos interativos, consulte Testar recursos interativos para apps do Google Chat.

Resolver problemas

Quando um app do Google Chat ou um card retorna um erro, a interface do Chat mostra uma mensagem informando que "Ocorreu um erro". ou "Não foi possível processar sua solicitação". Às vezes, a interface do Chat não mostra nenhuma mensagem de erro, mas o app ou o card do Chat produz um resultado inesperado. Por exemplo, uma mensagem de card 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 saber como visualizar, depurar e corrigir erros, consulte Resolver e corrigir erros do Google Chat.

Limpar

Para evitar cobranças na sua conta do Google Cloud pelos recursos usados neste tutorial, recomendamos que você exclua o projeto do Cloud.

Cuidado:excluir um projeto tem os seguintes efeitos:

• Tudo no projeto é excluído. Se você tiver usado um projeto atual para seguir este tutorial, a exclusão dele incluirá quaisquer outras ações feitas no projeto.
• Os IDs do projeto personalizados são perdidos. Ao criar o projeto, você pode ter criado um ID do projeto personalizado para ser usado no futuro. Para preservar os URLs que usam o ID do projeto, como um URL em appspot.com, exclua os recursos selecionados dentro do projeto em vez de excluir o projeto inteiro.

Se você planeja conferir vários tutoriais e guias de início rápido, a reutilização de projetos pode evitar que você exceda os limites da cota do projeto.

1. No console do Google Cloud, acesse a página Gerenciar recursos. Clique em Menu > IAM e administrador > Gerenciar recursos.

   Acesse o Resource Manager

2. Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir .
3. Na caixa de diálogo, digite o ID do projeto e clique em Encerrar para excluir o projeto.