Recurso: GiftCardObject
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 pai. Esses campos são recuperados durante um GET. |
cardNumber |
Obrigatório. O número do cartão. |
pin |
O PIN do cartão. |
balance |
O saldo monetário do cartão. |
balanceUpdateTime |
A data e a hora em que o saldo foi atualizado pela última vez. O deslocamento é obrigatório. Se o saldo for atualizado e essa propriedade não for fornecida, o sistema usará o horário atual por padrão. |
eventNumber |
O número do evento do cartão, um campo opcional usado por alguns vales-presente. |
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 precisa incluir apenas caracteres alfanuméricos, ".", "_" ou "-". |
classId |
Obrigatório. A classe associada a este 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 |
Suspenso |
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 deste objeto vão receber as mensagens associadas. O número máximo desses campos é 10. |
validTimeInterval |
O período em que este objeto será |
locations[] |
Observação: no momento, este 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 pelo Toque inteligente por NFC para esse objeto. Os campos no nível da turma |
hasLinkedDevice |
Indica se esse objeto está vinculado a um único dispositivo no momento. Esse 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 precisam 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 de 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 vai aparecer como um botão na frente do cartão. Se AppLinkData for fornecido para o objeto somente de classe correspondente, AppLinkData será exibido. |
rotatingBarcode |
O tipo e o valor do código de barras rotativo. |
heroImage |
Imagem do banner opcional exibida na parte frontal do cartão. Se nenhuma estiver presente, a imagem principal da turma, se houver, será exibida. Se a imagem principal da turma 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 captura de tela. |
saveRestrictions |
Restrições no objeto que precisam ser verificadas antes que o usuário tente salvar o cartão. Essas restrições serão aplicadas apenas durante o horário de funcionamento. Se as restrições mudarem depois que o usuário salvar o cartão, as novas restrições não serão aplicadas a um cartão já salvo. |
Métodos |
|
---|---|
|
Adiciona uma mensagem ao objeto de vale-presente indicado pelo ID de objeto fornecido. |
|
Retorna o objeto de vale-presente com o ID de objeto fornecido. |
|
Insere um objeto de vale-presente com o código e as propriedades fornecidos. |
|
Retorna uma lista de todos os objetos de vale-presente de um determinado ID de emissor. |
|
Atualiza o objeto de vale-presente indicado pelo ID de objeto fornecido. |
|
Atualiza o objeto de vale-presente indicado pelo ID de objeto fornecido. |