Schema Registry-API-Handbuch

Die Schema Registry wird verwendet, um auf die Schemabibliothek in Adobe Experience Platform zuzugreifen und eine Benutzeroberfläche und RESTful-API bereitzustellen, von der aus auf alle verfügbaren Bibliotheksressourcen zugegriffen werden kann.

Die Schema Registry-API bietet mehrere Endpunkte, mit denen Sie alle Schemas und zugehörigen Experience-Datenmodell (XDM)-Ressourcen, die Ihnen in Platform zur Verfügung stehen, programmgesteuert verwalten können. Dazu gehören auch die von Adobe, Experience Platform und Anbietern definierten Anwendungen, die Sie verwenden.

Diese Endpunkte werden nachfolgend beschrieben. Weitere Informationen zu erforderlichen Kopfzeilen, zum Lesen von Beispiel-API-Aufrufen und mehr finden Sie in den einzelnen Endpunkthandbüchern sowie in den Ersten Schritten.

Um alle verfügbaren Endpunkte und CRUD-Vorgänge anzuzeigen, besuchen Sie die API-Referenz zur Schemaregistrierung.

Schemata

XDM-Schemata stellen die Struktur und das Format von Daten dar, die in Platform aufgenommen werden, und validieren diese. Ein Schema besteht aus einer Klasse und keiner oder mehreren Schemafeldgruppen. Sie können Schemas mithilfe des /schemas-Endpunkts erstellen, anzeigen, bearbeiten und löschen. Informationen zur Verwendung dieses Endpunkts finden Sie im Handbuch zu Schemas-Endpunkten.

Eine schrittweise Anleitung zum manuellen Erstellen eines vollständigen Schemas in der Schema Registry-API, einschließlich des Erstellens und Hinzufügens von Feldergruppen und Datentypen, finden Sie im API-Tutorial zur Schemaerstellung.

Wenn Sie CSV-Daten aufnehmen, lesen Sie den Abschnitt zur von CSV in Schemas.

Verhalten

Verhaltensweisen definieren die Art der Daten, die ein Schema beschreibt. Jede XDM-Klasse muss auf ein bestimmtes Verhalten verweisen, das alle Schemas, die diese Klasse verwenden, erben. Informationen Anzeigen verfügbarer Verhaltensweisen in der API findenim Handbuch zum Behaviors-Endpunkt .

Klassen

Eine Klasse definiert die Basisstruktur von allgemeinen Eigenschaften, die alle Schemata enthalten müssen, die auf dieser Klasse basieren, und bestimmt, welche Feldergruppen für die Verwendung in diesen Schemata geeignet sind. Jede Klasse muss mit einem vorhandenen Verhalten verknüpft sein. Weitere Informationen zur Verwendung von Klassen in API findenim Klassenendpunkthandbuch .

Feldergruppen

Feldergruppen sind wiederverwendbare Komponenten, die ein oder mehrere Felder definieren, die ein bestimmtes Konzept repräsentieren, z. B. eine einzelne Person, eine E-Mail-Adresse oder eine Webbrowser-Umgebung. Feldergruppen sind je nach dem Verhalten der Daten, die sie darstellen (Datensatz oder Zeitreihe), als Teil eines Schemas vorgesehen, das eine kompatible Klasse implementiert. Informationen Arbeiten mit Feldergruppen in der APISie im Handbuch zu Feldergruppen-Endpunkten .

Datentypen

Datentypen werden in Klassen oder Feldergruppen auf dieselbe Weise als Felder vom Typ „Verweis“ verwendet wie grundlegende Literalfelder, wobei der wesentliche Unterschied darin besteht, dass Datentypen mehrere Unterfelder definieren können. Datentypen ähneln zwar den Feldergruppen insofern, als sie die konsistente Verwendung einer Struktur mit mehreren Feldern ermöglichen, sind jedoch flexibler, da sie an einer beliebigen Stelle in die Schemastruktur aufgenommen werden können, während Feldergruppen nur auf der Stammebene hinzugefügt werden können. Weitere Informationen Arbeiten mit Datentypen in der APISie im Handbuch zum Datentypendpunkt .

Deskriptoren

Deskriptoren sind Metadatensätze, die bestimmten Feldern innerhalb eines Schemas zugewiesen werden und verschiedene kontextuelle Details bereitstellen, darunter die Beziehung dieser Felder (und des Schemas selbst) zu anderen Schemas. Auf jedes Schema können eine oder mehrere Deskriptorentitäten angewendet werden. Es gibt mehrere verschiedene Deskriptortypen, die unterschiedlichen Zwecken dienen. Weitere Informationen zum Arbeiten mit Deskriptoren in API sowieÜberblick über die verschiedenen Deskriptortypen und ihre Anwendungsfälle finden Sie im Handbuch zum descriptors-.

Vereinigungen

Platform ermöglicht es Ihnen zwar, Schemas für bestimmte Anwendungsfälle zu erstellen, aber auch, eine „Vereinigung“ von Schemas zu erstellen, die zu einer bestimmten Klasse gehören. Ein Vereinigungsschema aggregiert die Felder aller Schemata, die dieselbe Klasse haben, in einer einzigen Darstellung. Wenn Sie ein Schema für die Verwendung mit Echtzeit-Kundenprofil aktivieren, wird dieses Schema in die Vereinigung für seine bestimmte Klasse aufgenommen. Vereinigungsschemata können daher nicht direkt bearbeitet werden und können nur durch das Ein- oder Ausschließen von Schemata zur Verwendung im Profil beeinflusst werden.

Informationen zum Anzeigen von Vereinigungen in der Schema Registry-API finden Sie im Handbuch zum Vereinigungsendpunkt.

Konvertierung von CSV in Schemas csv-to-schema

Sie können automatisch ein XDM-Schema mithilfe einer CSV-Datei als Vorlage generieren, sodass Sie Vorlagen erstellen können, um Schemafelder per Massenimport zu importieren und den manuellen API- oder UI-Arbeitsaufwand zu reduzieren.

Weitere Informationen finden Sie Handbuch zum Konvertierungsendpunkt von CSVSchema .

Exportieren export

Mit der Schema Registry-API können Sie XDM-Ressourcen zwischen Sandboxes und Organisationen übertragen und freigeben. Für jedes Schema, jede Feldergruppe oder jeden Datentyp können Sie eine Export-Payload generieren, die die Struktur der Ressource und alle abhängigen Ressourcen enthält. Diese Payload kann dann zum Importieren der Ressource in eine Ziel-Sandbox und in eine Organisation verwendet werden.

Weitere Informationen Erstellen einer Export-Payload fürvorhandene XDM-Ressource finden Sie im Handbuch zum Exportieren von Endpunkten .

Importieren

Wenn Sie die Endpunkte Export oder CSV in Schema-Konversion zum Erstellen einer Export-Payload verwenden, können Sie diese Payload an eine Zielorganisation und Sandbox senden, um die angegebenen Ressourcen zu importieren.

Weitere Informationen zum Generieren von XDMRessourcen aus Export-Payloads finden SieHandbuch zum Import-Endpunkt .

Beispieldaten

Sie können Beispieldaten für jedes angegebene Schema in der Schemabibliothek generieren. Das zurückgegebene Antwortobjekt kann dann als Datenquelle für die Datenaufnahme verwendet werden.

Weitere Informationen Verwendung dieses Endpunkts findenim Handbuch zum Beispieldaten-.

Auditprotokoll

Die Schemaregistrierung verwaltet ein Protokoll aller Änderungen, die an einer Ressource (Klasse, Feldergruppe, Datentyp oder Schema) zwischen verschiedenen Aktualisierungen vorgenommen wurden. Sie können das Protokoll für eine bestimmte Ressource abrufen, indem Sie deren $id oder meta:altId im Pfad einer GET-Anfrage an diesen Endpunkt angeben.

Weitere zur Verwendung dieses Endpunkts findenim Handbuch zum audit log endpoint .

Nächste Schritte

Um mit der Durchführung von Aufrufen mit der Schema Registry API zu beginnen, lesen Sie das Erste-Schritte-Handbuch und wählen Sie dann eines der Endpunkt-Handbücher aus, um zu erfahren, wie Sie bestimmte Endpunkte verwenden.