Recurso REST: 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)
  }
}
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. Estes 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 comprimento 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. É preciso que os objetos de oferta já existam.

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

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. Este 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 este objeto. É preciso que a classe seja do mesmo tipo que este objeto, já existente e 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)

Obsoleto

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

locations[]

object (LatLongPoint)

A lista de locais em que o objeto pode ser usado. A plataforma usa estas informações para acionar notificações de geolocalização para os usuários. Observe que os locais no objeto modificam os locais na classe, que por sua vez modificam os locais no ID do Google Places.

hasUsers

boolean

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

smartTapRedemptionValue

string

Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações.

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 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 esses dados 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.

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 comprimento 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

O formato 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 código de objeto fornecido.

get

Retorna o objeto de fidelidade com o código 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 código 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.