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 "John Smith". 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á devem 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 prêmios por fidelidade secundários. Exibido 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 último é escolhido por você. O identificador exclusivo precisa 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 deste objeto receberão as mensagens associadas. O número máximo desses campos é 10.

validTimeInterval

object (TimeInterval)

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

locations[]

object (LatLongPoint)

Observação: no momento, este campo não está disponível 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 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 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 vão ser usados como substitutos, se houver.

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 precisam ser suprimidas explicitamente. Se esse 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 "false".

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 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 do objeto e 10 da classe.

rotatingBarcode

object (RotatingBarcode)

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

heroImage

object (Image)

Imagem de banner opcional exibida na frente do cartão. Se não houver nenhuma, será exibida a imagem principal da turma, se houver. 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 dos comportamentos de NFC e captura 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 é 9 caracteres.

balance

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.

localizedLabel

object (LocalizedString)

Strings traduzidas do rótulo. O tamanho máximo recomendado é 9 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) deve ser preenchido.

int

integer

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

double

number

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

money

object (Money)

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

update

Atualiza o objeto de fidelidade indicado pelo código de objeto fornecido.