UI で列挙と推奨値を定義 enums-and-suggested-values
Experience Data Model （XDM）では、文字列フィールドに受け入れられるまたは提案された値の事前定義されたセットを与えることで、そのフィールドに取り込まれる値や、セグメント化でどのように動作するかを適切に制御できます。
Enums文字列フィールドに取り込むことができる値を、定義済みのセットに制限します。 列挙フィールドにデータを取り込もうとし、値がその設定で定義されているどれにも一致しない場合、取り込みは拒否されます。
列挙とは対照的に、Suggested values オプションを使用すると、取り込み可能な値を制限しない文字列フィールドの推奨値のセットを示すことができます。 代わりに、推奨される値は、文字列フィールドを属性として含める場合、 セグメント化UIで使用できる定義済みの値に影響します。
Adobe Experience Platform ユーザーインターフェイスで新しいフィールド を定義し、型をStringに設定すると、そのフィールドに列挙型または推奨値を定義するオプションが与えられます。
このドキュメントでは、Schemas UI ワークスペースで列挙と推奨値を定義する方法について説明します。 UIでの設定方法やダウンストリームのエフェクトなど、列挙と推奨値の概要については、次のビデオをご覧ください。
列挙の定義 enum
Enums and Suggested Valuesを選択してから、Enumsを選択します。 追加のコントロールが表示され、列挙の値の制約を指定できます。 制約を追加するには、Add rowを選択します。
UIで選択された列挙オプションを示す
Value列の下で、フィールドを制約する値を正確に指定する必要があります。 制約に対して人間に適した Display Name をオプションで指定することもできます。これは、値がセグメンテーションでどのように表示されるかに影響します。
Add rowを引き続き使用して、目的の制約とオプションのラベルを列挙に追加するか、以前に追加した行の横にある削除アイコン（
カンバスが更新され、変更が反映されます。 今後このスキーマを検討する場合は、右側のパネルで列挙フィールドの制約を表示および編集できます。
推奨値の定義 suggested-values
Enums and Suggested Valuesを選択し、Suggested Valuesを選択して追加のコントロールを表示します。 ここから、Add rowを選択して、推奨値の追加を開始します。
Display Name列の下で、セグメント UIに表示する値に人間に適した名前を指定します。 より多くの推奨値を追加するには、Add rowをもう一度選択し、必要に応じてプロセスを繰り返します。 以前に追加した行を削除するには、該当する行の横にある削除アイコン
完了したら、Applyを選択して、変更をスキーマに適用します。
標準フィールドの推奨値の管理
標準XDM コンポーネントの一部のフィールドには、eventType クラス XDM ExperienceEventのなど、独自の推奨値が含まれています。 標準フィールドに追加の推奨値を作成することはできますが、組織で定義されていない推奨値を変更または削除することはできません。 UIで標準フィールドを表示する場合、推奨される値は表示されますが、読み取り専用です。
標準フィールドに新しい推奨値を追加するには、Add rowを選択します。 組織によって以前に追加された推奨値を削除するには、該当する行の横にある削除アイコン
列挙と推奨値の展開ルール evolution
列挙フィールドを持つスキーマを使用してExperience Platformにデータを取り込んだ後、スキーマ定義に加えるさらなる変更は、システム内の既にデータに準拠する必要があります。 一般的に、既存のフィールドに対して行われた変更は、そのフィールドを より小さい 制限にすることしかできません。 フィールドを既存より制限することはできません。
列挙と推奨値に関しては、次のルールが取り込み後に適用されます。
- 標準フィールドとカスタムフィールドの推奨値を既存の推奨値に追加するには、CANします。
- CANは、既存の推奨値を持つカスタムフィールドから推奨値を削除できます。
- 既存のカスタム列挙フィールドに新しい列挙値を CAN 追加できます。
- CANは、カスタムフィールドの列挙値を推奨値のみに切り替えたり、列挙値や推奨値のない文字列に変換したりできます。 この切り替えは、一度適用すると元に戻せません。
- 標準フィールドから列挙または推奨値を削除できません。
- 既存の列挙がないフィールドに列挙値を CANNOT 追加できます。
- カスタムフィールドの既存のすべての列挙値よりも少ない値を削除することはできません。
- は、推奨値から列挙に切り替えることはできません。
列挙と推奨値のルールの結合 merging
複数のスキーマが異なる設定で同じ列挙フィールドを使用し、それらのスキーマが結合に含まれている場合、列挙の違いがどのように紐付けられるかに関して、特定のルールが適用されます。 正確なルールは、スキーマが同じ標準フィールド （eventTypeなど）を参照しているか、異なるフィールドグループで同じカスタムフィールドパスを参照しているかどうかに応じて異なります。
同じ標準フィールドを参照する場合：
- 追加の推奨値は、和集合の Appended です。
- 同じ列挙キーの推奨値に対して行われた更新は、和集合の UPDATED です。
異なるフィールドグループで同じカスタムフィールドパスを参照する場合：
- 追加の推奨値は、和集合の Appended です。
- 複数のスキーマで同じ追加の推奨値が定義されている場合、それらの値は和集合の 結合 です。 つまり、マージ後に同じ推奨値が2回表示されなくなります。
検証の制限
現在のシステム制限により、取り込み中に列挙がシステムによって検証されない場合が2つあります。
- 列挙は配列フィールド で定義されています。
- 列挙は、スキーマ階層の1つ以上のレベルで定義されます。
次の手順
このガイドでは、UIで文字列フィールドの列挙と推奨値を定義する方法について説明しました。 Schema Registry APIを使用して列挙と推奨値を管理する方法について詳しくは、次の チュートリアル を参照してください。
Schema Editorで他のXDM フィールドタイプを定義する方法については、UIでのフィールドの定義の概要を参照してください。