Schema Registry-API-Handbuch

Der Schema Registry wird verwendet, um auf die Schema Library in Adobe Experience Platform zuzugreifen und eine Benutzeroberfläche und RESTful-API bereitzustellen, über die alle verfügbaren Bibliotheksressourcen zugänglich sind.

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 die von Adobe, Experience Platform Partnern und Anbietern, deren Anwendungen 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.

WICHTIG

XDM verwendet die JSON-Schema-Formatierung, um die Struktur der erfassten Kundenerlebnisdaten zu beschreiben und zu validieren. Bevor Sie mit der Schema Registry-API arbeiten, wird dringend empfohlen, die offizielle JSON-Schema-Dokumentation zu lesen, um ein besseres Verständnis dieser zugrunde liegenden Technologie zu erhalten.

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

Schemas

XDM-Schemata stellen die Struktur und das Format der in Platform erfassten Daten dar und validieren sie. Ein Schema besteht aus einer Klasse und keiner oder mehr Schemafeldgruppen. Mit dem Endpunkt /schemas können Sie Schemas erstellen, anzeigen, bearbeiten und löschen. Informationen zur Verwendung dieses Endpunkts finden Sie im Schemas-Endpunkt-Handbuch.

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

Verhalten

Verhaltensweisen definieren die Art der Daten, die ein Schema beschreibt. Jede XDM-Klasse muss auf ein bestimmtes Verhalten verweisen, das von allen Schemas übernommen wird, die diese Klasse verwenden. Weitere Informationen zum Anzeigen der verfügbaren Verhaltensweisen in der API finden Sie im Endpoint-Handbuch für Verhaltensweisen .

Klassen

Eine Klasse definiert die Basisstruktur von allgemeinen Eigenschaften, die alle Schemas, die auf dieser Klasse basieren, enthalten müssen, und bestimmt, welche Feldgruppen für die Verwendung in diesen Schemas geeignet sind. Jede Klasse muss mit einem vorhandenen Verhalten verknüpft sein. Weitere Informationen zum Arbeiten mit Klassen in der API finden Sie im Klassen-Endpoint-Handbuch .

Feldergruppen

Feldergruppen sind wiederverwendbare Komponenten, die ein oder mehrere Felder definieren, die ein bestimmtes Konzept repräsentieren, z. B. eine Einzelperson, eine Postanschrift oder eine Webbrowser-Umgebung. Feldergruppen sind als Teil eines Schemas vorgesehen, das eine kompatible Klasse implementiert, je nach dem Verhalten der Daten, die sie darstellen (Datensatz oder Zeitreihen). Informationen zum Arbeiten mit Feldergruppen in der API finden Sie im Handbuch zum Feldergruppen-Endpunkt .

Datentypen

Datentypen werden in Klassen oder Feldergruppen auf die gleiche Weise wie einfache literale Felder als Referenztypen verwendet, wobei der wesentliche Unterschied darin besteht, dass Datentypen mehrere Unterfelder definieren können. Auch wenn sie Feldgruppen insofern ähnlich sind, als sie die konsistente Verwendung einer Mehrfeld-Struktur ermöglichen, sind Datentypen flexibler, da sie an einer beliebigen Stelle in die Schemastruktur aufgenommen werden können, während Feldgruppen nur auf der Stammebene hinzugefügt werden können. Weitere Informationen zum Arbeiten mit Datentypen in der API finden Sie im Endpunkthandbuch zu Datentypen .

Deskriptoren

Deskriptoren sind Metadatensätze, die bestimmten Feldern innerhalb eines Schemas zugewiesen werden und verschiedene kontextbezogene Details enthalten, einschließlich der Art und Weise, wie diese Felder (und das Schema selbst) mit anderen Schemas verbunden sind. Auf jedes Schema können eine oder mehrere Deskriptorentitäten angewendet werden, und es gibt mehrere verschiedene Deskriptortypen, die unterschiedlichen Zwecken dienen. Weitere Informationen zum Arbeiten mit Deskriptoren in der API und eine Übersicht über die verschiedenen Deskriptortypen und ihre Anwendungsfälle finden Sie im Endpunkthandbuch für Deskriptoren .

Vereinigungen

Platform ermöglicht es Ihnen zwar, Schemas für bestimmte Anwendungsfälle zu erstellen, ermöglicht es Ihnen aber auch, eine "Vereinigung"von Schemas zu erstellen, die zu einer bestimmten Klasse gehören. Ein Vereinigungsschema aggregiert die Felder aller Schemas, die dieselbe Klasse teilen, in einer einzigen Darstellung. Durch Aktivierung eines Schemas zur Verwendung mit Echtzeit-Kundenprofil wird dieses Schema in die Vereinigung für die jeweilige Klasse aufgenommen. Vereinigungsschemata können daher nicht direkt bearbeitet werden und können nur durch das Einschließen oder Ausschließen von Schemas zur Verwendung in Profil beeinflusst werden.

Informationen zum Anzeigen von Vereinigungen in der Schema Registry-API finden Sie im Vereinigungs-Endpunkthandbuch.

Export/Import

Mit der Schema Registry-API können Sie XDM-Ressourcen zwischen Sandboxes und IMS-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 verwendet werden, um die Ressource in eine Ziel-Sandbox und IMS-Organisation zu importieren.

Weitere Informationen zur Verwendung dieser Endpunkte finden Sie im Handbuch zu Export/Import-Endpunkten .

Sample data

Sie können Beispieldaten für jedes angegebene Schema in der Schema Library generieren. Das zurückgegebene Antwortobjekt kann dann als Quelle der Datenerfassung verwendet werden.

Weitere Informationen zur Verwendung dieses Endpunkts finden Sie im Beispiel-Daten-Endpunkt-Handbuch .

Auditprotokoll

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

Weitere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunkt des Auditprotokolls .

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.

Auf dieser Seite