Recurso: LoyaltyObject
Representação JSON |
---|
{ "kind": string, "classReference": { object ( |
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
classReference |
Uma cópia dos campos herdados da classe mãe. Esses campos são recuperados durante um GET. |
accountName |
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 |
O identificador da conta de fidelidade. O tamanho máximo recomendado é de 20 caracteres. |
loyaltyPoints |
Rótulo, saldo e tipo de pontos de prêmios por fidelidade. |
linkedOfferIds[] |
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 |
Rótulo, saldo e tipo de pontos de recompensa por fidelidade secundários. Exibido além dos principais pontos de fidelidade. |
id |
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 |
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 |
Descontinuado |
state |
Obrigatório. O estado do objeto. Esse campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto |
barcode |
O tipo e o valor do código de barras. |
messages[] |
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 |
O período em que este objeto será |
locations[] |
Observação: no momento, esse campo não é suportado para acionar notificações geográficas. |
hasUsers |
Indica se o objeto tem usuários. Este campo é definido pela plataforma. |
smartTapRedemptionValue |
O valor que será transmitido para um terminal certificado de Toque inteligente por NFC para este objeto. Os campos de nível de classe Se esse valor não for definido, mas os campos de nível de classe |
hasLinkedDevice |
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 |
Indica se as notificações devem ser explicitamente suprimidas. Se esse campo for definido como verdadeiro, independentemente do campo No momento, isso só pode ser definido para ofertas. |
infoModuleData |
Obsoleto. Use textModulesData. |
imageModulesData[] |
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[] |
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. |
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. |
appLinkData |
Link opcional do app ou site que será exibido como botão na frente do cartão. Se AppLinkData for fornecido para o objeto da classe correspondente, somente o objeto AppLinkData será exibido. |
rotatingBarcode |
O tipo e o valor do código de barras rotativo. |
heroImage |
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 |
Informações que controlam como os cartões são agrupados. |
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 ( |
Campos | |
---|---|
label |
O rótulo dos pontos de fidelidade, como "Pontos". O tamanho máximo recomendado é de nove caracteres. |
balance |
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 |
localizedLabel |
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 ( |
Campos | |
---|---|
string |
O formato de string de um saldo. Somente um desses subtipos (string, int, double, dinheiro) precisa ser preenchido. |
int |
A forma inteira de um saldo. Somente um desses subtipos (string, int, double, dinheiro) precisa ser preenchido. |
double |
A forma dupla de um saldo. Somente um desses subtipos (string, int, double, dinheiro) precisa ser preenchido. |
money |
A forma monetária de um saldo. Somente um desses subtipos (string, int, double, dinheiro) precisa ser preenchido. |
Métodos |
|
---|---|
|
Adiciona uma mensagem ao objeto de fidelidade indicado pelo ID de objeto fornecido. |
|
Retorna o objeto de fidelidade com o ID de objeto fornecido. |
|
Insere um objeto de fidelidade com o ID e as propriedades fornecidos. |
|
Retorna uma lista de todos os objetos de fidelidade de um determinado ID de emissor. |
|
Modifica objetos de oferta vinculados do objeto de fidelidade com o código fornecido. |
|
Atualiza o objeto de fidelidade indicado pelo ID de objeto fornecido. |
|
Atualiza o objeto de fidelidade indicado pelo ID de objeto fornecido. |