REST Resource: loyaltyobject

Recurso: LoyaltyObject

Representação JSON 
{
  "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)
  }
}
Campos
kind
(deprecated)

string

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

object (LoyaltyClass)

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

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.
accountId

string

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

object (LoyaltyPoints)

Rótulo, saldo e tipo de pontos de prêmios por fidelidade.
linkedOfferIds[]

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ê.
secondaryLoyaltyPoints

object (LoyaltyPoints)

Rótulo, saldo e tipo de pontos de recompensa por fidelidade secundários. Exibido além dos principais pontos de fidelidade.
id

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 deve incluir apenas caracteres alfanuméricos, ".", "_" ou "-".
classId

string

Obrigatório. A classe associada a esse 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ê.
version
(deprecated)

string (int64 format)

Descontinuado
state

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".
barcode

object (Barcode)

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

object (Message)

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

object (TimeInterval)

O período em que este objeto será active e poderá ser usado. O estado de um objeto vai mudar para expired quando esse período terminar.
locations[]

object (LatLongPoint)

Observação: no momento, esse campo não é suportado para acionar notificações geográficas.
hasUsers

boolean

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

string

O valor que será transmitido para um terminal certificado de Toque inteligente por NFC para este objeto. Os campos de nível de 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 aceitos.

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

boolean

Se este objeto está atualmente 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.
disableExpirationNotification

boolean

Indica se as notificações devem 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.
infoModuleData

object (InfoModuleData)

Obsoleto. Use textModulesData.
imageModulesData[]

object (ImageModuleData)

Dados do módulo de imagem. O número máximo destes campos exibidos é 1 no nível do objeto e 1 no nível do objeto da classe.
textModulesData[]

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.
rotatingBarcode

object (RotatingBarcode)

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

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

LoyaltyPoints

Representação JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Campos
label

string

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

object (LoyaltyPointsBalance)

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

object (LocalizedString)

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

LoyaltyPointsBalance

Representação JSON 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
Campos
string

string

O formato de string de um saldo. Somente um desses subtipos (string, int, double, dinheiro) precisa ser preenchido.
int

integer

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

number

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

object (Money)

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

Métodos

addmessage

 Adiciona uma mensagem ao objeto de fidelidade indicado pelo ID de objeto fornecido.

get

 Retorna o objeto de fidelidade com o ID de objeto fornecido.

insert

 Insere um objeto de fidelidade com o ID e as propriedades fornecidos.

list

 Retorna uma lista de todos os objetos de fidelidade de um determinado ID de emissor.

modifylinkedofferobjects

 Modifica objetos de oferta vinculados do objeto de fidelidade com o código fornecido.

patch

 Atualiza o objeto de fidelidade indicado pelo ID de objeto fornecido.

update

 Atualiza o objeto de fidelidade indicado pelo ID de objeto fornecido.