UIでのXDMフィールドの定義

Adobe Experience PlatformユーザーインターフェイスのSchema Editorを使用すると、カスタムエクスペリエンスデータモデル(XDM)クラスとスキーマフィールドグループ内に独自のフィールドを定義できます。 このガイドでは、各フィールドタイプで使用可能な設定オプションなど、UIでXDMフィールドを定義する手順を説明します。

前提条件

このガイドでは、XDMシステムに関する十分な知識が必要です。 Experience Platformエコシステム内でのXDMの役割の概要については、XDMの概要を参照し、クラスとフィールドグループがXDMスキーマにフィールドを貢献する方法については、スキーマ構成の基本を参照してください。

このガイドは必須ではありませんが、 Schema Editorの様々な機能に慣れるために、 UIでのスキーマの作成に関するチュートリアルに従うことをお勧めします。

フィールドをに追加するリソースを選択します

UIで新しいXDMフィールドを定義するには、まずSchema Editor内でスキーマを開く必要があります。 Schema Libraryで現在使用可能なスキーマに応じて、新しいスキーマを作成するか、編集する既存のスキーマを選択します。

Schema Editorを開いたら、左側のレールを使用して、フィールドを定義するクラスまたはフィールドグループを選択します。 リソースが組織で定義されたカスタムリソースの場合、フィールドを追加または編集するためのコントロールがキャンバスに表示されます。 これらのコントロールは、スキーマ名の横に表示され、選択したクラスまたはフィールドグループで定義されたオブジェクトタイプのフィールドも表示されます。

メモ

選択したクラスまたはフィールドグループが、Adobeが提供するコアリソースである場合、編集できないので、上に示したコントロールは表示されません。 フィールドの追加先のスキーマがコアXDMクラスに基づいており、カスタムフィールドグループが含まれていない場合は、代わりに新しいフィールドグループを作成して、スキーマに追加できます。

リソースに新しいフィールドを追加するには、キャンバス内でスキーマ名の横にある「+」アイコンを選択するか、フィールドを定義するオブジェクトタイプフィールドの横にある「」を選択します。

リソースのフィールドの定義

プラス(+)​アイコンを選択すると、キャンバスに​新しいフィールド​が表示されます。このフィールドは、一意のテナントIDに名前空間が割り当てられたルートレベルオブジェクト内にあります(下の例では_tenantId)。 Adobeが指定したクラスやフィールドグループの他のフィールドと競合しないように、カスタムクラスやフィールドグループを使用してスキーマに追加されたすべてのフィールドは、自動的にこの名前空間内に配置されます。

フィールドのプロパティ​の下の右側のレールで、新しいフィールドの詳細を設定できます。 各フィールドには、次の情報が必要です。

Fieldプロパティ 説明
フィールド名 フィールドを説明する一意の名前。 スキーマを保存すると、フィールドの名前は変更できなくなります。

名前はcamelCaseで書くのが理想的です。英数字、ダッシュ、アンダースコアの各文字を使用できますが、先頭にアンダースコアを付けることはできません。
  • 正しい: fieldName
  • 許容可能: field_name2Field-Name field-name_3
  • 誤った構文: _fieldName
表示名 フィールドのわかりやすい名前。
タイプ フィールドに格納するデータのタイプ。 このドロップダウンメニューから、XDMでサポートされている標準のスカラ型の1つ、またはSchema Registryで以前に定義された複数フィールドデータ型の1つを選択できます。

また、「詳細タイプの検 索」を選択し て、既存のデータタイプを検索およびフィルタリングし、目的のタイプを見つけやすくすることもできます。

また、人間が読み取り可能なオプションの​説明​をフィールドに指定して、フィールドの意図した使用例に関して、より詳細なコンテキストを示すこともできます。

メモ

フィールドに選択した​タイプ​に応じて、追加の設定コントロールが右側のレールに表示される場合があります。 これらのコントロールの詳細については、タイプ固有のフィールドプロパティの節を参照してください。

右側のレールには、特別なフィールドタイプを指定するチェックボックスも表示されます。 詳しくは、特別なフィールドタイプの節を参照してください。

フィールドの設定が完了したら、「適用」を選択します。

キャンバスが更新され、フィールドの名前とタイプが表示され、右側のレールに、その他のプロパティに加えて、フィールドのパスがリストされるようになりました。

上記の手順に従って、引き続きスキーマにフィールドを追加できます。 スキーマを保存すると、基本クラスとフィールドグループに変更が加えられた場合は、そのグループも保存されます。

メモ

1つのスキーマのフィールドグループまたはクラスに対して行った変更は、それらを使用する他のすべてのスキーマに反映されます。

タイプ固有のフィールドプロパティ

新しいフィールドを定義する際に、右側のレールに追加の設定オプションが表示される場合があります(フィールドに選択した​タイプ​に応じて異なります)。 次の表に、これらの追加のフィールドプロパティと、互換性のあるタイプの概要を示します。

Fieldプロパティ 互換性のある型 説明
デフォルト値 文字列、 倍精度浮動小数点数、 長さ、 整数、 短い、 バイト、 ブール値 取得中に他の値が指定されない場合にこのフィールドに割り当てられるデフォルト値。 この値は、フィールドの選択されたタイプに準拠する必要があります。
パターン String 取得時に受け入れられるように、このフィールドの値が準拠している必要がある正規表現
形式 文字列 値が準拠する必要がある文字列に対して、事前に定義された形式のリストから選択します。 次の形式を使用できます。
最小長 文字列 取得時に受け入れられる値のために、文字列に含める必要がある最小文字数。
最大長 文字列 取得時に受け入れられる値のために、文字列に含める必要がある最大文字数。
最小値 Double 取り込み時に受け入れられる倍精度浮動小数点数の最小値です。 取り込んだ値がここに入力した値と完全に一致する場合、値が受け入れられます。 この制約を使用する場合、「排他的最小値」制約は空白のままにする必要があります。
最大値 ダブル 取り込み時に受け入れられる倍精度浮動小数点数の最大値。 取り込んだ値がここに入力した値と完全に一致する場合、値が受け入れられます。 この制約を使用する場合、「Exclusive maximum value」制約は空白のままにする必要があります。
排他的最小値 ダブル 取り込み時に受け入れられる倍精度浮動小数点数の最大値。 取り込んだ値がここに入力した値と完全に一致する場合、値は拒否されます。 この制約を使用する場合、「最小値」(非排他的)制約は空白のままにする必要があります。
排他的最大値 ダブル 取り込み時に受け入れられる倍精度浮動小数点数の最大値。 取り込んだ値がここに入力した値と完全に一致する場合、値は拒否されます。 この制約を使用する場合、「最大値」(非排他的)制約は空白のままにする必要があります。

特別なフィールドタイプ

右側のレールには、選択したフィールドの特別な役割を指定するチェックボックスがいくつか表示されます。 これらのオプションの一部の使用例には、データモデリング戦略とダウンストリームのPlatformサービスの使用方法に関する重要な考慮事項が含まれています。

これらの特殊なタイプについて詳しくは、次のドキュメントを参照してください。

  • 必須
  • 配列
  • Enum
  • ID (文字列フィールドに対してのみ使用可能)
  • 関係 (文字列フィールドに対してのみ使用可能)

技術的には特別なフィールドタイプではありませんが、スキーマ構造でネストされたサブフィールドを定義する方法について詳しくは、 オブジェクトタイプフィールドの定義のガイドを参照することをお勧めします。

次の手順

このガイドでは、UIでXDMフィールドを定義する方法の概要を説明しました。 フィールドは、クラスとフィールドグループを使用してのみスキーマに追加できます。 UIでこれらのリソースを管理する方法について詳しくは、classesおよびfield groupsの作成と編集に関するガイドを参照してください。

スキーマワークスペースの機能について詳しくは、スキーマワークスペースの概要を参照してください。

このページ