結構描述登入API指南附錄

本檔案提供與使用Schema Registry API相關的補充資訊。

使用查詢引數 query

Schema Registry支援在列出資源時，使用查詢引數來分頁和篩選結果。

分頁 paging

分頁最常見的查詢引數包括：

篩選 filtering

您可以使用property引數來篩選結果，該引數可用來針對擷取的資源內的指定JSON屬性套用特定運運算元。 支援的運運算元包括：

相容性模式 compatibility

Experience Data Model (XDM)是公開記錄的規格，由Adobe驅動，以改善數位體驗的互通性、表現力和威力。 Adobe會在GitHub🔗上的開放原始碼專案中維護原始程式碼和正式XDM定義。 這些定義會使用JSON-LD (連結資料的JavaScript物件標籤法)和JSON結構描述當作定義XDM結構描述的文法，以XDM標準標籤法撰寫。

在公開存放庫中檢視正式XDM定義時，您可以看到標準XDM與您在Adobe Experience Platform中看到的不同。 您在Experience Platform中看到的稱為「相容性模式」，它提供標準XDM與其在Platform中的使用方式之間的簡單對應。

相容性模式的運作方式

相容性模式可讓XDM JSON-LD模型透過變更標準XDM中的值同時保持相同的語意來搭配現有資料基礎結構使用。 它會使用巢狀JSON結構，以樹狀格式顯示結構描述。

您會注意到標準XDM和相容性模式的主要差異，是移除欄位名稱的「xdm：」首碼。

以下並排比較顯示在標準XDM和相容模式中與生日相關的欄位（已移除「說明」屬性）。 請注意，相容性模式欄位包含對XDM欄位的參照，且其資料型別位於「meta：xdmField」和「meta：xdmType」屬性中。

{
  "xdm：birthDate"： {
    "title"： "Birth Date"，
    "type"： "string"，
    "format"： "date"
  }，
  "xdm：birthDayAndMonth"： {
    "title"： "Birth Date"，
    "type"： "string"，
    "pattern"： "[0-1][0-9]-[0-9][0-9]"
  }，
  "xdm：birthYear"： {
    "title"： "Birth year"，
    "type"： "integer"，
    "minimum"： 1，
    "maximum"： 32767
  }
}

{
  "birthDate"： {
    "title"： "Birth Date"，
    "type"： "string"，
    "format"： "date"，
    "meta：xdmField"： "xdm：birthDate"，
    "meta：xdmType"： "date"
  }，
  "birthDayAndMonth"： {
    "title"： "Birth Date"，
    "type"： "string"，
    "pattern"： "[0-1][0-9]-[0-9][0-9]"，
    "meta：xdmField"： "xdm：birthDayAndMonth"，
    "meta：xdmType"： "string"
  }，
  "birthYear"： {
    "title"： "Birth year"，
    "type"： "integer"，
    "minimum"： 1，
    "maximum"：32767，
    "meta：xdmField"： "xdm：birthYear"，
    "meta：xdmType"： "short"
  }
}

為何需要相容性模式？

Adobe Experience Platform的設計用途是與多種解決方案和服務搭配使用，而每一種解決方案和服務都有各自的技術難題和限制（例如，某些技術如何處理特殊字元）。 為了克服這些限制，我們開發了相容性模式。

大部分的Experience Platform服務（包括Catalog、Data Lake和Real-Time Customer Profile）都使用Compatibility Mode來代替標準XDM。 Schema Registry API也使用Compatibility Mode，本檔案中的範例全部使用Compatibility Mode顯示。

您應該知道在標準XDM和它在Experience Platform中的操作方式之間發生了對應，但它不應該影響您對Platform服務的使用。

您可以使用此開放原始碼專案，但若是透過Schema Registry與資源互動，本檔案中的API範例提供您應知道並遵循的最佳實務。