Pour éviter tout changement de contexte lorsque les utilisateurs partagent un lien dans Google Chat, votre application Chat peut prévisualiser le lien en joignant à leur message une fiche qui fournit plus d'informations et permet aux utilisateurs d'agir directement depuis Google Chat.
Par exemple, imaginez 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 de service client dans l'espace Chat. Chaque fois qu'ils le font, leurs collègues doivent ouvrir le lien de la demande pour voir des informations telles que l'agent responsable, l'état et l'objet. De même, si un utilisateur souhaite prendre en charge une demande ou modifier son état, il doit ouvrir le lien.
L'aperçu des liens permet à l'application Chat de l'espace, Case-y, d'ajouter une fiche indiquant le responsable, l'état et l'objet chaque fois qu'un utilisateur partage un lien vers une 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 chat.
Fonctionnement de l'aperçu 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 envoyé à l'application Chat, qui génère et joint la fiche au message de l'utilisateur.
À côté du lien, la fiche fournit des informations supplémentaires sur celui-ci, 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 un bouton.
Si un utilisateur ne souhaite pas que l'application Chat prévisualise son lien en joignant une fiche à son message, il peut empêcher la prévisualisation en cliquant sur
sur le chip d'aperçu. Les utilisateurs peuvent supprimer la fiche jointe à tout moment en cliquant sur Supprimer l'aperçu.Prérequis
Node.js
Une application Google Chat pour laquelle les fonctionnalités interactives sont activées. 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 pour laquelle les fonctionnalités interactives sont activées. 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 avec des fonctionnalités interactives. 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 pour laquelle les fonctionnalités interactives sont activées. 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 (comme example.com
, support.example.com
et support.example.com/cases/
) en tant que modèles d'URL sur la page de configuration de votre application Chat dans la console Google Cloud afin qu'elle puisse les prévisualiser.
- Ouvrez Google Cloud Console.
- À 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 API Google Chat. - Cliquez sur Gérer > Configuration.
- Sous "Aperçus des liens", ajoutez ou modifiez un format d'URL.
- Pour configurer des aperçus de lien 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 Host pattern (Modèle 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 pour un sous-domaine spécifique, comme
subdomain.example.com
, incluez le sous-domaine.Pour que les liens d'aperçu de l'application Chat s'affichent pour l'ensemble du domaine, spécifiez un caractère générique avec un astérisque (*) en tant que sous-domaine. Par exemple,
*.example.com
correspond àsubdomain.example.com
etany.number.of.subdomains.example.com
.Dans le champ Préfixe de chemin, saisissez un chemin d'accès à ajouter au domaine du format d'hôte.
Pour faire correspondre toutes les URL du domaine du format d'hôte, laissez Préfixe de chemin vide.
Par exemple, si le format d'hôte est
support.example.com
, saisissezcases/
pour faire correspondre les URL des demandes hébergées sursupport.example.com/cases/
.Cliquez sur OK.
Cliquez sur Enregistrer.
Désormais, chaque fois qu'un utilisateur inclut un lien correspondant à un format d'URL d'aperçu de lien vers un message d'un espace Chat incluant votre application Chat, votre application affiche un aperçu du lien.
Prévisualiser un lien
Une fois que vous avez configuré la prévisualisation des liens pour un lien donné, votre application Chat peut le reconnaître et le prévisualiser en y joignant plus d'informations.
Dans les espaces Chat incluant votre application Chat, lorsque le message d'une personne contient un lien qui correspond au format d'URL d'aperçu du lien, votre application Chat reçoit un événement d'interaction MESSAGE
. 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 par un message texte de base ou joindre une fiche.
Répondre par un message
Pour les réponses de base, votre application Chat peut prévisualiser un lien en répondant par un simple message texte. Cet exemple joint 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
joindre une fiche qui présente un aperçu du lien ;
Pour joindre une fiche à un lien prévisualisé, renvoyez un ActionResponse
de type UPDATE_USER_MESSAGE_CARDS
. Cet exemple associe une fiche de base.
Node.js
Python
Java
Apps Script
Cet exemple envoie un message de carte en renvoyant un fichier JSON de carte. Vous pouvez également utiliser le service de carte 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'expéditeur du message contenant l'aperçu du lien:
- Si un utilisateur a envoyé le message, définissez
actionResponse.type
surUPDATE_USER_MESSAGE_CARDS
. - Si l'application Chat a envoyé le message, définissez
actionResponse.type
surUPDATE_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 BOT
.
L'exemple suivant montre comment une application Chat met à jour l'aperçu d'un lien chaque fois qu'un utilisateur clique sur le bouton Attribuer à moi en modifiant le champ Cession de la fiche et en désactivant le bouton.
Node.js
Python
Java
Apps Script
Cet exemple envoie un message de carte en renvoyant un fichier JSON de carte. Vous pouvez également utiliser le service de carte Apps Script.
Limites et considérations
Lorsque vous configurez des aperçus de liens pour votre application Chat, tenez compte des limites et des considérations suivantes:
- Chaque application Chat prend en charge les aperçus de liens pour un maximum de cinq modèles d'URL.
- Les applications Chat prévisualisent un lien par message. Si plusieurs liens pouvant être prévisualisés sont présents dans un même message, seul le premier est prévisualisé.
- Les applications de chat ne prévisualisent que les liens commençant par
https://
.https://support.example.com/cases/
est donc prévisualisé, mais passupport.example.com/cases/
. - Sauf si le message inclut d'autres informations envoyées à l'application Chat, comme une commande à barre oblique, seule l'URL du lien est envoyée à l'application Chat par les aperçus de lien.
- 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 elle, par exemple en cliquant sur un bouton. Vous ne pouvez pas appeler la méthode
update()
de l'API Chat sur la ressourceMessage
pour mettre à jour le message d'un utilisateur de manière asynchrone. - Les applications de chat doivent prévisualiser les liens pour tous les membres de l'espace. Le message doit donc omettre le champ
privateMessageViewer
.
Déboguer les aperçus de liens
Lorsque vous implémentez des aperçus de lien, 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.