Criar um app do Google Chat com o Google Apps Script

Nesta página, explicamos como criar um app do Google Chat usando o Google Apps Script. O app do Chat permite que você envie mensagens diretas e 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. Como opção, a lógica do app do Chat pode ser integrada aos serviços do Google Workspace, como o Agenda ou as Planilhas, ou a 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 ao serviço do app do Chat no Chat.
5. A resposta é enviada ao usuário.

Objetivos

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

Pré-requisitos

• Uma conta Business ou Enterprise do Google Workspace 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 na nuvem no console do Google Cloud.

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

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

   Selecione um projeto na nuvem

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 para ele.

Ativar a API Chat

Antes de usar as APIs do Google, é preciso 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. A configuração da tela de permissão OAuth do app define o que é mostrado aos usuários e revisores do app e registra o app para que você possa publicá-lo mais tarde.

1. No console de APIs do Google, acesse Menu > Plataforma do Google Auth > Branding.

   Acessar Branding

2. Se você já configurou a plataforma de autenticação do Google, pode definir as seguintes configurações da tela de permissão OAuth em Branding, Público e Acesso a dados. Se aparecer a mensagem A plataforma de autenticação do Google ainda não está configurada, clique em Começar:
1. Em Informações do app, em 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 Dados de contato, insira um endereço de e-mail para receber notificações sobre mudanças no 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 essa etapa. No futuro, ao 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 o consentimento do OAuth.

Configurar o script

Para configurar o script, use o modelo de app do Chat na página Primeiras etapas do Apps Script.

Criar o projeto do Apps Script

1. Na página Primeiros passos do Apps Script, acesse Inicializadores de complementos do Google Workspace e clique no modelo App do Chat:

   Abra o modelo do app Chat

2. No novo projeto do Apps Script que será aberto, dê um nome a ele:

   1. Clique em Projeto sem título.

   2. Em Título do projeto, digite Quickstart app.

   3. Clique em Renomear.

No futuro, se você quiser usar determinadas APIs do Google ou publicar seu app, será necessário associar o 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 de teste

Você precisa de um ID de implantação para este projeto do Apps Script para usá-lo na próxima etapa.

Para encontrar 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 da implantação principal para usar em uma etapa posterior e clique em Concluído.

Configurar o app do Chat

Siga estas etapas para configurar o app Google Chat:

1. No Console de APIs, pesquise Google Chat API e clique em API Google Chat.
2. Clique em Gerenciar.

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

   1. No campo Nome do app, digite Quickstart app.
   2. No campo URL do avatar, digite https://developers.google.com/workspace/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 Projeto do Apps Script.
   6. No campo ID de implantação, cole o ID de implantação principal 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 do Chat está pronto para responder às mensagens.

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:

1. Abra o Google Chat usando a conta do Google Workspace que você informou quando se adicionou como trusted tester.

   Acessar o Google Chat

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

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

   Observação:se o app do 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 de APIs do Google.

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

   O app do Chat agradece por você ter adicionado ele e repete sua mensagem.

Para adicionar trusted testers 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 card retorna um erro, 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 mostra nenhuma mensagem de erro, mas o app do Chat ou card 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 você a corrigir erros quando o registro de erros para apps do Chat está ativado. Para receber ajuda para visualizar, depurar e corrigir erros, consulte Resolver problemas 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 na nuvem.

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 ver 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 de APIs do Google, 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

• Crie cards interativos: as mensagens de card oferecem suporte a um layout definido, elementos de interface interativos, como botões, e mídia avançada, como imagens. Use mensagens de card para apresentar informações detalhadas, coletar informações dos usuários e orientá-los sobre as próximas etapas.
• Responder a comandos: os comandos ajudam os usuários a descobrir e usar os principais recursos do app do Chat.
• Iniciar caixas de diálogo: as caixas de diálogo são interfaces em janela baseadas em cards que o 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 com várias etapas, como o preenchimento de dados de formulários.
• Codelab:tudo pronto para criar um app do Chat mais avançado? Confira o app de chat de feedback do codelab Criar apps para o Google Chat com o Gemini.

Apps do Chat que não são complementos: criar um app do Google Chat com o Google Apps Script

Para criar um app do Chat que não seja um complemento do Google Workspace com o Apps Script, siga estas etapas para criar o script com base no modelo e configurar o app do Chat que não é um complemento.

Criar o script com base no modelo

1. Abra o modelo do app Chat

2. Clique em Projeto sem título, digite Quickstart app e clique em Renomear.

   No futuro, se você quiser usar determinadas APIs do Google ou publicar seu app, será necessário associar o 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.

3. No projeto do Apps Script do app do Chat, clique em Implantar > Testar implantações.

4. Copie o ID da implantação principal para usar na próxima etapa e clique em Concluído.

Configurar o app do Chat que não é um complemento

Configure o app do Chat que não é um complemento no Console de APIs:

1. No Console de APIs, pesquise Google Chat API e clique em API Google Chat.
2. Clique em Gerenciar.

3. Clique em Configuração e configure o app do Chat que não é um complemento:

   1. Desmarque a opção Criar este app do Chat como um complemento do Google Workspace. Uma caixa de diálogo será aberta pedindo para você confirmar. Na caixa de diálogo, clique em Desativar.
   2. No campo Nome do app, digite Quickstart app.
   3. No campo URL do avatar, digite https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
   4. No campo Descrição, use Quickstart app.
   5. Em Funcionalidade, selecione Participar de espaços e conversas em grupo.
   6. Em Configurações de conexão, selecione Apps Script.
   7. No campo ID de implantação, cole o ID de implantação principal que você copiou anteriormente.
   8. Em Visibilidade, selecione Pessoas e grupos específicos do seu domínio e digite seu e-mail.

4. Clique em Salvar.