UI でのクラスの作成と編集
作成対象:
- 開発者
Adobe Experience Platformでは、スキーマのクラスは、スキーマに含まれるデータ(レコードまたは時系列)の行動の側面を定義します。 これに加えて、クラスは、そのクラスに基づくすべてのスキーマに含める必要のある共通のプロパティの最小数を記述し、複数の互換性のあるデータセットを結合する方法を提供します。
Adobeは、(XDM 個人プロファイル)や XDM エクスペリエンスイベントなど、いくつかの標準(「コア」)エクスペリエンスデータモデル(XDM🔗 クラス 提供しています。 これらのコアクラスに加えて、独自のカスタムクラスを作成して、組織のより具体的な使用例を記述することもできます。
このドキュメントでは、Experience Platform UI でカスタムクラスを作成、編集、管理する方法の概要を説明します。
前提条件
このガイドでは、XDM システムに関する十分な知識が必要です。 クラスが XDM スキーマにどのように寄与するかを学ぶには、Experience Platform エコシステムにおける XDM の役割の概要および スキーマ構成の基本について XDM の概要を参照してください。
このガイドには必須ではありませんが、UI でのスキーマの作成に関するチュートリアルに従って、スキーマエディターの様々な機能を理解することをお勧めします。
はじめに
Experience Platform UI で、左側のナビゲーションで「スキーマ」を選択して スキーマ ワークスペースを開き、「クラス」タブを選択します。 使用可能なクラスのリストが表示されます。
クラスをフィルター
クラスのリストは、作成方法に基づいて自動的にフィルタリングされます。 デフォルト設定には、Adobeで定義されたクラスが表示されます。 また、リストをフィルタリングして、組織で作成したリストを表示することもできます。 ラジオボタンを選択して、「 標準 」オプションと「 カスタム オプションの中から選択します。 「 標準 」オプションにはAdobeで作成されたエンティティが表示され、「 カスタム 」オプションには組織内で作成されたエンティティが表示されます。
新しいクラスの作成
Experience Platform UI でクラスを作成するには、クラスを作成 または スキーマを作成 の 2 つの方法があります。
クラスを作成
スキーマ ワークスペースの クラス タブから クラスを作成 を選択します。
クラスを作成 ダイアログが表示されます。 クラスの 表示名 と 説明 を入力し、ラジオボタンでクラスの意図した動作を選択します。 クラスのタイプは、 レコード または 時系列 です。 「作成」を選択して選択を確定し、「 クラス 」タブに戻ります。
作成したクラスが使用可能になり、 クラス ビューに表示されます。
スキーマを作成
または、スキーマを手動で作成してクラスを作成することもできます。 スキーマ ワークスペースの クラス タブから スキーマを作成 を選択します。
表示される スキーマを作成 ダイアログで 手動 を選択します。
スキーマ作成ワークフローが表示されます。 「 スキーマの詳細 」セクションで、「その他」を選択します。 使用可能なクラスのリストが表示されます。 クラスを作成 を選択します。
クラスを作成 ダイアログが表示されます。 クラスの 表示名 と 説明 を入力し、ラジオボタンでクラスの意図した動作を選択します。 クラスのタイプは、 レコード または 時系列 です。 「作成」を選択して選択を確定し、「 クラス 」タブに戻ります。
「 スキーマの詳細 」セクションでクラスリストが更新され、新しく作成したクラスが自動的に選択されます。 「次へ」を選択して、スキーマの作成を続行します。
クラスを選択すると、「名前とレビュー セクションが表示され す。 このセクションでは、スキーマを識別するための名前と説明を指定します。キャンバスにスキーマの基本構造(クラスによって提供される)が表示され、選択したクラスとスキーマ構造を確認できます。
テキストフィールドに、人間にとってわかりやすい スキーマ表示名 を入力します。 次に、スキーマの識別に役立つ適切な説明を入力します。 スキーマ構造をレビューし、設定に満足したら、「完了」を選択してスキーマを作成します。
クラスへのフィールドの追加
スキーマエディターでカスタムクラスを採用するスキーマを開いたら、クラスへのフィールドの追加を開始できます。 新しいフィールドを追加するには、スキーマ名の横にある プラス (+) アイコンを選択します。
名称未設定フィールド プレースホルダーがキャンバスに表示されます。また、右側のパネルが更新されて、フィールドのプロパティを設定するためのコントロールが表示されます。 割り当て先 で、「クラス」を選択します。
フィールドを設定してクラスに追加する方法に関する具体的な手順については、UI でのフィールドの定義に関するガイドを参照してください。 クラスに必要な数のフィールドを追加し続けます。 終了したら、「保存 を選択して、スキーマとクラスの両方を保存します。
このクラスを採用するスキーマを以前に作成した場合、新しく追加されたフィールドはこれらのスキーマに自動的に表示されます。
クラスの編集(#edit-a-class)
クラスを編集するには、スキーマワークフローを使用して、クラスを拡張する既存のスキーマを編集するか、スキーマを手動で作成します。 クラスを直接編集することはできません。 スキーマ ワークスペースの 参照 タブ内から、既存のクラスまたは スキーマを作成 を選択します。
新しいスキーマを作成する場合は、 スキーマの作成の節を参照してください。 スキーマの作成が完了したら(または既存のスキーマを選択した後)、スキーマエディターが表示されます。 既存のクラスフィールドを更新するには、スキーマ構造からフィールドを選択します。 フィールドの情報が右側のパネルに表示されます。 割り当て先 を確認します。
オプション クラス が選択されています。選択されていない場合、更新してもクラスに影響はありません。
フィールドに必要な変更を加え、右側のレールを下にスクロールして「適用」を選択し、変更を保存します。
新しいフィールドを追加するには、「 クラスへのフィールドの追加ガイドに従ってください。 終了したら、「保存 を選択して、スキーマとクラスの両方を保存します。
スキーマクラスの変更
スキーマが保存される前の初期作成プロセス中の任意の時点で、スキーマのクラスを変更できます。 ただし、フィールドグループは特定のクラスとのみ互換性があるので、これは注意して行う必要があります。 クラスを変更すると、キャンバスと追加したフィールドがリセットされます。
詳しくは、 スキーマの作成と編集に関するガイドを参照してください。
次の手順
このドキュメントでは、Experience Platform UI を使用してクラスを作成および編集する方法について説明しました。 スキーマ ワークスペースの機能について詳しくは、 スキーマ ワークスペースの概要を参照してください。
スキーマレジストリ API を使用してクラスを管理する方法については、 クラスエンドポイントガイドを参照してください。