UI でのスキーマリソースの調査

最終更新日: 2023-09-29
  • トピック:
  • Schemas
    このトピックの詳細を表示
  • 作成対象:
  • Developer
    User
    Admin
    Leader

Adobe Experience Platformでは、すべての Experience Data Model(XDM) スキーマリソースは、 Schema Library:組織が定義したAdobeおよびカスタムリソースによって提供される標準リソースを含みます。 Experience PlatformUI で、 Schema Library. UI は、これらの XDM リソースが提供する各フィールドの期待されるデータタイプと使用例に関する情報を提供するので、データ取得の計画と準備をおこなう際に特に役立ちます。

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

スキーマリソースの検索

Platform UI で、「 」を選択します。 スキーマ をクリックします。 The スキーマ workspace には、 参照 タブをクリックし、組織内のすべてのスキーマを参照します。また、参照用の専用タブも追加されています。 クラス, フィールドグループ、および データタイプ それぞれ。

フィルターアイコン (フィルターアイコン画像) をクリックすると、左側のレールにコントロールが表示され、リストに表示される結果を絞り込みます。 表示されるコントロールは、表示されるリソースのタイプに応じて異なります。

例えば、リストをフィルターして、Adobeが提供する標準データ型のみを表示するには、「 」を選択します。 データタイプ および Adobe の下に タイプ および 所有者 各セクションに割り当てられます。

The プロファイルに含まれる toggle を使用すると、結果をフィルタリングして、で使用可能になっているスキーマで使用されているリソースのみを表示できます。 リアルタイム顧客プロファイル. The アドホックスキーマを表示 切り替えは、1 つのデータセットでのみ使用するために名前空間が設定されたフィールドを使用して作成されたスキーマのリストをフィルターします。

The スキーマ workspace 参照 タブをクリックし、フィルターパネルをハイライトします。

リソースを クラス, フィールドグループ​または データタイプ タブ、 Adobe 標準のリソースのみを表示するか、 顧客 :組織が作成したリソースのみを表示します。

検索バーを使用して、結果をさらに絞り込むこともできます。

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

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

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

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

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

システム生成フィールド

一部のフィールド名の前には、アンダースコアが付いています ( 例: _repo および _id. これらは、データの取り込み時にシステムが自動的に生成し、割り当てるフィールドのプレースホルダーを表します。

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

データタイプ

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

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

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

フィールドのプロパティ

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

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

ID フィールド

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

キャンバス上で ID フィールドが指紋アイコン (指紋アイコン画像) をクリックします。 ID フィールドの名前を選択すると、 ID 名前空間 フィールドがスキーマのプライマリ ID かどうかを示します。

メモ

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

関係フィールド

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

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

メモ

に関するチュートリアルを参照してください。 UI での関係の作成 を参照してください。

次の手順

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

このページ