Modèle CSV vers point d’entrée de l’API de conversion de schéma
Le point d’entrée /rpc/csv2schema
de l’API Schema Registry 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 en tant que 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.
Commencer
Le point d’entrée /rpc/csv2schema
fait partie de l’ Schema Registry API. Avant de poursuivre, consultez le guide de prise en main pour obtenir des liens vers la documentation connexe, un guide de lecture d’exemples d’appels API dans ce document et des informations importantes sur les en-têtes requis pour réussir les appels à une API Adobe Experience Platform.
Le point d’entrée /rpc/csv2schema
fait partie des appels de procédure distante (RPC) pris en charge par Schema Registry. Contrairement à d’autres points de terminaison dans l’API Schema Registry, les points de terminaison RPC ne nécessitent pas d’en-têtes supplémentaires tels que Accept
ou Content-Type
et n’utilisent pas un CONTAINER_ID
. Au lieu de cela, ils doivent utiliser l’espace de noms /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, qui est utilisé pour interroger le
fieldGroupId
.fieldPath
fieldGroupName
), définissez la valeur sur ALL
.displayName
fieldDescription
dataType
Si
dataType
est défini sur object
, properties
ou $ref
doit également être défini pour la même ligne, mais pas les deux.isRequired
isArray
dataType
indiqué.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éfini. 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éfini. Cela définit le $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 d’en-tête du schéma.Reportez-vous au modèle CSV suivant pour déterminer comment votre fichier CSV doit être formaté.
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 point de terminaison /rpc/csv2schema
et le convertir en charge utile 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 la classe XDM 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 au point de terminaison /rpc/import
pour générer le schéma.
Pour plus d’informations sur la génération de schémas à partir de payloads d’exportation, reportez-vous au guide de point d’entrée d’import .