Criar um app do Google Chat com o Google Apps Script

Crie um app do Google Chat para o qual você pode mandar mensagens diretas, e que responde 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 do Chat implementada no Apps Script, que reside no Google Cloud, recebe e processa a mensagem.
3. Opcionalmente, a lógica do app Chat pode ser integrada aos serviços do Google Workspace, como Agenda ou Planilhas, ou a outros Serviços do Google, como Maps ou YouTube.
4. A lógica do app Chat envia uma resposta de volta para o serviço do app Chat no Chat.
5. A resposta é enviada ao usuário.

Objetivos

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

Pré-requisitos

• Uma conta do Google Workspace Business ou Enterprise 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 ele ainda não estiver aberto, abra o projeto do Google Cloud que você pretende usar para esta amostra:

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

   Selecione 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, é necessário 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 permissão. Configurar a tela de consentimento do OAuth do app define o que é mostrado aos usuários e revisores de apps, além de registrar o app para que você possa publicá-lo mais tarde.

1. No console do Google Cloud, acesse Menu > > Branding.

   Acessar Branding

2. Se você já tiver configurado o , poderá definir as seguintes configurações da tela de permissão do OAuth em Branding, Público-alvo e Acesso a dados. Se aparecer uma mensagem informando que ainda não foi configurado, clique em Começar:
1. Em Informações do app, no campo Nome do app, insira um nome para o app.
2. Em E-mail para suporte do usuário, escolha um endereço de e-mail para que os usuários entrem em contato com você se tiverem dúvidas sobre o consentimento deles.
3. Clique em Próxima.
4. Em Público-alvo, selecione Interno.
5. Clique em Próxima.
6. Em Informações de contato, insira um Endereço de e-mail para receber notificações sobre mudanças no seu projeto.
7. Clique em Próxima.
8. Em Concluir, leia 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.
9. Clique em Continuar.
10. Clique em Criar.
3. Por enquanto, você pode pular a adição de escopos. No futuro, quando você criar um app para uso fora da sua organização do Google Workspace, mude o Tipo de usuário para Externo. Em seguida, adicione os escopos de autorização necessários para o app. Para saber mais, consulte o guia completo Configurar a permissão OAuth.

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 Como começar a usar o Apps Script (link em inglês).
2. Clique no modelo App de chat na parte de cima da página.
3. Clique em Projeto sem título, digite Quickstart app e clique em Renomear.

Copie o número do projeto do Google Cloud.

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

   Acessar as configurações do IAM e do administrador

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

Definir o projeto do Cloud do projeto 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 etapas a seguir) e personalizar para atender aos seus requisitos.

Confira 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 a conta padrão sem que você perceba.

Criar uma implantação de teste

Você precisa de um ID de implantação para esse 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 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.

Publicar o app do Chat

Publique o app Chat no console.

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 Quickstart app.
   2. No campo URL do avatar, insira https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. No campo Descrição, use Quickstart app.
   4. Em Funcionalidade, selecione Participar de espaços e conversas em grupo.
   5. Em "Configurações de conexão", selecione Apps Script.
   6. No campo ID da implantação, cole o ID da implantação principal que você copiou antes.
   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 o app do Chat, abra um espaço de mensagem direta com ele e envie uma mensagem:

1. Abra o Google Chat usando a conta do Google Workspace que você informou ao se tornar um testador de confiança.

   Acessar o Google Chat

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

4. Selecione seu app de 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 por ter sido adicionado e repete sua mensagem.

Para adicionar testadores de confiança 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 a mensagem "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 card do Chat produz um resultado inesperado. Por exemplo, uma mensagem do card pode não aparecer.

Embora uma mensagem de erro não apareça na interface do Chat, mensagens de erro descritivas e dados de registro estão disponíveis para ajudar você a corrigir erros quando o registro de erros para apps do Chat está ativado. Para ajuda com a visualização, depuração e correção de 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 todo o projeto.

Se você planeja explorar 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 excluí-lo.

Próximas etapas

• Criar cards interativos: as mensagens de card aceitam um layout definido, elementos de interface interativos, como botões, e mídia avançada, como imagens. Use mensagens em card para apresentar informações detalhadas, coletar informações dos usuários e orientá-los para a próxima etapa.
• Responder a comandos: os comandos ajudam os usuários a descobrir e usar os principais recursos do app do Chat.
• Caixas de diálogo de inicialização: são interfaces baseadas em cards e janelas que seu app pode abrir para interagir com um usuário. Vários cards podem ser encadeados sequencialmente, o que ajuda os usuários a concluir processos de várias etapas, como preencher dados de formulário.
• Codelab:tudo pronto para criar um app de chat mais avançado? Confira o feedback App de chat do codelab Crie apps para o Google Chat com o Gemini.