Handbuch zur Schema Registry-API
Dieses Dokument enthält zusätzliche Informationen zum Arbeiten mit der Schema Registry-API.
Verwenden von Abfrageparametern query
Der Schema Registry unterstützt die Verwendung von Abfrageparametern zur Seite und Filterung von Ergebnissen bei der Auflistung von Ressourcen.
&) getrennt werden.Paging paging
Zu den häufigsten Abfrageparametern für das Paging gehören:
orderbyorderby=title sortiert die Ergebnisse in aufsteigender Reihenfolge (A-Z) nach Titel. Durch Hinzufügen von "-"vor dem Parameterwert (orderby=-title) werden Elemente nach Titel in absteigender Reihenfolge sortiert (Z-A).limitorderby -Parameter beschränkt limit die maximale Anzahl von Elementen, die für eine bestimmte Anfrage zurückgegeben werden sollen. Dieser Parameter kann nur verwendet werden, wenn ein orderby -Parameter vorhanden ist.Der Parameter
limit gibt eine positive Ganzzahl (zwischen 0 und 500) als Hinweis an, die die maximale Anzahl der zurückzugebenden Elemente angibt. Beispielsweise gibt limit=5 nur fünf Ressourcen in der Liste zurück. Dieser Wert wird jedoch nicht genau berücksichtigt. Die tatsächliche Antwortgröße kann kleiner oder größer sein, da eine Einschränkung darin besteht, dass der zuverlässige Vorgang des Parameters start bereitgestellt werden muss, sofern einer bereitgestellt wird.startorderby -Parameter gibt start an, wo die untergeordnete Liste von Elementen beginnen soll. Dieser Parameter kann nur verwendet werden, wenn ein orderby -Parameter vorhanden ist. Dieser Wert kann aus dem Attribut _page.next einer Listenantwort abgerufen und für den Zugriff auf die nächste Ergebnisseite verwendet werden. Wenn der _page.next -Wert 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 Maximalwert der primären Sortiereigenschaft des auf der vorherigen Seite empfangenen orderby -Felds gesetzt werden. Die API-Antwort gibt dann Einträge zurück, die mit jenen beginnen, die eine primäre Sortiereigenschaft von orderby aufweisen, die strikt größer ist als (für aufsteigende Werte) oder strikt kleiner ist als (für absteigende Werte) der angegebene Wert.Wenn der Parameter
orderby beispielsweise auf orderby=name,firstname gesetzt ist, enthält der Parameter start einen Wert für die Eigenschaft name. Wenn Sie in diesem Fall die nächsten 20 Einträge einer Ressource anzeigen möchten, die unmittelbar auf den Namen "Miller"folgt, verwenden Sie: ?orderby=name,firstname&start=Miller&limit=20.Filter filtering
Sie können Ergebnisse mithilfe des Parameters property filtern, mit dem ein bestimmter Operator auf eine bestimmte JSON-Eigenschaft in den abgerufenen Ressourcen angewendet wird. Zu den unterstützten Operatoren gehören:
==property=title==test!=property=title!=test<property=version<5>property=version>5<=property=version<=5>=property=version>=5property=titleproperty 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 Klasse XDM Individual Profile kompatibel sind.Kompatibilitätsmodus compatibility
Experience Data Model (XDM) ist eine öffentlich dokumentierte Spezifikation, die von Adobe zur Verbesserung der Interoperabilität, Ausdrucksfähigkeit und Leistungsfähigkeit digitaler Erlebnisse unterstützt wird. 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 Standard-XDM und der Art und Weise, wie es in 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.
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 -Dienste 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 und die Beispiele in diesem Dokument werden alle mit Compatibility Mode angezeigt.
Es lohnt sich zu wissen, dass eine Zuordnung zwischen dem Standard-XDM und der Art und Weise erfolgt, wie es in Experience Platform operationalisiert wird. Sie sollte jedoch Ihre Verwendung von Platform-Diensten nicht beeinträchtigen.
Das Open-Source-Projekt steht Ihnen zur Verfügung. Wenn es jedoch darum geht, mit Ressourcen über Schema Registry zu interagieren, bieten die API-Beispiele in diesem Dokument die Best Practices, die Sie kennen und befolgen sollten.