DocumentationExperience PlatformGuide de modèle de données d’expérience (XDM)

Annexe du guide de l’API Schema Registry

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Rubriques :

Créé pour :

  • Développeur

Ce document fournit des informations supplémentaires relatives à l’utilisation de l’API Schema Registry.

Utiliser des paramètres de requête query

Le Schema Registry prend en charge l’utilisation de paramètres de requête pour paginer et filtrer les résultats lors de l’énumération des ressources.

NOTE
Lorsque vous combinez plusieurs paramètres de requête, ceux-ci doivent être séparés par des esperluettes (&).

Pagination paging

Les paramètres de requête les plus courants pour la pagination sont les suivants :

Paramètre
Description
orderby
Triez les résultats en fonction d'une propriété spécifique. Exemple : orderby=title triera les résultats par titre dans l’ordre croissant (A-Z). L’ajout d’un - avant la valeur de paramètre (orderby=-title) trie les éléments par titre dans l’ordre décroissant (Z-A).
limit
Utilisé conjointement avec un paramètre de orderby, limit limite le nombre maximal d’éléments qui doivent être renvoyés pour une requête donnée. Ce paramètre ne peut pas être utilisé sans un paramètre orderby présent.

Le paramètre limit spécifie un entier positif (entre 0 et 500) comme conseil quant au nombre maximal d’éléments qui doivent être renvoyés. Par exemple, limit=5 renvoie uniquement cinq ressources dans la liste. Cependant, cette valeur n’est pas strictement respectée. La taille réelle de la réponse peut être plus petite ou plus grande si elle est limitée par la nécessité de fournir le fonctionnement fiable du paramètre de start, si un tel paramètre est fourni.
start
Utilisé conjointement avec un paramètre orderby, start spécifie l’emplacement où doit commencer la liste d’éléments sous-définie. Ce paramètre ne peut pas être utilisé sans un paramètre orderby présent. Cette valeur peut être obtenue à partir de l’attribut _page.next d’une réponse de liste et utilisée pour accéder à la page de résultats suivante. Si la valeur _page.next est nulle, aucune page supplémentaire n’est disponible.

En règle générale, ce paramètre est omis pour obtenir la première page de résultats. Ensuite, start doit être défini sur la valeur maximale de la propriété de tri principale du champ de orderby reçu dans la page précédente. La réponse de l’API renvoie ensuite les entrées commençant par celles qui ont une propriété de tri principale de orderby strictement supérieure à (pour l’ordre croissant) ou strictement inférieure à (pour l’ordre décroissant) la valeur spécifiée.

Par exemple, si le paramètre orderby est défini sur orderby=name,firstname, le paramètre start contient une valeur pour la propriété name. Dans ce cas, si vous souhaitez afficher les 20 entrées suivantes d’une ressource juste après le nom « Miller », vous devez utiliser : ?orderby=name,firstname&start=Miller&limit=20.

Filtrage filtering

Vous pouvez filtrer les résultats à l’aide du paramètre property, qui est utilisé pour appliquer un opérateur spécifique à une propriété JSON donnée dans les ressources récupérées. Les opérateurs pris en charge sont les suivants :

Opérateur
Description
Exemple
==
Filtre en fonction de si la propriété est égale à la valeur fournie.
property=title==test
!=
Filtre en fonction de si la propriété n’est pas égale à la valeur fournie.
property=title!=test
<
Filtre en fonction de si la valeur de la propriété est inférieure à la valeur fournie.
property=version<5
>
Filtre en fonction de si la propriété est supérieure à la valeur fournie.
property=version>5
<=
Filtre en fonction de si la propriété est inférieure ou égale à la valeur fournie.
property=version<=5
>=
Filtre selon que la propriété est supérieure ou égale à la valeur fournie.
property=version>=5
(Aucun)
En n’indiquant que le nom de la propriété renvoie uniquement les entrées où la propriété existe.
property=title
TIP
Vous pouvez utiliser le paramètre property pour filtrer les groupes de champs de schéma selon leur classe compatible. Par exemple, property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile renvoie uniquement les groupes de champs compatibles avec la classe XDM Individual Profile.

Mode de compatibilité compatibility

Experience Data Model (XDM) est une spécification documentée publiquement, pilotée par Adobe pour améliorer l’interopérabilité, l’expressivité et la puissance des expériences digitales. Adobe conserve le code source et les définitions formelles XDM dans un projet open source sur GitHub. Ces définitions sont écrites dans la notation standard XDM, et utilisent JSON-LD (JavaScript Object Notation for Linked Data) et le schéma JSON comme grammaire de définition des schémas XDM.

Lorsque vous examinez les définitions XDM formelles dans le référentiel public, vous pouvez voir que le XDM standard est différent de ce que vous voyez dans Adobe Experience Platform. Ce qui apparaît dans Experience Platform s’appelle Mode de compatibilité et celui-ci fournit un mappage simple entre le XDM standard et la manière dont il est utilisé dans Experience Platform.

Fonctionnement du mode de compatibilité

Le mode de compatibilité permet au modèle XDM JSON-LD de fonctionner avec une infrastructure de données existante en modifiant les valeurs du XDM standard tout en conservant la même sémantique. Il utilise une structure JSON imbriquée en affichant les schémas dans un format de type arbre.

La principale différence que vous noterez entre le XDM standard et le mode de compatibilité est la suppression du préfixe « xdm: » devant les noms des champs.

Le tableau ci-dessous contient une comparaison côte à côte affichant les champs associés à la date de naissance (dont les attributs « description » ont été supprimés) aux formats XDM standard et Mode de compatibilité. Notez que les champs Mode de compatibilité incluent une référence au champ XDM et à son type de données dans les attributs « meta:xdmField » et « meta:xdmType ».

XDM standard
Mode de compatibilité
{
  « xdm:bornDate » : {
    « title » : « Date de naissance »,
    « type »: « string »,
    « format »: « date »
  },
  « xdm:bornDayAndMonth » : {
    « title » : « Date de naissance »,
    « type »: « string »,
    « pattern » : « [0-1][0-9]-[0-9][0-9] »
  },
  « xdm:bornYear » : {
    « title » : « Année de naissance »,
    « type » : « integer »,
    « minimum » : 1,
    « maximum » : 32767
  }
}


{
  « bornDate » : {
    « title » : « Date de naissance »,
    « type »: « string »,
    « format »: « date »,
    « meta:xdmField »: « xdm:bornDate »,
    « meta:xdmType »: « date »
  },
  « bornDayAndMonth » : {
    « title » : « Date de naissance »,
    « type »: « string »,
    « pattern » : « [0-1][0-9]-[0-9][0-9] »,
    « meta:xdmField »: « xdm:bornDayAndMonth »,
    « meta:xdmType »: « string »
  },
  « bornYear » : {
    « title » : « Année de naissance »,
    « type » : « integer »,
    « minimum » : 1,
    « maximum » : 32767,
    « meta:xdmField »: « xdm:bornYear »,
    « meta:xdmType » : « short »
  }
}

Pourquoi le mode de compatibilité est-il nécessaire ?

Adobe Experience Platform est conçu de manière à fonctionner avec plusieurs solutions et services possédant chacun leurs propres défis et limitations techniques (par exemple, la manière dont certaines technologies traitent les caractères spéciaux). Le mode de compatibilité a été développé dans le but de surpasser ces limites.

La plupart des services Experience Platform, notamment Catalog, Data Lake et Real-Time Customer Profile, utilisent Compatibility Mode au lieu de XDM standard. L’API Schema Registry utilise également Compatibility Mode et les exemples de ce document sont tous présentés à l’aide de Compatibility Mode.

Il est intéressant de savoir qu’un mappage a lieu entre le XDM standard et la manière dont il est opérationnalisé dans Experience Platform, mais cela ne doit pas affecter votre utilisation des services Experience Platform.

Le projet open source est à votre disposition, mais lorsqu’il s’agit d’interagir avec des ressources par le biais du Schema Registry, les exemples d’API dans ce document fournissent les bonnes pratiques que vous devez connaître et suivre.

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07