Créer des interfaces Google Chat

Cette page explique comment créer des interfaces utilisateur (UI) pour les modules complémentaires Google Workspace qui étendent Google Chat.

Pour créer des interfaces pour les applications Chat, vous utilisez les composants complémentaires suivants :

  • Déclencheurs : les méthodes permettant aux utilisateurs de Google Chat d'appeler une application Chat, par exemple en l'ajoutant à un espace ou en lui envoyant un message.
  • Objets d'événement : données que les applications Chat reçoivent des déclencheurs ou des interactions avec l'UI.
  • Actions : les façons dont les applications Chat peuvent répondre aux interactions, par exemple en envoyant des messages ou en renvoyant une interface utilisateur basée sur des fiches.
L'application Chat reçoit un objet d'événement à partir d'un déclencheur "Ajouté à un espace"
Figure 1 : Lorsqu'un utilisateur ajoute une application Chat à un espace, le déclencheur Ajouté à l'espace se déclenche et envoie un objet événement. Pour répondre par un message, l'application Chat gère l'objet événement et renvoie une action qui crée le message.

Les applications de chat peuvent créer et afficher des fiches dans les interfaces suivantes :

  • Les messages peuvent contenir du texte, des fiches statiques ou interactives, et des boutons.
  • Les boîtes de dialogue sont des cartes qui s'ouvrent dans une nouvelle fenêtre et qui invitent généralement les utilisateurs à fournir des informations.
  • Les aperçus de liens, qui sont des fiches affichant des informations sur un service externe.

Déclencheurs

Cette section explique les déclencheurs utilisés par les modules complémentaires Google Workspace dans Chat.

Les déclencheurs sont les méthodes spécifiques que les utilisateurs emploient pour appeler une application Chat à l'aide de l'interface utilisateur Chat, par exemple en utilisant des @mentions ou des commandes d'application.

Le tableau suivant présente les déclencheurs Chat, une description et la façon dont les applications Chat répondent généralement :

Déclencheur Description Réponse type
Ajouté à l'espace

Un utilisateur ajoute l'application Chat à un espace ou un administrateur Google Workspace installe l'application Chat dans les espaces de messages privés pour les utilisateurs de son organisation. Pour en savoir plus sur les applications Chat installées par les administrateurs, consultez Installer des applications Marketplace dans votre domaine dans la documentation du centre d'aide pour les administrateurs Google Workspace.

 L'application Chat envoie un message d'accueil qui explique ce qu'elle fait et comment les utilisateurs de l'espace peuvent interagir avec elle.
Message

Un utilisateur interagit avec l'application Chat dans un message de l'une des manières suivantes :

  • Envoie un message dans un espace de message privé (MP) avec l'application Chat.
  • @mentionne l'application Chat dans n'importe quel type d'espace.
  • Envoie un message contenant un lien qui correspond au format d'URL des aperçus de liens.
  • Saisit du texte dans le menu à sélection multiple d'un widget selectionInput.
 L'application Chat répond en fonction du contenu du message. Par exemple, une application Chat répond à la commande à barre oblique /about par un message expliquant les tâches qu'elle peut effectuer.
Supprimé de l'espace

Un utilisateur supprime l'application Chat d'un espace ou un administrateur Google Workspace désinstalle l'application Chat pour un utilisateur de son organisation.

Les utilisateurs ne peuvent pas supprimer les applications Chat installées par leur administrateur. Si un utilisateur a déjà installé l'application Chat, elle reste installée, même si un administrateur Google Workspace tente de la désinstaller.

 L'application Chat supprime toutes les notifications entrantes configurées pour l'espace (par exemple, la suppression d'un webhook) et efface tout stockage interne. Les applications de chat ne peuvent pas répondre à ce déclencheur avec des messages, car elles ne sont plus membres de l'espace.
Commande d'application

Un utilisateur utilise une commande de l'application Chat.

 L'application Chat répond à la commande. Par exemple, il répond avec un message ou ouvre une boîte de dialogue.

Contrairement aux autres modules complémentaires Google Workspace, vous devez configurer les fonctions de rappel pour ces déclencheurs à l'aide de l'API Google Chat. Pour obtenir de l'aide, consultez Configurer une application Google Chat.

Pour répondre à un déclencheur, consultez les guides suivants :

Objets d'événement

Les applications de chat reçoivent des objets d'événement lorsqu'un déclencheur Chat se déclenche ou lorsque des utilisateurs Chat interagissent avec une UI de l'application Chat (par exemple, en cliquant sur un bouton). L'objet d'événement contient des données sur l'interaction que l'application Chat peut utiliser pour répondre ou mettre à jour une UI.

Pour savoir comment gérer les objets d'événement, consultez les guides suivants :

Pour en savoir plus sur les objets d'événement de module complémentaire dans Chat et d'autres applications Google Workspace, consultez Objets d'événement.

Actions du chat

Cette section explique comment les applications Chat peuvent utiliser les actions de module complémentaire pour répondre aux interactions utilisateur.

Pour répondre avec une action de module complémentaire, une application Chat doit répondre dans les 30 secondes, et la réponse doit être publiée dans l'espace où l'interaction a eu lieu. Sinon, l'application Chat doit configurer l'authentification et appeler l'API Google Chat pour répondre.

Les applications de chat peuvent gérer les interactions et y répondre de différentes manières. Dans de nombreux cas, les applications Chat répondent par un message. Les applications de chat peuvent également rechercher des informations à partir d'une source de données, enregistrer les informations de l'objet d'événement ou effectuer à peu près n'importe quelle autre action. Ce comportement de traitement définit essentiellement l'application Google Chat.

Pour répondre aux interactions des utilisateurs, les applications Chat doivent gérer l'objet événement correspondant et renvoyer l'un des objets JSON suivants :

Réponse de l'application de chat Action requise pour le retour
Envoyer ou modifier un message DataActions
Ouvrez, mettez à jour ou fermez une boîte de dialogue. RenderActions
Pour collecter des informations à partir d'une fiche ou d'une boîte de dialogue, suggérez des éléments de sélection en fonction de ce que les utilisateurs saisissent dans un menu à sélection multiple. RenderActions
Aperçus des liens dans les messages que les utilisateurs Chat envoient dans un espace. DataActions

Répondre à l'aide de l'API Google Chat

Au lieu de renvoyer une action de module complémentaire, les applications Chat peuvent avoir besoin d'utiliser l'API Google Chat pour répondre à une interaction. Par exemple, les applications Chat doivent appeler l'API Google Chat pour effectuer l'une des opérations suivantes :

  • Répondez à une interaction au bout de 30 secondes.
  • effectuer des tâches en dehors de l'espace où l'interaction a eu lieu ;
  • Effectuer dans Chat des tâches qui ne sont pas disponibles en tant qu'actions de module complémentaire. Par exemple, lister les espaces dont un utilisateur ou une application Chat est membre, ou ajouter des utilisateurs à un espace.
  • effectuer des tâches au nom de l'utilisateur Chat (ce qui nécessite l'authentification de l'utilisateur) ;

Pour savoir comment vous authentifier et appeler l'API Chat, consultez la présentation de l'API Chat.