方案註冊表API指南附錄

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

使用查詢參數

Schema Registry支援在列出資源時,使用查詢參數來篩選結果至頁面。

注意

組合多個查詢參數時,必須以&符號(&)分隔。

尋呼

最常用於分頁的查詢參數包括:

參數 說明
start 指定列出的結果的開始位置。 此值可從清單回應的_page.next屬性中取得,並用於存取下一頁結果。 如果_page.next值為null,則沒有其他頁面可用。
limit 限制傳回的資源數。 範例:limit=5將會傳回5個資源的清單。
orderby 依特定屬性排序結果。 範例:orderby=title將依標題以升序排序結果(A-Z)。 在參數值(orderby=-title)之前新增-,將依標題以遞減順序(Z-A)排序項目。

篩選

您可以使用property參數來篩選結果,此參數可用來針對擷取的資源內的指定JSON屬性套用特定運算子。 支援的運算子包括:

運算元 說明 範例
== 依屬性是否等於提供的值來篩選。 property=title==test
!= 依屬性是否不等於提供的值來篩選。 property=title!=test
< 依屬性是否小於提供的值來篩選。 property=version<5
> 依屬性是否大於提供的值來篩選。 property=version>5
<= 依屬性是否小於或等於提供的值來篩選。 property=version<=5
>= 依屬性大於或等於提供的值來篩選。 property=version>=5
~ 依屬性是否與提供的規則運算式相符來篩選。 property=title~test$
(None) 僅聲明屬性名稱僅返回存在屬性的條目。 property=title
秘訣

您可以使用property參數,依其相容類別篩選混音。 例如,property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile僅傳回與XDM Individual Profile類別相容的混音。

相容模式

Experience Data Model (XDM)是公開記載的規格,由Adobe推動,以改善數位體驗的互用性、表現力和力量。Adobe在GitHub](https://github.com/adobe/xdm/)上的[開放原始碼專案中維護原始碼和正式的XDM定義。 這些定義是以XDM標準記法撰寫,使用JSON-LD(連結資料的JavaScript物件記法)和JSON結構描述作為定義XDM結構描述的語法。

在公共資料庫中查看正式的XDM定義時,您可以看到標準XDM與您在Adobe Experience Platform中看到的不同。 您在Experience Platform中看到的內容稱為相容模式,它提供了標準XDM與在Platform中使用方式之間的簡單映射。

相容性模式的運作方式

相容性模式可讓XDM JSON-LD模型變更標準XDM中的值,並維持相同的語義,以便與現有的資料基礎架構搭配運作。 它使用巢狀JSON結構,以樹狀格式顯示結構。

在標準XDM和相容性模式之間,您會注意到的主要區別是刪除欄位名稱的"xdm:"前置詞。

以下是並排比較,顯示標準XDM和相容性模式中與生日相關的欄位(已移除「說明」屬性)。 請注意,「相容性模式」欄位在「meta:xdmField」和「meta:xdmType」屬性中包含對XDM欄位及其資料類型的參考。

標準XDM 相容模式
        {
          "xdm:birthDate":{
              「標題」:"出生日期",
              「類型」:"字串",
              「格式」:「日期」,
          },
          "xdm:phirthDayAndMonth":{
              「標題」:"出生日期",
              「類型」:"字串",
              「模式」:"[0-1][0-9]-[0-9][0-9]",
          },
          "xdm:parthYear":{
              「標題」:"出生年"
              「類型」:"integer",
              「最小」:1,
              「最大值」:郵編:32767
        }
  
        {
          "birthDate":{
              「標題」:"出生日期",
              「類型」:"字串",
              「格式」:「日期」,
              "meta:xdmField":"xdm:birthDate",
              "meta:xdmType":"日期"
          },
          "brithDayAndMonth":{
              「標題」:"出生日期",
              「類型」:"字串",
              「模式」:"[0-1][0-9]-[0-9][0-9]",
              "meta:xdmField":"xdm:phortyDayAndMonth",
              "meta:xdmType":"字串"
          },
          "pristorYear":{
              「標題」:"出生年"
              「類型」:"integer",
              「最小」:1,
              「最大值」:32767,
              "meta:xdmField":"xdm:parthYear",
              "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範例提供您應瞭解和遵循的最佳實務。

本頁內容

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
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