熟客方案詳細資料結構描述欄位群組
熟客方案詳細資料是XDM個人設定檔類別的標準結構描述欄位群組。 它提供單一物件型別欄位loyalty，可模擬客戶的熟客方案會員資格狀態，包括熟客方案ID、點數餘額、層級指派、獎勵、挑戰及卡片詳細資料。
此頁面適用於熟悉XDM個人設定檔和結構描述欄位群組的結構描述設計人員和資料工程師。 閱讀此頁面後，您可以將熟客方案設定檔資料對應至正確的loyalty欄位路徑。
IMPORTANT
此欄位群組會擷取忠誠度會員資格狀態。 個別熟客方案事件通常以XDM ExperienceEvent結構描述建模。
何時使用此欄位群組 when-to-use
當以下所有條件都適用時，使用此欄位群組。
- 結構描述類別是XDM個人設定檔，代表忠誠計畫成員的目前狀態。
- 此結構描述會將持續忠誠度屬性儲存在即時客戶個人檔案中。
- 下游使用案例需要忠誠會員資格狀態以進行細分或個人化。
使用XDM ExperienceEvent結構描述進行事件型熟客活動，例如累積點數、挑戰完成或層級變更事件。
欄位群組結構 structure
loyalty物件包含下列屬性。
屬性
資料類型
說明
adjustedPoints雙精度
因修正、傳回或其他修改而調整的點數。
expiredPoints雙精度
已過期且無法再使用的點總數。
lifetimePoints雙精度
客戶熟客方案會員積分總數。
lifetimePurchases雙精度
在客戶的忠誠度計畫會員資格期間進行的所有購買的總貨幣值。
loyaltyID字串陣列
與成員相關聯的熟客方案識別碼。
nextTier字串
成員可以取得的下一個忠誠度等級。
points雙精度
目前會員的熟客點數或獎勵餘額。
pointsExpiration物件陣列
列出排程過期的熟客點數或熟客點群組。 每個陣列專案包含：
pointsExpirationDate：點數到期的日期和時間。pointsExpiring：在相關日期到期的點數。
pointsRedeemed雙精度
兌換成購買或其他獎勵的總點數。
pointsToNextTier雙精度
成員符合下一個忠誠度層級資格之前的所需點數。
program字串
個人註冊的熟客方案名稱。
promisedPoints雙精度
已承諾給客戶但尚未貸記至帳戶的點數。
returnedPoints雙精度
因退款或調整而退回客戶帳戶的點數。
status字串
熟客方案會員資格的目前狀態，例如
active、disabled或suspended。tier字串
成員註冊的目前熟客層級。
tierExpiryDate日期時間
客戶目前的忠誠度等級到期的日期和時間。
tierUpgradeDate日期時間
客戶升級至下一個忠誠度層級的日期和時間。
upgradeDate字串
已棄用。 請改用
tierUpgradeDate。 更新參照upgradeDate的現有結構描述和來源對應以使用tierUpgradeDate。下列範例顯示具有巢狀結構代表值的loyalty物件。 檢視XDM存放庫中的填入範例，以取得完整的有效裝載。
{
"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字串
熟客卡編號或識別碼。
series字串
熟客卡所屬的系列或集合。
status字串
目前的熟客卡狀態，例如
active、inactive或suspended。challenges challenges
challenges是一組物件，可擷取與成員相關的忠誠度挑戰，包括挑戰進度和相關工作。
屬性
資料類型
說明
description字串
忠誠度挑戰的詳細說明。
endDate日期時間
挑戰結束的日期和時間。
frequencyType字串
與挑戰相關的頻率，例如每日、每週或每月。
id字串
忠誠度挑戰的唯一識別碼。
name字串
忠誠度挑戰的名稱。
series字串
挑戰所屬的系列或集合。
startDate日期時間
挑戰開始的日期和時間。
state字串
目前的挑戰狀態，例如
active、completed或expired。tasks物件陣列
列出與忠誠度挑戰相關的任務。 每個陣列專案包含：
endDate：任務結束日期和時間。entity：與工作關聯的實體。goal：工作的目標值。name：工作名稱。progress：目前朝向任務目標的進度。startDate：任務開始日期和時間。state：目前的工作狀態。type：任務型別或類別。
rewards rewards
rewards物件會擷取與熟客方案相關的獎勵。
屬性
資料類型
說明
badges物件陣列
成員所獲的成就徽章。 每個陣列專案包含：
id：徽章識別碼。name：徽章名稱。series：徽章系列或集合。startDate：徽章生效的日期和時間。endDate：徽章到期的日期和時間。state：目前的徽章狀態。
coupons物件陣列
會員可使用的熟客優惠券。 每個陣列專案包含：
discountValue：貨幣折扣值。endDate：優惠券到期日。id：優惠券識別碼。name：優惠券名稱。redemptionCount：抵用券已兌換的次數。redemptionLimit：抵用券贖回次數上限。series：優惠券系列或行銷活動。startDate：優惠券生效的日期和時間。state：目前的抵用券狀態。storeName：關聯存放區的名稱。
giveaways物件陣列
與成員相關聯的贈送促銷活動。 每個陣列專案包含：
endDate：贈送結束日期。id：贈送識別碼。name：贈送名稱。partnerId：合作夥伴識別碼。partnerName：合作夥伴名稱。series：贈送系列或行銷活動。startDate：贈與開始日期。state：目前的贈送狀態。type：贈送型別或類別。
referrals物件陣列
成員獲得的推薦獎勵。 每個陣列專案包含：
endDate：轉介結束日期。id：轉介識別碼。name：轉介獎勵名稱。recipient：被轉介者的識別碼或名稱。series：轉介系列或行銷活動。startDate：轉介開始日期。state：目前的轉介狀態。
後續步驟 next-steps
實作忠誠度設定檔結構描述時，請使用下列資源。
- 在擷取忠誠度設定檔資料之前，使用結構描述編輯器欄位群組指南將此欄位群組新增到XDM個別設定檔結構描述。
- 使用XDM存放庫中的填入範例驗證忠誠度裝載對應。
- 如需資料型別限制和必要欄位定義，請參閱完整結構描述。
recommendation-more-help
experience-platform-help-xdm