ドキュメントExperience Platformエクスペリエンスデータモデル（XDM）ガイド

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

Last update: Tue Mar 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • Developer

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

前提条件

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

このガイドは必須ではありませんが、 UI でのスキーマの構成 の様々な機能を身に付ける Schema Editor.

フィールドを追加するリソースを選択 select-resource

UI で新しい XDM フィールドを定義するには、まず Schema Editor. で現在使用可能なスキーマに応じて、 Schema Libraryを使用する場合、 新しいスキーマの作成 または 編集する既存のスキーマを選択.

次に、 Schema Editor を開くと、フィールドを追加するためのコントロールがキャンバスに表示されます。 これらのコントロールは、スキーマ名の横に表示され、選択したクラスまたはフィールドグループの下で定義されたオブジェクトタイプのフィールドも表示されます。

追加アイコンがハイライトされたスキーマエディター。

WARNING
標準フィールドグループで提供されるオブジェクトにフィールドを追加しようとすると、そのフィールドグループはカスタムフィールドグループに変換され、元のフィールドグループは使用できなくなります。 詳しくは、 標準フィールドグループへのフィールドの追加 （スキーマ UI ガイド）を参照してください。

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

追加アイコンがハイライトされたスキーマエディター。

フィールドを直接スキーマに追加するか、構成するクラスとフィールドグループに追加するかに応じて、フィールドの追加に必要な手順は異なります。 このドキュメントの残りの部分では、スキーマ内でフィールドが表示される場所に関係なく、フィールドのプロパティを設定する方法に焦点を当てます。 フィールドをスキーマに追加する様々な方法について詳しくは、『スキーマ UI ガイド』の次の節を参照してください。

フィールドのプロパティを定義する define

次を選択した後： プラス (+) アイコン、 名称未設定フィールド プレースホルダーがキャンバスに表示されます。

新しい名称未設定フィールドがハイライトされたスキーマエディター。

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

Field プロパティ
説明
フィールド名

フィールドを説明する一意の名前。 スキーマを保存した後は、フィールドの名前を変更できません。 この値は、コード内のフィールドおよび他のダウンストリームアプリケーションでのフィールドの識別および参照に使用されます

名前は camelCase で書くのが理想的です。 英数字、ダッシュ、アンダースコアの各文字を使用できますが、 次の場合は不可 まず、アンダースコアを使用します。

  • 正しい: fieldName
  • 許容可能： field_name2, Field-Name, field-name_3
  • 誤った: _fieldName
表示名
フィールドの表示名。 これは、スキーマエディターキャンバス内のフィールドを表すために使用される名前です。 フィールド名は、 表示名の切り替え.
タイプ
フィールドに格納するデータのタイプ。 このドロップダウンメニューから、 標準スカラー型 XDM またはマルチフィールドの 1 つでサポートされます。 データタイプ 以前に Schema Registry.
注意： Map データ型を選択した場合、 マップ値のタイプ プロパティが表示されます。

また、 詳細タイプ検索 既存のデータ型を検索およびフィルタリングし、目的の型を見つけやすくする。
マップ値のタイプ
この値は、 マップ をフィールドのデータタイプとして設定します。 マップに使用できる値は次のとおりです。 文字列 および 整数. 使用可能なオプションのドロップダウンリストから値を選択します。
詳しくは、以下を参照してください。 タイプ固有のフィールドプロパティ」を参照してください。フィールドの定義の概要を参照してください。

各フィールドの説明とメモを指定することもできます。 以下を使用します。 説明 コンテキストを追加し、map データ型の機能を説明するフィールド。 これは、実装の保守性と読みやすさに貢献します。 また、メモを追加して、最初の説明を補完することもできます。 これにより、開発者がコードベースのコンテキスト内でマップを効果的に理解、管理、利用するのに役立つ、より詳細で具体的な情報を提供する必要があります。 |

NOTE
に応じて タイプ 「 」フィールドで「 」を選択した場合、追加の設定コントロールが右側のパネルに表示される場合があります。 詳しくは、 タイプ固有のフィールドプロパティ を参照してください。
右側のレールには、特別なフィールドタイプを指定するためのチェックボックスも表示されます。 詳しくは、 特別なフィールドタイプ を参照してください。

フィールドの設定が完了したら、「 適用.

The フィールドのプロパティ スキーマエディターの「 」セクションがハイライト表示されます。

キャンバスが更新され、新しく追加されたフィールドが、一意のテナント ID( _tenantId （以下の例）。 Adobeが提供するクラスやフィールドグループの他のフィールドとの競合を防ぐために、スキーマに追加されたすべてのカスタムフィールドは、自動的にこの名前空間内に配置されます。 右側のレールに、他のプロパティに加えて、フィールドのパスが表示されるようになりました。

スキーマダイアグラムの新しいフィールドと、 フィールドのプロパティ セクションがハイライト表示されます。

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

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

タイプ固有のフィールドプロパティ type-specific-properties

新しいフィールドを定義する際に、右側のパネルに追加の設定オプションが表示される場合があります。これは、 タイプ 「 」フィールドで「 」を選択します。 次の表に、その他のフィールドプロパティと互換性のあるタイプの概要を示します。

Field プロパティ
互換性のあるタイプ
説明
マップ値のタイプ
マップ
The マップ値のタイプ プロパティは、 タイプ ドロップダウンオプション。 Map の String 値型と Integer 値型を選択できます。
「タイプ」および「マップ」の値タイプのフィールドがハイライトされたスキーマエディター。 {width="100" modal="regular"}
注意： API を使用して作成された、String 型または Integer 型以外の map データ型は、「複雑'データタイプ。 「 」を作成できません複雑' UI を使用してデータタイプを作成できます。
デフォルト値
文字列, ダブル, Long, 整数, Short, Byte, Boolean
取り込み中に他の値が指定されない場合にこのフィールドに割り当てられるデフォルト値。 この値は、フィールドの選択されたタイプに準拠している必要があります。

デフォルト値は、時間の経過と共に変化する可能性があるので、取得時にデータセットに保存されません。 スキーマに設定されたデフォルト値は、ダウンストリームの Platform サービスやアプリケーションがデータセットからデータを読み取る際に、それらによって推論されます。 例えば、クエリサービスを使用してデータをクエリする場合、属性に NULL 値が含まれ、デフォルトはに設定されているとします。 5 スキーマレベルでは、クエリサービスは 5 NULL の代わりに使用します。 現在、この動作はすべての AEP サービスで共通ではありません。
パターン
文字列
A 正規表現 取り込み時に受け入れられるように、このフィールドの値がに準拠している必要があります。
形式
文字列

値が準拠する必要がある文字列に対して、事前定義済みの形式のリストから選択します。 使用可能な形式は次のとおりです。

最小長
文字列
取得時に受け入れられる値の最小文字数。
最大長
文字列
取得時に受け入れられる値のために、文字列に含める必要がある最大文字数です。
最小値
倍精度浮動小数点
取り込み時に受け入れられる倍精度浮動小数点型 (Double) の最小値です。 取り込んだ値がここに入力した値と完全に一致する場合は、値が受け入れられます。 この制約を使用する場合、排他的な最小値「 」制約は空白のままにする必要があります。
最大値
倍精度浮動小数点
取り込み時に受け入れられる倍精度浮動小数点型 (Double) の最大値です。 取り込んだ値がここに入力した値と完全に一致する場合は、値が受け入れられます。 この制約を使用する場合、排他的な最大値「 」制約は空白のままにする必要があります。
排他的な最小値
倍精度浮動小数点
取り込み時に受け入れられる倍精度浮動小数点型 (Double) の最大値です。 取り込んだ値がここに入力した値と完全に一致する場合、値は拒否されます。 この制約を使用する場合、最小値" （非排他）制約は空白のままにする必要があります。
排他的な最大値
倍精度浮動小数点
取り込み時に受け入れられる倍精度浮動小数点型 (Double) の最大値です。 取り込んだ値がここに入力した値と完全に一致する場合、値は拒否されます。 この制約を使用する場合、最大値" （非排他）制約は空白のままにする必要があります。

特別なフィールドタイプ special

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

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

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

次の手順

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

の機能の詳細については、 スキーマ ワークスペースについては、 スキーマ workspace の概要.

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07