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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}

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 Silva". O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.

string

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

object (LoyaltyPoints)

Rótulo, saldo e tipo de pontos de prêmios do programa de fidelidade.

string

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

Os IDs de objeto da 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 recompensa secundários por fidelidade. Exibidos além dos principais pontos de fidelidade.

string

Obrigatório. O identificador exclusivo de um objeto. Esse ID precisa ser exclusivo entre 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 precisa incluir apenas caracteres alfanuméricos, ".", "_" ou "-".

string

Obrigatório. A classe associada a este objeto. A classe precisa ser do mesmo tipo que este objeto, já deve 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)

Suspenso

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 página "Cartões expirados". nesta seção.

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 deste objeto vão receber as mensagens associadas. O número máximo desses campos é 10.

object (TimeInterval)

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

object (LatLongPoint)

Observação: no momento, este campo não é suportado 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 turma 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 aceitos.

Se esse valor não for definido, mas os campos no nível da classe enableSmartTap e redemptionIssuers estiverem configurados corretamente, os campos barcode.value ou accountId serão usados como substitutos, se estiverem presentes.

boolean

Indica se esse objeto está vinculado a um único dispositivo no momento. Esse 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 explicitamente suprimidas. Se esse campo for definido como verdadeiro, independentemente do campo messages, as notificações de expiração enviadas ao usuário serão suprimidas. Por padrão, esse campo é definido como falso.

No momento, 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 é 1 no nível do objeto e 1 no nível do objeto da classe.

object (TextModuleData)

Dados do módulo de texto. Se os dados do módulo de texto também estiverem 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 estiverem definidos na classe, ambos serão exibidos.

object (AppLinkData)

Link opcional do app ou site que vai aparecer como um botão na frente do cartão. Se AppLinkData for fornecido para o objeto somente de classe correspondente, AppLinkData será exibido.

object (RotatingBarcode)

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

object (Image)

Imagem do banner opcional exibida na parte frontal do cartão. Se nenhuma estiver presente, a imagem principal da turma, se houver, será exibida. Se a imagem principal da turma também não estiver presente, nada será exibido.

object (GroupingInfo)

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

object (PassConstraints)

Restrições de transmissão para o objeto. Inclui a limitação de comportamentos de NFC e captura de tela.

object (SaveRestrictions)

Restrições no objeto que precisam ser verificadas antes que o usuário tente salvar o cartão. Essas restrições serão aplicadas apenas durante o horário de funcionamento. Se as restrições mudarem depois que o usuário salvar o cartão, as novas restrições não serão aplicadas a um cartão já salvo.

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

string

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

object (LoyaltyPointsBalance)

O saldo de pontos de fidelidade do proprietário da conta, como "500" ou "US$ 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 de string de um saldo. Somente um desses subtipos (string, int, double, money) deve ser preenchido.

integer

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

number

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

object (Money)

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