UIでのXDMリソースの参照

Adobe Experience Platformでは、すべてのExperience Data Model(XDM)リソースがSchema Libraryに保存されます。これには、組織が提供する標準リソースや、Adobeが定義するカスタムリソースが含まれます。 Experience PlatformUIでは、Schema Library内の任意の既存のスキーマ、クラス、スキーマフィールドグループ、またはデータ型の構造とフィールドを表示できます。 これは、データ取り込みの計画と準備を行う際に特に便利です。UIは、これらのXDMリソースが提供する各フィールドに必要なデータタイプと使用例に関する情報を提供します。

このチュートリアルでは、Experience PlatformUIの既存のスキーマ、クラス、フィールドグループ、データタイプを調べる手順を説明します。

XDMリソースを検索します。

Platform UIの左側のナビゲーションで「スキーマ」を選択します。 スキーマワークスペースには、「参照」タブがあり、組織内のすべての既存のXDMリソースを調査できます。また、クラス、フィールドグループ、データ型​を調査する専用タブもあります。

「参照」タブで、フィルターアイコン（）を使用して左側のレールにコントロールを表示し、リストに表示されている結果を絞り込むことができます。

例えば、Adobeが提供する標準データ型のみを表示するようにリストをフィルタリングするには、型​と​Adobe​の下の​データ型​と​所有者​を選択します。

「プロファイルに含める」トグルを使用すると、結果をフィルタして、リアルタイム顧客プロファイルでの使用が有効になっているスキーマで使用されているリソースのみを表示できます。

検索バーを使用して、結果をさらに絞り込むこともできます。 キーワードを検索する場合、最上位の項目は検索クエリと名前が一致するリソースを表します。 これらの項目の下の​標準フィールド​には、クエリに一致するフィールドを含むリソースがすべて表示されます。 これにより、XDMリソースの名前を事前に知る必要なく、XDMリソースを含むデータのタイプに基づいて検索できます。

検索結果に表示されるリソースは、まずタイトルの一致で順に並べられ、次に説明の一致で順に並べられます。 次に、これらのいずれかのカテゴリで一致する単語が多いほど、リストに表示されるリソースは高くなります。

調査するリソースが見つかったら、リストから名前を選択し、キャンバスの構造を表示します。

キャンバスでXDMリソースを調べます。

リソースを選択すると、キャンバスにその構造が表示されます。

サブプロパティを含むオブジェクトタイプのフィールドは、最初にキャンバスに表示されたときに、デフォルトですべて折りたたまれます。 フィールドのサブプロパティを表示するには、名前の横のアイコンを選択します。

システム生成フィールド

一部のフィールド名の先頭にアンダースコアが付くもの（_repoや_idなど）があります。 これらは、データの取り込み時に自動的に生成および割り当てを行うフィールドのプレースホルダです。

したがって、これらのフィールドのほとんどは、プラットフォームに取り込む際に、データの構造から除外する必要があります。 この規則の主な例外は_{TENANT_ID}フィールドです。組織で作成するすべてのXDMフィールドは、以下の名前に置く必要があります。

データタイプ

キャンバスに表示される各フィールドについて、名前の横に対応するデータタイプが表示され、一目で取り込みが必要なデータのタイプを示します。

角括弧([])が付いたデータ型は、そのデータ型の配列を表します。 例えば、String[]​のデータ型は、フィールドに文字列値の配列が必要であることを示します。 支払い項目[]​のデータ型は、支払い項目のデータ型に準拠するオブジェクトの配列を示します。

配列フィールドがオブジェクトタイプに基づいている場合は、キャンバスでそのアイコンを選択して、各配列項目に対して必要な属性を表示できます。

フィールドプロパティ

キャンバス内のフィールドの名前を選択すると、右側のパネルが更新され、フィールドプロパティ​の下にそのフィールドの詳細が表示されます。 例えば、フィールドの使用例、デフォルト値、パターン、形式、必須フィールドかどうかに関係なく、その他の説明を入力できます。

検査対象のフィールドが列挙型フィールドの場合、右側のレールには、フィールドが受け取ると想定する有効な値も表示されます。

IDフィールド

IDフィールドを含むスキーマを検査する場合、これらのフィールドは、スキーマに提供するクラスまたはフィールドグループの左側のナビゲーションバーに表示されます。 左側のレールでIDフィールド名を選択すると、階層化の深さに関係なく、カンバスにフィールドが表示されます。

キャンバス内のIDフィールドは、指紋アイコン（）で強調表示されます。 IDフィールドの名前を選択すると、ID名前空間や、そのフィールドがスキーマの主IDかどうかなどの追加情報を表示できます。

関係フィールド

関係フィールドを含むスキーマを検査している場合、左側のレールの​関係​の下にフィールドが表示されます。 左側のレールで関係フィールド名を選択すると、階層化の深さに関係なく、キャンバスにフィールドが表示されます。

また、関係フィールドはキャンバスで一意にハイライト表示され、フィールドが参照する宛先スキーマの名前が表示されます。 関係フィールドの名前を選択すると、右側のパネルに、宛先スキーマのプライマリIDのID名前空間を表示できます。

次の手順

このドキュメントでは、Experience PlatformUIで既存のXDMリソースを調べる方法を説明します。 スキーマワークスペースとSchema Editorの様々な機能について詳しくは、スキーマワークスペースの概要を参照してください。