Show Menu
トピック×

スキーマエディターを使用したスキーマの作成

スキーマレジストリは、Adobe Experience Platformスキーマライブラリのすべてのリソースを表示および管理できるユーザーインターフェイスおよびRESTful APIを提供します。 スキーマライブラリには、アドビ、Experience Platformパートナー、および使用するアプリケーションのベンダーが提供するリソースと、定義してスキーマレジストリに保存するリソースが含まれています。
このチュートリアルでは、Experience Platform内でスキーマエディターを使用してスキーマを作成する手順を説明します。 スキーマレジストリAPIを使用してスキーマを作成する場合は、APIを使用したスキーマの 作成を試みる前に、『 スキーマレジストリ開発者ガイド 』を読んでください
このチュートリアルには、スキーマを構成する際に使用できる新しいクラス 定義する手順も含まれています。

はじめに

このチュートリアルでは、スキーマエディターの使用に関連するAdobe Experience Platformの様々な側面について、十分に理解している必要があります。 このチュートリアルを開始する前に、次の概念に関するドキュメントを確認してください。
  • Experience Data Model(XDM) : プラットフォームが顧客体験データを編成する際に使用する標準化されたフレームワーク。
  • スキーマ構成の基本 : XDMスキーマとその構築ブロックの概要です。クラス、ミックスイン、データ型、フィールドなどが含まれます。
  • リアルタイム顧客プロファイル : 複数のソースからの集計データに基づいて、統合されたリアルタイムの消費者プロファイルを提供します。
このチュートリアルでは、エクスペリエンスプラットフォームにアクセスできる必要があります。 Experience PlatformのIMS組織にアクセスできない場合は、先に進む前に、システム管理者にお問い合わせください。

スキーマワークスペースでの既存のスキーマの参照

Experience Platform内のスキーマワークスペースは、スキーマライブラリのビジュアライゼーションを提供します。これにより、ユーザーが利用できるすべてのスキーマの表示と管理を行うことができ、新しいワークスペースを作成することもできます。 ワークスペースにはスキーマエディタも含まれています。このキャンバスには、このチュートリアル全体を通してスキーマを構成するキャンバスがあります。
Experience Platformにログインした後、左側のナビゲーションで「 スキーマ 」をクリックすると、スキーマのワークスペースに移動します。 スキーマのリスト(スキーマライブラリの表現)が表示されます。ここで、使用可能なすべてのスキーマを表示、管理およびカスタマイズできます。 リストには、スキーマの基となる名前、タイプ、クラス、動作(レコードまたは時系列)、およびスキーマが最後に変更された日時が含まれます。
検索バーの横にあるフィルターアイコンをクリックして、クラス、ミックスイン、データ型など、レジストリ内のすべてのリソースにフィルター機能を使用します。

スキーマの作成と命名

スキーマの構成を開始するには、スキーマワークスペースの右上隅にある「 スキーマを作成 」をクリックします。
スキーマエディタ (Editor)が表示されます。 これは、スキーマを作成するキャンバスです。 エディターに到達すると、カンバスの「 構造 」セクションに「無題のスキーマ」が自動的に作成され、カスタマイズを開始できます。
エディタの右側には、 スキーマプロパティ (「 表示名 」フィールドを使用してスキーマの名前を指定できます)があります。 名前を入力すると、キャンバスが更新され、スキーマの新しい名前が反映されます。
スキーマの名前を決定する際に、いくつかの重要な考慮事項を考慮する必要があります。
  • スキーマ名は短く、説明的にし、後でスキーマを簡単に見つけられるようにします。
  • スキーマ名は一意にする必要があります。つまり、将来再利用できなくなるように十分に特定する必要があります。 例えば、組織で異なるブランドに対して別々の忠誠度プログラムを持つ場合は、後で定義する他の忠誠度関連のスキーマと区別しやすいように、スキーマに「忠誠度メンバー」という名前を付けると効果的です。
  • 必要に応じて、「 説明 」フィールドを使用して、スキーマに関する追加情報を入力できます。
このチュートリアルでは、忠誠度プログラムのメンバに関連するデータを取り込むスキーマを構成しているので、スキーマの名前は「Loyality Members」になります。

クラスの割り当て

エディターの左側には、「 コンポジション 」セクションがあります。 現在、2つのサブセクションが含まれています。 スキーマ クラス
スキーマに名前が付けられたら、スキーマが実装するクラスを割り当てる時間です。 「 クラス」の横の「 割り当て 」をクリックし ​ます。
# ダイアログが表示されます。 このウィンドウには、組織で定義された任意のクラス(「お客様」として定義された所有者)と、アドビが定義した標準クラスを含む、使用可能なすべてのクラスのリストが表示されます。
クラス名をクリックして、クラスの説明を表示します。 「 プレビュークラス構造 」を選択して、クラスに関連付けられたフィールドとメタデータを表示することもできます。
このチュートリアルでは、XDM Individualプロファイルクラスを使用します。 クラスの横にあるラジオボタンをクリックして選択し、「 Assign Class 」をクリックします。
キャンバスが再び表示されます。 「 Class 」セクションには、選択したクラス(XDM Individualプロファイル)が含まれ、XDM Individualプロファイルクラスが提供するフィールドが Structure セクション内に表示されます。
フィールドは、「fieldName」の形式で表示されます |データタイプ". UIでスキーマフィールドを定義する手順は、このチュートリアルで後述します。
スキーマのクラスは、スキーマが保存される前の最初の構成プロセスのどの時点でも 変更できますが 、これは非常に注意して行う必要があります。 ミックスインは特定のクラスとのみ互換性があるので、クラスを変更するとキャンバスと追加したフィールドがリセットされます。

ミッ追加クスイン

クラスが割り当てられたので、 Composition セクションに3つ目のサブセクションが含まれます。 ミックスイン
これで、ミックスインを追加して、スキーマへのフィールドの追加を開始できます。 ミックスインは、特定の概念を説明する1つ以上のフィールドのグループです。 このチュートリアルでは、ミックスインを使用して忠誠度プログラムのメンバーの説明を行い、名前、誕生日、電話番号、住所などの主要情報を取り込みます。
Mixinを追加するには、「Mixins ​** 」サブセクションでをクリックします。
# ダイアログが表示されます。 ミックスインは特定のクラスでのみ使用されるため、ミックスインのリストは選択したクラス(この場合はXDM Individualプロファイルクラス)と互換性のあるもののみを表示します。
Mixinの横にあるラジオボタンを選択すると、Mixinの構造を プレビューするオプションが表示されます 。 「プロファイルの人物の詳細」ミックスインを選択し、「 追加Mixin」をクリックします
スキーマキャンバスが再び表示されます。 「 Mixins 」セクションには「プロファイルの人物の詳細」Mixinがリストされ、「 構造 」セクションにはMixinが寄与するフィールドが含まれるようになりました。
このMixinは、最上位レベルの名前「person」の下に、データタイプ「Person」のフィールドを表示します。 このフィールドグループは、名前、生年月日、性別など、個人に関する情報を説明します。
フィールドは、スキーマレジストリ内の「データ型」(共通の概念を表すフィールドのグループ)の他に、スカラー型(文字列、整数、配列、日付など)をデータ型として使用できます。
「名前」フィールドのデータタイプは「人名」です。つまり、共通の概念を表し、名、姓、フルネームなどの名前関連のサブフィールドが含まれます。
キャンバス内の別のフィールドをクリックして、そのフィールドがスキーマ構造に貢献する追加のフィールドを表示します。

追加別のミックスイン

同じ手順を繰り返して別のミックスインを追加できるようになりました。 今回、 Mixin 追加ダイアログを表示するとき、「プロファイル人物の詳細」ミックスインがグレー表示になっていて、隣のラジオボタンは選択できないことに注意してください。 これにより、現在のスキーマに既に含まれているミックスインが誤って複製されるのを防ぐことができます。
Mixin ダイアログから「プロファイルの個人情報」ミックスインを追加できるよう 追加になりました。
追加したキャンバスが再び表示されます。 「プロファイルの個人情報」が「 組版 」セクションの「 ミックスイン 」に表示され、自宅住所、携帯電話などのフィールドが「 構造 」に追加されました。
「名前」フィールドと同様に、先ほど追加したフィールドは複数フィールドの概念を表します。 例えば、「homeAddress」のデータタイプは「Address」、「mobilePhone」のデータタイプは「Phone Number」です。 これらの各フィールドをクリックすると、それらのフィールドが展開され、データ型に含まれる追加のフィールドが表示されます。

新しいミックスインの定義

「忠誠度メンバー」スキーマは、忠誠度プログラムのメンバーに関連するデータを取り込むためのものなので、いくつかの特定の忠誠度関連フィールドが必要になります。 必要なフィールドを含む標準ミックスインが存在しないので、新しいミックスインを定義する必要があります。
今回は、 追加Mixin ダイアログを開いたときに、「新規Mixinを 作成 」を選択します。 その後、ミックスインの 表示名 ​説明を入力するように求められます。
クラス名と同様に、ミックスイン名は短く単純で、ミックスインがスキーマに何を貢献するかを説明する必要があります。 これらも一意なので、名前を再利用できないので、十分に限定的であることを確認する必要があります。
このチュートリアルでは、新しいmixinに「Loyality Details」という名前を付けます。
追加Mixin 」をクリックしてスキーマエディタに戻ります。 「忠誠度の詳細」がキャンバスの左側の ミックスイン (Mixins )の下に表示されるようになりましたが、関連付けられたフィールドはまだないので、 ​構造(Structure)の下に新しいフィールドは表示されません。

Mixin追加のフィールド

「忠誠度の詳細」ミックスインを作成したので、ここでミックスインがスキーマに貢献するフィールドを定義します。
最初に、 Mixins セクションのMixin名をクリックします。 この操作を行うと、エディタの右側に Mixinプロパティ が表示され、 構造 の下のスキーマ名の横にフィールド **​ボタンが表示されます。
Loyality Members」の横にある「 追加Field」をクリックして、構造内に新しいノードを作成します。 このノード(この例では「_tenantId」と呼ばれます)は、IMS組織のテナントIDを表し、前にアンダースコアが付きます。 テナントIDが表示されている場合は、追加するフィールドが組織の名前空間に含まれていることを示します。
つまり、追加するフィールドは組織に固有のもので、IMS組織のみがアクセスできる特定の領域のスキーマレジストリに保存されます。 定義するフィールドは、他の標準クラス、ミックスイン、データ型、フィールドの名前との競合を防ぐために、常に名前空間に追加する必要があります。
その名前空間ノード内には「新しいフィールド」があります。 これは、「忠誠度の詳細」ミックスインの開始です。
エディターの右側の フィールドプロパティ (Field Properties)を使用して、忠誠度関連のフィールドの保持に使用するタイプが「Object」の「忠誠度」フィールドを作成し、開始します。 終了したら、「 適用 」をクリックします。
変更が適用され、新しく作成された「忠誠度」オブジェクトが表示されます。 オブジェクトの 横にある「 追加フィールド」をクリックして、忠誠度関連のフィールドを追加します。 「新しいフィールド」が表示され、キャンバスの右側に 「フィールドプロパティ 」セクションが表示されます。
各フィールドには、次の情報が必要です。
  • フィールド名: フィールドの名前。キャメルケースで書かれます。 例: loyaltyLevel
  • 表示名: フィールドの名前。タイトルの場合は大文字で記述されます。 例: 忠誠度レベル
  • タイプ: フィールドのデータ型です。 これには、基本的なスカラー型と、スキーマレジストリで定義されたすべてのデータ型が含まれます。 例: 文字列、整数、ブール値、人、住所、電話番号など
  • 説明: フィールドのオプションの説明を文頭の場合と同様に記述します。 (最大200文字)
Loyaltyオブジェクトの最初のフィールドは、「loyaltyId」という文字列になります。 新しいフィールドのタイプを「文字列」に設定すると、「 フィールドプロパティ 」ウィンドウに、 デフォルト値 Default Value(デフォルト値)、Maximum Length(最大長)の形式など、制約を適用するためのオプションが表示され ​ます。
選択したデータタイプに応じて、様々な制約オプションを使用できます。 「loyalityId」は電子メールアドレスになるので、「 形式 」ドロップダウンメニューから「email」を選択します。 「 Apply 」を選択して変更を適用します。

Mixinの追加その他のフィールド

「loyaltyId」フィールドを追加したら、次のような忠誠度関連の情報を取り込むためのフィールドを追加できます。
  • ポイント(整数)
  • 次のメンバー(日付)
各フィールドを追加するには、忠誠度オブジェクトの「 追加Field 」をクリックし、必要な情報を入力します。
完了すると、Loyaltyオブジェクトに次のフィールドが含まれます。 忠誠度ID、ポイントおよびメンバー登録。

ミックスインする追加'enum'フィールド

スキーマエディタでフィールドを定義する場合、基本的なフィールドの種類に適用できる追加のオプションがいくつかあり、フィールドに含めることのできるデータに対してさらなる制約を設けることができます。
例えば、「忠誠度レベル」フィールドの場合、値には4つのオプションのいずれかしか使用できません。 このフィールドをスキーマに追加するには、「 追加loyality」オブジェクトの横にある「 Field 」をクリックし、「 Field Properties」の必須フィールドに入力します。
Type 」で「String」を選択すると、「 Array 」、「 Enum 」、「 ​Identity」の各チェックボックスが追加表示されます。
# チェックボックスをオンにして、下の # セクションを開きます。 ここでは、許容可能な各忠誠度レベルの (camelCase単位)と ラベル (タイトルケース単位のオプションで読みやすい名前)を入力できます。
すべてのフィールドプロパティの入力が完了したら、「 Apply 」をクリックします。「loyaltyLevel」フィールドが「loyalty」オブジェクトに追加されます。
使用可能な追加制約の詳細:
  • 必須: フィールドがデータ取り込みに必要であることを示します。 このスキーマに基づいてデータセットにアップロードされた、このフィールドを含まないデータは、取り込み時に失敗します。
  • 配列: フィールドに値の配列が含まれ、各値は指定されたデータ型になっていることを示します。 例えば、「String」というデータ型を選択し、「Array」チェックボックスをオンにすると、フィールドに文字列の配列が含まれます。
  • 列挙: このフィールドに、可能な値の列挙リストの値の1つを含める必要があることを示します。
  • ID: このフィールドがIDフィールドであることを示します。 IDフィールドの詳細については、このチュートリアル で後述します

複数フィールドオブジェクトのデータ型への変換

忠誠度に固有のフィールドをいくつか追加した後、「忠誠度」オブジェクトに、他のスキーマで役立つ共通のデータ構造が含まれるようになりました。
複数フィールド構造が再利用可能な場合があり、同じデータ構造を他の場所で柔軟に使用できるようにしたい場合、スキーマエディターを使用すると、その構造をデータ型に変換できます。
データ型を使用すると、複数フィールド構造を一貫して使用でき、ミックスインよりも柔軟に使用できます。これは、データ型がスキーマ内のどこでも使用できるからです。 これは、mixin内のフィールドの 種類 (Type)を、レジストリで定義されている任意のデータ型に設定することで行います。
「忠誠度」オブジェクトをデータ型に変換するには、「 構造 」の「忠誠度」フィールドをクリックし、エディターの右側の「フィールドプロパティ 」で「 新しいデータ型に変換」を選択します **。 「データタイプに変換されたオブジェクト」の確認を示す小さな緑のポップアップが表示されます。
構造 」の下を見ると、「忠誠度」フィールドのデータタイプが「忠誠度」で、フィールドの横に小さな錠前のアイコンが表示されています。これは、個々のフィールドではなく、複数フィールド構造の一部であることを示します。
今後のスキーマでは、フィールドに「忠誠度」の ​タイプを割り当てることができ、「忠誠度レベル」、「ポイント」、「メンバー以降」、「忠誠度ID」の各フィールドが自動的に含まれるようになります。

スキーマフィールドをIDフィールドとして設定する

スキーマは、データをエクスペリエンスプラットフォームに取り込むために使用され、最終的には、データは、個人を識別し、複数のソースから収集される情報を結合するために使用されます。 この処理に役立つように、主要フィールドを「ID」フィールドとしてマークすることができます。
Experience Platformでは、スキーマエディターの「 Identity 」チェックボックスを使用して、IDフィールドを簡単に指定できます。
例えば、同じ「レベル」に属する忠誠度プログラムの何千ものメンバーが存在する場合がありますが、忠誠度プログラムの各メンバーには一意の「loyaltyId」(この場合は、個々のメンバーの電子メールアドレス)があります。 「loyaltyId」が各メンバーの一意の識別子であることは、IDフィールドに適した候補となりますが、「level」は異なります。
エディタの「 構造 」セクションで、作成した「loyaltyId」フィールドをクリックすると、「フィールドプロパティ 」の下に「 ID 」チェックボックスが表示されます。 チェックボックスをオンにすると、これを ​プライマリIDに設定するオプションが表示され**​ます。 そのチェックボックスもオンにします。
次に、 ID名前空間を指定する必要があります 。 定義済みの名前空間はいくつかありますが、「loyalityId」はメンバーの電子メールアドレスなので、ドロップダウンリストから「電子メール」を選択します。 「 Apply 」をクリックして、「loyaltyId」フィールドの更新を確認できるようになりました。
これで、「loyaltyId」フィールドに取り込まれるすべてのデータは、その個人を識別し、その顧客の1つの表示をつなぎ合わせるのに使用されます。
スキーマフィールドをプライマリIDとして設定すると、後でスキーマ内の別のフィールドをプライマリIDとして設定しようとすると、エラーメッセージが表示されます。 各スキーマには、1つのプライマリIDフィールドのみを含めることができます。
IDの使用方法の詳細については、 IDサービスのドキュメントを参照してください

スキーマをリアルタイム顧客プロファイルで使用できるようにする

スキーマエディターでは、スキーマを リアルタイム顧客プロファイルで使用できるようにする機能を提供します 。 プロファイルは、堅牢で360°のプロファイルの顧客属性を構築し、エクスペリエンスプラットフォームと統合されたシステム全体での顧客のすべてのインタラクションのタイムスタンプのあるアカウントを作成することで、個々の顧客の全体的な表示を提供します。
スキーマをリアルタイム顧客プロファイルで使用できるようにするには、プライマリIDが定義されている必要があります。 最初にプライマリIDを定義せずにスキーマを有効にしようとすると、「プライマリIDが見つかりません」というエラーメッセージが表示されます。
プロファイルでの「忠誠度メンバー」スキーマの使用を有効にするには、まずエディターの「 構造 」セクションで「忠誠度メンバー」をクリックします。
エディタの右側の # には、スキーマに関する情報(表示名、説明、タイプなど)が表示されます。 この情報に加えて、 プロファイルというトグルボタンがあります
プロファイル 」をクリックすると、スキーマのプロファイルを有効にするかどうかを確認するポップアップが表示されます。
スキーマをリアルタイム顧客プロファイルに対して有効にして保存すると、無効にすることはできません。

次の手順

「忠誠度メンバー」スキーマの構成が完了すると、エディターの 構造 セクションに完全なスキーマが表示されます。 「 保存 」をクリックすると、スキーマがスキーマライブラリに保存され、スキーマレジストリからアクセスできるようになります。
これで、新しいスキーマを使用して、データをプラットフォームに取り込むことができます。 スキーマを使用してデータを取り込むと、追加的な変更のみが行われる場合があることに注意してください。 スキーマのバージョン管理について詳しくは、スキーマ構成の 基本 (英語)を参照してください。
スキーマレジストリAPIを使用して、「Loyality Members」スキーマを表示および管理することもできます。 APIの使用を開始するには、 スキーマレジストリAPI開発ガイドを読んで開始します

付録

次の情報は、「スキーマエディタのチュートリアル」の補足情報です。

Create a new class

エクスペリエンスプラットフォームは、組織に固有のクラスに基づいてスキーマを定義する柔軟性を提供します。
スキーマエディタの「 Class​ 」セクションで「Assign 」をクリックして、「Assign Class 」ダイアログを開きます。 ダイアログで、「 新しいクラスを作成 」を選択します。
次に、新しいクラスに、スキーマが定義するデータの 表示名 (短く、説明的で、一意で、わかりやすい名前)、 説明 動作 (「レコード」または「時系列」)を付けます。
組織で定義されたクラスを実装するスキーマを構築する場合、ミックスインは互換性のあるクラスでのみ使用できることに注意してください。 定義したクラスは新しいので、 Mixin ダイアログには互換性のあるミックスインが一覧表示されません。 代わりに、「 新しいMixinを作成」を選択し 、そのクラスで使用するMixinを定義する必要があります。 次に新しいクラスを実装するスキーマを作成すると、定義したミックスインが一覧表示され、使用できます。

スキーマのクラスの変更

スキーマの初期構成プロセス中、いつでも、スキーマを保存する前に、スキーマの基となるクラスを変更できます。
授業を変える前に注意してください。 ミックスインは特定のクラスとのみ互換性があるので、クラスを変更するとキャンバスがリセットされ、その時点に追加したフィールドはすべて削除されます。
クラスを変更するには、エディタの「 組版 」セクションで「 クラス ** 」の横にある「割り当て」をクリックします。
# ダイアログが開いたら、使用可能なリストから新しいクラスを選択できます。 「 クラスを割り当て 」をクリックすると、新しいクラスを割り当てるかどうかを確認する新しいダイアログが開きます。
クラスの変更を確認すると、キャンバスがリセットされ、構成の進行状況はすべて失われます。