Pour éviter de changer de contexte lorsque les utilisateurs partagent un lien dans Google Chat, votre application Chat peut prévisualiser le lien en ajoutant une fiche à leur message. Cette fiche fournit plus de informations et permet aux utilisateurs d'effectuer des actions directement depuis Google Chat.
Imaginez, par exemple, un espace Google Chat qui inclut tous les agents du service client d'une entreprise, ainsi qu'une application Chat nommée Case-y. Les agents partagent fréquemment des liens vers des demandes d'assistance client dans l'espace Chat. Chaque fois qu'ils le font, leurs collègues doivent ouvrir le lien de la demande pour afficher des informations telles que l'assignataire, l'état et l'objet. De même, si quelqu'un souhaite prendre en charge une demande ou modifier son état, il doit ouvrir le lien.
La prévisualisation des liens permet à l'application Chat résidente de l'espace, Case-y, d'ajouter une fiche indiquant l'assignataire, l'état et l'objet chaque fois qu'un utilisateur partage un lien de demande. Les boutons de la fiche permettent aux agents de prendre en charge la demande et de modifier son état directement depuis le flux de discussion.
Fonctionnement de la prévisualisation des liens
Lorsqu'un utilisateur ajoute un lien à son message, un chip s'affiche pour l'informer qu'une application Chat peut prévisualiser le lien.

Une fois le message envoyé, le lien est transmis à l' application Chat, qui génère et ajoute ensuite la fiche au message de l'utilisateur.

À côté du lien, la fiche fournit des informations supplémentaires sur le lien, y compris des éléments interactifs tels que des boutons. Votre application Chat peut mettre à jour la fiche jointe en réponse aux interactions de l'utilisateur, comme les clics sur des boutons.
Si un utilisateur ne souhaite pas que l'application Chat prévisualise son lien en ajoutant une fiche à son message, il peut empêcher la prévisualisation en cliquant dans le chip de prévisualisation. Les utilisateurs peuvent supprimer la fiche jointe à tout moment en cliquant sur Supprimer l'aperçu.
Prérequis
Node.js
Une application Google Chat qui reçoit des événements d'interaction et y répond. Pour créer une application Chat interactive à l'aide d'un service HTTP, suivez ce guide de démarrage rapide.
Python
Une application Google Chat qui reçoit des événements d'interaction et y répond. Pour créer une application Chat interactive à l'aide d'un service HTTP, suivez ce guide de démarrage rapide.
Java
Une application Google Chat qui reçoit des événements d'interaction et y répond. Pour créer une application Chat interactive à l'aide d'un service HTTP, suivez ce guide de démarrage rapide.
Apps Script
Une application Google Chat qui reçoit des événements d'interaction et y répond. Pour créer une application Chat interactive dans Apps Script, suivez ce guide de démarrage rapide.
Configurer les aperçus de liens
Enregistrez des liens spécifiques (tels que example.com, support.example.com et
support.example.com/cases/) en tant que formats d'URL sur la page de configuration de votre application Chat dans la console Google Cloud afin que votre application Chat puisse les prévisualiser.

- Ouvrez la console Google Cloud.
- À côté de "Google Cloud", cliquez sur la flèche vers le bas et ouvrez le projet de votre application Chat.
- Dans le champ de recherche, saisissez
Google Chat API, puis cliquez sur Google Chat API. - Cliquez sur Gérer > Configuration.
- Sous "Aperçus de liens", ajoutez ou modifiez un format d'URL.
- Pour configurer les aperçus de liens pour un nouveau format d'URL, cliquez sur Ajouter un format d'URL.
- Pour modifier la configuration d'un format d'URL existant, cliquez sur la flèche vers le bas .
Dans le champ Format d'hôte, saisissez le domaine du format d'URL. L'application Chat prévisualisera les liens vers ce domaine.
Pour que l'application Chat prévisualise les liens d'un sous-domaine spécifique, tel que
subdomain.example.com, incluez le sous-domaine.Pour que l'application Chat prévisualise les liens de l'ensemble du domaine, spécifiez un caractère générique avec un astérisque (*) comme sous-domaine. Par exemple,
*.example.comcorrespond àsubdomain.example.cometany.number.of.subdomains.example.com.Dans le champ Préfixe de chemin, saisissez un chemin à ajouter au domaine du format d'hôte.
Pour faire correspondre toutes les URL du domaine du format d'hôte, laissez le champ Préfixe de chemin vide.
Par exemple, si le format d'hôte est
support.example.com, pour faire correspondre les URL des demandes hébergées sursupport.example.com/cases/, saisissezcases/.Cliquez sur OK.
Cliquez sur Enregistrer.
Désormais, chaque fois qu'un utilisateur inclut un lien qui correspond à un format d'URL d'aperçu de lien dans un message d'un espace Chat qui inclut votre application Chat, votre application prévisualise le lien.
Prévisualiser un lien
Une fois que vous avez configuré la prévisualisation des liens pour un lien donné, votre application Chat peut reconnaître et prévisualiser le lien en y ajoutant des informations.
Dans les espaces Chat qui incluent votre
application Chat, lorsqu'un message contient un lien qui
correspond à un format d'URL d'aperçu de lien, votre application Chat
reçoit un
MESSAGE événement d'interaction. La charge utile JSON de l'événement d'interaction contient le champ matchedUrl :
JSON
message: {
matchedUrl: {
url: "https://support.example.com/cases/case123"
},
... // other message attributes redacted
}
En vérifiant la présence du champ matchedUrl dans la charge utile de l'événement MESSAGE, votre application Chat peut ajouter des informations au message avec le lien prévisualisé. Votre application Chat peut répondre avec un message texte de base ou ajouter une fiche.
Répondre avec un message texte
Pour les réponses de base, votre application Chat peut prévisualiser un lien en répondant avec un simple message texte à un lien. Cet exemple ajoute un message qui répète l'URL du lien correspondant à un format d'URL d'aperçu de lien.
Node.js
Python
Java
Apps Script
Ajouter une fiche qui prévisualise le lien
Pour ajouter une fiche à un lien prévisualisé,
renvoyez un
ActionResponse
de type UPDATE_USER_MESSAGE_CARDS. Cet exemple ajoute une fiche de base.

Node.js
Python
Java
Apps Script
Cet exemple envoie un message de fiche en renvoyant du code JSON de fiche. Vous pouvez également utiliser le service de fiche Apps Script.
Mettre à jour une fiche d'aperçu de lien
Votre application Chat peut mettre à jour une fiche d'aperçu de lien lorsque les utilisateurs interagissent avec elle, par exemple en cliquant sur un bouton de la fiche.
Pour mettre à jour la fiche, votre application Chat
doit gérer l'événement d'interaction CARD_CLICKED
et renvoyer un
actionResponse
en fonction de l'auteur du message contenant l'aperçu du lien :
- Si un utilisateur a envoyé le message, définissez
actionResponse.typesurUPDATE_USER_MESSAGE_CARDS. - Si l'application Chat a envoyé le message, définissez
actionResponse.typesurUPDATE_MESSAGE.
Pour déterminer qui a envoyé le message, vous pouvez utiliser le champ message.sender.type de l'événement d'interaction pour voir si l'expéditeur était un utilisateur HUMAN ou un BOT.
L'exemple suivant montre comment une application Chat met à jour un aperçu de lien chaque fois qu'un utilisateur clique sur le bouton Assigner à moi en mettant à jour le champ Assignataire de la fiche et en désactivant le bouton.

Node.js
Python
Java
Apps Script
Cet exemple envoie un message de fiche en renvoyant du code JSON de fiche. Vous pouvez également utiliser le service de fiche Apps Script.
Limites et points à noter
Lorsque vous configurez les aperçus de liens pour votre application Chat, tenez compte des limites et points à noter suivants :
- Chaque application Chat accepte les aperçus de liens pour un maximum de cinq formats d'URL.
- Les applications Chat prévisualisent un lien par message. Si plusieurs liens prévisualisables sont présents dans un même message, seul le premier lien prévisualisable est prévisualisé.
- Les applications Chat ne prévisualisent que les liens commençant par
https://. Par conséquent,https://support.example.com/cases/est prévisualisé, mais passupport.example.com/cases/. - Sauf si le message inclut d'autres informations envoyées à l' application Chat, telles qu'une commande à barre oblique, seule l'URL du lien est envoyée à l'application Chat par les aperçus de liens.
- Si un utilisateur publie le lien, une application Chat ne peut mettre à jour la fiche d'aperçu du lien que si les utilisateurs interagissent avec la fiche, par exemple en cliquant sur un bouton. Vous ne pouvez pas appeler la méthode
update()de l'API Chat sur la ressourceMessagepour mettre à jour le message d'un utilisateur de manière asynchrone. - Les applications Chat doivent prévisualiser les liens pour tous les membres de l'espace.
Le message doit donc omettre le
privateMessageViewerchamp.
Déboguer les aperçus de liens
Lorsque vous implémentez des aperçus de liens, vous devrez peut-être déboguer votre application Chat en lisant ses journaux. Pour lire les journaux, accédez à l'explorateur de journaux dans la console Google Cloud.