Guida dell’API di Schema Registry

Ultimo aggiornamento: 4 aprile 2025
  • Argomenti:

Creato per:

  • Sviluppatore

Schema Registry viene utilizzato per accedere alla libreria di schemi in Adobe Experience Platform, fornendo un'interfaccia utente e un'API RESTful da cui tutte le risorse della libreria disponibili sono accessibili.

L’API Schema Registry fornisce diversi endpoint che consentono di gestire in modo programmatico tutti gli schemi e le relative risorse Experience Data Model (XDM) disponibili in Experience Platform. Sono inclusi quelli definiti da Adobe, dai partner Experience Platform e dai fornitori di cui utilizzi le applicazioni.

Questi endpoint sono descritti di seguito. Per informazioni dettagliate, consulta le guide dei singoli endpoint e fai riferimento alla guida introduttiva per informazioni importanti sulle intestazioni richieste, sulla lettura delle chiamate API di esempio e altro ancora.

IMPORTANT
XDM utilizza la formattazione dello schema JSON per descrivere e convalidare la struttura dei dati acquisiti sull’esperienza del cliente. Prima di utilizzare l'API Schema Registry, è consigliabile rivedere la documentazione ufficiale dello schema JSON per comprendere meglio questa tecnologia sottostante.

Per visualizzare tutti gli endpoint disponibili e le operazioni CRUD, visita il Riferimento API del registro di schema.

Schemi

Gli schemi XDM rappresentano e convalidano la struttura e il formato dei dati acquisiti in Experience Platform. Uno schema è composto da una classe e da zero o più gruppi di campi dello schema. È possibile creare, visualizzare, modificare ed eliminare schemi utilizzando l'endpoint /schemas. Per informazioni su come utilizzare questo endpoint, consulta la guida dell'endpoint degli schemi.

Per una guida dettagliata su come creare manualmente uno schema completo nell'API Schema Registry, inclusa la creazione e l'aggiunta di gruppi di campi e tipi di dati, consulta l'esercitazione Creazione schema API.

Se acquisisci dati CSV, consulta la sezione su CSV in conversione schema.

Comportamenti

I comportamenti definiscono la natura dei dati descritti da uno schema. Ogni classe XDM deve fare riferimento a un comportamento specifico che verrà ereditato da tutti gli schemi che utilizzano tale classe. Per informazioni su come visualizzare i comportamenti disponibili nell'API, consulta la guida dell'endpoint dei comportamenti.

Classi

Una classe definisce la struttura di base delle proprietà comuni che tutti gli schemi basati su tale classe devono contenere e determina quali gruppi di campi sono idonei per l’utilizzo in tali schemi. Ogni classe deve essere associata a un comportamento esistente. Per informazioni dettagliate sull'utilizzo delle classi nell'API, consulta la guida dell'endpoint classes.

Gruppi di campi

I gruppi di campi sono componenti riutilizzabili che definiscono uno o più campi che rappresentano un concetto particolare, ad esempio una singola persona, un indirizzo postale o un ambiente di browser web. I gruppi di campi sono destinati a essere inclusi come parte di uno schema che implementa una classe compatibile, a seconda del comportamento dei dati che rappresentano (record o serie temporali). Per informazioni su come utilizzare i gruppi di campi nell'API, consulta la guida dell'endpoint "field groups".

Tipi di dati

I tipi di dati vengono utilizzati come campi del tipo di riferimento nelle classi o nei gruppi di campi allo stesso modo dei campi letterali di base, con la differenza fondamentale che i tipi di dati possono definire più sottocampi. Sebbene siano simili ai gruppi di campi in quanto consentono l’utilizzo coerente di una struttura a più campi, i tipi di dati sono più flessibili in quanto possono essere inclusi ovunque nella struttura dello schema, mentre i gruppi di campi possono essere aggiunti solo al livello principale. Per ulteriori informazioni sull'utilizzo dei tipi di dati nell'API, consulta la guida dell'endpoint "data types".

NOTE
Se un campo è definito come tipo di dati specifico, non è possibile creare lo stesso campo con un tipo di dati diverso in un altro schema. Questo vincolo si applica a tutto il tenant dell’organizzazione.

Descrittori

I descrittori sono insiemi di metadati assegnati a campi specifici all’interno di uno schema, che forniscono vari dettagli contestuali, tra cui il modo in cui tali campi (e lo schema stesso) sono correlati ad altri schemi. A ogni schema possono essere applicate una o più entità descrittive ed esistono diversi tipi di descrittori per scopi diversi. Per ulteriori informazioni sull'utilizzo dei descrittori nell'API e una panoramica dei diversi tipi di descrittori e dei relativi casi d'uso, consulta la guida dell'endpoint "descriptors".