Modèle CSV vers point d’entrée de l’API de conversion de schéma
La variable /rpc/csv2schema
du point de terminaison Schema Registry L’API vous permet de créer automatiquement un schéma de modèle de données d’expérience (XDM) à l’aide d’un fichier CSV comme modèle. À l’aide de ce point de terminaison, vous pouvez créer des modèles pour importer en bloc des champs de schéma et réduire le travail manuel de l’API ou de l’interface utilisateur.
Prise en main
La variable /rpc/csv2schema
Le point de terminaison fait partie de la variable Schema Registry API. Avant de poursuivre, veuillez consulter la section guide de prise en main pour obtenir des liens vers la documentation connexe, un guide de lecture des exemples d’appels API de ce document, ainsi que des informations importantes concernant les en-têtes requis pour réussir les appels à une API Adobe Experience Platform.
La variable /rpc/csv2schema
Le point d’entrée fait partie des appels de procédure distants (RPC) pris en charge par la fonction Schema Registry. Contrairement aux autres points de terminaison dans la variable Schema Registry API, les points de terminaison RPC ne nécessitent pas d’en-têtes supplémentaires comme Accept
ou Content-Type
, et n’utilisez pas de CONTAINER_ID
. Ils doivent plutôt utiliser la variable /rpc
, comme illustré dans les appels API ci-dessous.
Exigences relatives aux fichiers CSV
Pour utiliser ce point de terminaison, vous devez d’abord créer un fichier CSV avec les en-têtes de colonne appropriés et les valeurs correspondantes. Certaines colonnes sont obligatoires, tandis que les autres sont facultatives. Le tableau ci-dessous décrit ces colonnes et leur rôle dans la construction du schéma.
isIgnored
true
, indique que le champ n’est pas prêt pour le chargement de l’API et doit être ignoré.isCustom
fieldGroupId
fieldGroupName
Facultatif pour les champs personnalisés n’étendant pas les champs standard existants. Si rien n’est indiqué, le système attribue automatiquement le nom.
Requis pour les champs standard ou personnalisés étendant des groupes de champs standard utilisés pour interroger la variable
fieldGroupId
.fieldPath
fieldGroupName
), définissez la valeur sur ALL
.displayName
fieldDescription
dataType
If
dataType
est défini sur object
, soit properties
ou $ref
doit également être définie pour la même ligne, mais pas les deux.isRequired
isArray
dataType
.isIdentity
identityNamespace
isIdentity
est vraiisPrimaryIdentity
minimum
maximum
enum
[value1,value2,value3]
).stringPattern
format
minLength
maxLength
properties
dataType
est défini sur object
et $ref
n’est pas définie. Cela définit le corps de l’objet sous la forme d’une chaîne JSON (par exemple, {"myField": {"type": "string"}}
).$ref
dataType
est défini sur object
et properties
n’est pas définie. Cela définit la variable $id
de l’objet référencé pour le type d’objet (par exemple, https://ns.adobe.com/xdm/context/person
).comment
isIgnored
est défini sur true
, cette colonne est utilisée pour fournir les informations de l’en-tête du schéma.Reportez-vous aux Modèle CSV pour déterminer le format de votre fichier CSV.
Création d’une payload d’exportation à partir d’un fichier CSV
Une fois que vous avez configuré votre modèle CSV, vous pouvez envoyer le fichier au /rpc/csv2schema
et convertissez-le en payload d’exportation.
Format d’API
POST /rpc/csv2schema
Requête
Le payload de requête doit utiliser les données de formulaire comme format. Les champs de formulaire requis sont présentés ci-dessous.
curl -X POST \
https://platform.adobe.io/data/foundation/schemaregistry/rpc/csv2schema \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-F 'csv-file=@"/Users/userName/Documents/sample-csv-template.csv"' \
-F 'schema-class-id="https://ns.adobe.com/xdm/context/profile"' \
-F 'schema-name="Example Schema"' \
-F 'schema-description="Example schema description."'
csv-file
schema-class-id
$id
de XDM class que ce schéma utilisera.schema-name
schema-description
Réponse
Une réponse réussie renvoie un payload d’exportation généré à partir du fichier CSV. La payload prend la forme d’un tableau et chaque élément du tableau est un objet qui représente un composant XDM dépendant pour le schéma. Sélectionnez la section ci-dessous pour afficher un exemple complet de payload d’exportation générée à partir d’un fichier CSV.
code language-json |
---|
|
Importation de la payload de schéma
Après avoir généré la payload d’exportation à partir du fichier CSV, vous pouvez envoyer cette payload à la variable /rpc/import
point d’entrée pour générer le schéma.
Voir guide de point de fin d’importation pour plus d’informations sur la génération de schémas à partir de payloads d’exportation.