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.

Dans Google Chat, les modules complémentaires sont présentés aux utilisateurs en tant qu'applications Google Chat. Pour en savoir plus, consultez la présentation de l'extension Google Chat.

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

  • Déclencheurs: façons dont les utilisateurs de Google Chat peuvent 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 à partir de déclencheurs ou d'interactions avec l'UI.
  • Actions: façons dont les applications Chat peuvent répondre aux interactions, comme envoyer des messages ou renvoyer 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 Added to space (Ajout à l'espace) se déclenche et envoie un objet d'événement. Pour répondre par un message, l'application Chat gère l'objet d'événement et renvoie une action qui crée le message.

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

  • Messages pouvant contenir du texte, des fiches statiques ou interactives, et des boutons.
  • Boîtes de dialogue, qui sont des cartes qui s'ouvrent dans une nouvelle fenêtre et qui invitent généralement les utilisateurs à envoyer des informations.
  • Aperçus de lien, qui sont des fiches qui présentent 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 moyens spécifiques par lesquels les utilisateurs appellent une application Chat à l'aide de l'interface utilisateur de 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 réponse habituelle des applications Chat:

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 des 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 d'aide pour les administrateurs Google Workspace.

 L'application Chat envoie un message d'intégration qui explique son fonctionnement et la façon dont 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:

  • Envoyer 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 correspondant au format d'URL pour les aperçus de liens.
  • Saisit du texte dans le menu de 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 avec un message expliquant les tâches que l'application Chat 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, que l'administrateur Google Workspace tente de la désinstaller ou non.

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

Un utilisateur utilise une commande de l'application Chat.

 L'application Chat répond à la commande. (par exemple, 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 des conseils, consultez Configurer une application Google Chat.

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

Objets d'événement

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

Pour en savoir plus sur la gestion des objets d'événement, consultez les guides suivants:

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

Actions du chat

Cette section explique comment les applications Chat peuvent utiliser des 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 un délai de 30 secondes, et la réponse doit être publiée dans l'espace où l'interaction s'est produite. Sinon, l'application Chat doit configurer l'authentification et appeler l'API Google Chat pour répondre.

Les applications de chat peuvent gérer et répondre aux interactions de nombreuses manières. Dans de nombreux cas, les applications Chat répondent par un message. Les applications de chat peuvent également rechercher des informations dans une source de données, enregistrer les informations de l'objet de l'événement ou presque tout autre chose. C'est ce comportement de traitement qui définit essentiellement l'application Google Chat.

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

Réponse de l'application Chat Action requise pour effectuer un retour
Envoyer ou mettre à jour 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çu des liens dans les messages que les utilisateurs de 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 devoir 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épondre à une interaction au bout de 30 secondes
  • effectuer des tâches en dehors de l'espace dans lequel l'interaction a eu lieu ;
  • Effectuer des tâches dans Chat qui ne sont pas disponibles en tant qu'actions de modules complémentaires Par exemple, listez les espaces auxquels un utilisateur ou une application Chat est membre, ou ajoutez des utilisateurs à un espace.
  • Effectuer des tâches pour le compte de l'utilisateur Chat (ce qui nécessite une authentification de l'utilisateur).

Pour en savoir plus sur l'authentification et l'appel de l'API Chat, consultez la présentation de l'API Chat.