Receber e responder a interações do usuário

Esta página descreve como seu app do Google Chat pode receber e respondem às interações do usuário, também conhecidas como app do Google Chat eventos de interação.

Esta página explica como fazer o seguinte:

• Configurar o app do Chat para receber interação eventos.
• Processe o evento de interação na infraestrutura.
• Se apropriado, responda aos eventos de interação.

Pré-requisitos

Um app do Google Chat com recursos interativos ativados. Para criar um interativo do Chat, conclua um dos seguintes guias de início rápido com base na arquitetura do app que você quer usar:

• Serviço HTTP com o Google Cloud Functions
• Google Apps Script
• Dialogflow CX do Google Cloud
• Google Cloud Pub/Sub

Como os eventos de interação funcionam

Um evento de interação com o app do Google Chat representa qualquer ação realizada por um que o usuário faz para invocar ou interagir com um app do Chat, como como @mencionar um app do Chat ou adicioná-lo a um espaço. Quando os usuários interagem com um app do Chat, O Google Chat envia um evento de interação para o app do Chat. O app do Chat pode usar o evento para processar as e criar uma resposta.

Por exemplo, os apps do Chat usam eventos de interação para realizar qualquer uma das seguinte:

Para cada tipo de interação do usuário, o Google Chat envia um tipo diferente de evento de interação que ajuda o app do Chat a processar cada o tipo de evento. Por exemplo, o Google Chat usa o tipo de evento ADDED_TO_SPACE para qualquer interação em que um usuário adiciona o do app do Chat em um espaço. Assim, O app do Chat pode processar respostas, como postar mensagem de boas-vindas. Para ver todos os eventos de interação compatíveis, consulte o Referência de EventType na documentação do Google.

Receber eventos de interação com o app do Chat

Esta seção descreve como receber e processar eventos de interação para sua App Chat.

Configurar o app do Chat para receber eventos de interação

Nem todos os apps do Chat são interativos. Por exemplo: webhooks de entrada só podem enviar mensagens de saída e não podem responder aos usuários. Se você está criando um modelo interativo do Google Chat, escolha um endpoint que permita Receber, processar e responder a interações com apps de chat eventos. Para saber mais sobre como projetar seu app do Chat, consulte Arquiteturas de implementação de apps do Chat.

Para cada recurso interativo que você quer criar, é necessário atualizar sua configuração na API Chat para que o Google Chat possa enviar eventos de interação relacionados ao app do Chat:

1. No console do Google Cloud, acesse a página da API Chat e clique no Configuração:

   Acessar a página de configuração da API Chat

2. Em Recursos interativos, revise as configurações e atualize com base em: os recursos que você quer criar:

   Campo	Descrição
   Funcionalidade	Obrigatório. Um conjunto de campos que determina como o app do Chat pode interagir com os usuários: Receber mensagens individuais: os usuários podem encontrar e enviar mensagens para o app do Chat no Google Chat. Participar de espaços e conversas em grupo: os usuários podem adicionar o app Chat a espaços e conversas em grupo.
   Configurações de conexão	Obrigatório. O endpoint do app do Chat, que é um destes: URL do app: um endpoint HTTPS que hospeda a implementação do app do Chat. Projeto do Apps Script: um ID de implantação para um projeto do Apps Script que implementa um app do Chat. Nome do tópico do Cloud Pub/Sub: um tópico do Pub/Sub que o app do Chat assina como um endpoint. Dialogflow: registra o app do Chat com uma integração com o Dialogflow. Para mais informações, consulte Criar um app do Dialogflow para o Google Chat que entenda linguagem natural.
   Comandos de barra	Opcional. Comandos que podem ser exibidos aos usuários no Google Chat. Permite que os usuários confiram as ações principais do seu app do Chat no Google Chat e escolham uma ação específica. Para mais informações, consulte Responder a comandos de barra como um app do Chat.
   Visualizações de links	Opcional. Padrões de URL que o app do Chat reconhece e disponibiliza mais conteúdo para quando os usuários enviam links. Para mais informações, consulte Visualizar links.
   Visibilidade	Opcional. Até cinco pessoas ou um ou mais Grupos do Google podem ver e instalar o app do Chat. Use esse campo para testar o app do Chat ou compartilhar com sua equipe. Para mais informações, consulte Testar recursos interativos.

3. Clique em Salvar. Quando você salvar o app do Chat configuração, o app do Chat fica disponível para usuários específicos na sua organização do Google Workspace.

Seu app do Chat agora está configurado para receber interações eventos do Google Chat.

Processar novas tentativas de chamadas HTTP para o serviço

Se uma solicitação HTTPS para seu serviço falhar (como tempo limite, tempo limite, falha ou código de status HTTPS que não seja 2xx), o Google Chat poderá tentar entregar novamente alguns vezes em poucos minutos, mas isso não é garantido. Como resultado, uma O app de chat pode receber a mesma mensagem algumas vezes em determinadas situações. Se a solicitação é concluída com êxito, mas retorna um erro payload da mensagem, o Google Chat não vai repetir a solicitação.

Processar ou responder a eventos de interação

Esta seção explica como os apps do Google Chat podem processar e responder a eventos de interação.

Depois que o app do Chat receber um evento de interação do Google Chat, eles podem responder de várias formas. Em muitos casos, as interações Os apps de chat respondem ao usuário com uma mensagem. O app Google Chat também pode pesquisar algumas informações origem, registrar as informações do evento de interação ou qualquer outra coisa. Esse comportamento de processamento é essencialmente o que define app Google Chat.

Para responder de forma síncrona, um app do Chat precisa responder em 30 segundos, e a resposta deve ser postada no espaço ocorreu uma interação. Caso contrário, o app do Chat pode responder de forma assíncrona.

Para cada evento de interação, os apps do Chat recebem um corpo da solicitação. que é o payload JSON que representa o evento. Você pode usar o informações para processar uma resposta. Para exemplos de payloads de evento, consulte Tipos de eventos de interação com o app do Chat

O diagrama a seguir demonstra como O app Google Chat geralmente processa ou responde a diferentes tipos de eventos de interação:

Resposta em tempo real

Os eventos de interação permitem que os apps do Chat respondam em tempo real. de forma síncrona. As respostas síncronas não exigem autenticação.

Responder à participação em um espaço

Neste exemplo, o app do Chat cria e envia uma mensagem de texto sempre que ela for adicionada a um espaço. Para saber mais sobre as práticas recomendadas de integração de usuários, consulte Apresente os usuários ao seu app do Chat.

Para enviar uma mensagem de texto quando um usuário adicionar seu app do Chat: a um espaço, o app do Chat responde a um ADDED_TO_SPACE. evento de interação. Para responder a ADDED_TO_SPACE eventos de interação com uma mensagem de texto, use este código:

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} req The event object from Chat API.
 * @param {Object} res The response object from the Chat app. An onboarding message that
 * introduces the app and helps people get started with it.
 */
exports.onMessage = function onMessage(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    res.send(
      'Hello! This function is meant to be used in a Google Chat space.');
  }

  // Send an onboarding message when added to a Chat space
  if (req.body.type === 'ADDED_TO_SPACE') {
    res.json({
      'text': 'Hi, Cymbal at your service. I help you manage your calendar
      from Google Chat. Take a look at your schedule today by typing
      `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To
      learn what else I can do, type `/help`.'
    });
  }
};

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app. An onboarding message that
 * introduces the app and helps people get started with it.
 */
function onAddToSpace(event) {

  return {
    'text': 'Hi, Cymbal at your service. I help you manage your calendar
    from Google Chat. Take a look at your schedule today by typing
    `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn
    what else I can do, type `/help`.'
  }
}

O exemplo de código retorna a seguinte mensagem de texto:

Outros exemplos de resposta a interações

Para criar respostas síncronas a eventos de interação, consulte os seguintes guias:

• Configurar comandos de barra
• Abrir caixas de diálogo interativas
• Visualizar vinculações
• Processar informações enviadas pelos usuários

Responder de forma assíncrona

Às vezes, os apps do Chat precisam responder a um evento de interação após esse período segundos ou realizar tarefas fora do espaço em que o evento de interação foi gerada. Por exemplo, um app do Chat pode precisar responder ao usuário depois de concluir uma tarefa de longa duração. Nesse caso, Os apps do Chat podem responder de forma assíncrona chamando a API Google Chat.

Para criar uma mensagem usando a API Chat, consulte Crie uma mensagem. Para guias sobre como usar outros métodos da API Chat, consulte a Visão geral da API Chat.

Temas relacionados

• Enviar uma mensagem
• Abrir caixas de diálogo interativas
• Visualizar vinculações
• Ler a entrada de dados de formulário pelos usuários em cards
• Responder a comandos de barra
• Criar a página inicial de um app do Chat
• Verificar solicitações do Chat
• Testar recursos interativos para apps do Google Chat