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'effectuer une action directement depuis Google Chat.
Par exemple, imaginez un espace Google Chat incluant tous les agents du service client d'une entreprise et une application Chat nommée Case-y. Les agents partagent souvent des liens vers des demandes adressées au service 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 la personne responsable, l'état et l'objet. De même, si une personne souhaite devenir propriétaire d'un dossier ou en modifier l'état, elle doit ouvrir le lien correspondant.
L'aperçu des liens permet à l'application Chat résidente de l'espace, Case-y, de joindre une fiche indiquant la personne responsable, le statut et l'objet chaque fois qu'un utilisateur partage un lien vers une demande. Les boutons de la fiche permettent aux agents de s'approprier le dossier 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 lui indiquer 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 ensuite la carte et l'ajoute au message de l'utilisateur.
La fiche contient des informations supplémentaires sur le lien, y compris des éléments interactifs comme des boutons. Votre application Chat peut mettre à jour la fiche jointe en réponse aux interactions des utilisateurs, comme les clics sur les boutons.
Si un utilisateur ne souhaite pas que l'application Chat prévisualise son lien en joignant une fiche à son message, il peut empêcher l'aperçu 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.Configurer les aperçus de lien
Enregistrez des liens spécifiques (comme 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 celle-ci 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 du lien", 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 Format d'hôte, saisissez le domaine du format d'URL. L'application Chat prévisualisera les liens vers ce domaine.
Pour que les liens d'aperçu de l'application Chat d'un sous-domaine spécifique (
subdomain.example.com
, par exemple) s'affichent, 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 (*) comme sous-domaine. Par exemple,
*.example.com
correspond àsubdomain.example.com
etany.number.of.subdomains.example.com
.Dans le champ Préfixe du chemin, saisissez un chemin d'accès à ajouter au domaine du modèle d'hôte.
Pour représenter 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
, saisissezcases/
pour correspondre aux 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 qui correspond au format d'URL d'aperçu du lien avec un message dans un espace Chat incluant votre application Chat, votre application prévisualise le lien.
Prévisualiser un lien
Une fois que vous avez configuré l'aperçu du lien pour un lien donné, votre application Chat peut le reconnaître et le prévisualiser en y joignant davantage d'informations.
Dans les espaces Chat qui incluent votre application Chat, lorsqu'un message contient un lien correspondant au format d'URL d'aperçu du lien, votre application Chat reçoit un événement d'interaction MESSAGE
. La charge utile JSON pour l'événement d'interaction contient le champ matchedUrl
:
JSON
message {
. . . // other message attributes redacted
"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 message simple ou joindre une carte.
Répondre par SMS
Pour obtenir des réponses simples, votre application Chat peut prévisualiser un lien en répondant par un message simple à un lien. Cet exemple joint un message qui répète l'URL du lien qui correspond à un format d'URL d'aperçu de lien.
Node.js
Apps Script ;
Joindre une carte
Pour joindre une fiche à un lien prévisualisé, renvoyez un ActionResponse
de type UPDATE_USER_MESSAGE_CARDS
. Dans cet exemple, une carte simple est jointe.
Node.js
Apps Script ;
Mettre à jour une carte
Pour mettre à jour la carte associée à un lien prévisualisé, renvoyez un ActionResponse
de type UPDATE_USER_MESSAGE_CARDS
. Les applications de chat ne peuvent mettre à jour que les fiches qui prévisualisent les liens en réponse à un événement d'interaction avec une application Chat.
Les applications Chat ne peuvent pas mettre à jour ces fiches en appelant l'API Chat de manière asynchrone.
L'aperçu du lien ne permet pas de renvoyer un ActionResponse
de type UPDATE_MESSAGE
. Étant donné que UPDATE_MESSAGE
met à jour l'intégralité du message et pas uniquement la fiche, il ne fonctionne que si l'application Chat a créé le message d'origine. L'aperçu du lien joint une carte à un message créé par l'utilisateur. L'application Chat n'est donc pas autorisée à la modifier.
Pour vous assurer qu'une fonction met à jour les fiches créées par l'utilisateur et l'application dans le flux Chat, définissez de façon dynamique la ActionResponse
selon que l'application Chat ou l'utilisateur a créé le message.
- Si un utilisateur a créé le message, définissez
ActionResponse
surUPDATE_USER_MESSAGE_CARDS
. - Si une application Chat a créé le message, définissez
ActionResponse
surUPDATE_MESSAGE
.
Pour cela, vous pouvez spécifier et vérifier un actionMethodName
personnalisé dans la propriété onclick
de la carte jointe (qui identifie le message comme créé par l'utilisateur) ou vérifier si le message a bien été créé par un utilisateur.
Option 1: Recherchez actionMethodName
Pour utiliser actionMethodName
afin de gérer correctement les événements d'interaction CARD_CLICKED
sur les fiches prévisualisées, définissez un actionMethodName
personnalisé dans la propriété onclick
de la fiche jointe:
JSON
. . . // Preview card details
{
"textButton": {
"text": "ASSIGN TO ME",
"onClick": {
// actionMethodName identifies the button to help determine the
// appropriate ActionResponse.
"action": {
"actionMethodName": "assign",
}
}
}
}
. . . // Preview card details
"actionMethodName": "assign"
identifie le bouton dans le cadre d'un aperçu de lien, et il est possible de renvoyer dynamiquement la bonne ActionResponse
en recherchant une actionMethodName
correspondante:
Node.js
Apps Script ;
Option 2: Vérifier le type d'expéditeur
Vérifiez si message.sender.type
est défini sur HUMAN
ou BOT
. Si la valeur est HUMAN
, définissez ActionResponse
sur UPDATE_USER_MESSAGE_CARDS
. Sinon, définissez ActionResponse
sur UPDATE_MESSAGE
. Voici comment procéder :
Node.js
Apps Script ;
La mise à jour d'une carte est souvent due à un clic sur un bouton. Rappelez-vous le bouton M'assigner de la section précédente, Joindre une carte. Dans l'exemple ci-dessous, la fiche est mise à jour de façon à indiquer qu'elle est attribuée à "Vous" lorsqu'un utilisateur clique sur M'attribuer. L'exemple définit de façon dynamique ActionResponse
en vérifiant le type d'expéditeur.
Exemple complet: Case-y pour l'application Chat du service client
Voici le code complet de Case-y, une application Chat qui affiche un aperçu des liens vers les demandes partagées dans un espace Chat avec lequel les agents du service client collaborent.
Node.js
Apps Script ;
Limites et considérations
Lorsque vous configurez des aperçus de liens pour votre application Chat, tenez compte des limites et considérations suivantes:
- Chaque application Chat permet d'afficher des aperçus de liens pour cinq formats d'URL au maximum.
- Les applications de chat prévisualisent un lien par message. Si plusieurs liens prévisualisables sont présents dans un même message, seul le premier peut être prévisualisé.
- Les applications de chat ne prévisualisent que les liens qui commencent par
https://
.https://support.example.com/cases/
affiche l'aperçu, mais passupport.example.com/cases/
. - À moins que le message n'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 via les aperçus de lien.
- Les fiches jointes aux liens prévisualisés ne sont compatibles qu'avec un
ActionResponse
de typeUPDATE_USER_MESSAGE_CARDS
et uniquement en réponse à un événement d'interaction avec l'application Chat. Les aperçus de lien ne sont pas compatibles avecUPDATE_MESSAGE
ni avec les requêtes asynchrones de mise à jour des fiches associées à un lien prévisualisé via l'API Chat. Pour en savoir plus, consultez Mettre à jour une carte.
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.