Schemafältgruppen Loyalty Details

Loyalty Details är en standardschemafältgrupp för klassen XDM Individual Profile ​. Det innehåller ett enskilt fält av objekttyp, loyalty, som modellerar kundens lojalitetsprogrammedlemskapsstatus, inklusive lojalitets-ID:n, poängsaldon, nivåtilldelningar, belöningar, utmaningar och kortinformation.

Den här sidan är avsedd för schemadesigners och datatekniker som är bekanta med enskilda XDM-profiler och schemafältgrupper. När du har läst den här sidan kan du mappa data för lojalitetsprofilen till rätt loyalty-fältsökvägar.

IMPORTANT
Den här fältgruppen fångar statusen för lojalitetsmedlemskap. Enskilda lojalitetshändelser är vanligtvis modellerade i XDM ExperienceEvent scheman.

När den här fältgruppen ska användas when-to-use

Använd den här fältgruppen när alla följande villkor gäller.

  • Schemaklassen är den enskilda XDM-profilen och representerar en lojalitetsprogrammedlems aktuella tillstånd.
  • Schemat lagrar beständiga lojalitetsattribut i kundprofilen i realtid.
  • Användningsfall i senare led kräver lojalitetsmedlemskapsstatus för segmentering eller personalisering.

Använd XDM ExperienceEvent-scheman för händelsebaserad lojalitetsaktivitet, till exempel periodiseringspunkter, provslutföranden eller nivåändringshändelser.

Diagram som visar lojalitetsobjektet med fält på den översta nivån, inklusive punkter, nivå, status och kapslade arrayer för cardsDetails, issues, pointsExpiration och ett belöningsobjekt ​

Fältgruppstruktur structure

Objektet loyalty innehåller följande egenskaper.

Egenskap
Datatyp
Beskrivning
adjustedPoints
Dubbel
Punkter justerade på grund av korrigeringar, radbrytningar eller andra ändringar.
cardsDetails
Array med objekt
Visar förmånskort som är associerade med medlemmen. Mer information finns i underavsnittet cardsDetails.
challenges
Array med objekt
Visar de lojalitetsproblem som är kopplade till medlemmen. Mer information finns i avsnittet ​ om utmaningar.
expiredPoints
Dubbel
Totalt antal poäng som har gått ut och som inte längre är tillgängliga för användning.
joinDate
DateTime
En ISO 8601-datetime som anger när personen gick med i bonusprogrammet.
lifetimePoints
Dubbel
Totalt antal poäng som erhållits genom kundens lojalitetsprogram.
lifetimePurchases
Dubbel
Totalt penningvärde av alla inköp som gjorts under kundens lojalitetsprogram.
loyaltyID
Array med strängar
Identifierare för bonusprogram som är associerade med medlemmen.
nextTier
Sträng
Nästa lojalitetsnivå som medlemmen kan erhålla.
points
Dubbel
Aktuell balans mellan poäng och utmärkelser för medlemmen.
pointsExpiration
Array med objekt

Visar en lista över förmånspoäng, eller grupper av förmånspoäng, som har schemalagts att upphöra att gälla. Varje arrayobjekt innehåller:

  • pointsExpirationDate: Datum och tid när poängen förfaller.
  • pointsExpiring: Antalet poäng som förfaller det associerade datumet.
pointsRedeemed
Dubbel
Totalt antal poäng som lösts in vid inköp eller andra belöningar.
pointsToNextTier
Dubbel
Antal poäng som krävs innan medlemmen kvalificerar sig för nästa lojalitetsnivå.
program
Sträng
Namn på det bonusprogram som personen är registrerad i.
promisedPoints
Dubbel
Poäng utlovade för kunden men ännu inte krediterade kontot.
returnedPoints
Dubbel
Poäng som återförs till kundens konto på grund av återbetalningar eller justeringar.
rewards
Objekt
Hämtar belöningar som är tillgängliga eller tilldelade medlemmen genom bonusprogrammet. Mer information finns i underavsnittet belöningar.
status
Sträng
Aktuell status för lojalitetsmedlemskapet, till exempel active, disabled eller suspended.
tier
Sträng
Aktuell lojalitetsnivå där medlemmen är registrerad.
tierExpiryDate
DateTime
Datum och tid när kundens aktuella lojalitetsnivå förfaller.
tierUpgradeDate
DateTime
Datum och tid när kunden uppgraderades till nästa lojalitetsnivå.
upgradeDate
Sträng
Föråldrat. Använd tierUpgradeDate i stället. Uppdatera befintliga scheman och källmappningar som refererar till upgradeDate för att använda tierUpgradeDate.

I följande exempel visas objektet loyalty med representativa värden för de kapslade strukturerna. Se det ifyllda exemplet i XDM-databasen för en fullständig giltig nyttolast.

{
  "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 är en array med objekt som samlar in information om förmånskort som är associerade med medlemmen.

Egenskap
Datatyp
Beskrivning
number
Sträng
Förmånskortnummer eller ID.
series
Sträng
Serien eller samlingen som förmånskortet tillhör.
status
Sträng
Aktuell status för förmånskort, till exempel active, inactive eller suspended.

challenges challenges

challenges är en array med objekt som fångar upp lojalitetsproblem som är kopplade till medlemmen, inklusive utmaningsförlopp och relaterade uppgifter.

Egenskap
Datatyp
Beskrivning
description
Sträng
Detaljerad beskrivning av lojalitetsfrågan.
endDate
DateTime
Datum och tid när utmaningen upphör.
frequencyType
Sträng
Den frekvens som är associerad med utmaningen, till exempel varje dag, varje vecka eller varje månad.
id
Sträng
Unik identifierare för lojalitetsfrågan.
name
Sträng
Namn på lojalitetsfrågan.
series
Sträng
Serien eller samlingen som utmaningen tillhör.
startDate
DateTime
Datum och tid då utmaningen börjar.
state
Sträng
Aktuellt utmaningstillstånd, som active, completed eller expired.
tasks
Array med objekt

Visar uppgifter som är associerade med lojalitetsfrågan. Varje arrayobjekt innehåller:

  • endDate: Aktivitetens slutdatum och sluttid.
  • entity: Den entitet som är associerad med uppgiften.
  • goal: Målvärdet för aktiviteten.
  • name: Aktivitetsnamnet.
  • progress: Aktuellt förlopp mot uppgiftsmålet.
  • startDate: Startdatum och starttid för aktiviteten.
  • state: Aktuellt aktivitetstillstånd.
  • type: Uppgiftstyp eller kategori.

rewards rewards

Objektet rewards hämtar belöningar som är associerade med bonusprogrammet.

Egenskap
Datatyp
Beskrivning
badges
Array med objekt

Achievement-emblem som medlemmen har tjänat in. Varje arrayobjekt innehåller:

  • id: Identifierare för emblem.
  • name: Märkesnamn.
  • series: Märk serie eller samling.
  • startDate: Datum och tid då märket blev aktivt.
  • endDate: Datum och tid då märket upphör att gälla.
  • state: Aktuellt emblem-tillstånd.
coupons
Array med objekt

Medlemmens förmånskuponger. Varje arrayobjekt innehåller:

  • discountValue: Monetärt rabattvärde.
  • endDate: Kupongens förfallodatum.
  • id: Kupongidentifierare.
  • name: Kupongnamn.
  • redemptionCount: Antal gånger som kupongen har lösts in.
  • redemptionLimit: Maximalt antal kuponginlösen.
  • series: Kupongserie eller -kampanj.
  • startDate: Datum och tid när kupongen blir giltig.
  • state: Aktuell kupongstatus.
  • storeName: Namnet på det associerade arkivet.
giveaways
Array med objekt

Presentationer som är kopplade till medlemmen. Varje arrayobjekt innehåller:

  • endDate: Slutdatum för presentationen.
  • id: Giveaway-ID.
  • name: Giveaway-namn.
  • partnerId: Partner-ID.
  • partnerName: Partnernamn.
  • series: Giveaway-serie eller -kampanj.
  • startDate: Startdatum för presentationen.
  • state: Aktuellt tillstånd.
  • type: Givway-typ eller -kategori.
referrals
Array med objekt

Referensersättningar som medlemmen har tjänat. Varje arrayobjekt innehåller:

  • endDate: Referensslutdatum.
  • id: Referens-ID.
  • name: Namn på hänvisningsbelöning.
  • recipient: Identifierare eller namn på den refererade personen.
  • series: Referensserie eller kampanj.
  • startDate: Referensstartdatum.
  • state: Aktuellt hänvisningstillstånd.

Nästa steg next-steps

Använd följande resurser när du implementerar bonusprofilscheman.

  • Lägg till den här fältgruppen i ett XDM-schema för enskild profil med hjälp av gruppguiden för schemaredigeraren innan du anger data för lojalitetsprofilen.
  • Använd det ifyllda exemplet i XDM-databasen för att validera mappningar av lojalitetsnyttolast.
  • Mer information om datatypsbegränsningar och obligatoriska fältdefinitioner finns i det fullständiga schemat.
recommendation-more-help
experience-platform-help-xdm