Guia de início rápido do app Google Apps Script do Chat

Crie um app do Google Chat para enviar mensagens diretamente e que responda ecoando suas mensagens.

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

No diagrama anterior, um usuário interagindo com um app do Apps Script Chat 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 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.
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

• Uma conta do Google Workspace com acesso ao Chat.
• um projeto do Google Cloud;

Configure seu ambiente

Abrir o projeto do Cloud no console do Google Cloud

Se ele ainda não estiver aberto, abra o projeto do Cloud que você pretende usar para esta amostra:

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. Se preferir, 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 permissão OAuth do app define o que é exibido aos usuários e revisores e registra seu app para que você possa publicá-lo mais tarde.

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. Em Tipo de usuário, selecione Interno e clique em Criar.
3. Preencha o formulário de registro do app e clique em Save and continue.

4. Por enquanto, ignore a adição de escopos e clique em Salvar e continuar. No futuro, ao criar um aplicativo para uso fora da sua organização do Google Workspace, você precisará alterar o Tipo de usuário para Externo e adicionar os escopos de autorização exigidos pelo aplicativo.

5. Analise o resumo do registro do app. Para fazer mudanças, clique em Editar. Se o registro do app estiver OK, 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 de 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.

Copie o número do projeto do Cloud

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

   Acessar "IAM e configurações de 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 no 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 em funcionamento que pode ser testado (conforme descrito nas etapas a seguir) e personalizar para atender aos seus requisitos.

Verifique se você fez login na 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 este projeto do Apps Script para usá-lo na próxima etapa.

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

1. No projeto do Apps Script no app 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.

Publicar o app do Chat

Publique o app do Chat no console do Google Cloud.

1. No Console do Google Cloud, pesquise por 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, insira 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.
   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 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ê forneceu ao se adicionar como trusted tester.

   Acessar o Google Chat

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

4. Selecione seu 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 do Google Cloud.

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

   O app do Chat agradece a informação 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 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 exibe nenhuma mensagem de erro, mas o app ou card produz um resultado inesperado. Por exemplo, uma mensagem de card pode não aparecer.

Embora uma mensagem de erro possa não ser exibida na interface do Chat, mensagens de erro descritivas e dados de registro estão disponíveis para ajudar você a corrigir erros quando a geração de registros de erros para apps do Chat está ativada. Se precisar de 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 excluir 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 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 do Google Cloud, acesse a página Gerenciar recursos. Clique em Menu > IAM e administrador > Gerenciar recursos.

   Acessar 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 do card oferecem suporte a um layout definido, elementos de interface interativos, como botões, e rich media, como imagens. Use mensagens no card para apresentar informações detalhadas, reunir informações dos usuários e orientá-los sobre a próxima etapa.
• Comandos de barra de suporte: os comandos de barra permitem registrar e anunciar comandos específicos que os usuários podem dar ao seu app digitando um comando que comece com uma barra (/), como /help.
• Abrir caixas de diálogo: são interfaces baseadas em cards em janelas que o app pode abrir para interagir com um usuário. Vários cards podem ser agrupados em sequência, o que ajuda os usuários a concluir processos de várias etapas, como preencher dados de formulários.
• Codelab:tudo pronto para criar um app do Chat mais avançado? Confira o feedback App Chat do codelab Criar apps para o Google Chat com o Gemini.