Dokumentation Experience Platform Handbuch zum Experience-Datenmodell (XDM)

Handbuch zur Schema Registry-API

Letzte Aktualisierung: 4. April 2025

Themen:

Erstellt für:

Entwickler

Dieses Dokument enthält zusätzliche Informationen zur Arbeit mit der Schema Registry-API.

Verwenden von Abfrageparametern

Der Schema Registry unterstützt die Verwendung von Abfrageparametern zum Seiten- und Filtern von Ergebnissen beim Auflisten von Ressourcen.

NOTE

Wenn mehrere Abfrageparameter kombiniert werden, müssen diese durch Und-Zeichen (&) getrennt werden.

Paging

Zu den häufigsten Abfrageparametern für das Paging gehören:

Parameter	Beschreibung
`orderby`	Sortieren Sie die Ergebnisse nach einer bestimmten Eigenschaft. Beispiel: `orderby=title` sortiert die Ergebnisse in aufsteigender Reihenfolge (A-Z) nach Titel. Wenn Sie vor dem Parameterwert (`orderby=-title`) einen `-` hinzufügen, werden die Elemente nach Titel in absteigender Reihenfolge sortiert (Z-A).
`limit`	Bei Verwendung in Verbindung mit einem `orderby` beschränkt `limit` die maximale Anzahl von Elementen, die für eine bestimmte Anfrage zurückgegeben werden sollen. Dieser Parameter kann nicht verwendet werden, ohne dass ein `orderby` Parameter vorhanden ist. Der Parameter `limit` gibt eine positive Ganzzahl (zwischen `0` und `500`) als Hinweis für die maximale Anzahl der zurückzugebenden Elemente an. Beispielsweise gibt `limit=5` nur fünf Ressourcen in der Liste zurück. Dieser Wert wird jedoch nicht strikt eingehalten. Die tatsächliche Antwortgröße kann kleiner oder größer sein, wenn dies durch die Notwendigkeit, den zuverlässigen Betrieb des `start`, falls vorhanden, zu gewährleisten, eingeschränkt ist.
`start`	Bei Verwendung in Verbindung mit einem `orderby`-Parameter gibt `start` an, wo die untergeordnete Liste von Elementen beginnen soll. Dieser Parameter kann nicht verwendet werden, ohne dass ein `orderby` Parameter vorhanden ist. Dieser Wert kann aus dem Attribut `_page.next` einer Listenantwort abgerufen und zum Zugriff auf die nächste Ergebnisseite verwendet werden. Wenn der `_page.next` null ist, ist keine zusätzliche Seite verfügbar. Normalerweise wird dieser Parameter weggelassen, um die erste Ergebnisseite zu erhalten. Danach sollte `start` auf den Höchstwert der primären Sortiereigenschaft des auf der vorherigen Seite empfangenen `orderby` gesetzt werden. Die API-Antwort gibt dann Einträge zurück, die mit jenen beginnen, die eine primäre Sortiereigenschaft von `orderby` haben, die streng größer (für aufsteigende Werte) oder streng kleiner (für absteigende Werte) als der angegebene Wert ist. Wenn der `orderby` beispielsweise auf `orderby=name,firstname` gesetzt ist, würde der `start` einen Wert für die `name`-Eigenschaft enthalten. Wenn Sie in diesem Fall die nächsten 20 Einträge einer Ressource anzeigen möchten, die unmittelbar auf den Namen „Miller“ folgen, würden Sie Folgendes verwenden: `?orderby=name,firstname&start=Miller&limit=20`.

Filterung

Sie können die Ergebnisse mithilfe des property-Parameters filtern, mit dem ein bestimmter Operator auf eine bestimmte JSON-Eigenschaft in den abgerufenen Ressourcen angewendet wird. Zu den unterstützten Operatoren gehören:

Operator	Beschreibung	Beispiel
`==`	Filtert, ob die Eigenschaft dem angegebenen Wert entspricht.	`property=title==test`
`!=`	Filtert danach, ob die Eigenschaft dem angegebenen Wert nicht entspricht.	`property=title!=test`
`<`	Filtert nach dem Wert, ob die Eigenschaft kleiner als der angegebene Wert ist.	`property=version<5`
`>`	Filtert danach, ob die Eigenschaft größer als der angegebene Wert ist.	`property=version>5`
`<=`	Filtert danach, ob die Eigenschaft kleiner oder gleich dem angegebenen Wert ist.	`property=version<=5`
`>=`	Filtert danach, ob die Eigenschaft größer oder gleich dem angegebenen Wert ist.	`property=version>=5`
(Keine)	Wenn nur der Eigenschaftsname angegeben wird, werden nur die Einträge zurückgegeben, bei denen die Eigenschaft vorhanden ist.	`property=title`

TIP

Sie können den property-Parameter verwenden, um Schemafeldgruppen nach ihrer kompatiblen Klasse zu filtern. Beispielsweise gibt property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile nur Feldergruppen zurück, die mit der XDM Individual Profile-Klasse kompatibel sind.

Kompatibilitätsmodus

Experience Data Model (XDM) ist eine öffentlich dokumentierte Spezifikation, die von Adobe unterstützt wird, um die Interoperabilität, Ausdruckskraft und Leistungsfähigkeit digitaler Erlebnisse zu verbessern. Adobe verwaltet den Quell-Code und formale XDM-Definitionen in einem Open-Source-Projekt auf GitHub. Diese Definitionen werden in XDM Standard Notation geschrieben, wobei JSON-LD (JavaScript Object Notation for Linked Data) und JSON-Schema als Grammatik zur Definition von XDM-Schemata verwendet werden.

Wenn Sie sich die formalen XDM-Definitionen im öffentlichen Repository ansehen, können Sie erkennen, dass sich das Standard-XDM von dem unterscheidet, das Sie in Adobe Experience Platform sehen. Was Sie in Experience Platform sehen, wird als Kompatibilitätsmodus bezeichnet und bietet eine einfache Zuordnung zwischen standardmäßigem XDM und der Art und Weise, wie es in Experience Platform verwendet wird.

Funktionsweise des Kompatibilitätsmodus

Der Kompatibilitätsmodus ermöglicht es dem XDM JSON-LD-Modell, mit der vorhandenen Dateninfrastruktur zu arbeiten, indem Werte innerhalb des XDM-Standards verändert werden, während die Semantik gleich bleibt. Es verwendet eine verschachtelte JSON-Struktur, die Schemata in einem baumähnlichen Format anzeigt.

Der Hauptunterschied, den Sie zwischen Standard-XDM und Kompatibilitätsmodus bemerken, ist die Entfernung des Präfix „xdm:“ für Feldnamen.

Im Folgenden finden Sie einen Vergleich, der sowohl im Standard-XDM als auch im Kompatibilitätsmodus geburtstagsbezogene Felder (mit entfernten „Beschreibungsattributen“) nebeneinander anzeigt. Beachten Sie, dass die Felder für den Kompatibilitätsmodus einen Verweis auf das XDM-Feld und seinen Datentyp in den Attributen „meta:xdmField“ und „meta:xdmType“ enthalten.

Standard-XDM Kompatibilitätsmodus

Standard-XDM	Kompatibilitätsmodus
`{ „xdm:bornDate“: { „title“: „Birth Date“, „type“: „string“, „format“: „date“ }, „xdm:bornDayAndMonth“: { „title“: „Birth Date“, „type“: „string“, „Muster“: "[0-1][0-9]-[0-9][0-9]" }, „xdm:BirthYear“: { „title“: „Birth year“, „type“: „integer“, „minimum“: 1, „Maximum“: 32767 } }`	{ „childDate“: { „title“: „Birth Date“, „type“: „string“, „format“: „date“, „meta:xdmField“: „xdm:BirthDate“, „meta:xdmType“: „date“ }, „BirthDayAndMonth“: { „title“: „Birth Date“, „type“: „string“, „Muster“: "[0-1][0-9]-[0-9][0-9]", „meta:xdmField“: „xdm:bornDayAndMonth“, „meta:xdmType“: „String“ }, „BirthYear“: { „title“: „Birth year“, „type“: „integer“, „minimum“: 1, „maximum“: 32767, „meta:xdmField“: „xdm:BirthYear“, „meta:xdmType“: „short“ } }

{
  „xdm:bornDate“: {
    „title“: „Birth Date“,
    „type“: „string“,
    „format“: „date“
  },
  „xdm:bornDayAndMonth“: {
    „title“: „Birth Date“,
    „type“: „string“,
    „Muster“: "[0-1][0-9]-[0-9][0-9]"
  },
  „xdm:BirthYear“: {
    „title“: „Birth year“,
    „type“: „integer“,
    „minimum“: 1,
    „Maximum“: 32767
  }
}

{
  „childDate“: {
    „title“: „Birth Date“,
    „type“: „string“,
    „format“: „date“,
    „meta:xdmField“: „xdm:BirthDate“,
    „meta:xdmType“: „date“
  },
  „BirthDayAndMonth“: {
    „title“: „Birth Date“,
    „type“: „string“,
    „Muster“: "[0-1][0-9]-[0-9][0-9]",
    „meta:xdmField“: „xdm:bornDayAndMonth“,
    „meta:xdmType“: „String“
  },
  „BirthYear“: {
    „title“: „Birth year“,
    „type“: „integer“,
    „minimum“: 1,
    „maximum“: 32767,
    „meta:xdmField“: „xdm:BirthYear“,
    „meta:xdmType“: „short“
  }
}

Warum ist der Kompatibilitätsmodus erforderlich?

Adobe Experience Platform ist für die Verwendung mit mehreren Lösungen und Diensten konzipiert, die jeweils eigene technische Herausforderungen und Einschränkungen aufweisen (z. B. wie bestimmte Technologien Sonderzeichen handhaben). Um diese Einschränkungen zu überwinden, wurde der Kompatibilitätsmodus entwickelt.

Die meisten Experience Platform-Services, einschließlich Catalog, Data Lake und Real-Time Customer Profile, verwenden Compatibility Mode anstelle von Standard-XDM. Die Schema Registry-API verwendet auch Compatibility Mode. Die Beispiele in diesem Dokument werden alle mit Compatibility Mode angezeigt.

Es lohnt sich, zu wissen, dass eine Zuordnung zwischen standardmäßigem XDM und der Art und Weise, wie es in Experience Platform operationalisiert wird, stattfindet. Dies sollte jedoch keine Auswirkungen auf Ihre Verwendung von Experience Platform-Services haben.

Das Open-Source-Projekt steht Ihnen zur Verfügung, aber wenn es um die Interaktion mit Ressourcen über die Schema Registry geht, bieten die API-Beispiele in diesem Dokument die Best Practices, die Sie kennen und befolgen sollten.

recommendation-more-help