Detalhes de fidelidade grupo de campos de esquema

Detalhes de fidelidade é um grupo de campos de esquema padrão para a classe ​ do Perfil Individual XDM. Ele fornece um único campo de tipo de objeto, loyalty, que modela o estado de associação de um programa de fidelidade do cliente, incluindo IDs de fidelidade, saldos de pontos, atribuições de camada, recompensas, desafios e detalhes do cartão.

Esta página é para designers de esquemas e engenheiros de dados familiarizados com o Perfil individual XDM e grupos de campos de esquema. Depois de ler esta página, você pode mapear os dados do perfil de fidelidade para os caminhos de campo loyalty corretos.

IMPORTANT
Este grupo de campos captura o estado de associação de fidelidade. Os eventos de fidelidade individuais geralmente são modelados em esquemas XDM ExperienceEvent.

Quando usar este grupo de campos when-to-use

Use este grupo de campos quando todas as condições a seguir se aplicarem.

  • A classe de esquema é Perfil Individual XDM e representa o estado atual de um membro do programa de fidelidade.
  • O esquema armazena atributos de fidelidade persistentes no Perfil do cliente em tempo real.
  • Casos de uso de downstream exigem o estado de associação de fidelidade para segmentação ou personalização.

Use esquemas XDM ExperienceEvent para atividades de fidelidade baseadas em eventos, como pontos acumulados, conclusões de desafio ou eventos de alteração de camada.

Diagrama mostrando o objeto de fidelidade com campos de nível superior, incluindo pontos, camada, status e matrizes aninhadas para cardsDetails, Challenge, pointsExpiration e um objeto rewards

Estrutura do grupo de campos structure

O objeto loyalty contém as propriedades a seguir.

Propriedade
Tipo de dados
Descrição
adjustedPoints
Duplo
Pontos ajustados devido a correções, retornos ou outras modificações.
cardsDetails
Matriz de objetos
Lista os cartões de fidelidade associados ao membro. Consulte a subseção cardsDetails para obter mais informações.
challenges
Matriz de objetos
Lista os desafios de fidelidade associados ao membro. Consulte a subseção de desafios para obter mais informações.
expiredPoints
Duplo
Número total de pontos que expiraram e não estão mais disponíveis para uso.
joinDate
DateTime
Um datetime ISO 8601 que indica quando a pessoa ingressou no programa de fidelidade.
lifetimePoints
Duplo
Total de pontos ganhos durante a associação do programa de fidelidade do cliente.
lifetimePurchases
Duplo
Valor monetário total de todas as compras feitas durante a associação ao programa de fidelidade do cliente.
loyaltyID
Matriz de cadeias de caracteres
Identificadores do programa de fidelidade associados ao membro.
nextTier
String
O próximo nível de fidelidade que o membro pode obter.
points
Duplo
Saldo atual de pontos de fidelidade ou prêmios para o membro.
pointsExpiration
Matriz de objetos

Lista pontos de fidelidade, ou grupos de pontos de fidelidade, que estão programados para expirar. Cada item de matriz contém:

  • pointsExpirationDate: a data e a hora em que os pontos expiram.
  • pointsExpiring: o número de pontos expirando na data associada.
pointsRedeemed
Duplo
Quantidade total de pontos resgatados em compras ou outras recompensas.
pointsToNextTier
Duplo
Número de pontos necessários antes que o membro se qualifique para o próximo nível de fidelidade.
program
String
Nome do programa de fidelidade no qual a pessoa está inscrita.
promisedPoints
Duplo
Pontos prometidos ao cliente, mas ainda não creditados na conta.
returnedPoints
Duplo
Pontos devolvidos à conta do cliente devido a reembolsos ou ajustes.
rewards
Objeto
Captura recompensas disponíveis ou atribuídas ao membro por meio do programa de fidelidade. Consulte a subseção de recompensas para obter mais informações.
status
String
Status atual da associação de fidelidade, como active, disabled ou suspended.
tier
String
Nível de fidelidade atual no qual o membro está inscrito.
tierExpiryDate
DateTime
Data e hora em que o nível de fidelidade atual do cliente expira.
tierUpgradeDate
DateTime
Data e hora em que o cliente foi atualizado para o próximo nível de nível de fidelidade.
upgradeDate
String
Obsoleto. Em vez disso, use tierUpgradeDate. Atualize esquemas existentes e mapeamentos de origem que fazem referência a upgradeDate para usar tierUpgradeDate.

O exemplo a seguir mostra o objeto loyalty com valores representativos para as estruturas aninhadas. Consulte o exemplo preenchido no repositório XDM para obter uma carga válida completa.

{
  "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 é uma matriz de objetos que captura informações sobre cartões de fidelidade associados ao membro.

Propriedade
Tipo de dados
Descrição
number
String
Número ou identificador do cartão-fidelidade.
series
String
Série ou coleção à qual o cartão-fidelidade pertence.
status
String
Status atual do cartão-fidelidade, como active, inactive ou suspended.

challenges challenges

challenges é uma matriz de objetos que captura desafios de fidelidade associados ao membro, incluindo o progresso do desafio e tarefas relacionadas.

Propriedade
Tipo de dados
Descrição
description
String
Descrição detalhada do desafio de fidelidade.
endDate
DateTime
Data e hora em que o desafio termina.
frequencyType
String
Frequência associada ao desafio, como diária, semanal ou mensal.
id
String
Identificador exclusivo do desafio de fidelidade.
name
String
Nome do desafio de fidelidade.
series
String
Série ou coleção à qual o desafio pertence.
startDate
DateTime
Data e hora em que o desafio começa.
state
String
Estado de desafio atual, como active, completed ou expired.
tasks
Matriz de objetos

Lista tarefas associadas ao desafio de fidelidade. Cada item de matriz contém:

  • endDate: A data e hora de término da tarefa.
  • entity: a entidade associada à tarefa.
  • goal: o valor de destino da tarefa.
  • name: O nome da tarefa.
  • progress: Progresso atual em direção à meta da tarefa.
  • startDate: A data e hora de início da tarefa.
  • state: Estado atual da tarefa.
  • type: Tipo ou categoria da tarefa.

rewards rewards

O objeto rewards captura recompensas associadas ao programa de fidelidade.

Propriedade
Tipo de dados
Descrição
badges
Matriz de objetos

Medalhas de conquista obtidas pelo membro. Cada item de matriz contém:

  • id: Identificador de selo.
  • name: Nome da medalha.
  • series: série ou coleção de selos.
  • startDate: Data e hora em que a medalha se tornou ativa.
  • endDate: Data e hora em que a medalha expira.
  • state: Estado atual da medalha.
coupons
Matriz de objetos

Cupons de fidelidade disponíveis para o membro. Cada item de matriz contém:

  • discountValue: Valor de desconto monetário.
  • endDate: data de expiração do cupom.
  • id: Identificador do cupom.
  • name: Nome do cupom.
  • redemptionCount: Número de vezes que o cupom foi resgatado.
  • redemptionLimit: Número máximo de resgates de cupom.
  • series: Série ou campanha de cupons.
  • startDate: Data e hora em que o cupom se torna válido.
  • state: Estado atual do cupom.
  • storeName: Nome do armazenamento associado.
giveaways
Matriz de objetos

Promoções de brinde associadas ao membro. Cada item de matriz contém:

  • endDate: Data de término do brinde.
  • id: Identificador de brinde.
  • name: Nome do brinde.
  • partnerId: Identificador do parceiro.
  • partnerName: Nome do parceiro.
  • series: Série ou campanha de doações.
  • startDate: Data de início do brinde.
  • state: Estado atual do brinde.
  • type: Tipo ou categoria de brinde.
referrals
Matriz de objetos

Recompensas de indicação obtidas pelo membro. Cada item de matriz contém:

  • endDate: Data final da referência.
  • id: Identificador de referência.
  • name: Nome da premiação de referência.
  • recipient: Identificador ou nome da pessoa indicada.
  • series: Série ou campanha de referência.
  • startDate: Data de início da referência.
  • state: Estado de referência atual.

Próximas etapas next-steps

Use os recursos a seguir ao implementar esquemas de perfil de fidelidade.

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