Experience PlatformAPI基礎知識

Adobe Experience Platform API採用數個重要的基礎技術和語法,以有效管理JSON型Platform資源。 本檔案提供這些技術的簡短概觀,以及外部檔案的連結以取得詳細資訊。

JSON指標 json-pointer

JSON指標是標準化的字串語法(RFC 6901),用於識別JSON檔案內的特定值。 JSON指標是以/字元分隔的權杖字串,指定了物件索引鍵或陣列索引,而權杖可以是字串或數字。 Platform API的許多PATCH作業都會使用JSON指標字串,如本檔案稍後所述。 如需JSON指標的詳細資訊,請參閱JSON指標概觀檔案

範例JSON結構描述物件

以下JSON代表簡化的XDM結構描述,其欄位可使用JSON指標字串參照。 請注意,所有使用自訂結構描述欄位群組(例如loyaltyLevel)新增的欄位,都是在_{TENANT_ID}物件底下命名的,而使用核心欄位群組(例如fullName)新增的欄位則否。

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

根據結構描述物件的JSON指標範例

JSON指標
解析為
"/title"
"Example schema"
"/properties/person/properties/name/properties/fullName"
(傳回核心欄位群組提供的fullName欄位參考。)
"/properties/_{TENANT_ID}/properties/loyaltyLevel"
(傳回自訂欄位群組提供的loyaltyLevel欄位參考。)
"/properties/_{TENANT_ID}/properties/loyaltyLevel/enum"
["platinum", "gold", "silver", "bronze"]
"/properties/_{TENANT_ID}/properties/loyaltyLevel/enum/0"
"platinum"
NOTE
處理Experience Data Model (XDM)描述項的xdm:sourcePropertyxdm:destinationProperty屬性時,任何properties索引鍵都必須從JSON指標字串中​ 排除。 如需詳細資訊,請參閱描述元上的Schema Registry API開發人員指南子指南。

JSON修補程式 json-patch

Platform API有許多接受JSON修補程式物件的PATCH作業,以供其要求裝載使用。 JSON修補程式是標準化格式(RFC 6902),用於說明JSON檔案的變更。 它可讓您定義JSON的部分更新,而不需在請求內文中傳送整個檔案。

範例JSON修補程式物件

{
  "op": "remove",
  "path": "/foo"
}
  • op:修補操作的型別。 雖然JSON修補程式支援數種不同的作業型別,但並非所有Platform API中的PATCH作業都與每種作業型別相容。 可用的作業型別為:

    • add
    • remove
    • replace
    • copy
    • move
    • test
  • path:要更新的JSON結構部分,使用JSON指標標籤法識別。

根據op中指示的作業型別,JSON修補程式物件可能需要其他屬性。 如需不同JSON修補程式操作及其所需語法的詳細資訊,請參閱JSON修補程式檔案

JSON結構描述 json-schema

JSON結構描述是一種用於說明和驗證JSON資料結構的格式。 體驗資料模型(XDM)運用JSON結構描述功能,對擷取的客戶體驗資料的結構和格式強制執行限制。 如需JSON結構描述的詳細資訊,請參閱正式檔案

後續步驟

本檔案介紹管理Experience Platform之JSON型資源相關的一些技術和語法。 如需使用Platform API (包括最佳實務)的詳細資訊,請參閱快速入門手冊。 如需常見問題的解答,請參閱平台疑難排解指南

recommendation-more-help
5741548a-2e07-44b3-9157-9c181502d0c5