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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
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 pai. 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 é 20 caracteres.
loyaltyPoints

object (LoyaltyPoints)

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

string

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

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

object (LoyaltyPoints)

Rótulo, saldo e tipo de pontos de prêmios por fidelidade secundários. Mostrado além dos pontos de fidelidade principais.
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 segundo é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos, ".", "_" ou "-".
classId

string

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

Suspenso
state

enum (State)

Obrigatório. O estado do objeto. Este 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)

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

object (TimeInterval)

O período em que esse objeto fica active e pode ser usado. O estado de um objeto será alterado para expired quando esse período se esgotar.
locations[]
(deprecated)

object (LatLongPoint)

Observação: no momento, esse campo não é compatível com o acionamento de 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 pelo Toque inteligente por NFC para esse objeto. Os campos de nível de classe enableSmartTap e redemptionIssuers também precisam ser configurados corretamente para que o cartão ofereça suporte ao Toque inteligente. Somente caracteres ASCII são aceitos.

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

boolean

Indica se este objeto está vinculado a um único dispositivo no momento. 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 estiver 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, só é possível definir isso para ofertas.
infoModuleData

object (InfoModuleData)

Obsoleto. Use textModulesData.
imageModulesData[]

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.
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 de 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 do banner opcional exibida na parte frontal do cartão. Se não houver nenhuma, a imagem principal da classe, se houver, será exibida. 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)

Transmitir restrições para o objeto. Inclui limitar os comportamentos de NFC e captura de tela.
saveRestrictions

object (SaveRestrictions)

Restrições no objeto que precisam ser verificadas antes que o usuário tente salvar o cartão. Essas restrições só serão aplicadas durante o tempo de gravação. Se as restrições mudarem depois que um usuário salvar o cartão, as novas restrições não serão aplicadas a um cartão já salvo.
linkedObjectIds[]

string

Os linkedObjectIds são uma lista de outros objetos, como ingresso de evento, fidelidade, oferta, genérico, vale-presente, transporte público e cartão de embarque, que precisam ser anexados automaticamente a esse objeto de fidelidade. Se um usuário tivesse salvo esse cartão de fidelidade, esses linkedObjectIds seriam enviados automaticamente à carteira do usuário (a menos que ele tivesse desativado a configuração para receber esses cartões vinculados).

Verifique se os objetos presentes em linkedObjectIds já foram inseridos. Caso contrário, as chamadas vão falhar. Depois de vincular, não é possível desvincular os objetos. Não é possível vincular objetos que pertencem a outro emissor. Há um limite para o número de objetos que podem ser vinculados a um único objeto. Quando o limite for atingido, os novos objetos vinculados na chamada serão ignorados silenciosamente.

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

enum (NotificationSettingsForUpdates)

Se as atualizações de campo para esse objeto precisam acionar notificações. Quando definida como NOTIFY, tentaremos acionar uma notificação de atualização de campo para os usuários. Essas notificações só serão enviadas aos usuários se o campo fizer parte de uma lista de permissões. Se definido como DO_NOT_NOTIFY ou NOTIFICATION_SETTINGS_UNSPECIFIED, nenhuma notificação será acionada. Essa configuração é temporária e precisa ser definida com cada solicitação PATCH ou UPDATE. Caso contrário, uma notificação não será acionada.
valueAddedModuleData[]

object (ValueAddedModuleData)

Dados opcionais do módulo de valor agregado. Máximo de dez no objeto.

LoyaltyPoints

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

string

O rótulo de pontos de fidelidade, como "Pontos". O tamanho máximo recomendado é 9 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 é 7 caracteres. Este é um campo obrigatório de loyaltyPoints e secondaryLoyaltyPoints.
localizedLabel

object (LocalizedString)

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

LoyaltyPointsBalance

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

string

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

integer

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

number

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

object (Money)

A forma monetária de um saldo. Somente um desses subtipos (string, int, double, money) deve 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 código 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 ID 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.