Show Menu
トピック×

スキーマの作成には、 Schema Editor

Adobe Experience Platformユーザーインターフェイスを使用すると、と呼ばれるインタラクティブなビジュアルキャンバスで Experience Data Model (XDM)スキーマを作成および管理でき Schema Editorます。 このチュートリアルでは、を使用してスキーマを作成する方法を説明し Schema Editorます。
デモ目的で、このチュートリアルの手順では、顧客忠誠度プログラムのメンバーを説明するサンプルスキーマを作成します。 これらの手順を使用して目的に合わせて別のスキーマを作成できますが、まずサンプルスキーマの作成に従って、の機能を学ぶことをお勧めし Schema Editorます。
If you prefer to compose a schema using the Schema Registry API instead, start by reading the Schema Registry developer guide before attempting the tutorial on creating a schema using the API .

はじめに

このチュートリアルでは、スキーマの作成に関わるAdobe Experience Platformのさまざまな側面について、十分に理解する必要があります。 このチュートリアルを始める前に、次の概念に関するドキュメントを確認してください。

Browse existing schemas in the Schemas workspace

UIの スキーマ Platform ワークスペースは、のビジュアライゼーションを提供し Schema Library、組織で使用可能なスキーマを表示が管理できます。 The workspace also includes the Schema Editor, the canvas on which you can compose a schema throughout this tutorial.
ログイン後、左側のナビゲーションで「 Experience Platformスキーマ 」を選択し、 スキーマ ​ワークスペースを開きます。 「 参照 」タブには、スキーマのリスト(の表現 Schema Library)が表示され、表示やカスタマイズが可能です。 リストには、スキーマの基となる名前、型、クラス、動作(レコードまたは時系列)、およびスキーマが最後に変更された日時が含まれます。
検索バーの横にあるフィルターアイコンを選択し、クラス、ミックスイン、データ型など、レジストリ内のすべてのリソースに対してフィルター機能を使用します。 また、Adobeが所有しているか組織が所有しているか、およびでの使用が有効になっているかに基づいて、リソースをフィルタリングすることもでき Real-time Customer Profileます。

スキーマの作成と命名

To begin composing a schema, select Create schema in the top-right corner of the Schemas workspace. ドロップダウンメニューが表示され、コアクラス XDM Indivialプロファイル と XDM ExperienceEventのいずれかを選択できます。 これらのクラスが目的に合わない場合は、 「参照 」を選択して、使用可能な他のクラスから選択するか、新しいクラス を作成することもできます
このチュートリアルの目的で、「 XDM Individual Individualプロファイル 」を選択します。
が表示 Schema Editor されます。 これは、スキーマを作成するキャンバスです。スキーマの基にする標準XDMクラスを選択したので、エディターに到達すると、名称未設定のスキーマがキャンバスの 構造 セクションに自動的に作成され、そのクラスに基づくすべてのスキーマに含まれる標準フィールドも作成されます。 スキーマに割り当てられたクラスは、「 組版 」セクションの「クラス 」にも表示されます。
スキーマが保存される前の初期構成プロセス中の任意の時点で スキーマのクラスを変更 できますが、これは非常に注意しておこなう必要があります。ミックスインは特定のクラスとのみ互換性があるので、クラスを変更するとキャンバスと追加したフィールドがリセットされます。
エディターの右側のフィールドを使用して、スキーマの表示名とオプションの説明を入力します。 名前を入力すると、キャンバスが更新され、スキーマの新しい名前が反映されます。
スキーマの名前を決定する際に考慮すべき重要な点がいくつかあります。
  • スキーマ名は短く、スキーマを後で簡単に見つけられるように、説明的にします。
  • スキーマ名は一意である必要があります。つまり、将来再利用されないように十分に具体的でなければなりません。例えば、組織が異なるブランドに対して別々のロイヤルティプログラムを持つ場合、後で定義する他のロイヤルティ関連スキーマと区別しやすいように、スキーマに「ブランド A ロイヤルティメンバー」という名前を付けると効果的です。
  • スキーマの説明を使用して、スキーマに関する追加のコンテキスト情報を提供することもできます。
このチュートリアルでは、忠誠度プログラムのメンバに関連するデータを取り込むスキーマを構成します。したがって、スキーマの名前は「Loyalty Members」になります。

Mixin の追加

これで、mixin を追加して、スキーマにフィールドを追加できます。ミックスインは、特定の概念を説明するためによく一緒に使用される1つ以上のフィールドのグループです。 このチュートリアルでは、mixin を使用してロイヤルティプログラムのメンバーを説明し、名前、誕生日、電話番号、住所などの重要な情報を取得します。
To add a mixin, select Add in the Mixins sub-section.
新しいダイアログが表示され、使用可能なミックスインのリストが表示されます。 各ミックスインは特定のクラスでのみ使用されるため、ダイアログには選択したクラス(この場合はクラス)と互換性のあるリストミックスインのみが表示され XDM Individual Profile ます。 標準のXDMクラスを使用している場合、ミックスインのリストは、使用頻度に基づいてインテリジェントに並べ替えられます。
リストからMixinを選択すると、右側のパネルにMixinが表示されます。 必要に応じて複数のミックスインを選択し、各ミックスインを確認する前に右側のレールのリストに追加します。 また、現在選択されているミックスインの右側にアイコンが表示され、そのフィールドの構造をプレビューできます。
Mixinをプレビューする際、Mixinのスキーマの詳細が右側のパネルに表示されます。 また、提供されたキャンバス内のMixinのフィールド間を移動することもできます。 別のフィールドを選択すると、右側のパネルが更新され、目的のフィールドに関する詳細が表示されます。 プレビューが終了したら 「戻る 」を選択して、mixinの選択ダイアログに戻ります。
このチュートリアルでは、 プロファイルの人物詳細 Mixinを選択し、「 Mixin」を選択し ​ます。
スキーマキャンバスが再び表示されます。The Mixins section now lists "Profile person details" and the Structure section includes the fields contributed by the mixin. 「ミックスイン ​」セクションの下でミックスインの名前を選択して、キャンバス内で提供される特定のフィールドを強調表示することができます。
This mixin contributes several fields under the top-level name person with the data type "Person". このフィールドグループは、名前、生年月日、性別など、個人に関する情報を説明します。
Remember that fields may use scalar types (such as string, integer, array, or date), as well as any data type (a group of fields representing a common concept) defined within the Schema Registry.
Notice that the name field has a data type of "Full name", meaning it too describes a common concept and contains name-related sub-fields such as first name, last name, courtesy title, and suffix.
キャンバス内の別のフィールドを選択すると、スキーマ構造に影響を与える追加のフィールドが表示されます。

別の mixin の追加

次に、同じ手順を繰り返して、別の mixin を追加できます。When you view the Add mixin dialog this time, notice that the "Profile person details" mixin has been greyed out and the checkbox next to it cannot be selected. これは、既に現在のスキーマに含まれている mixin を誤って複製するのを防ぎます。
このチュートリアルでは、ダイアログから「Profile personal details」ミックスインを選択し、「 mixin 」を選択してスキーマに追加します。
追加すると、キャンバスが再び表示されます。"Profile personal details" is now listed under Mixins in the Composition section, and fields for home address, mobile phone, and more have been added under Structure .
Similar to the name field, the fields you just added represent multi-field concepts. For example, homeAddress has a data type of "Postal address" and mobilePhone has a data type of "Phone number". これらの各フィールドを選択して展開し、データ型に含まれる追加のフィールドを表示できます。

新しい mixin の定義

The "Loyalty Members" schema is meant to capture data related to the members of a loyalty program, so it will require some specific loyalty-related fields. 必要なフィールドを含む標準 mixin がないので、新しい mixin を定義する必要があります。
今回は、 Mixin の追加 ​ダイアログを開いたときに、「 新規 mixin の作成 」を選択します。その後、mixin の​ 表示名 ​と​ 説明 ​を入力するよう求められます。
クラス名と同様に、mixin 名は短く単純で、mixin がスキーマに与える影響を説明するべきです。これらも一意なので、名前を再利用できません。名前が十分に具体的であるようにしてください。
For this tutorial, name the new mixin "Loyalty Details".
に戻る には 、「 Schema Editormixin」を選択します。 "Loyalty Details" should now appear under Mixins on the left-side of the canvas, but there are no fields associated with it yet and therefore no new fields appear under Structure .

Mixin へのフィールドの追加

Now that you have created the "Loyalty Details" mixin, it is time to define the fields that the mixin will contribute to the schema.
To begin, select the mixin name in the Mixins section. Once you do this, the mixin's properties appear on the right-hand side of the editor and an Add field button appears next to the name of the schema under Structure .
Select Add field next to "Loyalty Members" to create a new node in the structure. このノード(この例では「_tenantId」と呼ばれます)は、IMS 組織のテナント ID を表し、前にアンダースコアが付いています。テナント ID の存在は、追加するフィールドが組織の名前空間に限られていることを示しています。
つまり、追加するフィールドは組織に固有のものであり、組織にのみアクセス可能な特定の領域 Schema Registry に保存されます。 定義するフィールドは、他の標準クラス、ミックスイン、データ型、およびフィールドの名前との競合を防ぐために、常にテナント名前空間に追加する必要があります。
Inside that namespaced node is a "New Field". This is the beginning of the "Loyalty Details" mixin.
Using the controls on the right-hand side of the editor, start by creating a loyalty field with type "Object" that will be used to hold your loyalty-related fields. When finished, select Apply .
The changes are applied and the newly created loyalty object appears. Select Add field next to the object to add additional loyalty-related fields. A "New Field" appears and the Field properties section is visible on the right-hand side of the canvas.
各フィールドには、次の情報が必要です。
  • フィールド名: フィールドの名前。キャメルケースで書かれます。 例:loyaltyLevel
  • 表示名: フィールドの名前。タイトルの場合は大文字で記述されます。 例:Loyalty Level
  • タイプ: フィールドのデータ型です。 This includes basic scalar types and any data types defined in the Schema Registry. Examples: String, Integer, Boolean, Person, Address, Phone number, etc.
  • 説明: フィールドのオプションの説明は、文頭の場合で記述し、最大200文字で入力します。
The first field for the Loyalty object will be a string called loyaltyId . When setting the new field's type to "String", the Field properties section becomes populated with several options for applying constraints, including Default value , Format , and Maximum length .
選択したデータ型に応じて、様々な制約オプションを使用できます。Since loyaltyId will be an email address, select "email" from the Format dropdown menu. 「 適用 」を選択して変更を適用します。

Add more fields to the mixin

Now that you have added the loyaltyId field, you can add additional fields to capture loyalty-related information such as:
  • ポイント(整数)
  • 会員登録日
Each field is added by selecting Add field on the loyalty object and filling in the required information.
完了すると、忠誠度オブジェクトには、忠誠度ID、ポイント、およびメンバー登録用のフィールドが含まれます。

mixin追加の列挙フィールド

When defining fields in the Schema Editor, there are some additional options that you can apply to basic field types in order to provide further constraints on the data the field can contain. これらの制約の使用例を次の表に示します。
制約
説明
必須
フィールドがデータ取り込みに必要であることを示します。 このフィールドを含まないデータセットに基づいてスキーマセットにアップロードされたデータの取得は失敗します。
配列
フィールドに値の配列が含まれ、各値は指定されたデータ型になっていることを示します。 例えば、データ型が「String」のフィールドに対してこの制約を使用すると、フィールドに文字列の配列が含まれるように指定できます。
Enum
このフィールドに、可能な値の列挙リストの値の1つを含める必要があることを示します。
ID
このフィールドがIDフィールドであることを示します。 ID フィールドの詳細については、 このチュートリアルの後半 で説明します。
Relationship
スキーマの関係は、和集合スキーマを使用して推論できますが、 Real-time Customer Profileこれは同じクラスを共有するスキーマにのみ適用されます。 Relationship 制約は、このフィールドが、異なるクラスに基づくスキーマの主なIDを参照することを示し、2つのスキーマ間の関係を示します。 See the tutorial on defining a relationship for more information.
このチュートリアルでは、スキーマの "loyalty" オブジェクトに、顧客の「忠誠度レベル」を説明する新しい列挙フィールドが必要です。値は、4つのオプションのうちの1つに限定できます。 To add this field to the schema, select Add field beside the loyalty object and fill in the required fields for Field name and Display name . 「 タイプ 」で「文字列」を選択します。
タイプを選択した後、 Array Enum ​Identityのチェックボックスなど、フィールドに追加のチェックボックスが表示されます。
Select the Enum checkbox to open the Enum values section below. ここで、許容可能な各ロイヤルティレベルの​ (キャメルケース)と​ ラベル (タイトルケースでの読みやすい名前でオプション)を入力できます。
すべてのフィールドプロパティの入力が完了したら、「 Apply 」を選択して「loyaltyLevel」フィールドを loyalty オブジェクトに追加します。

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

この loyalty オブジェクトには複数の忠誠度固有のフィールドが含まれ、他のスキーマで役立つ共通のデータ構造を表すようになりました。 では、これら Schema Editor のオブジェクトの構造をデータ型に変換することで、再利用可能な複数フィールドオブジェクトを簡単に適用できます。
データ型を使用すると、複数フィールド構造を一貫して使用でき、mixin よりも柔軟性が高まります。これは、データ型がスキーマ内のどこでも使用できるからです。これは、フィールドの Type 値を、で定義されている任意のデータ型の値に設定することで行われ Schema Registryます。
To convert the loyalty object to a data type, select the loyalty field under Structure , then select Convert to new data type on the right-hand side of the editor under Field properties . オブジェクトが正常に変換されたことを確認する緑のポーバーが表示されます。
Now, when you look under Structure , you can see that the loyalty field has a data type of "Loyalty" and the fields have small lock icons beside them, indicating they are no longer individual fields but rather part of a multi-field data type.
In a future schema, you could now assign a field the Type of "Loyalty" and it would automatically include fields for ID, loyalty level, member since, and points.

スキーマフィールドの検索とフィルター

スキーマには、基本クラスが提供するフィールドに加えて、複数のミックスインが含まれるようになりました。 大きいスキーマを使用する場合は、左側のレールでmixin名の横にあるチェックボックスをオンにして、表示されるフィールドを、関心のあるミックスインで提供されるフィールドのみにフィルタリングできます。
スキーマ内で特定のフィールドを探している場合は、検索バーを使用して、表示されるフィールドを、どのミックスインがどの下に提供されているかに関係なく、名前でフィルターすることもできます。

ID フィールドとしてのスキーマフィールドの設定

スキーマが提供する標準的なデータ構造を活用して、複数のソースにわたって同じ個人に属するデータを識別でき、分類、レポート、データサイエンスの分析など、様々な下流の使用例に対応できます。 個々のIDに基づいてデータを結合するには、該当するスキーマ内でキーフィールドを ID フィールドとしてマークする必要があります。
Experience Platform で「 ID 」チェックボックスを使用して、IDフィールドを簡単に示すことがで Schema Editorきます。 ただし、データの性質に基づいて、IDとして使用するのに最適なフィールドを決定する必要があります。
For example, there may be thousands of loyalty program members belonging to the same "loyalty level", but each member of the loyalty program has a unique loyaltyId (which in this instance is the individual member's email address). The fact that loyaltyId is a unique identifier for each member makes it a good candidate for an identity field, whereas loyaltyLevel is not.
次の手順は、既存のスキーマフィールドにID記述子を追加する方法を説明します。 スキーマ自体の構造内にIDフィールドを定義する代わりに、 identityMap フィールドを使用してID情報を含めることもできます。
を使用する場合は、スキーマに直接追加するすべてのプライマリIDが上書きされることに注意して identityMap ください。 詳しくは、『スキーマコンポジションの identityMap 基本』ガイドののの節を参照してください xdm:identityMap
エディタの「 構造 」セクションで、 loyaltyId フィールドを選択し、「フィールドプロパティ 」の下に「 ID 」チェックボックスが表示されます。 Check the box and the option to set this as the Primary identity appears. このボックスも選択します。
各スキーマには、1 つのプライマリ ID フィールドのみを含めることができます。スキーマフィールドをプライマリIDとして設定すると、後でスキーマ内の別のIDフィールドをプライマリIDとして設定しようとすると、エラーメッセージが表示されます。
次に、ドロップダウン内の事前定義済みの 名前空間のリストから ID名前空間を指定する必要があります。 は顧客の電子メ loyaltyId ールアドレスなので、ドロップダウンから「Email」を選択します。 「 適用 」を選択して、 loyaltyId フィールドの更新を確認します。
標準名前空間とその定義のリストについては、 Identity Service ドキュメントを参照してください
変更を適用した後、のアイコンには指紋の記号が表示され、それが現在のIDフィールドであることが示されます。 loyaltyId さらに、左側のレールの Loyalty Details ミックスインはその下のIDフィールドをリストするので、そのスキーマのIDフィールドに提供するスキーマのミックスインを簡単に判断できます。
Now all data ingested into the loyaltyId field will be used to help identify that individual and stitch together a single view of that customer. To learn more about working with identities in Experience Platform, please review the Identity Service documentation.

スキーマを Real-time Customer Profile

リアルタイム顧客プロファイル 。個々の顧客の全体的な表示を提供するために、でIDデータ Experience Platform を利用します。 このサービスは、堅牢で360°の顧客属性プロファイルを構築し、お客様がと統合されたあらゆるシステムにわたって持つすべてのインタラクション顧客のタイムスタンプのあるアカウントを作成 Experience Platformします。
In order for a schema to be enabled for use with Real-time Customer Profile, it must have a primary identity defined. 最初にプライマリIDを定義せずにスキーマを有効にしようとすると、エラーメッセージが表示されます。
To enable the "Loyalty Members" schema for use in Profile, begin by selecting "Loyalty Members" in the Structure section of the editor.
エディターの右側には、スキーマに関する情報(表示名、説明、タイプなど)が表示されます。 この情報に加えて、 プロファイル 切り替えボタンもあります。
Select Profile and a popover appears, asking you to confirm that you wish to enable the schema for Profile.
Once a schema has been enabled for Real-time Customer Profile and saved, it cannot be disabled.
有効にする 」を選択して選択を確定します。 必要に応じて、 プロファイルの切り替えを再度選択してスキーマを無効にすることができますが、有効にした状態でスキーマを保存すると Profile 、無効にすることはできません。

次の手順とその他のリソース

スキーマの構成が完了すると、カンバスに完全なスキーマが表示されます。 「 保存 」を選択すると、スキーマがに保存され Schema Library、がアクセスできるようになり Schema Registryます。
これで、新しいスキーマを使用してにデータを取り込むことができ Platformます。 データの取得にスキーマを使用した後は、追加的な変更のみがおこなわれる場合があります。スキーマバージョン管理について詳しくは、「 スキーマ合成の基本 」を参照してください。
これで、UIでスキーマの関係を 定義するチュートリアルに従って、「Loyalty Members 」スキーマに新しい関係フィールドを追加できます。
The "Loyalty Members" schema is also available to be viewed and managed using the Schema Registry API. To begin working with the API, start by reading the Schema Registry API developer guide .

ビデオリソース

次のビデオに示す Platform UIは古いです。 最新のUIのスクリーンショットと機能については、上記のドキュメントを参照してください。
次のビデオでは、 Platform UIで単純なスキーマを作成する方法を示します。

次のビデオは、ミックスインとクラスを使用する際の理解を深めるためのものです。

付録

以下の節では、の使用に関する追加情報について説明し Schema Editorます。

新しいクラスの作成

Experience Platform は、組織に固有のクラスに基づいてスキーマを定義する柔軟性を提供します。
[ スキーマ ワークスペースで # ​作成 を選択し、ドロップダウンから # 参照]を選択します。
使用可能なクラスのリストから選択できるダイアログが表示されます。 ダイアログの上部で、「 新しいクラスを作成 」を選択します。 You can then give your new class a Display name (a short, descriptive, unique, and user-friendly name for the class), a Description , and a Behavior ("Record" or "Time Series") for the data the schema will define.
組織で定義されたクラスを実装するスキーマを構築する場合、mixin は互換性のあるクラスでのみ使用できることに注意してください。Since the class you defined is new, there are no compatible mixins listed in the Add mixin dialog. Instead, you will need to select Create new mixin and define a mixin for use with that class. 次に新しいクラスを実装するスキーマを作成すると、定義した mixin が一覧表示され、使用できます。

スキーマクラスの変更

スキーマのクラスは、スキーマが保存される前の最初の構成プロセスの任意の時点で変更できます。
スキーマに対するクラスの再割り当ては、細心の注意を払って行う必要があります。 ミックスインは特定のクラスとのみ互換性があるので、クラスを変更するとキャンバスと追加したフィールドがリセットされます。
クラスを再割り当てするには、キャンバスの左側で 「割り当て 」を選択します。
A dialog appears that displays a list of all available classes, including any defined by your organization (the owner being "Customer") as well as standard classes defined by Adobe.
リストからクラスを選択し、ダイアログの右側に説明を表示します。 You can also select Preview class structure to see the fields and metadata associated with the class. 続行するには、 # を選択します。
新しいクラスを割り当てるかどうかを確認する新しいダイアログが開きます。 「 割り当て 」を選択して確認します。
クラスの変更を確認した後、キャンバスはリセットされ、構成の進行状況はすべて失われます。