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」を選択します。 リレーショナルスキーマは、プライマリキーの適用、レコードレベルのバージョン管理、プライマリキーと外部キーを介したスキーマレベルの関係をサポートしています。 また、CHANGE DATA CAPTURE を使用した増分取り込みに最適化されており、Campaign オーケストレーション、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ダイアログが表示され、スキーマをプレビューできます。スキーマ構造を確認し、ラジオ ボタンとチェック ボックスを使用して、各エンティティに主キーとバージョン識別子が指定されていることを確認します。

取得中に必要ですが、 _change_request_type などのコントロール列はスキーマに格納されず、最終的なスキーマ構造には表示されません。 すべて問題がなければ、[ Done ] を選択してスキーマを作成します。

スキーマエディターでスキーマが開き、保存する前に構造を調整できます。

次へ、必要に応じて フィールドの追加、および スキーマレベルのリレーションの追加 に進みます。

Experience Platform ソースで変更データ キャプチャを有効にする方法については、「 変更データ キャプチャ取得 ガイド」を参照してください。

スキーマ作成標準 standard-based-creation

「スキーマタイプを選択」ドロップダウンメニューから「標準スキーマタイプ」を選択すると、Create a schema のダイアログが表示されます。 このダイアログでは、フィールドとフィールドグループを追加して手動でスキーマを作成するか、CSV ファイルをアップロードして ML アルゴリズムを使用してスキーマを生成するかを選択できます。 ダイアログからスキーマ作成ワークフローを選択します。

[Beta]{class="badge informative"} 手動または ML で支援されたスキーマの作成 manual-or-assisted

ML アルゴリズムを使用して、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 構造をコピーしたり、Real-時間 Customer プロフィール に対して有効になっていない場合やデータセットが関連付けられている場合はスキーマを削除したりすることもできます。 ビューの上部にある「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 」を選択してスキーマを保存します。

これで、スキーマ を Real-時間 Customer プロフィールで使用できるようになりました。 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 workspace の機能について詳しくは、Schemas workspace の概要を参照してください ​

Schema Registry API でスキーマを管理する方法については、​ スキーマエンドポイントガイド ​ を参照してください。