Le Knowledge Graph prend en charge différents types de champs, chacun conçu pour différents types de données.
Types de champs standard
Chaque champ est défini par un type. Ce sont les types de champs standard disponibles sur la plateforme Yext.
| Type | Description | Validation disponible |
|---|---|---|
| Appel à l'action | Appel à l'action avec intitulé et lien | Nombre de caractères de l'intitulé (jusqu'à 255), nombre de caractères du lien (jusqu'à 2 000) |
| Photo complexe | Photo avec légende intégrée, détails, URL de redirection et texte alternatif | Rapport hauteur/largeur, largeur/hauteur min. |
| Galerie de photos complexes | Galerie de photos avec légende intégrée, détails, URL de redirection et texte alternatif | Rapport hauteur/largeur, largeur/hauteur min., nombre d'éléments (jusqu'à 500) |
| Vidéo Complex | URL YouTube (et YouTube Shorts) avec description intégrée | Nombre de caractères de la description (jusqu'à 140) |
| Galerie vidéo Complex | Galerie d'URL YouTube avec description intégrée | Nombre de caractères de la description (jusqu'à 140), nombre d'éléments (jusqu'à 100) |
| Horaires d'ouverture quotidiens | Configurez des horaires spécifiques pour chaque jour de la semaine. | n/a |
| Date | Champ de date | Plage de dates |
| Date + Heure | Champ de date avec heure spécifiée | Plage de dates et d'heures |
| Relations entre entités | Liste des entités liées avec la possibilité de sélectionner un type de relation unidirectionnelle, bidirectionnelle (champ partagé) ou bidirectionnelle (champ distinct) | Types d'entités sélectionnables, nombre d'éléments (jusqu'à 5 000) |
| Fichier | Les types de champ Fichier peuvent être configurés pour prendre en charge un seul fichier ou une liste de fichiers. | Format de fichier et taille maximale de fichier (jusqu'à 1 Go) |
| Horaires | Configurez une liste d'horaires pour chaque jour de la semaine. Précisez si une entité est opérationnelle en utilisant Ouvert, Fermé, Horaires fractionnés ou 24h/24. Vous pouvez ajouter plusieurs plages horaires pour un jour précis. | n/a |
| Texte à plusieurs lignes | Texte long | Nombre de caractères (jusqu'à 100 000) |
| Sélection à choix multiples | Champ d'options où l'utilisateur peut sélectionner plusieurs options | Options disponibles, nombre d'éléments (jusqu'à 2 000) |
| Numéro | Champ numérique | Plage de nombres |
| Numéro de téléphone | Champ numérique avec préfixe de code pays et mise en forme automatique du numéro de téléphone | s/o (la validation de ce qui constitue un numéro de téléphone valide provient de Google ) |
| Photo | Photo avec texte alternatif | Rapport hauteur/largeur, largeur/hauteur min. |
| Galerie de photos | Galerie de photos avec texte alternatif | Rapport hauteur/largeur, largeur/hauteur min., nombre d'éléments (jusqu'à 500) |
| Prix | Champ de prix | n/a |
| Texte enrichi | Champ de texte enrichi avec mise en forme | Type de mise en forme (gras, italique, souligné, liste à puces, liste numérotée, lien hypertexte ou bloc de code), nombre de caractères (jusqu'à 100 000) |
| Texte à une ligne | Texte court | Nombre de caractères (jusqu'à 100 000) |
| Sélection à choix unique | Champ d'option où l'utilisateur ne peut sélectionner qu'une seule option | Options disponibles |
| Slug | Un intitulé court et facile à lire à la fin d'une URL qui sert généralement d'identifiant, par exemple hitchhikers.yext.com/docs | Caractères alphanumériques en minuscules et caractères spéciaux suivants : - . _ ~ : / [ ] @ ! $ ' ( ) * + ; = “ |
| Liste de textes | Liste de chaînes de caractères | Nombre de caractères (jusqu'à 100 000), nombre d'éléments (jusqu'à 1 000) |
| Heure | Une valeur en heures et en minutes (hh:mm) |
n/a |
| Adresse URL | Adresse URL du site Web | Nombre de caractères (jusqu'à 2 000) |
| Vidéo | URL YouTube (et YouTube Shorts) | n/a |
| Galerie vidéo | Galerie d'URL YouTube (et YouTube Shorts) | Rapport hauteur/largeur, largeur/hauteur min., nombre d'éléments (jusqu'à 100) |
| Oui/Non | Champ avec options Oui, Non ou Non précisé | n/a |
Type de champ Fichier
Le type de champ Fichier vous permet de stocker des fichiers directement sur vos entités. Ce type peut être utilisé dans les champs personnalisés et les types de champs personnalisés.
Propriétés
Le type de champ Fichier est composé des cinq propriétés suivantes :
| Propriété | Description |
|---|---|
sourceURL |
URL source du fichier. Ne se remplit que si elle est chargée en fournissant une URL d'hébergement. |
url |
L'URL d'hébergement par Yext du fichier. |
mimeType |
Le type MIME du fichier. Actuellement, tous les types MIME sont pris en charge. |
nom |
Le nom d'affichage du fichier. Définissable par l'utilisateur. Remarque : la propriété name ne peut pas être mappée via le connecteur, mais peut être définie ou modifiée sur toutes les autres interfaces. |
taille |
La taille du fichier en octets. |
Les types de champ Fichier peuvent être configurés pour prendre en charge un seul fichier ou une liste de fichiers. Cela créera automatiquement une validation de nombre maximal de fichiers chargés de 1 ou 5 000 respectivement.
Validation
La validation par défaut des champs Fichier est indiquée ci-dessous. Vous pouvez également configurer la validation pour les champs personnalisés Fichier et les types de champs personnalisés Fichier.
| Option | Validation par défaut | Validation personnalisée |
|---|---|---|
| Format de fichier | Tous les formats de type MIME sont autorisés. | Vous pouvez limiter les fichiers chargés à un sous-ensemble de types de fichiers autorisés par type MIME courant. |
| Taille maximale de fichier | Les fichiers ne peuvent pas dépasser 1 Go. | Définissez une autre taille maximale en octets, kilooctets ou mégaoctets. La valeur doit être un nombre entier. |
Remarque : il existe un problème connu avec JsonFormat.Printer qui affecte la configuration en tant que code, la propriété maxSize étant renvoyée comme chaîne lorsqu'elle est extraite. Cependant, lorsqu'elle est appliquée, cette propriété doit être un nombre.
Chargement de fichiers
Les fichiers peuvent être chargés à l'aide de toutes les interfaces permettant de modifier les entités dans le Knowledge Graph (Modification d'entités, Chargement d'entités, Connecteurs, API et CaC).
Toutes les interfaces prennent en charge le chargement de fichiers via une URL source. Le chargement à partir d'un système de fichiers local n'est possible que dans Modification d'entités.
Pour charger un fichier hébergé en ligne, indiquez l'URL d'hébergement à l'aide de la propriété url. L'URL fournie sera ensuite propagée à la propriété sourceUrl, tandis que le champ URL affichera l'URL d'hébergement par Yext de ce fichier.
Mise à jour de fichiers
Pour modifier un fichier stocké dans un champ sur une entité, mettez à jour la valeur de la propriété url avec l'URL du nouveau fichier hébergé. L'envoi de mises à jour à la propriété sourceUrl n'est pas pris en charge.
La chaîne d'agent utilisateur servant à télécharger les fichiers est YextBot YextFileDownloader/1.0.
Accès aux fichiers stockés
Les fichiers stockés sur les entités sont accessibles via Modification d'entités et API.
Modification d'entités
Les fichiers peuvent être téléchargés à partir de la propriété URL. L'état de modification de ce champ affichera toutes les propriétés du champ Fichier. Il n'est pas possible de modifier les propriétés d'un fichier dans Modification d'entités, à l'exception du nom du fichier.
API
L'ouverture de l'URL stockée dans la propriété url téléchargera le fichier sur votre appareil local. Voici un exemple de ce à quoi cela ressemblerait sur une Entities: GET :
Si d'autres champs sont omis, la réponse se présente comme suit :
{
"response": {
"entities": [{
"c_pdfFile": [{
"sourceUrl": "https://www.pdfs.com/123",
"url":"https://a.mktgcdn.com/f/3912636/123",
"mimeType": "application/pdf",
"name": "Instruction Manual",
"size": 2001
}]
}]
}
}Type de champ Photo
Le type de champ Photo vous permet de stocker des photos directement sur vos entités. Ce type peut être utilisé dans les champs personnalisés et les types de champs personnalisés.
Propriétés
Le type de champ Photo est composé des cinq propriétés suivantes :
| Propriété | Description |
|---|---|
largeur |
La largeur de la photo en pixels. |
hauteur |
La hauteur de la photo en pixels. |
url |
L'URL d'hébergement par Yext du fichier. |
sourceUrl |
URL source du fichier. Ne se remplit que si elle est chargée en fournissant une URL d'hébergement. |
thumbnails (Ancienne) |
Ancienne fonctionnalité générant des vignettes de différentes tailles pour une photo lors de son chargement. Cette fonctionnalité a été remplacée par la transformation dynamique d'image. |
Validation
Vous pouvez configurer la validation pour les champs personnalisés Photo et les types de champs personnalisés Photo.
| Option | Validation disponible | Par défaut | Valeurs acceptées |
|---|---|---|---|
| Largeur | Définissez la largeur minimale en pixels | 0 | Nombres entiers de 0 à 1 000 |
| Hauteur | Définissez la hauteur minimale en pixels | 0 | Nombres entiers de 0 à 1 000 |
| Rapport hauteur/largeur | Définissez le rapport hauteur/largeur accepté | Sans contraintes | Sans contraintes, 1:1, 4:3, 3:2, 5:3, 16:9, 3:1, 2:3, 5:7, 4:5 et 16:10 |
Restrictions
| Option | Valeurs acceptées |
|---|---|
| Taille d'image | Jusqu'à 100 mégapixels |
| Format d'image | JPEG, PNG, BMP, GIF, TIFF et WEBP |
Chargement de photos
Les photos peuvent être chargées à l'aide de toutes les interfaces permettant de modifier les entités dans le Knowledge Graph.
Toutes les interfaces prennent en charge le chargement de photos via une URL source. Le chargement d'une photo à partir d'un système de fichiers local n'est pris en charge que dans Modification d'entités.
Pour charger une photo hébergée en ligne, renseignez l'URL de la photo dans la propriété url. Cette URL sera ensuite propagée à la propriété sourceUrl, tandis que le champ URL sera l'URL d'hébergement par Yext de la photo.
Mise à jour de photos
Pour modifier la photo stockée dans un champ Photo donné, mettez à jour la valeur de la propriété url avec l'URL de la nouvelle photo hébergée. L'envoi de mises à jour directement à la propriété sourceUrl n'est pas pris en charge.
Accès aux photos
Une fois qu'une image a été chargée vers une entité, son URL d'hébergement est conservée comme référence dans le champ de l'entité. Vous pouvez accéder à l'entité via l'API pour récupérer directement l'URL de la photo, par exemple :
Si d'autres champs sont omis, la réponse se présente comme suit :
{
"response": {
"entities": [{
"photoGallery": [{
"image": {
"width": 314,
"height": 366,
"url": "http://a.mktgcdn.com/p/Oua5ocwC7euaUFkJ-V8n3OpF76Xtfh_rdsDT9ki_laY/314x366.jpg"
}]
}]
}
}Chaque image se voit attribuer un long UUID (la longue chaîne aléatoire ci-dessus), de sorte que l'URL a la forme : a.mktgcdn.com/p/UUID/WIDTHxHEIGHT.EXT.
Le HTTP et le HTTPS sont tous deux pris en charge.
Types de champ personnalisé
Vous pouvez créer des types de champs personnalisés pour regrouper plusieurs champs en un seul champ complexe. Par exemple, vous pourriez créer un type de champ « Remplacement des horaires d'ouverture » avec des sous-champs pour le jour, l'heure d'ouverture et l'heure de fermeture.
Vous utiliserez généralement les types de champs intégrés de Yext. Si cela s'avère nécessaire pour votre cas d'utilisation, vous pouvez également créer des types de champs personnalisés.
Pour créer un type de champ personnalisé :
- Accédez à Knowledge Graph > Configuration et cliquez sur la tuile Types de champs.
-
Cliquez sur Ajouter un type de champ personnalisé.
-
Saisissez les informations de base relatives à votre type de champ personnalisé.
- Nom du type de champ
- Nom de l'API : il sera défini automatiquement en fonction du nom, mais vous pouvez le modifier si vous le souhaitez.
-
Description du type (facultatif)
.
- Si vous utilisez des profils linguistiques supplémentaires, ajoutez des traductions à votre type d'entité personnalisé. Cliquez sur Ajouter une traduction sous le paramètre Nom ou Description.
- Choisissez la langue souhaitée et saisissez la valeur traduite. Cliquez sur Sauvegarder ou Sauvegarder et ajouter un autre élément pour ajouter une autre traduction aux mêmes paramètres.
- Ajoutez les champs individuels qui constitueront votre nouveau type de champ. Pour commencer, cliquez sur Ajouter un sous-champ.
- Saisissez les paramètres de votre sous-champ.
- Type du sous-champ : choisissez le type de sous-champ que vous souhaitez ajouter. Selon le type de champ choisi, des options légèrement différentes s'offrent à vous.
- Label du sous-champ : saisissez un label pour le sous-champ. Ajoutez des traductions si vous le souhaitez.
- Validation : définissez des règles de validation, comme un nombre minimum ou maximum de caractères, ou tout autre contenu accepté dans le sous-champ.
- Paramètres : indiquez si ce sous-champ est obligatoire lors du remplissage de votre champ personnalisé et s'il doit comporter des options de liste.
- Cliquez sur Ajouter un sous-champ pour ajouter d'autres sous-champs.
- Cliquez sur l'icône de poubelle depuis un sous-champ pour le supprimer.
- Cliquez sur Enregistrer en bas de l'écran pour enregistrer votre type de champ personnalisé.