UI でのスキーマの作成と編集 create-edit-schemas-in-ui
このガイドでは、Adobe Experience Platform UIでExperience Data Model (XDM)スキーマを作成、編集、管理する方法の概要を説明します。
前提条件 prerequisites
このガイドでは、XDM システムに関する実用的な理解が必要です。 Experience Platform エコシステム内でのXDMの役割の概要については、XDMの概要を、スキーマの構築方法の概要については、 スキーマ構成の基本を参照してください。
新しいスキーマの作成 create
Schemas ワークスペースで、右上隅の Create schema を選択します。 「スキーマタイプを選択」ドロップダウンメニューが表示され、StandardまたはRelational スキーマのオプションが表示されます。
リレーショナルスキーマを作成 create-relational-schema
レコードをきめ細かく制御する構造化されたリレーショナルスタイルのスキーマを定義するには、Relationalを選択します。 リレーショナルスキーマは、プライマリキーの適用、レコードレベルのバージョン管理、プライマリキーと外部キーを介したスキーマレベルの関係をサポートします。 また、変更データキャプチャを使用した増分取り込みに最適化されており、キャンペーンオーケストレーション、Data Distiller、B2Bの実装で使用される複数のデータモデルをサポートしています。
詳しくは、Data Mirrorまたは リレーショナルスキーマ の概要を参照してください。
手動で作成 create-manually
Create a relational schema ダイアログが表示されます。 スキーマ構造を定義するには、Create manuallyまたは Upload DDL file のいずれかを選択できます。
Create a relational schema ダイアログで「Create manually」を選択し、「Next」を選択します。
Relational schema details ページが表示されます。 スキーマの表示名とオプションの説明を入力し、Finishを選択してスキーマを作成します。
スキーマエディターが開き、スキーマ構造を定義するための空のキャンバスが表示されます。 通常どおりフィールドを追加できます。
バージョン識別子フィールドを追加する add-version-identifier
バージョンの追跡を有効にし、変更データキャプチャをサポートするには、スキーマでバージョン識別子フィールドを指定する必要があります。 スキーマエディターで、プラス(
updateSequenceなどのフィールド名を入力し、DateTimeまたは Number のデータタイプを選択します。
右側のパネルで「Version Identifier」チェックボックスを有効にし、「Apply」を選択してフィールドを確定します。
関係を定義するには、スキーマエディターで Add Relationship を選択して、スキーマレベルのプライマリ/外部キー関係を作成します。 詳しくは、 スキーマレベルの関係の追加に関するチュートリアルを参照してください。
次に、 プライマリキーの定義に進み、必要に応じてフィールドを追加します。 Experience Platform ソースで変更データキャプチャを有効にする方法のガイダンスについては、変更データキャプチャ取り込みガイド を参照してください。
DDL ファイルのアップロード upload-ddl-file
このワークフローを使用して、DDL ファイルをアップロードしてスキーマを定義します。 Create a relational schema ダイアログで「Upload DDL file」を選択し、ローカル DDL ファイルをシステムからドラッグするか、「Choose files」を選択します。 Experience Platformはスキーマを検証し、ファイルのアップロードが成功した場合は緑色のチェックマークを表示します。 Nextを選択してアップロードを確認します。
Select entities and fields to import ダイアログが表示され、スキーマをプレビューできます。 スキーマ構造を確認し、ラジオボタンとチェックボックスを使用して、各エンティティにプライマリキーとバージョン識別子が指定されていることを確認します。
updateSequence フィールドなど)。_change_request_typeという名前の特別な列も必要です。 このフィールドは、データ変更の種類(例:u (upsert)またはd (delete))を示します。取り込み中は必要ですが、_change_request_typeなどの制御列はスキーマに保存されず、最終的なスキーマ構造には表示されません。 正しく表示されたら、Doneを選択してスキーマを作成します。
スキーマエディターでスキーマが開き、保存する前に構造を調整できます。
次に、追加フィールド に進み、必要に応じてスキーマレベルの関係を追加します。
Experience Platform ソースで変更データキャプチャを有効にする方法のガイダンスについては、変更データキャプチャ取り込みガイド を参照してください。
標準スキーマの作成 standard-based-creation
「スキーマタイプを選択」ドロップダウンメニューから「標準スキーマタイプ」を選択すると、Create a schema ダイアログが表示されます。 このダイアログでは、フィールドとフィールドグループを追加してスキーマを手動で作成するか、CSV ファイルをアップロードしてML アルゴリズムを使用してスキーマを生成するかを選択できます。 ダイアログからスキーマ作成ワークフローを選択します。
[Beta]{class="badge informative"}手動またはML支援のスキーマ作成 manual-or-assisted
マシンラーニングアルゴリズムを使用して、csv ファイルに基づくスキーマ構造を推奨する方法については、機械学習支援スキーマ作成ガイド を参照してください。 このUI ガイドでは、手動作成ワークフローに焦点を当てます。
手動スキーマ作成 manual-creation
Create schema ワークフローが表示されます。 スキーマの基本クラスを選択するには、Individual Profile、Experience Eventまたは Other のいずれかを選択し、その後 Next を選択して選択を確定します。 これらのクラスについて詳しくは、XDM individual profileおよびXDM ExperienceEventのドキュメントを参照してください。
Otherを選択すると、使用可能なクラスのリストが表示されます。 ここから、既存のクラスを参照してフィルタリングできます。
ラジオボタンを選択して、カスタムクラスと標準クラスのどちらに属しているかに基づいてクラスをフィルタリングします。 業界に基づいて使用可能な結果をフィルタリングしたり、検索フィールドを使用して特定のクラスを検索したりすることもできます。
適切なクラスを決めるには、各クラスの情報とプレビューアイコンがあります。 情報アイコン (
プレビューアイコン (
任意の行を選択してクラスを選択し、Nextを選択して選択を確定します。
クラスを選択すると、Name and review セクションが表示されます。 このセクションでは、スキーマを識別するための名前と説明を指定します。スキーマのベース構造(クラスから提供される)がキャンバスに表示され、選択したクラスとスキーマ構造を確認および検証できます。
人間に適したSchema display nameをテキストフィールドに入力します。 次に、適切な説明を入力して、スキーマを特定します。 スキーマ構造を確認し、設定に満足したら、Finishを選択してスキーマを作成します。
スキーマエディターが表示され、キャンバスにスキーマの構造が表示されます。 必要に応じて、 クラスにフィールドを追加できるようになりました。
既存のスキーマの編集 edit
既存のスキーマを編集するには、「Browse」タブを選択し、編集するスキーマの名前を選択します。 検索バーを使用して、使用可能なオプションのリストを絞り込むこともできます。
スキーマを選択すると、キャンバスにスキーマの構造が表示されたSchema Editorが表示されます。 スキーマに フィールドグループ を追加できるようになりました(または、これらのグループから個々のフィールド を追加)、 フィールド表示名を編集、または既存のカスタムフィールドグループを編集 (スキーマに含まれる場合)。
その他のアクション more
次に、スキーマエディターのヘッダーアクションについて説明します。
スキーマエディター内で、スキーマのJSON構造をコピーするためのクイックアクションを実行したり、スキーマがリアルタイム顧客プロファイルに対して有効になっていないか、関連するデータセットがある場合にスキーマを削除したりすることもできます。 ビューの上部にある「More」を選択すると、クイックアクションを含むドロップダウンが表示されます。
JSON構造のコピー機能を使用すると、スキーマとデータパイプラインの構築中にサンプルペイロードがどのように表示されるかを確認できます。 この機能は、ID マップなど、スキーマ内に複雑なオブジェクトマップ構造がある場合に特に便利です。
表示名切り替え display-name-toggle
スキーマエディターには、元のフィールド名と、より読みやすい表示名を切り替えるための切り替えスイッチが用意されています。 この柔軟性により、フィールドの検出性が向上し、スキーマを編集できます。トグルは、スキーマエディタービューの右上にあります。
標準フィールドグループの表示名はシステムで生成されますが、表示名 セクションの説明に従ってカスタマイズできます。 表示名は、マッピングやデータセットのプレビューなど、複数のUI ビューに反映されます。 デフォルト設定はオフで、フィールド名は元の値で表示されます。
スキーマへのフィールドグループの追加 add-field-groups
Schema Editor内のスキーマを開いたら、フィールドグループを使用してスキーマにフィールドを追加できます。 開始するには、左側のパネルの Add の横にある Field groups を選択します。
ダイアログが表示され、スキーマに選択できるフィールドグループのリストが表示されます。 フィールドグループは1つのクラスとしか互換性がないので、スキーマで選択したクラスに関連付けられているフィールドグループのみが一覧表示されます。 デフォルトでは、リストされたフィールドグループは、組織内での使用頻度に基づいて並べ替えられます。
追加するフィールドの一般的なアクティビティまたはビジネス領域がわかっている場合は、左側のパネルで1つ以上の業界垂直型カテゴリを選択して、表示されるフィールドグループのリストをフィルタリングします。
検索バーを使用して、目的のフィールドグループを見つけることもできます。 クエリと一致する名前のフィールドグループがリストの上部に表示されます。 Standard Fieldsの下に、目的のデータ属性を記述するフィールドを含むフィールドグループが表示されます。
スキーマに追加するフィールドグループの名前の横にあるチェックボックスを選択します。 リストから複数のフィールドグループを選択し、選択した各フィールドグループを右側のパネルに表示できます。
フィールドグループを選択したら、Add field groupsを選択してスキーマに追加します。
Schema Editorが再び表示され、キャンバスに表示されるフィールドグループが提供するフィールドが表示されます。
スキーマにフィールドグループを追加した後、必要に応じて、オプションで既存のフィールド を削除するか、新しいカスタムフィールド をそれらのグループに追加できます。
フィールドグループから追加されたフィールドの削除 remove-fields
フィールドグループをスキーマに追加したら、フィールドグループからグローバルにフィールドを削除するか、現在のスキーマからローカルにフィールドを非表示にすることができます。 これらのアクションの違いを理解することは、意図しないスキーマの変更を避けるために非常に重要です。
フィールドグループ を含むすべてのスキーマからフィールドを削除する場合を除き、このオプションを使用しないでください。
フィールドグループからフィールドを削除するには、キャンバスでフィールドを選択し、右側のパネルで「Remove」を選択します。 次の例は、taxId グループのDemographic Details フィールドを示しています。
フィールドグループ自体から削除せずにスキーマから複数のフィールドを非表示にするには、Manage related fields オプションを使用します。 キャンバスのグループから任意のフィールドを選択し、右側のパネルで Manage related fields を選択します。
フィールドグループの構造を示すダイアログが表示されます。 チェックボックスを使用して、含めるフィールドを選択または選択解除します。
Confirmを選択してキャンバスを更新し、選択したフィールドを反映します。
フィールドを削除または非推奨にする際のフィールドの動作 field-removal-deprecation-behavior
各アクションの範囲を理解するには、次の表を使用します。
フィールドグループへのカスタムフィールドの追加 add-fields
スキーマにフィールドグループを追加した後、そのグループの追加フィールドを定義できます。 ただし、1つのスキーマのフィールドグループに追加されたフィールドは、同じフィールドグループを使用する他のすべてのスキーマにも表示されます。
さらに、カスタムフィールドが標準フィールドグループに追加されると、そのフィールドグループはカスタムフィールドグループに変換され、元の標準フィールドグループは使用できなくなります。
カスタムフィールドを標準フィールドグループに追加する場合は、特定の手順については、以下の節を参照してください。 カスタムフィールドグループにフィールドを追加する場合は、フィールドグループ UI ガイドの カスタムフィールドグループの編集の節を参照してください。
既存のフィールドグループを変更しない場合は、新しいカスタムフィールドグループを作成して、代わりに追加フィールドを定義できます。
スキーマへの個々のフィールドの追加 add-individual-fields
特定のユースケースでフィールドグループ全体を追加しない場合は、スキーマエディターを使用して、個々のフィールドをスキーマに直接追加できます。 標準フィールドグループ から個別のフィールドを追加するか、独自のカスタムフィールドを追加できます。
標準フィールドを追加 add-standard-fields
標準フィールドグループのフィールドを、対応するフィールドグループを事前に把握することなく、スキーマに直接追加できます。 スキーマに標準フィールドを追加するには、キャンバス内のスキーマ名の横にあるプラス(+)アイコンを選択します。 Untitled Field プレースホルダーがスキーマ構造に表示され、右側のパネルが更新され、フィールドを設定するためのコントロールが表示されます。
Field nameで、追加するフィールドの名前を入力します。 クエリに一致する標準フィールドが自動的に検索され、それらが属するフィールドグループを含む Recommended Standard Fields の下に一覧表示されます。
一部の標準フィールドは同じ名前を共有していますが、その構造は、元のフィールドグループによって異なる場合があります。 標準フィールドがフィールドグループ構造の親オブジェクト内にネストされている場合、子フィールドが追加されると、親フィールドもスキーマに含まれます。
標準フィールドの横にあるプレビューアイコン(
キャンバスが更新され、スキーマに追加された標準フィールド(フィールドグループ構造内でネストされている親フィールドを含む)が表示されます。 フィールドグループの名前は、左側のパネルの Field groups の下にも表示されます。 同じフィールドグループからさらにフィールドを追加する場合は、右側のパネルで「Manage related fields」を選択します。
カスタムフィールドを追加 add-custom-fields
標準フィールドのワークフローと同様に、独自のカスタムフィールドをスキーマに直接追加することもできます。
スキーマのルートレベルにフィールドを追加するには、キャンバス内のスキーマ名の横にあるプラス(+)アイコンを選択します。 Untitled Field プレースホルダーがスキーマ構造に表示され、右側のパネルが更新され、フィールドを設定するためのコントロールが表示されます。
追加するフィールド名を入力すると、システムは一致する標準フィールドの検索を自動的に開始します。 代わりに新しいカスタムフィールドを作成するには、(New Field)が付いた一番上のオプションを選択します。
フィールドの表示名とデータタイプを指定したら、次の手順では、フィールドを親XDM リソースに割り当てます。 スキーマでカスタムクラスを使用している場合は、代わりに割り当てられたクラス または フィールドグループ にフィールドを追加することを選択できます。 ただし、スキーマで標準クラスを使用している場合は、カスタムフィールドをフィールドグループにのみ割り当てることができます。
カスタムフィールドグループへのフィールドの割り当て add-to-field-group
Assign toで、Field Groupを選択します。 スキーマで標準クラスを使用している場合、これは使用可能な唯一のオプションであり、デフォルトで選択されています。
次に、関連付ける新しいフィールドのフィールドグループを選択する必要があります。 指定したテキスト入力で、フィールドグループの名前を入力します。 入力に一致する既存のカスタムフィールドグループがある場合、それらはドロップダウンリストに表示されます。 または、一意の名前を入力して、新しいフィールドグループを作成することもできます。
リストからフィールドグループを選択したら、Applyを選択します。
新しいフィールドがキャンバスに追加され、標準XDM フィールドとの競合を避けるために、 テナント IDの下に名前空間が設定されます。 新しいフィールドを関連付けたフィールドグループは、左側のパネルの Field groups の下にも表示されます。
カスタムクラスへのフィールドの割り当て add-to-class
Assign toで、Classを選択します。 以下の入力フィールドは、現在のスキーマのカスタムクラスの名前に置き換えられ、新しいフィールドがこのクラスに割り当てられることを示します。
必要に応じてフィールドの設定を続行し、完了したら Apply を選択します。
新しいフィールドがキャンバスに追加され、標準XDM フィールドとの競合を避けるために、 テナント IDの下に名前空間が設定されます。 左側のパネルでクラス名を選択すると、クラスの構造の一部として新しいフィールドが表示されます。
標準フィールドグループの構造にカスタムフィールドを追加する custom-fields-for-standard-groups
作業中のスキーマに、標準フィールドグループによって提供されるオブジェクトタイプフィールドがある場合は、独自のカスタムフィールドをその標準オブジェクトに追加できます。
開始するには、標準フィールドグループによって提供されるオブジェクトのルートの横にあるプラス(+)アイコンを選択します。
警告メッセージが表示され、標準フィールドグループを変換するかどうかを確認するメッセージが表示されます。 続行するには、Continue creating field groupを選択してください。
新しいフィールドの名称未設定のプレースホルダーがキャンバスに再表示されます。 標準フィールドグループの名前には、元のバージョンから変更されたことを示す「(Extended)」が追加されています。 ここから、右側のパネルのコントロールを使用して、フィールドのプロパティを定義します。
標準オブジェクト
変更を適用すると、標準オブジェクト内のテナント ID名前空間の下に新しいフィールドが表示されます。 このネストされた名前空間は、同じフィールドグループを使用する他のスキーマの変更が壊れるのを防ぐために、フィールドグループ自体内でのフィールド名の競合を防ぎます。
標準オブジェクト
リアルタイム顧客プロファイルのスキーマを有効にする profile
リアルタイム顧客プロファイル は、様々なソースからデータを統合して、個々の顧客の全体像を構築します。 スキーマによってキャプチャされたデータをこのプロセスに参加させるには、Profileで使用するスキーマを有効にする必要があります。
スキーマを有効にするには、左側のパネルでスキーマの名前を選択してから、右側のパネルでProfile トグルを選択します。
ポップオーバーが表示され、スキーマを有効にして保存すると、無効にできないことを警告します。 続行するには、Enableを選択してください。
Profile トグルが有効になっている状態で、キャンバスが再び表示されます。
プロセスを完了するには、Saveを選択してスキーマを保存します。
スキーマは、リアルタイム顧客プロファイルで使用できるようになりました。 Experience Platformがこのスキーマに基づいてデータセットにデータを取り込むと、そのデータは統合されたプロファイルデータに組み込まれます。
スキーマフィールドの表示名の編集 display-names
クラスを割り当ててスキーマにフィールドグループを追加したら、それらのフィールドが標準またはカスタム XDM リソースによって提供されているかどうかに関係なく、スキーマの任意のフィールドの表示名を編集できます。
Show display names for fieldsを切り替えて、フィールド名を表示名に変更します。 スキーマフィールドの表示名を編集するには、キャンバスでフィールドを選択します。 右側のパネルで、Display nameの下に新しい名前を入力します。
右側のパネルで「Apply」を選択すると、キャンバスが更新され、フィールドの新しい表示名が表示されます。 Saveを選択して、変更をスキーマに適用します。
スキーマのクラスを変更する change-class
スキーマが保存される前の初期作成プロセス中の任意の時点で、スキーマのクラスを変更できます。
クラスを再割り当てするには、キャンバスの左側にある「Assign」を選択します。
ダイアログが表示され、使用可能なすべてのクラスのリストが表示されます。これには、組織で定義されたクラス(「Customer」の所有者)と、Adobeで定義された標準クラスが含まれます。
リストからクラスを選択して、ダイアログの右側にその説明を表示します。 Preview class structureを選択して、クラスに関連付けられているフィールドとメタデータを表示することもできます。 続行するには、Assign classを選択してください。
新しいクラスを割り当てることを確認するダイアログが開きます。 確認するには、Assignを選択してください。
クラスの変更を確認した後、キャンバスがリセットされ、すべてのコンポジションの進行状況が失われます。
次の手順 next-steps
このドキュメントでは、Experience Platform UIでのスキーマの作成と編集の基本について説明しました。 独自のユースケースに対するカスタムフィールドグループとデータタイプの作成を含む、UIで完全なスキーマを構築するための包括的なワークフローについては、 スキーマ作成チュートリアル を確認することを強くお勧めします。
Schemas ワークスペースの機能について詳しくは、Schemas ワークスペースの概要を参照してください。
Schema Registry APIでスキーマを管理する方法については、 スキーマエンドポイントガイド を参照してください。