Questa pagina spiega come configurare e rispondere ai comandi rapidi per l'app Google Chat.
Un comando rapido è un modo per invocare e interagire con un'app Chat. Per utilizzare un comando rapido, apri il menu di integrazione facendo clic su Strumenti Google Workspace in uno spazio o in una conversazione di Chat e poi seleziona un comando dell'app con un nome che non inizia con una barra (/). Se selezioni un comando rapido, l'app Chat viene invocata direttamente senza ulteriori input da parte dell'utente, consentendo interazioni rapide.
Gli utenti possono anche richiamare un'app di Chat tramite un comando slash. I comandi rapidi sono formattati con un nome più intuitivo nell'interfaccia utente di Chat, vengono richiamati immediatamente al momento della selezione e non richiedono all'utente di ricordare o digitare il nome del comando slash.
Configurare un comando rapido nell'API Google Chat
Per creare un comando rapido o aggiornare i comandi slash esistenti in comandi rapidi, devi specificare le informazioni sul comando nella configurazione dell'app Chat per l'API Google Chat.
Per configurare un comando rapido nell'API Google Chat, completa i seguenti passaggi:
Nella console Google Cloud, fai clic su Menu > API e servizi > API e servizi abilitati > API Google Chat
Fai clic su Configurazione.
In Impostazioni avanzate, vai a Trigger e controlla che il campo Comando app contenga un trigger, ad esempio un endpoint HTTP o una funzione di Apps Script. Devi utilizzare questo trigger nella sezione seguente per rispondere al comando rapido.
In Comandi, fai clic su Aggiungi un comando.
Inserisci un ID comando, un nome, una descrizione e un tipo di comando per il comando:
- ID comando:un numero compreso tra 1 e 1000 utilizzato dalla tua app Chat per riconoscere il comando e restituire una risposta.
- Nome:il nome visualizzato del comando. I nomi possono contenere fino a 50 caratteri e possono includere caratteri speciali.
- Utilizza parole o frasi brevi, descrittive e strategiche per rendere chiari i comandi per l'utente. Ad esempio, utilizza Aggiorna contatto per un comando che modifica un record del contatto.
- Descrizione:il testo che descrive cosa fa il comando.
Le descrizioni possono contenere fino a 50 caratteri e possono includere caratteri speciali.
- Mantieni la descrizione breve e chiara in modo che gli utenti sappiano cosa aspettarsi quando richiamano il comando.
- Comunica agli utenti se l'app Chat risponde a tutti gli utenti dello spazio o in privato all'utente che richiama il comando. Ad esempio, per il comando rapido Informazioni, potresti descriverlo come Scopri di più su questa app (visibile solo a te).
- Tipo di comando:seleziona Comando rapido.
(Facoltativo) Se vuoi che l'app Chat risponda al comando con una finestra di dialogo, seleziona la casella di controllo Apri una finestra di dialogo.
Fai clic su Salva.
Il comando rapido è ora configurato per l'app Chat.
Rispondere a un comando rapido
Quando gli utenti richiamano un comando rapido, l'app Chat
riceve un oggetto evento contenente informazioni sul comando rapido.
L'oggetto evento contiene un payload AppCommand con i dettagli del comando invocato (incluso l'ID comando), in modo da poter restituire una risposta appropriata.
Per rispondere a un comando rapido, devi implementare l'attivatore comando app in modo che la tua app Chat possa gestire tutti gli oggetti evento contenenti metadati dei comandi app.
Il seguente codice mostra un esempio di app Chat che risponde al comando Help. Per rispondere ai comandi rapidi, l'app Chat gestisce gli oggetti evento da un attivatore Comando app. Quando il payload di un oggetto evento contiene un ID comando rapido,
l'app Chat restituisce l'azione DataActions con un
createMessageAction oggetto:
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.'
}}}}};
}
}
}
Per utilizzare questo esempio di codice, sostituisci HELP_COMMAND_ID con l'ID comando specificato quando hai configurato il comando rapido nell'API Chat.
Per testare un comando rapido in Chat, apri il menu di integrazione facendo clic su Strumenti Google Workspace e poi selezionando il comando rapido.