Criar um app do Google Chat com o Google Apps Script

Crie um app do Google Chat para o qual você possa enviar mensagens diretamente e que responda ecoando suas mensagens.

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

Arquitetura de um app de chat implementado com o Apps Script.

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 do Chat implementada no Apps Script, localizada no Google Cloud, recebe e processa a mensagem.
  3. Opcionalmente, a lógica do app do Chat pode se integrar aos serviços do Google Workspace, como Agenda ou Planilhas, ou outros Serviços do Google, como Google Maps ou YouTube.
  4. A lógica do app do Chat envia uma resposta de volta ao serviço do app do Chat no Chat.
  5. A resposta é entregue ao usuário.

Objetivos

  • Configurar o ambiente.
  • Configure o script.
  • Publique o app do Chat.
  • Teste o app do Chat.

Pré-requisitos

configure seu ambiente

Abrir 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

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

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

    Acessar a tela de permissão OAuth

  2. Selecione o tipo de usuário para seu app e clique em Criar.
  3. Preencha o formulário de registro do app e clique em Salvar e continuar.
  4. Por enquanto, pule a adição de escopos e clique em Salvar e continuar. No futuro, quando você criar um app para uso fora da organização do Google Workspace, será necessário adicionar e verificar os escopos de autorização exigidos pelo app.

  5. Se você selecionou Externo como tipo de usuário, adicione usuários de teste:
    1. Em Usuários de teste, clique em Adicionar usuários.
    2. Insira seu endereço de e-mail e outros usuários de teste autorizados. Em seguida, clique em Salvar e continuar.
  6. Leia o resumo do registro do seu app. Para fazer mudanças, clique em Editar. Se o registro do app estiver certo, clique em Voltar para o painel.

Configurar o script

Para configurar o script, use um modelo e defina seu projeto do Cloud no Apps Script.

Criar o script com base no modelo

  1. Acesse a página Primeiros passos do Apps Script.
  2. Clique no modelo App do Chat. Talvez seja necessário rolar para baixo para ver esse modelo.
  3. Clique em Projeto sem título, digite Quickstart app e clique em Renomear.

Copiar o número do projeto do Cloud

  1. Acesse seu projeto do Cloud no console do Google Cloud.
  2. Clique em Configurações e utilitários > Configurações do projeto.
  3. Copie o Número do projeto.

Definir o projeto do Cloud do projeto do Apps Script

  1. No projeto do Apps Script do app do Chat, clique em Configurações do projeto Ícone para 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 que pode ser testado, conforme descrito nas etapas a seguir, e depois personalizado para atender aos seus requisitos.

Verifique se você fez login com a Conta do Google correta ao abrir o modelo do Apps Script. Às vezes, a conta atual pode mudar para sua conta 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 poder usá-lo na próxima etapa.

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

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

Publique o app do Chat

Publique o app do Chat no console do Google Cloud.

  1. No console do Google Cloud, pesquise Google Chat API e clique em API Google Chat.
  2. Selecione Gerenciar.
  3. Clique em Configuração e configure o app do Chat:

    1. No campo Nome do app, insira Quickstart app.
    2. No campo URL do avatar, digite https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. No campo Descrição, use Quickstart 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 e cole o ID de implantação no campo.
    6. Em "Permissões", selecione Pessoas e grupos específicos do seu domínio e digite seu e-mail.
  4. Clique em Save e atualize a página.

  5. Na página de configuração, em Status do aplicativo, defina o status como Ativo - disponível para os usuários.

  6. Clique em Salvar.

O app do Chat está pronto para responder às mensagens.

Teste o app do Chat

  1. Abra o Chat.
  2. Envie uma nova mensagem direta para o app clicando em Iniciar um chat > Encontrar apps.
  3. Na página "Encontrar apps", pesquise Quickstart App.
  4. Ao lado de App de início rápido, clique em Chat.
  5. Na nova mensagem direta com o app, digite Hello e pressione enter.

O app agradece por adicioná-lo e repete sua mensagem.

Próximas etapas

  • Criar cards interativos: as mensagens de cards são compatíveis com um layout definido, elementos interativos da IU, como botões, e rich media, como imagens. Use as mensagens do card para apresentar informações detalhadas, reunir informações dos usuários e orientá-los a seguir para a próxima etapa.
  • Suporte a comandos de barra: os comandos de barra permitem registrar e anunciar comandos específicos que os usuários podem usar no app digitando um comando que comece com uma barra (/), como /help.
  • Caixas de diálogo de inicialização: são interfaces em janelas baseadas em cards que o app pode abrir para interagir com um usuário. Vários cartões podem ser agrupados sequencialmente, o que ajuda os usuários a concluir processos de várias etapas, como o preenchimento de dados de formulários.