En esta página, se explica cómo configurar y responder comandos rápidos en la app de Google Chat.
Un comando rápido es una forma en que los usuarios pueden invocar e interactuar con una app de Chat. Para usar un comando rápido, abre el menú de integración haciendo clic en Herramientas de Google Workspace en un espacio o una conversación de Chat y, luego, selecciona un comando de app con un nombre que no comience con una barra (/). Cuando seleccionas un comando rápido, la app de Chat se invoca directamente sin más entradas del usuario, lo que permite interacciones rápidas.
Los usuarios también pueden invocar una app de Chat a través de un comando de barra. En comparación con los comandos de barra, los comandos rápidos tienen un formato con un nombre más fácil de usar en la IU de Chat, se invocan inmediatamente después de la selección y no requieren que el usuario recuerde o escriba el nombre del comando de barra.
Configura un comando rápido en la API de Google Chat
Para crear un comando rápido o actualizar los comandos de barra existentes a comandos rápidos, debes especificar información sobre el comando en la configuración de la app de Chat para la API de Google Chat.
Para configurar un comando rápido en la API de Google Chat, completa los siguientes pasos:
En la consola de Google Cloud, haz clic en Menú > APIs y servicios > APIs y servicios habilitados > API de Google Chat
Haz clic en Configuración.
En Configuración avanzada, ve a Activadores y verifica que el campo App command contenga un activador, como un extremo HTTP o una función de Apps Script. Debes usar este activador en la siguiente sección para responder al comando rápido.
En Comandos, haz clic en Agregar un comando.
Ingresa un ID, un nombre, una descripción y un tipo de comando para el comando:
- ID de comando: Es un número de 1 a 1,000 que usa tu app de Chat para reconocer el comando y mostrar una respuesta.
- Nombre: Es el nombre visible del comando. Los nombres pueden tener hasta 50 caracteres y pueden incluir caracteres especiales.
- Usa palabras o frases cortas, descriptivas y prácticas para que los comandos sean claros para el usuario. Por ejemplo, usa Update contact para un comando que modifique un registro de contacto.
- Descripción: Es el texto que describe lo que hace el comando.
Las descripciones pueden tener hasta 50 caracteres y pueden incluir caracteres especiales.
- Mantén la descripción breve y clara para que los usuarios sepan qué esperar cuando invoquen el comando.
- Informa a los usuarios si la app de Chat responde a todos los usuarios del espacio o de forma privada al usuario que invoca el comando. Por ejemplo, para el comando rápido Acerca de, puedes describirlo como Más información sobre esta app (solo visible para ti).
- Tipo de comando: Selecciona Comando rápido.
Opcional: Si quieres que tu app de chat responda al comando con un diálogo, selecciona la casilla de verificación Abrir un diálogo.
Haz clic en Guardar.
El comando rápido ya está configurado para la app de Chat.
Cómo responder un comando rápido
Cuando los usuarios invocan un comando rápido, tu app de Chat recibe un objeto de evento que contiene información sobre el comando.
El objeto del evento contiene una carga útil AppCommand con detalles sobre el comando invocado (incluido el ID del comando) para que puedas mostrar una respuesta adecuada.
Para responder a un comando rápido, debes implementar el activador de comando de la app para que tu app de Chat pueda controlar cualquier objeto de evento que contenga metadatos de comandos de la app.
En el siguiente código, se muestra un ejemplo de una app de chat que responde al comando Help. Para responder a los comandos rápidos, la app de Chat controla los objetos de eventos de un activador de comando de app. Cuando la carga útil de un objeto de evento contiene un ID de comando rápido, la app de Chat muestra la acción DataActions con un 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 esta muestra de código, reemplaza HELP_COMMAND_ID por el ID de comando que especificaste cuando configuraste el comando rápido en la API de Chat.
Para probar un comando rápido en Chat, abre el menú de integración haciendo clic en Herramientas de Google Workspace y, luego, selecciona tu comando rápido.