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

Crie um app do Google Chat para enviar mensagens diretamente responde ecoando suas mensagens.

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

Arquitetura de um app do Chat implementado com o Apps Script.

No diagrama anterior, um usuário interagindo com um Apps Script O app do Chat tem o seguinte fluxo de informações:

  1. Um usuário envia uma mensagem para um app do Chat em um mensagem direta ou em um espaço do Chat.
  2. A lógica do app do Chat implementada na O Apps Script, localizado no Google Cloud, recebe e processa a mensagem.
  3. Outra opção é a integração da lógica do app do Chat serviços do Google Workspace, como Agenda ou Planilhas ou outros Serviços do Google, como o Google Maps ou o YouTube.
  4. A lógica do app de chat envia uma resposta de volta ao Serviço de 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

Configurar o ambiente

Abrir o projeto do Cloud no console do Google Cloud

Abra o projeto do Cloud que você pretende usar, caso ele ainda não esteja aberto. 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

Todos os apps que usam o OAuth 2.0 exigem uma configuração de tela de consentimento. Como configurar a tela de permissão OAuth do seu app define o que é exibido aos usuários e ao app revisores e registra seu app para que possa publicá-lo mais tarde.

  1. No console do Google Cloud, acesse o 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, quando você criar um aplicativo para usar fora de sua organização do Google Workspace, mude o Tipo de usuário para Externo. Em seguida, adicionar os escopos de autorização exigidos pelo app.

  5. Analise o resumo do registro do app. Para fazer alterações, clique em Editar. Se o app estiver tudo certo, clique em Voltar para o painel.

Configurar o script

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

Criar o script com base no modelo

  1. Acesse o Página de 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 o menu > IAM e Administrador > Configurações.

    Acesse "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 O ícone das 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 testar (conforme descrito na etapas a seguir) e personalize de acordo com seus requisitos.

Confira se você fez login na Conta do Google correta ao abrir o Modelo do Apps Script. A conta atual às vezes 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. Assim, poderá 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. Na Console do Google Cloud 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 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.
    6. No campo Deployment ID, cole o ID de implantação principal que você copiado anteriormente.
    7. Em "Visibilidade", selecione Pessoas e grupos específicos na sua 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 do app do Chat e enviar uma mensagem:

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

    Acessar o Google Chat

  2. Clique em Nova conversa.
  3. No campo Adicionar uma ou mais pessoas, digite o nome da sua App Chat.
  4. Selecione seu app do Chat nos resultados. Um direto a mensagem será aberta.

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

    O app do Chat agradece por você o adicionar e ecoa sua mensagem.

Para adicionar trusted testers e saber mais sobre como testar recursos interativos, consulte Teste os recursos interativos do Apps do Google Chat

Resolver problemas

Quando um app ou card retornar um erro, o 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 exibe nenhuma mensagem de erro, mas o app do Chat ou produz um resultado inesperado; por exemplo, uma mensagem de cartão 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 os erros quando a geração de registros de erros nos apps do Chat está ativada. Para receber ajuda com a visualização, depurar e corrigir erros, consulte Resolver problemas e corrigir erros do Google Chat.

Limpar

Para evitar cobranças na sua conta do Google Cloud pelo recursos usados neste tutorial, recomendamos que você exclua os do Google Cloud.

  1. No console do Google Cloud, acesse a página Gerenciar recursos. Clique em Cardápio > 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 o projeto.

Próximas etapas

  • Criar cards interativos: card as mensagens oferecem suporte a um layout definido, elementos interativos da IU, como botões, e rich media, como imagens. Use mensagens no card para apresentar informações detalhadas, coletar informações dos usuários e orientá-los sobre a próxima etapa.
  • Comandos de barra de suporte: os comandos de barra permitem Você registra e anuncia 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: as caixas são em janelas e baseadas em cards. interfaces que o app pode abrir para interagir com um usuário. Vários cards podem ser agrupadas sequencialmente, o que ajuda os usuários a concluir várias etapas como o preenchimento de dados de formulários.
  • Codelab: pronto para criar um ambiente App do Chat? Ver o feedback App do Chat do codelab Criar apps para o Google Chat com o Gemini.