Criar um app do Google Chat com o Google Apps Script

Esta página explica como criar um complemento do Google Workspace que funciona no Google Chat usando o Google Apps Script.

Observação:no Google Chat, os complementos aparecem para os usuários como apps do Google Chat. Também é possível criar seu app do Chat usando eventos de interação da API Google Chat. Para saber mais, consulte a visão geral de como estender o Google Chat.

O app do Chat permite enviar mensagens diretamente e responde repetindo 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 do Chat pode ser integrada aos serviços do Google Workspace, como Agenda ou 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 é entregue ao usuário.

Objetivos

• Prepare o ambiente.
• Configure o script.
• Configure o app do Chat.
• Teste o app do 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

Abrir o 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.

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

1. No console de APIs do Google, acesse Menu > Plataforma de autenticação do Google > Branding.

   Acessar Branding

2. Se você já tiver configurado a plataforma de autenticação do Google, poderá 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 dizendo 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 de suporte para que os usuários possam entrar em contato com você se tiverem dúvidas sobre o consentimento.
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, 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.
9. Clique em Continuar.
10. Clique em Criar.
3. Por enquanto, você pode pular a adição de escopos. No futuro, ao criar um app para uso fora da sua organização do Google Workspace, será necessário mudar 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 guide.

Configurar o script

Para configurar o script, use o modelo de app do Chat na página Introdução do Apps Script.

Criar o projeto do Apps Script

1. Na página Introdução do Apps Script, acesse Iniciadores de complementos do Google Workspace e clique no modelo App do Chat:

   Abrir o modelo de app do Chat

2. No novo projeto do Apps Script que é aberto, nomeie o projeto:

   1. Clique em Projeto sem título.

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

   3. Clique em Renomear.

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 Projetos do Google Cloud.

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 receber o ID de 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 uso 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, insira Add-on Chat app.
   2. No campo URL do avatar, insira https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png.
   3. No campo Descrição, insira Add-on Chat 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 insira seu e-mail.

4. Clique em Salvar.

O app do 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 o app do Chat e envie uma mensagem:

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

   Acessar o Google Chat

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

4. Selecione o app do Chat nos resultados. Uma mensagem direta será 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 adicioná-lo 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 ou card do Google Chat retorna um erro, a interface do Chat mostra uma mensagem dizendo "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 ou card do Chat produz um resultado inesperado. Por exemplo, uma mensagem de card pode não aparecer.

Embora uma mensagem de erro não seja exibida 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 do Chat está ativado. Para receber ajuda para 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 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 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 desligar para excluir o projeto.