Recurso: GenericObject
Objeto genérico
Representação JSON |
---|
{ "genericType": enum ( |
Campos | |
---|---|
genericType |
Especifique a qual |
cardTitle |
Obrigatório. O cabeçalho do cartão. Geralmente, é o nome da empresa, como "Academia XXX", "Seguro AAA". Este campo é obrigatório e aparece na linha do cabeçalho na parte superior do cartão. |
subheader |
O rótulo do título do cartão, como o local onde ele pode ser usado. Aparece logo acima do título na linha do título na visualização de detalhes do cartão. |
header |
Obrigatório. O título do cartão, como "Cupom de 50% de desconto", "Cartão da biblioteca" ou "Cupom". Esse campo é obrigatório e aparece na linha do título da visualização de detalhes do cartão. |
logo |
A imagem do logotipo do cartão. Essa imagem é exibida na visualização de detalhes do card, no canto superior esquerdo, e também na visualização em lista/miniatura. Se o logotipo não estiver presente, a primeira letra de |
hexBackgroundColor |
A cor de fundo do cartão. Se a política não for definida, a cor dominante da imagem principal será usada. Se nenhuma imagem principal for definida, a cor dominante do logotipo será usada. Se ele não for definido, uma cor será escolhida pelo Google. |
notifications |
As configurações de notificação que estão ativadas para esse objeto. |
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 |
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 |
barcode |
O tipo e o valor do código de barras. Se o cartão não tiver um código de barras, podemos permitir que o emissor defina Barcode.alternate_text e exiba apenas isso. |
heroImage |
Imagem do banner exibida na frente do cartão, se houver. A imagem será exibida com 100% de largura. |
validTimeInterval |
O período em que esse objeto será considerado válido ou utilizável. Quando o período acaba, o objeto é considerado expirado, o que afeta a renderização nos dispositivos do usuário. |
imageModulesData[] |
Dados do módulo de imagem. Somente uma das imagens da classe e outra do nível do objeto será renderizada quando ambas forem definidas. |
textModulesData[] |
Dados do módulo de texto. Se |
linksModuleData |
Dados do módulo de links. Se |
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. |
groupingInfo |
Informações que controlam como os cartões são agrupados. |
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 |
rotatingBarcode |
Configurações/detalhes do código de barras rotativo. |
state |
O estado do objeto. Esse campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto |
hasUsers |
Indica se o objeto tem usuários. Este campo é definido pela plataforma. |
passConstraints |
Restrições de transmissão para o objeto. Inclui a limitação de comportamentos de NFC e de capturas de tela. |
wideLogo |
O logotipo largo do cartão. Quando fornecido, ele será usado no lugar do logotipo no canto superior esquerdo da visualização de card. |
GenericType
O tipo do cartão genérico.
Tipos enumerados | |
---|---|
GENERIC_TYPE_UNSPECIFIED |
Tipo genérico não especificado. |
GENERIC_SEASON_PASS |
Passaporte para a temporada |
GENERIC_UTILITY_BILLS |
Contas de consumo |
GENERIC_PARKING_PASS |
Bilhete de estacionamento |
GENERIC_VOUCHER |
Cupom |
GENERIC_GYM_MEMBERSHIP |
Cartões de inscrição em academias |
GENERIC_LIBRARY_MEMBERSHIP |
Cartões de inscrição em bibliotecas |
GENERIC_RESERVATIONS |
Reservas |
GENERIC_AUTO_INSURANCE |
Cartões de seguro de automóvel |
GENERIC_HOME_INSURANCE |
Cartões de seguro residencial |
GENERIC_ENTRY_TICKET |
Ingressos |
GENERIC_RECEIPT |
Recibos |
GENERIC_OTHER |
Outro tipo |
Notificações
Indica se o objeto precisa ter a notificação ativada. Oferecemos suporte apenas a uma ExpiryNotification/NextNotification. expiryNotification
tem precedência sobre upcomingNotification
. Em outras palavras, se expiryNotification
estiver definido, vamos ignorar o campo upcomingNotification
.
Representação JSON |
---|
{ "expiryNotification": { object ( |
Campos | |
---|---|
expiryNotification |
Uma notificação seria acionada em um momento específico antes do vencimento do cartão. |
upcomingNotification |
Uma notificação seria acionada em um momento específico antes de o cartão se tornar utilizável. |
ExpiryNotification
Indica que o emissor quer que a Carteira do Google envie notificações de expiração dois dias antes da expiração do cartão.
Representação JSON |
---|
{ "enableNotification": boolean } |
Campos | |
---|---|
enableNotification |
Indica se o objeto precisa ter uma notificação de expiração ativada. |
UpcomingNotification
Indica que o emissor gostaria que a Carteira do Google enviasse uma notificação de validade do cartão um dia antes de o cartão se tornar válido/usável.
Representação JSON |
---|
{ "enableNotification": boolean } |
Campos | |
---|---|
enableNotification |
Indica se o objeto precisa ter a notificação futura ativada. |
Métodos |
|
---|---|
|
Adiciona uma mensagem ao objeto genérico indicado pelo ID de objeto fornecido. |
|
Retorna o objeto genérico com o ID de objeto fornecido. |
|
Insere um objeto genérico com o ID e as propriedades fornecidos. |
|
Retorna uma lista de todos os objetos genéricos de um determinado ID de emissor. |
|
Atualiza o objeto genérico indicado pelo ID de objeto fornecido. |
|
Atualiza o objeto genérico indicado pelo ID de objeto fornecido. |