UI で列挙と推奨値を定義 enums-and-suggested-values

エクスペリエンスデータモデル(XDM)では、文字列フィールドに受け入れられる値や提案される値の定義済みセットを指定して、そのフィールドに取り込む値やセグメント化での動作を、より詳細に制御できます。

文字列フィールド Enums 取り込むことができる値を、事前定義済みのセットに制限します。 列挙フィールドにデータを取り込もうとすると、その値が設定で定義されている値と一致しない場合、取り込みは拒否されます。

列挙とは異なり、Suggested values オプションでは、文字列フィールドに推奨値のセットを指定でき、取り込む値を制限しません。 代わりに、文字列フィールドを属性として含める場合、推奨値は、​ セグメント化 UI で使用できる事前定義済みの値に影響を与えます。

Adobe Experience Platform ユーザーインターフェイスで ​ 新しいフィールドを定義 ​ し、タイプを String に設定すると、そのフィールドに enum または ​ 推奨値 ​ を定義するオプションが提供されます。

UI の文字列フィールドに対して「列挙と推奨値」オプションが有効になっている様子を示す画像

このドキュメントでは、Schemas UI ワークスペースで列挙と推奨値を定義する方法を説明します。 UI での設定方法やダウンストリーム効果など、列挙と推奨値の概要については、次のビデオをご覧ください。

列挙の定義 enum

Enums and Suggested Values」を選択し、「Enums」を選択します。 追加のコントロールが表示され、列挙の値の制約を指定できます。 制約を追加するには、「Add row」を選択します。

UI で「列挙」オプションが選択されていることを示す画像

Value」列で、フィールドの制約対象となる正確な値を指定する必要があります。 オプションで、制約に対して人間にわかりやすい Display Name を指定することもできます。これにより、セグメント化での値の表現方法が変わります。

引き続き Add row を使用して、必要な制約とオプションラベルを列挙に追加するか、以前に追加した行の横にある削除アイコン( 削除アイコンの画像 )を選択して削除します。 終了したら、「Apply」を選択して、変更をスキーマに適用します。

UI の文字列フィールドに入力されている列挙値と表示名を示す画像

キャンバスが更新され、変更が反映されます。 今後、このスキーマを参照する際は、右側のパネル内の列挙フィールドの制約を表示して編集できます。

推奨値を定義 suggested-values

Enums and Suggested Values」を選択してから「Suggested Values」を選択し、追加のコントロールを表示します。 ここから「Add row」を選択して、推奨値の追加を開始します。

UI で「推奨値」オプションが選択されていることを示す画像

Display Name 列で、セグメント化 UI に表示する値にわかりやすい名前を付けます。 推奨値をさらに追加するには、Add row を再度選択し、必要に応じてこの手順を繰り返します。 以前に追加した行を削除するには、該当する行の横にある 削除アイコン を選択します。

終了したら、「Apply」を選択して、変更をスキーマに適用します。

UI の文字列フィールドに入力されている列挙値と表示名を示す画像

NOTE
フィールドの更新された推奨値がセグメント化 UI に反映されるまでに、約 5 分の遅延があります。

標準フィールドの推奨値の管理

標準 XDM コンポーネントの一部のフィールドには、独自の推奨値(eventType クラス XDM ExperienceEvent の ​ など)が含まれています。 標準フィールドに推奨値を追加作成することはできますが、組織で定義されていない推奨値を変更または削除することはできません。 UI で標準フィールドを表示すると、推奨値は表示されますが、読み取り専用です。

UI の文字列フィールドに入力されている列挙値と表示名を示す画像

標準フィールドに新しい推奨値を追加するには、「Add row」を選択します。 組織が以前に追加した推奨値を削除するには、該当する行の横にある 削除アイコン を選択します。

UI の文字列フィールドに入力されている列挙値と表示名を示す画像

列挙と推奨値の進化ルール evolution

列挙フィールドを含むスキーマを使用してデータをExperience Platformに取り込んだ後、スキーマ定義に加えたさらなる変更は、システム内に既にあるデータに従う必要があります。 通常、既存のフィールドに加えた変更は、そのフィールドのみを制限 軽減 できます。 フィールドには、既に設定されている制限よりも厳しい制限を適用することはできません。

列挙と推奨値に関しては、次のルールが取り込み後に適用されます。

  • 標準フィールドとカスタムフィールドの推奨値を、既存の推奨値で追加すること できます
  • 既存の推奨値を使用して、カスタムフィールドから推奨値を削除 できます
  • 既存のカスタム列挙フィールドに新しい列挙値を追加 できます
  • カスタムフィールドの列挙値を推奨値のみに切り替える CAN か、列挙のない文字列または推奨値に変換します。 この切り替えは、適用後に元に戻すことはできません。
  • 標準フィールドから列挙や推奨値を削除することは できません
  • 既存の列挙がないフィールドに列挙値を追加することは できません
  • カスタムフィールドには、既存の列挙値の一部を削除することはできま
  • 推奨値から列挙に切り替えることはできま

列挙と推奨値のルールの結合 merging

複数のスキーマが異なる設定で同じ列挙フィールドを使用し、それらのスキーマが結合に含まれている場合、列挙の違いの紐付け方法に関しては、特定のルールが適用されます。 正確なルールは、スキーマが(eventType のように)同じ標準フィールドを参照しているか、異なるフィールドグループで同じカスタムフィールドパスを参照しているかによって異なります。

同じ標準フィールドを参照する場合:

  • その他の推奨値は、和集合に 追加 されます。
  • 同じ列挙キーの推奨値に対して行われた更新は、和集合では UPDATED です。

異なるフィールドグループの同じカスタムフィールドパスを参照する場合:

  • その他の推奨値は、和集合に 追加 されます。
  • 複数のスキーマで同じ追加の推奨値が定義されている場合、それらの値は和集合内で MERGED になります。 つまり、結合後に同じ推奨値が 2 回表示されることはありません。

検証の制限

現在のシステム制限により、取り込み中にシステムによって列挙が検証されない場合が 2 つあります。

  1. 列挙は、​ 配列フィールド ​ で定義されます。
  2. 列挙がスキーマ階層の複数のレベルで定義されています。

次の手順

このガイドでは、UI で文字列フィールドの列挙と推奨値を定義する方法について説明しました。 スキーマレジストリ API を使用して列挙と推奨値を管理する方法について詳しくは、次の ​ チュートリアル ​ を参照してください。

Schema Editor で他の XDM フィールドタイプを定義する方法については、UI でのフィールドの定義 ​ の概要を参照してください。

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07