UI での XDM リソースの参照

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

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

XDM リソースの検索

Platform UI で、左のナビゲーションで「スキーマ」を選択します。 スキーマ ワークスペースには、組織内の既存のすべての XDM リソースを調べる 参照 タブと、クラスフィールドグループデータ型 を特別に調べる専用タブが用意されています。

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

例えば、Adobeが提供する標準のデータ型のみを表示するようにリストをフィルターするには、Adobe の下で、それぞれ データ型データ型 を選択します。

プロファイルに含まれる」切り替えを使用すると、結果をフィルタリングして、 リアルタイム顧客プロファイル で使用可能になったスキーマで使用されているリソースのみを表示できます。

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

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

メモ

標準の XDM リソースの場合、検索機能は xdm 名前空間を含む個々のフィールドのみを返します。 異なる名前空間(テナント ID など)の下にあるフィールドは、カスタムリソースに含まれている場合にのみ返されます。

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

キャンバスでの XDM リソースの参照

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

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

システム生成フィールド

一部のフィールド名の先頭には、_repo_id など、アンダースコアが付きます。 これらは、データの取り込み時にシステムが自動的に生成し、割り当てるフィールドのプレースホルダーを表します。

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

データタイプ

キャンバスに表示される各フィールドの名前の横に、対応するデータ型が表示され、フィールドの取得に必要なデータのタイプが一目でわかります。

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

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

フィールドプロパティ

キャンバスで任意のフィールドの名前を選択すると、右側のレールが更新され、そのフィールドに関する詳細が フィールドのプロパティ の下に表示されます。 これには、フィールドの使用例の説明、デフォルト値、パターン、形式、必須フィールドかどうかなどが含まれます。

検査中のフィールドが列挙フィールドの場合、右側のレールには、フィールドが受け取ることを想定している許容値も表示されます。

ID フィールド

ID フィールドを含むスキーマを調べる際、これらのフィールドは、スキーマに提供するクラスまたはフィールドグループの下の左側のレールに表示されます。 左側のレールで ID フィールド名を選択して、フィールドがネストされている深さに関係なく、キャンバスに表示します。

キャンバス上で、ID フィールドが指紋アイコン( 指紋アイコン画像 )でハイライトされます。 ID フィールドの名前を選択すると、ID 名前空間 や、フィールドがスキーマのプライマリ ID であるかどうかなどの追加情報を表示できます。

メモ

ID フィールドとダウンストリーム Platform サービスとの関係について詳しくは、ID フィールドの定義 に関するガイドを参照してください。

関係フィールド

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

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

メモ

XDM スキーマでの関係の使用について詳しくは、UI での関係の作成 に関するチュートリアルを参照してください。

次の手順

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

このページ