Show Menu
THEMEN×

Grundlagen der Adobe Experience Platform-API

Adobe Experience Platform-APIs verwenden verschiedene zugrunde liegende Technologien und Syntaxen, die für eine effektive Verwaltung der JSON-basierten Plattformressourcen wichtig sind. Dieses Dokument bietet einen kurzen Überblick über diese Technologien sowie Links zur externen Dokumentation für weitere Informationen.

JSON-Zeiger

JSON Pointer ist eine standardisierte Zeichenfolgensyntax ( RFC 6901 ) zur Identifizierung bestimmter Werte in JSON-Dokumenten. Ein JSON-Zeiger ist eine Zeichenfolge aus Token, die durch / Zeichen getrennt ist und entweder Objektschlüssel oder Array-Indizes angeben. Die Token können eine Zeichenfolge oder eine Zahl sein. JSON-Zeigerzeichenfolgen werden in vielen PATCH-Operationen für Plattform-APIs verwendet, wie weiter unten in diesem Dokument beschrieben. Weitere Informationen zu JSON-Zeiger finden Sie in der JSON-Zeiger-Übersichtsdokumentation .

Beispiel für ein JSON-Schema

{
    "type": "object",
    "title": "Loyalty Member Details",
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/profile"
    ],
    "description": "Loyalty Program Mixin.",
    "definitions": {
        "loyalty": {
            "properties": {
                "_{TENANT_ID}": {
                    "type": "object",
                    "properties": {
                        "loyaltyId": {
                            "title": "Loyalty Identifier",
                            "type": "string",
                            "description": "Loyalty Identifier.",
                            "meta:xdmType": "string"
                        },
                        "loyaltyLevel": {
                            "title": "Loyalty Level",
                            "description": "The current loyalty program level to which the individual member belongs.",
                            "type": "string",
                            "enum": [
                                "platinum",
                                "gold",
                                "silver",
                                "bronze"
                            ],
                            "meta:enum": {
                                "platinum": "Platinum",
                                "gold": "Gold",
                                "silver": "Silver",
                                "bronze": "Bronze"
                            },
                            "meta:xdmType": "string"
                        }
                    },
                    "meta:xdmType": "object"
                }
            },
            "type": "object",
            "meta:xdmType": "object"
        }
    }
}

Beispiel für JSON-Zeiger, die auf dem Schema-Objekt basieren

JSON-Zeiger
Löst
"/title"
"Details zu Treuemitgliedern"
"/definitions/loyalty"
(Gibt den Inhalt des loyalty Objekts zurück)
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum"
["platinum", "gold", "silver", "bronze"]
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum/0"
"platinum"

JSON-Patch

Es gibt viele PATCH-Vorgänge für Plattform-APIs, die JSON-Patch-Objekte für ihre Anforderungs-Nutzdaten akzeptieren. JSON Patch ist ein standardisiertes Format ( RFC 6902 ) zur Beschreibung von Änderungen an einem JSON-Dokument. Damit können Sie Teilaktualisierungen zu JSON definieren, ohne das gesamte Dokument in einem Anforderungstext senden zu müssen.

Beispiel für ein JSON-Patch-Objekt

{
  "op": "remove",
  "path": "/foo"
}

  • op : Die Art des Patch-Vorgangs. Obwohl JSON Patch mehrere verschiedene Operationstypen unterstützt, sind nicht alle PATCH-Vorgänge in Plattform-APIs mit jedem Operationstyp kompatibel. Verfügbare Vorgangsarten sind:
    • add
    • remove
    • replace
    • copy
    • move
    • test
  • path : Der Teil der zu aktualisierenden JSON-Struktur, der mit der JSON-Zeigernotation identifiziert wird.
Je nach dem in op dem JSON Patch-Objekt angegebenen Operationstyp sind möglicherweise zusätzliche Eigenschaften erforderlich. Weitere Informationen zu den verschiedenen JSON Patch-Operationen und deren benötigter Syntax finden Sie in der JSON Patch-Dokumentation .

JSON-Schema

JSON-Schema ist ein Format, mit dem die Struktur von JSON-Daten beschrieben und validiert wird. Das Experience Data Model (XDM) nutzt JSON-Schema-Funktionen, um Beschränkungen in Bezug auf die Struktur und das Format der erfassten Kundenerlebnisdaten zu erzwingen. Weitere Informationen zum JSON-Schema finden Sie in der offiziellen Dokumentation .

Nächste Schritte

In diesem Dokument wurden einige der Technologien und Syntaxen für die Verwaltung von JSON-basierten Ressourcen für Experience Platform eingeführt. Weitere Informationen zum Arbeiten mit Plattform-APIs, einschließlich Best Practices und Antworten auf häufig gestellte Fragen, finden Sie im Handbuch zur Fehlerbehebung für Plattformen .