UI での XDM フィールドの定義
作成対象：
- 開発者
Adobe Experience Platform ユーザーインターフェイスの Schema Editor を使用すると、カスタム Experience Data Model （XDM）クラスおよびスキーマフィールドグループ内で独自のフィールドを定義できます。 このガイドでは、各フィールドタイプで使用可能な設定オプションなど、UI で XDM フィールドを定義する手順を説明します。
前提条件
このガイドでは、XDM システムに関する十分な知識が必要です。 クラスとフィールドグループが XDM スキーマにフィールドを提供する方法については、Experience Platform エコシステムでの XDM の役割の概要および スキーマ構成の基本を参照してください XDM の概要。
このガイドには必要ありませんが、UI でのスキーマの作成に関するチュートリアルに従って、Schema Editor の様々な機能を理解することをお勧めします。
フィールドを追加するリソースを選択
UI で新しい XDM フィールドを定義するには、まず Schema Editor でスキーマを開く必要があります。 Schema Library で現在使用可能なスキーマに応じて、 新しいスキーマを作成または 編集する既存のスキーマを選択を選択できます。
Schema Editor を開くと、フィールドを追加するためのコントロールがキャンバスに表示されます。 これらのコントロールは、スキーマ名の横に表示されるほか、選択したクラスまたはフィールドグループの下で定義されたオブジェクトタイプフィールドにも表示されます。
WARNINGリソースに新しいフィールドを追加するには、キャンバスでスキーマ名の横にある プラス （+） アイコン、またはフィールドを定義するオブジェクトタイプフィールドの横にある「+」アイコンを選択します。
フィールドをスキーマに直接追加するか、その構成要素のクラスとフィールドグループに追加するかによって、フィールドの追加に必要な手順は異なります。 このドキュメントでは、スキーマ内のそのフィールドの表示場所に関係なく、フィールドのプロパティを設定する方法について重点的に説明します。 スキーマにフィールドを追加できる様々な方法について詳しくは、スキーマ UI ガイドの次の節を参照してください。
フィールドのプロパティの定義
プラス（+） アイコンを選択すると、「名称未設定フィールド プレースホルダーがキャンバスに表示されます。
フィールドプロパティ の下の右側のパネルで、新しいフィールドの詳細を設定できます。 各フィールドには次の情報が必要です。
フィールドの一意でわかりやすい名前。 スキーマが保存されると、フィールドの名前は変更できません。 この値は、コード内および他のダウンストリームアプリケーションでフィールドを識別および参照するために使用されます
この名前は、キャメルケースで記述することが理想的です。 英数字またはアンダースコア文字が含まれる場合がありますが、アンダースコアで始まる ない 場合があります。
- 正解:
fieldName - 指定できます：
field_name2、fieldName_3 - 間違った形式:
_fieldName
タイプ固有のフィールドプロパティ について詳しくはフィールド定義の概要を参照してください。
各フィールドに説明とメモを入力することもできます。 「説明」フィールドを使用してコンテキストを追加し、マップデータタイプの機能を説明します。 これにより、実装のメンテナンス性と読みやすさが向上します。 最初の説明を補完するメモを追加することもできます。 これにより、開発者がコードベースのコンテキスト内でマップを効果的に理解、維持および利用するのに役立つ、より詳細で具体的な情報が提供されます。 |
NOTEフィールドの設定が完了したら、「適用」を選択します。
キャンバスが更新され、一意のテナント ID を名前空間とするオブジェクト内に配置された、新しく追加されたフィールドが表示されます（以下の例に _tenantId 示します）。 Adobeが提供するクラスおよびフィールドグループの他のフィールドとの競合を防ぐために、スキーマに追加されたすべてのカスタムフィールドはこの名前空間内に自動的に配置されます。 右側のパネルに、フィールドのパスとその他のプロパティが表示されるようになりました。
引き続き上記の手順に従って、スキーマにさらにフィールドを追加できます。 スキーマを保存すると、基本クラスとフィールドグループも、変更がある場合は保存されます。
NOTEタイプ固有のフィールドのプロパティ
新しいフィールドを定義する際に、フィールドに選択した タイプ に応じて、追加の設定オプションが右側のパネルに表示される場合があります。 次の表に、これらの追加のフィールドプロパティと、互換性のあるタイプの概要を示します。
メモ：API で作成された、文字列タイプでも整数タイプでもないマップデータタイプは、「Complex」データタイプとして表示されます。 UI を使用して「Complex」データタイプを作成することはできません。
値が準拠する必要がある文字列の事前定義済み形式のリストから選択します。 使用可能な形式は次のとおりです。
特殊なフィールドタイプ
右側のパネルには、選択したフィールドの特別な役割を指定するためのチェックボックスがいくつか表示されます。 これらのオプションの一部のユースケースでは、データモデリング方法と、ダウンストリーム Experience Platform サービスの使用方法に関する重要な考慮事項が含まれます。
これらの特殊タイプの詳細については、次のドキュメントを参照してください。
技術的には特別なフィールドタイプではありませんが、 オブジェクトタイプのフィールドの定義に関するガイドにアクセスして、スキーマ構造に応じたネストされたサブフィールドの定義について詳しく確認することもお勧めします。
次の手順
このガイドでは、UI で XDM フィールドを定義する方法の概要を説明しました。 フィールドは、クラスとフィールドグループを使用してのみスキーマに追加できます。 UI でこれらのリソースを管理する方法について詳しくは、 クラスおよび フィールドグループの作成と編集に関するガイドを参照してください。
スキーマ ワークスペースの機能について詳しくは、 スキーマ ワークスペースの概要を参照してください。