​ ロイヤルティの詳細 スキーマフィールドグループ

​ ロイヤルティの詳細は、XDM個人プロファイル ​ クラス ​の標準スキーマフィールドグループです。 ロイヤルティ ID、ポイント残高、階層の割り当て、報酬、課題、カードの詳細など、顧客のロイヤルティプログラムのメンバーシップ状態をモデル化する、単一のオブジェクトタイプのフィールド loyaltyを提供します。

このページは、XDM個人プロファイルと​ スキーマフィールドグループ ​に精通しているスキーマデザイナーおよびデータエンジニア向けです。 このページを読み終えると、ロイヤルティプロファイルデータを正しいloyalty フィールドパスにマッピングできます。

IMPORTANT
このフィールドグループは、ロイヤルティメンバーシップの状態をキャプチャします。 個々のロイヤルティイベントは、通常、XDM ExperienceEvent スキーマでモデル化されます。

このフィールドグループを使用するタイミング when-to-use

次のすべての条件が適用される場合は、このフィールドグループを使用します。

  • スキーマクラスはXDM Individual Profileで、ロイヤルティプログラムメンバーの現在の状態を表します。
  • このスキーマは、永続的なロイヤルティ属性をリアルタイム顧客プロファイルに保存します。
  • ダウンストリームのユースケースでは、セグメンテーションやパーソナライゼーションにロイヤルティメンバーシップの状態が必要です。

ポイント獲得、チャレンジ完了、階層変更イベントなど、イベントベースのロイヤルティアクティビティにXDM ExperienceEvent スキーマを使用します。

​ ポイント、階層、ステータス、およびcardsDetails、challenges、pointsExpiration、および報酬オブジェクトのネストされた配列を含む最上位フィールドを含むロイヤルティオブジェクトを示す図

フィールドグループ構造 structure

loyalty オブジェクトには、次のプロパティが含まれています。

プロパティ
データタイプ
説明
adjustedPoints
Double
修正、返品、その他の変更によって調整されたポイント。
cardsDetails
オブジェクトの配列
メンバーに関連付けられているロイヤルティカードを一覧表示します。 詳しくは、cardsDetails サブセクション ​を参照してください。
challenges
オブジェクトの配列
メンバーに関連するロイヤルティの課題をリストアップします。 詳しくは、課題サブセクション ​を参照してください。
expiredPoints
Double
有効期限が切れ、使用できなくなったポイントの合計数。
joinDate
日時
顧客がロイヤルティプログラムに参加した日付を示すISO 8601日付。
lifetimePoints
Double
顧客のロイヤルティプログラムのメンバーシップ全体で獲得した合計ポイント。
lifetimePurchases
Double
顧客のロイヤルティプログラムのメンバーシップ全体を通じて行われたすべての購入の金銭的価値の合計。
loyaltyID
文字列の配列
メンバーに関連付けられたロイヤルティプログラム識別子。
nextTier
文字列
顧客が獲得できるロイヤルティ層。
points
Double
会員のロイヤルティポイントまたは特典の現在の残高。
pointsExpiration
オブジェクトの配列

有効期限が切れる予定のロイヤルティポイント(ロイヤルティポイントのグループ)を一覧表示します。 各配列項目には、次のものが含まれます。

  • pointsExpirationDate: ポイントの有効期限が切れる日時。
  • pointsExpiring:関連する日付に有効期限が切れるポイントの数。
pointsRedeemed
Double
購入またはその他の特典に対して交換されたポイントの合計金額。
pointsToNextTier
Double
メンバーが次のロイヤルティ層に適格になるまでに必要なポイント数。
program
文字列
個人が登録されているロイヤルティプログラムの名前。
promisedPoints
Double
ポイントは顧客に約束されましたが、まだアカウントに入金されていません。
returnedPoints
Double
払い戻しまたは調整により、お客様のアカウントにポイントが戻ります。
rewards
オブジェクト
ロイヤルティプログラムを通じて、会員が利用できる、または会員に割り当てられた報酬を獲得できます。 詳しくは、報酬サブセクション ​を参照してください。
status
文字列
ロイヤルティメンバーシップの現在のステータス(activedisabled、またはsuspendedなど)。
tier
文字列
メンバーが登録されている現在のロイヤルティ層。
tierExpiryDate
日時
顧客の現在のロイヤルティ層の有効期限が切れる日時。
tierUpgradeDate
日時
顧客が次のロイヤルティ階層レベルにアップグレードされた日時。
upgradeDate
文字列
非推奨(廃止予定): 代わりにtierUpgradeDateを使用してください。 upgradeDateを参照する既存のスキーマとソースマッピングを更新して、tierUpgradeDateを使用します。

次の例は、ネストされた構造の代表値を持つloyalty オブジェクトを示しています。 完全な有効なペイロードについては、XDM リポジトリのpopulated exampleを参照してください。

{
  "loyalty": {
    "program": "Acme Rewards",
    "tier": "gold",
    "points": 4200,
    "pointsExpiration": [
      { "pointsExpirationDate": "2026-12-31T00:00:00Z", "pointsExpiring": 500 }
    ],
    "cardsDetails": [
      { "number": "LC-0042", "status": "active" }
    ],
    "challenges": [
      {
        "id": "CH-001",
        "state": "active",
        "tasks": [{ "name": "Make 3 purchases", "goal": 3, "progress": 1 }]
      }
    ],
    "rewards": {
      "badges": [
        { "id": "BDG-100", "state": "active" }
      ]
    }
  }
}

cardsDetails cardsDetails

cardsDetailsは、メンバーに関連付けられたロイヤルティカードに関する情報をキャプチャするオブジェクトの配列です。

プロパティ
データタイプ
説明
number
文字列
ロイヤルティカード番号またはID。
series
文字列
ロイヤルティカードが属するシリーズまたはコレクション。
status
文字列
現在のロイヤルティカードの状態(activeinactivesuspendedなど)。

challenges challenges

challengesは、チャレンジの進捗状況や関連タスクなど、メンバーに関連するロイヤルティの課題をキャプチャするオブジェクトの配列です。

プロパティ
データタイプ
説明
description
文字列
ロイヤルティチャレンジの詳細。
endDate
日時
チャレンジが終了する日時。
frequencyType
文字列
日単位、週単位、月単位など、課題に関連する頻度。
id
文字列
ロイヤルティチャレンジの一意のID。
name
文字列
ロイヤルティチャレンジの名前。
series
文字列
チャレンジが属するシリーズまたはコレクション。
startDate
日時
チャレンジが開始された日時。
state
文字列
現在のチャレンジ状態(activecompletedexpiredなど)。
tasks
オブジェクトの配列

ロイヤルティチャレンジに関連するタスクを一覧表示します。 各配列項目には、次のものが含まれます。

  • endDate: タスクの終了日時。
  • entity: タスクに関連付けられているエンティティ。
  • goal: タスクのターゲット値。
  • name: タスク名。
  • progress: タスク目標に向けた現在の進行状況。
  • startDate: タスクの開始日時。
  • state:現在のタスク状態。
  • type: タスクの種類またはカテゴリ。

rewards rewards

rewards オブジェクトは、ロイヤルティプログラムに関連する報酬をキャプチャします。

プロパティ
データタイプ
説明
badges
オブジェクトの配列

メンバーが獲得した達成バッジ。 各配列項目には、次のものが含まれます。

  • id: バッジ ID。
  • name: バッジ名。
  • series: バッジシリーズまたはコレクション。
  • startDate: バッジがアクティブになった日時。
  • endDate: バッジの有効期限が切れる日時。
  • state:現在のバッジ状態。
coupons
オブジェクトの配列

会員限定のロイヤルティクーポン。 各配列項目には、次のものが含まれます。

  • discountValue:金銭的割引の値。
  • endDate: クーポンの有効期限
  • id: クーポン ID。
  • name: クーポン名。
  • redemptionCount: クーポンが利用された回数。
  • redemptionLimit: クーポン引き換えの最大数。
  • series: クーポンシリーズまたはキャンペーン。
  • startDate: クーポンが有効になる日時。
  • state:現在のクーポン状態。
  • storeName:関連付けられたストアの名前。
giveaways
オブジェクトの配列

会員に関連するプレゼント特典プロモーション。 各配列項目には、次のものが含まれます。

  • endDate:ギブアウェイ終了日。
  • id:プレゼント識別子。
  • name:プレゼント名。
  • partnerId: パートナーID。
  • partnerName: パートナー名。
  • series:景品シリーズまたはキャンペーン。
  • startDate:プレゼントの開始日。
  • state:現在のプレゼントの状態。
  • type:プレゼントの種類またはカテゴリ。
referrals
オブジェクトの配列

会員が獲得したリファラル報酬。 各配列項目には、次のものが含まれます。

  • endDate:参照終了日。
  • id:参照識別子。
  • name:参照報酬の名前。
  • recipient:参照されたユーザーの識別子または名前。
  • series:紹介シリーズまたはキャンペーン。
  • startDate:参照開始日。
  • state:現在の参照状態。

次の手順 next-steps

ロイヤルティプロファイルスキーマを実装する際には、次のリソースを使用します。

recommendation-more-help
experience-platform-help-xdm