Handbuch zur Schema Registry-API

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

Verwenden von Abfrageparametern query

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

Paging paging

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

Filterung filtering

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:

Kompatibilitätsmodus compatibility

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.

{
  „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.