Cette page explique comment configurer et répondre aux commandes rapides de votre application Google Chat.
Une commande rapide permet aux utilisateurs d'appeler et d'interagir avec une application Chat. Pour utiliser une commande rapide, ouvrez le menu d'intégration en cliquant sur Outils Google Workspace dans un espace ou une conversation Chat, puis sélectionnez une commande d'application dont le nom ne commence pas par une barre oblique (/). En sélectionnant une commande rapide, l'application Chat est directement appelée sans autre saisie de la part de l'utilisateur, ce qui permet des interactions rapides.
Les utilisateurs peuvent également appeler une application Chat à l'aide d'une commande à barre oblique. Contrairement aux commandes à barre oblique, les commandes rapides sont formatées avec un nom plus convivial dans l'interface utilisateur de Chat. Elles sont appelées immédiatement après la sélection et ne nécessitent pas que l'utilisateur se souvienne ou saisisse le nom de la commande à barre oblique.
Configurer une commande rapide dans l'API Google Chat
Pour créer une commande rapide ou convertir des commandes à barre oblique existantes en commandes rapides, vous devez spécifier des informations sur la commande dans la configuration de l'API Google Chat de votre application Chat.
Pour configurer une commande rapide dans l'API Google Chat, procédez comme suit:
Dans la console Google Cloud, cliquez sur Menu > > API et services > > API et services activés > > API Google Chat.
Cliquez sur Configuration
Sous Paramètres avancés, accédez à Déclencheurs et vérifiez que le champ Commande de l'application contient un déclencheur, tel qu'un point de terminaison HTTP ou une fonction Apps Script. Vous devez utiliser ce déclencheur dans la section suivante pour répondre à la commande rapide.
Sous Commandes, cliquez sur Ajouter une commande.
Saisissez un ID, un nom, une description et un type de commande pour la commande:
- ID de commande:nombre compris entre 1 et 1 000 utilisé par votre application Chat pour reconnaître la commande et renvoyer une réponse.
- Nom:nom à afficher pour la commande. Les noms peuvent comporter jusqu'à 50 caractères et peuvent inclure des caractères spéciaux.
- Utilisez des mots ou des expressions courts, descriptifs et pratiques pour que les commandes soient claires pour l'utilisateur. Par exemple, utilisez Mettre à jour le contact pour une commande qui modifie un enregistrement de contact.
- Description:texte décrivant l'action de la commande.
Les descriptions peuvent comporter jusqu'à 50 caractères et inclure des caractères spéciaux.
- Réduisez la description à quelques mots clairs et concis pour que les utilisateurs sachent à quoi s'attendre lorsqu'ils appellent la commande.
- Indiquez aux utilisateurs si l'application Chat répond à tous les membres de l'espace ou en privé à l'utilisateur qui appelle la commande. Par exemple, pour la commande rapide À propos, vous pouvez la décrire comme En savoir plus sur cette application (visible uniquement par vous).
- Type de commande:sélectionnez Commande rapide.
Facultatif: Si vous souhaitez que votre application Chat réponde à la commande par le biais d'une boîte de dialogue, cochez la case Ouvrir une boîte de dialogue.
Cliquez sur Enregistrer.
La commande rapide est maintenant configurée pour l'application Chat.
Répondre à une commande rapide
Lorsque les utilisateurs appellent une commande rapide, votre application Chat reçoit un objet d'événement contenant des informations sur la commande rapide.
L'objet d'événement contient une charge utile AppCommand avec des informations sur la commande appelée (y compris l'ID de commande), afin que vous puissiez renvoyer une réponse appropriée.
Pour répondre à une commande rapide, vous devez implémenter le déclencheur de commande d'application afin que votre application Chat puisse gérer tous les objets d'événement contenant des métadonnées de commande d'application.
Le code suivant montre un exemple d'application Chat qui répond à la commande Aide. Pour répondre aux commandes rapides, l'application Chat gère les objets d'événement à partir d'un déclencheur de commande d'application. Lorsque la charge utile d'un objet d'événement contient un ID de commande rapide, l'application Chat renvoie l'action DataActions avec un objet 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.'
}}}}};
}
}
}
Pour utiliser cet exemple de code, remplacez HELP_COMMAND_ID par l'ID de commande que vous avez spécifié lorsque vous avez configuré la commande rapide dans l'API Chat.
Pour tester une commande rapide dans Chat, ouvrez le menu d'intégration en cliquant sur Outils Google Workspace , puis sélectionnez votre commande rapide.