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

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

前提条件

このガイドでは、XDMシステムに関する十分な理解が必要です。 Experience Platformエコシステム内でのXDMの役割の説明はXDM overviewを参照し、クラスとフィールドグループがXDMスキーマにフィールドを寄与させる方法を学ぶために、スキーマ構成の基本を参照してください。

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

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

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

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

メモ

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

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

リソースのフィールドを定義する

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

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

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

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

また、「 アドバンスタイプ 検索」を選択して、既存のデータタイプを検索およびフィルタリングし、より簡単に目的のタイプを見つけることもできます。

オプションで人間が読み取り可能な​説明​をフィールドに提供し、フィールドの使用目的に関するより多くのコンテキストを提供することもできます。

メモ

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

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

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

カンバスが更新され、フィールドの名前とタイプが表示されます。右側のパネルには、他のプロパティに加えて、フィールドのパスがリストされます。

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

メモ

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

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

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

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

特殊フィールドの種類

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

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

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

次の手順

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

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

このページ