結構描述登入API指南附錄

上次更新: 2023-08-25
  • 主題:
  • Schemas
    檢視有關此主題的更多資訊
  • 建立對象:
  • Developer
    User
    Admin
    Leader

本檔案提供使用 Schema Registry API。

使用查詢引數

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

注意

結合多個查詢引數時,必須以&符號(&)。

分頁

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

參數 說明
orderby 依特定屬性排序結果。 範例: orderby=title 會依標題以遞增順序(A-Z)排序結果。 新增 - 在引數值之前(orderby=-title)會依標題以遞減順序(Z-A)排序專案。
limit 當與搭配使用時 orderby 引數, limit 限制指定請求應傳回的專案數上限。 沒有引數就無法使用此引數 orderby 出現引數。

limit 引數指定正整數(介於 0500) as a 提示 應傳回的專案數上限。 例如, limit=5 只傳回清單中的五個資源。 不過,此值並非嚴格遵循。 實際的回應大小可能會小於或大於,因為必須提供可靠的操作才行 start 引數(若有)。
start 當與搭配使用時 orderby 引數, start 指定專案子集清單的開始位置。 沒有引數就無法使用此引數 orderby 出現引數。 此值可從取得 _page.next 清單回應的屬性,並用來存取結果的下一頁。 如果 _page.next 值為null,則沒有其他可用頁面。

通常,為了獲得結果的第一頁,會省略此引數。 之後, start 應設定為以下專案的主要排序屬性最大值: orderby 在上一頁收到的欄位。 API回應接著會傳回開頭為具有主要排序屬性的專案 orderby 嚴格大於(遞增)或嚴格小於(遞減)指定值。

例如,如果 orderby 引數已設為 orderby=name,firstname,則 start 引數會包含 name 屬性。 在這種情況下,如果您想在名稱「Miller」之後立即顯示資源的接下來的20個專案,您可以使用: ?orderby=name,firstname&start=Miller&limit=20.

篩選

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

運算子 說明 範例
== 依屬性是否等於提供的值篩選。 property=title==test
!= 依據屬性是否不等於提供的值來篩選。 property=title!=test
< 依據屬性是否小於提供的值篩選。 property=version<5
> 依據屬性是否大於提供的值篩選。 property=version>5
<= 依據屬性是否小於或等於提供的值來篩選。 property=version<=5
>= 依據屬性是否大於或等於提供的值來篩選。 property=version>=5
(None) 若只陳述屬性名稱,只會傳回屬性存在的專案。 property=title
秘訣

您可以使用 property 用於依照結構描述欄位群組的相容類別來篩選結構描述欄位群組的引數。 例如, property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile 只傳回與相容的欄位群組 XDM Individual Profile 類別。

相容性模式

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

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

相容性模式的運作方式

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

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

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

標準XDM 相容性模式
{ "xdm:birthDate": { "title": "Birth Date", "type": "string", "format": "date" }, "xdm:birthDayAndMonth": { "title": "Birth Date", "type": "string", "pattern": "[0-1][0-9]-[0-9]]" }, "xdm:birthYear": { "title": "Birth", "integer": 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]", "meta:xdmField": "xdm:birthAndMonth", 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範例提供您應知道且遵循的最佳實務。

本頁內容