Nesta página, explicamos como configurar e responder a comandos rápidos no app Google Chat.
Um comando rápido é uma maneira de os usuários invocarem e interagirem com um
app de chat. Para usar um comando rápido, abra o menu de integração
clicando em Ferramentas do Google Workspace
em um espaço ou
conversa do Chat e selecione um comando de app com um nome que não comece
com um caractere de barra (/). Ao selecionar um comando rápido, o
app Chat é invocado diretamente sem outras entradas
do usuário, permitindo interações rápidas.
Os usuários também podem invocar um app Chat usando um comando de barra. Em comparação com os comandos de barra, os comandos rápidos são formatados com um nome mais amigável ao usuário na interface do Chat, são invocados imediatamente após a seleção e não exigem que o usuário se lembre ou digite o nome do comando de barra.
Configurar um comando rápido na API Google Chat
Para criar um comando rápido ou atualizar comandos de barra para comandos rápidos, especifique informações sobre o comando na configuração do app Chat para a API Google Chat.
Para configurar um comando rápido na API Google Chat, siga estas etapas:
No console do Google Cloud, clique em Menu > APIs e serviços > Ativar APIs e serviços > API Google Chat
Clique em Configuração.
Em Configurações avançadas, acesse Gatilhos e verifique se o campo Comando do app contém um acionador, como um endpoint HTTP ou uma função do Apps Script. Use esse acionador na próxima seção para responder ao comando rápido.
Em Comandos, clique em Adicionar um comando.
Insira um ID, nome, descrição e tipo de comando:
- ID do comando:um número de 1 a 1.000 que o app de chat usa para reconhecer o comando e retornar uma resposta.
- Nome:o nome de exibição do comando. Os nomes podem ter até 50
caracteres e podem incluir caracteres especiais.
- Use palavras ou frases curtas, descritivas e práticas para deixar os comandos claros para o usuário. Por exemplo, use Atualizar contato para um comando que modifique um registro de contato.
- Descrição:o texto que descreve o que o comando faz.
As descrições podem ter até 50 caracteres e incluir caracteres
especiais.
- Mantenha a descrição curta e clara para que os usuários saibam o que esperar ao invocar o comando.
- Informe aos usuários se o app de chat responde a todos no espaço ou de forma privada ao usuário que invoca o comando. Por exemplo, para o comando rápido Sobre, você pode descrever como Saiba mais sobre este app (visível apenas para você).
- Tipo de comando:selecione Comando rápido.
Opcional: se você quiser que o app de chat responda ao comando com uma caixa de diálogo, marque a caixa de seleção Abrir uma caixa de diálogo.
Clique em Salvar.
O comando rápido agora está configurado para o app Chat.
Responder a um comando rápido
Quando os usuários invocam um comando rápido, o app de chat
recebe um objeto de evento que contém informações sobre o comando rápido.
O objeto de evento contém um payload AppCommand
com detalhes sobre o comando invocado (incluindo o ID do comando) para que você
possa retornar uma resposta adequada.
Para responder a um comando rápido, implemente o gatilho Comando do app para que o app de chat possa processar todos os objetos de evento que contêm metadados do comando do app.
O código abaixo mostra um exemplo de um app de chat que
responde ao comando Help. Para responder a comandos rápidos, o
app Chat processa objetos de evento de um acionador de
comando do app. Quando o payload de um objeto de evento contém um ID de comando rápido,
o app Chat retorna a ação DataActions com um
objeto createMessageAction:
Apps Script
// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const HELP_COMMAND_ID = 0;
/**
* Responds to an APP_COMMAND event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onAppCommand(event) {
// Stores the Google Chat app command metadata as a variable.
const appCommandMetadata = event.chat.appCommandPayload.appCommandMetadata;
if (appCommandMetadata.appCommandType == "QUICK_COMMAND") {
// Executes the quick command logic based on its ID.
// Quick command IDs are set in the Google Chat API configuration.
switch (appCommandMetadata.appCommandId) {
case HELP_COMMAND_ID:
return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
text: 'The Avatar app replies to Google Chat messages.'
}}}}};
}
}
}
Para usar este exemplo de código, substitua HELP_COMMAND_ID pelo
ID de comando especificado ao
configurar o comando rápido na API Chat.
Para testar um comando rápido no Chat, abra o menu de integração clicando em
Ferramentas do Google Workspace e selecionando
o comando rápido.