Répondre aux commandes de l'application Google Chat (original) (raw)

Cette page explique comment configurer des commandes et y répondre en tant qu'application Google Chat.

Les commandes aident les utilisateurs à découvrir et à utiliser les principales fonctionnalités d'une application Chat. Seules les applications Chat peuvent voir le contenu d'une commande. Par exemple, si un utilisateur envoie un message avec une commande à barre oblique, le message n'est visible que par l'utilisateur et l'application Chat.

Pour déterminer si vous devez créer des commandes et comprendre comment concevoir les interactions utilisateur, consultez Définir tous les parcours utilisateur.

Vous pouvez créer des commandes d'application Chat sous forme de commandes à barre oblique ou de commandes rapides. Pour découvrir les commandes, les utilisateurs peuvent saisir une barre oblique / dans la zone de réponse ou cliquer sur Outils Google Workspace dans la zone de réponse d'un message Chat. Pour utiliser chaque type de commande, les utilisateurs peuvent procéder comme suit :

  1. Commandes à barre oblique : les utilisateurs peuvent sélectionner une commande à barre oblique dans le menu ou saisir une barre oblique (/), puis un texte prédéfini, tel que /about. Les applications de chat nécessitent généralement un texte d'argument pour la commande à barre oblique.
    Créez une commande à barre oblique si votre application Chat nécessite des informations supplémentaires de la part de l'utilisateur. Par exemple, vous pouvez créer une commande à barre oblique appelée /search qui s'exécute après que l'utilisateur a saisi une expression à rechercher, comme /search receipts.
  2. Commandes rapides : les utilisateurs utilisent les commandes en ouvrant le menu depuis la zone de réponse d'un message Chat. Pour utiliser une commande, il clique sur Ajouter et sélectionne une commande dans le menu.
    Créez une commande rapide si votre application Chat peut répondre immédiatement à l'utilisateur, sans attendre d'autres informations. Par exemple, vous pouvez créer une commande rapide appelée Image aléatoire qui répond immédiatement avec une image.

L'image suivante montre comment les utilisateurs découvrent un menu de commandes à barre oblique et de commandes rapides :

Un utilisateur découvre un menu de commandes à barre oblique et de commandes rapides.

Les utilisateurs découvrent un menu de commandes à barre oblique et de commandes rapides.

Prérequis

Configurer la commande

Cette section explique comment effectuer les étapes suivantes pour configurer la commande :

  1. Donnez un nom et une description à la commande.
  2. Configurez la commande dans la console Google Cloud.

Nommez et décrivez la commande

Le nom d'une commande est ce que les utilisateurs saisissent ou sélectionnent pour appeler l'application Chat. Une brève description s'affiche également sous le nom pour inciter les utilisateurs à en savoir plus sur l'utilisation de la commande :

Nom et description de la commande à barre oblique

Nom et description d'une commande à barre oblique.

Lorsque vous choisissez un nom et une description pour votre commande, tenez compte des recommandations suivantes :

Pour nommer une commande :

Pour décrire une commande :

Configurer la commande dans la console Google Cloud

Pour créer une commande à barre oblique ou rapide, vous devez spécifier des informations sur la commande dans la configuration de votre application Chat pour l'API Google Chat.

Pour configurer une commande 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 de commande, une description, un type de commande et un nom pour la commande :
    • ID de la commande : nombre compris entre 1 et 1 000 que votre application Chat utilise pour reconnaître la commande et renvoyer une réponse.
    • Description : texte décrivant l'action de la commande. Les descriptions peuvent comporter jusqu'à 50 caractères et inclure des caractères spéciaux.
    • Type de commande : sélectionnez Commande rapide ou Commande à barre oblique.
    • Spécifiez un nom pour la commande rapide ou la commande à barre oblique :
      * Nom de la commande rapide : nom à afficher que les utilisateurs sélectionnent dans le menu pour appeler la commande. Il peut contenir jusqu'à 50 caractères et inclure des caractères spéciaux. Exemple :Remind me
      * Nom de la commande à barre oblique : texte que les utilisateurs saisissent pour appeler la commande dans un message. Doit commencer par une barre oblique, ne contenir que du texte et ne pas dépasser 50 caractères. Exemple :/remindMe
  5. Facultatif : Si vous souhaitez que votre application Chat réponde à la commande avec une boîte de dialogue, cochez la case Ouvrir une boîte de dialogue.
  6. Cliquez sur Enregistrer.

La commande est maintenant configurée pour l'application Chat.

Répondre à une commande

Lorsque les utilisateurs utilisent une commande, votre application Chat reçoit un événement d'interaction. La charge utile de l'événement contient des métadonnées avec des informations sur la commande qui a été appelée (y compris l'ID et le type de commande), afin que vous puissiez renvoyer une réponse appropriée.

Message privé pour l'application de chat Cymbal Labs. Le message indique que l'application de chat a été créée par Cymbal Labs et partage un lien vers la documentation et un lien pour contacter l'équipe d'assistance.

Une application Chat répond en privé à la commande à barre oblique /help pour expliquer comment obtenir de l'aide.

Pour répondre à chaque type de commande, vous devez gérer différents types d'événements et d'objets de métadonnées dans la charge utile de l'événement :

Type de commande Type d'événement Métadonnées de commande
Commande à barre oblique MESSAGE message.slashCommand ou message.annotation.slashCommand
Commande rapide APP_COMMAND appCommandMetadata

Pour savoir comment répondre à une commande avec un message, consultez les sections suivantes.

Répondre à une commande à barre oblique

Le code suivant montre un exemple d'application Chat qui répond à la commande à barre oblique /about. L'application Chat gère les événements d'interaction MESSAGE, détecte si l'événement d'interaction contient l'ID de commande correspondant et renvoie un message privé :

Node.js

Apps Script

Python

Java

Remplacez ABOUT_COMMAND_ID par l'ID de commande que vous avez spécifié lorsque vous avez configuré la commande dans la console Google Cloud.

Répondre à une commande rapide

Le code suivant montre un exemple d'application Chat qui répond à la commande rapide Help (Aide). L'application Chat gère les événements d'interaction APP_COMMAND, détecte si l'événement d'interaction contient l'ID de commande correspondant et renvoie un message privé :

Node.js

Apps Script

Python

Java

Remplacez HELP_COMMAND_ID par l'ID de commande que vous avez spécifié lorsque vous avez configuré la commande dans la console Google Cloud.

Tester la commande

Pour tester la commande et le code, consultez Tester les fonctionnalités interactives des applications Google Chat.

Pour savoir comment tester et utiliser la commande dans l'interface utilisateur Chat, consultez Utiliser des applications dans Google Chat dans la documentation d'aide de Google Chat.