在UI中定義XDM欄位

Adobe Experience Platform使用者介面中的Schema Editor可讓您在自訂體驗資料模型(XDM)類別和結構描述欄位群組中定義自己的欄位。 本指南涵蓋在UI中定義XDM欄位的步驟,包括每個欄位型別的可用設定選項。

先決條件

本指南需要實際瞭解XDM系統。 請參閱XDM總覽,瞭解XDM在Experience Platform生態系統中的角色簡介,以及結構描述組合的基本概念,瞭解類別和欄位群組如何對XDM結構描述貢獻欄位。

雖然本指南並非必要專案,但建議您也按照有關在UI中構成結構描述的教學課程,熟悉Schema Editor的各種功能。

選取要新增欄位的資源 select-resource

若要在UI中定義新的XDM欄位,您必須先在Schema Editor中開啟結構描述。 視您在Schema Library中目前可用的結構描述而定,您可以選擇建立新的結構描述選取要編輯的現有結構描述

開啟Schema Editor後,畫布中就會顯示要新增欄位的控制項。 這些控制項會顯示在結構描述名稱旁,以及已定義在所選類別或欄位群組下的任何物件型別欄位旁。

反白顯示新增圖示的結構描述編輯器。

WARNING
如果您嘗試將欄位新增至標準欄位群組提供的物件,該欄位群組將會轉換為自訂欄位群組,且原始欄位群組將不再可用。 如需詳細資訊,請參閱結構描述UI指南中有關新增欄位至標準欄位群組的章節。

若要新增欄位至資源,請在畫布中選取結構描述名稱旁的​ 加號(+) ​圖示,或選取您想定義其下欄位的物件型別欄位旁的圖示。

結構描述編輯器(反白顯示新增圖示)。

視您是將欄位直接新增到結構描述或其組成類別和欄位群組而定,新增欄位的必要步驟將會有所不同。 本檔案的其餘部分著重於如何設定欄位的屬性,無論該欄位出現在結構描述中的何處。 如需有關欄位可以新增到結構描述的不同方式的詳細資訊,請參閱結構描述UI指南中的下列區段:

定義欄位的屬性 define

選取​ 加號(+) ​圖示後,Untitled field​預留位置會顯示在畫布中。

反白顯示新未命名欄位的結構描述編輯器。

在​ Field properties ​下方的右側邊欄中,您可以設定新欄位的詳細資料。 每個欄位都需要下列資訊:

欄位屬性
說明
Field name

欄位的不重複、描述性名稱。 請注意,一旦結構描述已儲存,欄位名稱就無法變更。 此值用於識別及參考程式碼和其他下游應用程式中的欄位

最好以camelCase撰寫此名稱。 它可包含英數字元或底線字元,但​ 不能 ​以底線開頭。

  • 正確fieldName
  • 可接受: field_name2fieldName_3
  • 不正確_fieldName
Display name
欄位的顯示名稱。 這是將用於表示結構描述編輯器畫布中欄位的名稱。 可使用顯示名稱切換將欄位名稱變更為顯示名稱。
Type
欄位將包含的資料型別。 從這個下拉式功能表,您可以選取XDM支援的標準純量型別之一,或是先前在Schema Registry中定義的多欄位資料型別之一。
注意:如果您選取Map資料型別,則會顯示Map value type屬性。

您也可以選取​ Advanced type search ​以搜尋及篩選現有的資料型別,更輕鬆地找到所要的型別。
Map value type
如果您選取Map作為欄位的資料型別,則需要此值。 地圖可用的值為String和Integer。 從可用選項的下拉式清單中選取一個值。
若要深入瞭解特定型別的欄位屬性,請參閱定義欄位概觀。

您也可以選擇為每個欄位提供說明和附註。 使用​ Description ​欄位來新增內容,並描述對應資料型別的功能。 這有助於實施的可維護性和可讀性。 您也可以新增附註以補充初始說明。 這可提供更細微且具體的資訊,以協助開發人員在程式碼基底的情境下,有效瞭解、維護及使用地圖。 |

NOTE
根據您為欄位選取的​Type,右側邊欄中可能會顯示其他設定控制項。 如需這些控制項的詳細資訊,請參閱特定型別欄位屬性的區段。
右邊欄也提供用於指定特殊欄位型別的核取方塊。 如需詳細資訊,請參閱特殊欄位型別的相關章節。

完成欄位設定後,請選取​Apply

結構描述編輯器的Field properties區段已反白顯示。

畫布更新以顯示新新增的欄位,該欄位位於以您唯一租使用者ID命名的物件中(在以下範例中顯示為_tenantId)。 新增到結構描述的所有自訂欄位會自動放置在此名稱空間中,以防止與Adobe提供的類別和欄位群組中的其他欄位衝突。 現在,右側邊欄會列出欄位路徑以及其他屬性。

結構描述圖表中的新欄位及其在Field properties區段中的對應路徑已反白顯示。

您可以繼續依照上述步驟,將更多欄位新增至結構描述。 一旦儲存結構描述後,如果對結構描述進行任何變更,也會儲存其基底類別和欄位群組。

NOTE
您對一個結構描述的欄位群組或類別所做的任何變更,都會反映在採用它們的所有其他結構描述中。

特定型別的欄位屬性 type-specific-properties

定義新欄位時,根據您為欄位選擇的​Type,右側邊欄中可能會顯示其他設定選項。 下表概述這些額外的欄位屬性及其相容型別。

設定後,在擷取期間會強制使用屬性(例如​PatternFormat​以及長度或數值界限)。 Default value​不同:它會記錄資訊性結構描述中繼資料,不會驗證或填入擷取的資料。 請參閱下方的​ Default value ​列和表格後面的備註。

欄位屬性
相容型別
說明
Map value type
Map
只有當您從Type下拉式選項中選取Map值時,Map value type屬性才會出現在UI中。 您可以為Map在String和Integer值型別之間選取。
Schemas Editor的Type和Map值型別欄位會反白顯示。 {width="100" modal="regular"}
注意:任何透過API建立的對應資料型別,若不是String或Integer型別,則會顯示為’Complex’資料型別。 您無法透過UI建立’Complex’資料型別。
Pattern
String
此欄位值必須符合的規則運算式,才能在內嵌期間被接受。
Format
String

從值必須符合的字串預先定義格式清單中選取。 可用的格式包括:

Minimum length
String
為了能在擷取期間接受的值,字串必須包含的最小字元數。
Maximum length
String
為了能在內嵌期間接受的值,字串必須包含的最大字元數。
Minimum value
Double
內嵌期間接受的Double的最小值。 如果內嵌的值與此處輸入的值完全相符,則會接受該值。 使用此限制時,"Exclusive minimum value"限制必須保留空白。
Maximum value
Double
內嵌期間接受的Double最大值。 如果內嵌的值與此處輸入的值完全相符,則會接受該值。 使用此限制時,"Exclusive maximum value"限制必須保留空白。
Exclusive minimum value
Double
內嵌期間接受的Double最大值。 如果擷取的值與此處輸入的值完全相符,則會拒絕該值。 使用此限制時,“Minimum value” (非獨佔)限制必須保留空白。
Exclusive maximum value
Double
內嵌期間接受的Double最大值。 如果擷取的值與此處輸入的值完全相符,則會拒絕該值。 使用此限制時,“Maximum value” (非獨佔)限制必須保留空白。
Default value
結構描述編輯器中支援JSON結構描述default的純量型別(例如String和Boolean)
JSON結構描述 default語意一致的資訊中繼資料,並儲存在結構描述定義中。 在內嵌或資料準備流程期間,不會自動套用已設定的值。 除非在資料流中明確對應或轉換,否則省略的欄位仍然不存在。 請參閱定義必要欄位

特殊欄位型別 special

右邊欄提供數個核取方塊,可指定所選欄位的特殊角色。 其中部分選項的使用案例涉及有關您的資料模型化策略以及您打算如何使用下游Experience Platform服務的重要考量。

若要深入瞭解這些特殊型別,請參閱下列檔案:

雖然從技術上講不是特殊欄位型別,但建議您造訪有關定義物件型別欄位的指南,以進一步瞭解如何在結構描述結構時定義巢狀子欄位。

後續步驟

本指南概述如何在UI中定義XDM欄位。 請記住,欄位只能透過使用類別和欄位群組新增到結構描述中。 若要進一步瞭解如何在UI中管理這些資源,請參閱建立和編輯類別欄位群組的指南。

如需Schemas工作區功能的詳細資訊,請參閱Schemas工作區概觀

recommendation-more-help
experience-platform-help-xdm