Experience Platform di base API

Le API di Adobe Experience Platform utilizzano diverse tecnologie e sintassi di base importanti per gestire in modo efficace le risorse Platform basate su JSON. Questo documento fornisce una breve panoramica di queste tecnologie e collegamenti alla documentazione esterna per ulteriori informazioni.

Puntatore JSON

JSON Pointer è una sintassi di stringa standardizzata (RFC 6901) per identificare valori specifici all'interno dei documenti JSON. Un puntatore JSON è una stringa di token separati da / caratteri, che specificano le chiavi dell’oggetto o gli indici della matrice e i token possono essere una stringa o un numero. Le stringhe del puntatore JSON vengono utilizzate in molte operazioni PATCH per le API Platform , come descritto più avanti in questo documento. Per ulteriori informazioni sul puntatore JSON, consulta la documentazione sulla panoramica del puntatore JSON.

Esempio di oggetto schema JSON

Il seguente JSON rappresenta uno schema XDM semplificato ai cui campi può essere fatto riferimento utilizzando le stringhe JSON Pointer. Tenere presente che tutti i campi aggiunti utilizzando i gruppi di campi di schema personalizzati (ad esempio loyaltyLevel) sono preceduti da un namespace in un oggetto _{TENANT_ID}, mentre i campi aggiunti utilizzando i gruppi di campi di base (ad esempio fullName) non vengono aggiunti.

{
  "$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"
        }
      }
    }
  }
}

Esempio di puntatori JSON basati sull’oggetto schema

Puntatore JSON Risolve in
"/title" "Example schema"
"/properties/person/properties/name/properties/fullName" (Restituisce un riferimento al campo fullName, fornito da un gruppo di campi di base.)
"/properties/_{TENANT_ID}/properties/loyaltyLevel" (Restituisce un riferimento al campo loyaltyLevel, fornito da un gruppo di campi personalizzato.)
"/properties/_{TENANT_ID}/properties/loyaltyLevel/enum" ["platinum", "gold", "silver", "bronze"]
"/properties/_{TENANT_ID}/properties/loyaltyLevel/enum/0" "platinum"
NOTA

Quando si gestiscono gli attributi xdm:sourceProperty e xdm:destinationProperty dei descrittori Experience Data Model (XDM), tutte le chiavi properties devono essere escluse dalla stringa del puntatore JSON. Per ulteriori informazioni, consulta la guida per gli sviluppatori Schema Registry API nella sezione dedicata ai descrittori .

Patch JSON

Esistono molte operazioni PATCH per le API Platform che accettano oggetti Patch JSON per i payload della richiesta. La patch JSON è un formato standardizzato (RFC 6902) per la descrizione delle modifiche a un documento JSON. Consente di definire aggiornamenti parziali a JSON senza dover inviare l’intero documento nel corpo della richiesta.

Esempio di oggetto Patch JSON

{
  "op": "remove",
  "path": "/foo"
}
  • op: Tipo di operazione patch. Mentre la patch JSON supporta diversi tipi di operazioni, non tutte le operazioni PATCH nelle API Platform sono compatibili con ogni tipo di operazione. I tipi di operazioni disponibili sono:
    • add
    • remove
    • replace
    • copy
    • move
    • test
  • path: La parte della struttura JSON da aggiornare, identificata utilizzando il puntatore JSON.

A seconda del tipo di operazione indicato in op, l’oggetto Patch JSON potrebbe richiedere proprietà aggiuntive. Per ulteriori informazioni sulle diverse operazioni di patch JSON e la relativa sintassi richiesta, consulta la documentazione sulle patch JSON.

Schema JSON

Lo schema JSON è un formato utilizzato per descrivere e convalidare la struttura dei dati JSON. Experience Data Model (XDM) sfrutta le funzionalità dello schema JSON per applicare vincoli alla struttura e al formato dei dati sulla customer experience acquisiti. Per ulteriori informazioni sullo schema JSON, consulta la documentazione ufficiale.

Passaggi successivi

In questo documento sono state introdotte alcune delle tecnologie e delle sintassi associate alla gestione delle risorse basate su JSON per Experience Platform. Per ulteriori informazioni sull’utilizzo delle API di Platform, incluse le best practice, consulta la guida introduttiva . Per le risposte alle domande frequenti, consulta la Guida alla risoluzione dei problemi della piattaforma.

In questa pagina

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now