Grundläggande om Experience Platform API

Adobe Experience Platform API:er använder flera underliggande tekniker och syntaxer som är viktiga att förstå för att effektivt hantera JSON-baserade Platform-resurser. Dokumentet innehåller en kort översikt över dessa tekniker samt länkar till extern dokumentation för mer information.

JSON-pekare json-pointer

JSON-pekaren är en standardiserad strängsyntax (RFC 6901) för att identifiera specifika värden i JSON-dokument. En JSON-pekare är en sträng med variabler som avgränsas med / tecken, som anger antingen objektnycklar eller matrisindex, och tokenerna kan vara en sträng eller ett tal. JSON-pekarsträngar används i många PATCH-åtgärder för Platform API:er, vilket beskrivs senare i det här dokumentet. Mer information om JSON-pekare finns i översiktsdokumentationen för JSON-pekaren.

Exempel på JSON-schemaobjekt

Följande JSON representerar ett förenklat XDM-schema vars fält kan refereras med JSON-pekarsträngar. Observera att alla fält som har lagts till med anpassade schemafältgrupper (till exempel loyaltyLevel) namnges under ett _{TENANT_ID} -objekt, medan fält som har lagts till med huvudfältgrupper (till exempel fullName) inte namnges.

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/85a4bdaa168b01bf44384e049fbd3d2e9b2ffaca440d35b9",
  "meta:altId": "_{TENANT_ID}.schemas.85a4bdaa168b01bf44384e049fbd3d2e9b2ffaca440d35b9",
  "meta:resourceType": "schemas",
  "version": "1.0",
  "title": "Example schema",
  "type": "object",
  "description": "This is an example schema.",
  "properties": {
    "_{TENANT_ID}": {
      "type": "object",
      "properties": {
        "loyaltyLevel": {
          "title": "Loyalty Level",
          "description": "",
          "type": "string",
          "isRequired": false,
          "enum": [
            "platinum",
            "gold",
            "silver",
            "bronze"
          ]
        }
      }
    },
    "person": {
      "title": "Person",
      "description": "An individual actor, contact, or owner.",
      "type": "object",
      "properties": {
        "name": {
          "title": "Full name",
          "description": "The person's full name.",
          "type": "object",
          "properties": {
            "fullName": {
              "title": "Full name",
              "type": "string",
              "description": "The full name of the person, in writing order most commonly accepted in the language of the name.",
            },
            "suffix": {
              "title": "Suffix",
              "type": "string",
              "description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc.",
            }
          },
          "meta:referencedFrom": "https://ns.adobe.com/xdm/context/person-name",
          "meta:xdmField": "xdm:name"
        }
      }
    }
  }
}

Exempel på JSON-pekare baserat på schemaobjekt

JSON Patch json-patch

Det finns många PATCH-åtgärder för Platform API:er som accepterar JSON Patch-objekt för deras begärandenyttolaster. JSON Patch är ett standardiserat format (RFC 6902) för att beskriva ändringar i ett JSON-dokument. Det gör att du kan definiera partiella uppdateringar av JSON utan att behöva skicka hela dokumentet i en begärandetext.

Exempel på JSON-lagningsobjekt

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

Beroende på vilken åtgärdstyp som anges i op kan JSON Patch-objektet kräva ytterligare egenskaper. Mer information om olika JSON-korrigeringsåtgärder och deras syntax som krävs finns i JSON-korrigeringsdokumentationen.

JSON-schema json-schema

JSON-schema är ett format som används för att beskriva och validera JSON-datastrukturen. Experience Data Model (XDM) använder JSON-schemafunktioner för att framtvinga begränsningar av strukturen och formatet för inkapslade kundupplevelsedata. Mer information om JSON-schema finns i den officiella dokumentationen.

Nästa steg

I det här dokumentet introducerades några av de tekniker och syntaxer som används för att hantera JSON-baserade resurser för Experience Platform. Mer information om hur du arbetar med plattforms-API:er finns i komma igång-guiden, inklusive bästa praxis. Svar på vanliga frågor finns i felsökningsguiden för plattformen.