REST Resource: loyaltyobject

{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}

string

Identifica o tipo de recurso. Valor: a string fixa "walletobjects#loyaltyObject".

object (LoyaltyClass)

Uma cópia dos campos herdados da classe pai. Esses campos são recuperados durante um GET.

string

O nome do titular da conta de fidelidade, como "João da Silva". O tamanho máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.

string

Identificador da conta de fidelidade. O tamanho máximo recomendado é 20 caracteres.

object (LoyaltyPoints)

Rótulo, saldo e tipo de pontos de recompensas de fidelidade.

string

Uma lista de objetos de oferta vinculados a este cartão de fidelidade. Os objetos de oferta já precisam existir.

Os IDs de objeto de oferta precisam seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você.

object (LoyaltyPoints)

Rótulo, saldo e tipo de pontos de prêmios de fidelidade secundários. Além dos principais pontos de fidelidade.

string

Obrigatório. Identificador exclusivo de um objeto. Ele precisa ser exclusivo em todos os objetos de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo só pode incluir caracteres alfanuméricos, ".", "_" ou "-".

string

Obrigatório. A classe associada a esse objeto. A classe precisa ser do mesmo tipo que esse objeto, já precisa existir e ser aprovada.

Os IDs de classe precisam seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você.

string (int64 format)

Descontinuado

enum (State)

Obrigatório. O estado do objeto. Esse campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto inactive é movido para a seção "Cartões expirados".

object (Barcode)

O tipo e o valor do código de barras.

object (Message)

Uma matriz de mensagens exibidas no app. Todos os usuários desse objeto receberão as mensagens associadas. O número máximo desses campos é 10.

object (TimeInterval)

O período em que esse objeto será active e o objeto poderá ser usado. O estado de um objeto será alterado para expired quando esse período terminar.

object (LatLongPoint)

Observação: no momento, este campo não é compatível para acionar notificações geográficas.

boolean

Indica se o objeto tem usuários. Este campo é definido pela plataforma.

string

O valor que será transmitido para um terminal certificado pelo Toque inteligente por NFC para esse objeto. Os campos no nível da classe enableSmartTap e redemptionIssuers também precisam ser configurados corretamente para que o cartão seja compatível com o toque inteligente. Somente caracteres ASCII são compatíveis.

Se esse valor não for definido, mas os campos enableSmartTap e redemptionIssuers de classe estiverem configurados corretamente, os campos barcode.value ou accountId serão usados como substitutos, se houver um.

boolean

Se o objeto está vinculado a um único dispositivo. Este campo é definido pela plataforma quando um usuário salva o objeto, vinculando-o ao dispositivo. Destinado ao uso por parceiros selecionados. Entre em contato com o suporte para mais informações.

boolean

Indica se as notificações precisam ser suprimidas explicitamente. Se este campo for definido como verdadeiro, independentemente do campo messages, as notificações de expiração enviadas para o usuário serão suprimidas. Por padrão, esse campo é definido como falso.

Atualmente, isso só pode ser definido para ofertas.

object (InfoModuleData)

Obsoleto. Use textModulesData.

object (ImageModuleData)

Dados do módulo de imagem. O número máximo de campos exibidos é um do nível do objeto e um do nível da classe.

object (TextModuleData)

Dados do módulo de texto. Se os dados do módulo de texto também forem definidos na classe, ambos serão exibidos. O número máximo desses campos exibidos é 10 para o objeto e 10 para a classe.

object (LinksModuleData)

Dados do módulo de links. Se os dados do módulo de links também forem definidos na classe, ambos serão exibidos.

object (AppLinkData)

Informações opcionais sobre o link do app do parceiro.

object (RotatingBarcode)

Tipo e valor rotativo do código de barras.

object (Image)

Imagem de banner opcional exibida na parte da frente do card. Se nenhum estiver presente, será exibida a imagem principal da classe. Se a imagem principal da classe também não estiver presente, nada vai ser exibido.

object (GroupingInfo)

Informações que controlam como os cartões são agrupados.

object (PassConstraints)

Transmitir restrições para o objeto. Inclui a limitação da NFC e dos comportamentos de captura de tela.

{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}

string

O rótulo de pontos de fidelidade, como "Pontos". O tamanho máximo recomendado é 9 caracteres.

object (LoyaltyPointsBalance)

O saldo do ponto de fidelidade do titular da conta, como "500" ou "R$ 10,00". O tamanho máximo recomendado é 7 caracteres. Este é um campo obrigatório de loyaltyPoints e secondaryLoyaltyPoints.

object (LocalizedString)

Strings traduzidas do rótulo. O tamanho máximo recomendado é 9 caracteres.

{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}

string

A forma da string de um saldo. Somente um desses subtipos (string, int, double, dinheiro) deve ser preenchido.

integer

A forma de número inteiro de um saldo. Somente um desses subtipos (string, int, double, dinheiro) deve ser preenchido.

number

A forma dupla de um saldo. Somente um desses subtipos (string, int, double, dinheiro) deve ser preenchido.

object (Money)

A forma monetária de um saldo. Somente um desses subtipos (string, int, double, dinheiro) deve ser preenchido.