Guida dell’API di Schema Registry

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 Platform. Sono inclusi quelli definiti da Adobe, Experience Platform partner e 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.

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 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".

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".

Unioni

Platform consente di comporre schemi per casi d’uso specifici, ma consente anche di comporre un’"unione" di schemi appartenenti a una classe specifica. Uno schema di unione aggrega i campi di tutti gli schemi che condividono la stessa classe in un’unica rappresentazione. Attivando uno schema da utilizzare con Real-Time Customer Profile, tale schema viene incluso nell'unione per la classe specifica. Di conseguenza, gli schemi di unione non possono essere modificati direttamente e possono essere interessati solo dall’inclusione o esclusione di schemi da utilizzare nel profilo.

Per informazioni su come visualizzare le unioni nell'API del Registro di sistema dello schema, consulta la guida dell'endpoint "unions".

Conversione da CSV a schema csv-to-schema

Puoi generare automaticamente uno schema XDM utilizzando come modello un file CSV, che ti consente di creare modelli per importare in blocco i campi dello schema e ridurre il lavoro manuale dell’API o dell’interfaccia utente.

Per ulteriori informazioni, consulta la guida dell'endpoint di conversione da CSV a schema.

Esporta export

L’API Schema Registry consente di trasferire e condividere risorse XDM tra sandbox e organizzazioni. Per qualsiasi schema, gruppo di campi o tipo di dati, puoi generare un payload di esportazione contenente la struttura della risorsa ed eventuali risorse dipendenti. Questo payload può quindi essere utilizzato per importare la risorsa in una sandbox e in un’organizzazione di destinazione.

Per ulteriori informazioni su come creare un payload di esportazione per una risorsa XDM esistente, consulta la guida dell'endpoint di esportazione.

Importa

Se utilizzi gli endpoint export o CSV to schema conversion per creare un payload di esportazione, puoi inviare tale payload a un'organizzazione di destinazione e a una sandbox per importare le risorse specificate.

Per ulteriori informazioni su come generare risorse XDM dai payload di esportazione, consulta la guida dell'endpoint "import".

Dati di esempio

È possibile generare dati di esempio per qualsiasi schema specificato all'interno della Raccolta schemi. L’oggetto di risposta restituito può quindi essere utilizzato come origine dell’acquisizione dei dati.

Per ulteriori informazioni sull'utilizzo di questo endpoint, vedere la guida dell'endpoint dei dati di esempio.

Registro di controllo

Il registro degli schemi gestisce un registro di tutte le modifiche apportate a una risorsa (classe, gruppo di campi, tipo di dati o schema) tra diversi aggiornamenti. È possibile recuperare il registro per una particolare risorsa fornendo il relativo $id o meta:altId nel percorso di una richiesta GET a questo endpoint.

Per ulteriori informazioni sull'utilizzo di questo endpoint, vedere la guida dell'endpoint del registro di controllo.

Passaggi successivi

Per iniziare a effettuare chiamate utilizzando l’API Schema Registry, leggi la guida introduttiva e seleziona una delle guide degli endpoint per capire come utilizzare endpoint specifici.