Répondre aux commandes rapides avec une application Google Chat

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. Pour connaître la procédure à suivre, consultez la section Répondre aux commandes slash. 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.

Menu d'intégration avec commandes rapides
Figure 1: Menu d'intégration contenant des commandes rapides pour une application Chat

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:

  1. Dans la console Google Cloud, cliquez sur Menu  > > API et services > > API et services activés > > API Google Chat.

    Accéder à la page de l'API Google Chat

  2. Cliquez sur Configuration

  3. Sous Commandes, cliquez sur Ajouter une commande.

  4. 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.

  5. 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.

  6. 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 événement d'interaction APP_COMMAND. La charge utile de l'événement contient l'objet appCommandMetadata avec des informations sur la commande appelée (y compris l'ID de commande et le type de commande), afin que vous puissiez renvoyer une réponse appropriée.

Le code suivant montre un exemple d'application Chat qui répond à la commande Aide en gérant les événements d'interaction APP_COMMAND et en détectant si la charge utile de l'événement contient l'ID de commande correspondant. Si la charge utile de l'événement contient l'ID de commande, l'application Chat renvoie un message privé:

Apps Script 

// Handle the APP_COMMAND event type.
function onAppCommand(event) {
  // Executes the command logic based on its ID.
  // Command IDs are set in the Google Chat API configuration.
  switch (event.appCommandMetadata.appCommandId) {
    case HELP_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Définissez HELP_COMMAND_ID avec l'ID de commande que vous avez spécifié lorsque vous avez configuré la commande rapide dans l'API Chat. Pour tester ce code, consultez la section Tester les fonctionnalités interactives des applications Google 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.

Convertir les commandes à barre oblique existantes en commandes rapides

Pour modifier une commande à barre oblique existante en commande rapide, modifiez la commande à barre oblique dans l'API Google Chat en remplaçant Commande à barre oblique par Commande rapide dans Type de commande.

Lorsque les utilisateurs appellent une commande rapide, votre application Chat reçoit un événement d'interaction APP_COMMAND au lieu d'un événement d'interaction MESSAGE envoyé pour les commandes à barre oblique. Mettez à jour votre application Chat pour gérer ce type d'événement d'interaction en lisant la charge utile de l'événement contenant l'objet appCommandMetadata avec des informations sur la commande rapide appelée. Consultez la section Répondre à une commande rapide.