REST Resource: genericobject

Recurso: GenericObject

Objeto genérico

Representação JSON 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  }
}
Campos
genericType

enum (GenericType)

Especifique a qual GenericType o cartão pertence.
cardTitle

object (LocalizedString)

Obrigatório. O cabeçalho do cartão. Geralmente, é o nome da empresa, como "Academia XXX", "Seguros AAA". Esse campo é obrigatório e aparece na linha do cabeçalho, na parte superior do cartão.
subheader

object (LocalizedString)

A etiqueta 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

object (LocalizedString)

Obrigatório. O título do passe, como "Cupom de 50% de desconto" ou "Cartão de biblioteca" ou "Cupom". Esse campo é obrigatório e aparece na linha do título da visualização de detalhes do cartão.
hexBackgroundColor

string

A cor de fundo do cartão. Se não for definida, a cor predominante da imagem principal será usada e, se nenhuma imagem principal for definida, a cor dominante do logotipo será usada. Se o logotipo não for definido, uma cor será escolhida pelo Google.
notifications

object (Notifications)

As configurações de notificação que estão ativadas para este objeto.
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 issuerID.identifier, em que issuerID é emitido pelo Google e identifier é escolhido por você. O identificador exclusivo só pode incluir caracteres alfanuméricos, ., _ ou -.
classId

string

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 issuerID.identifier, em que issuerID é emitido pelo Google e identifier é escolhido por você.
barcode

object (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.alternative_text e mostre apenas isso.
heroImage

object (Image)

Imagem do banner exibida na frente do cartão, se houver. A imagem será exibida com 100% de largura.
validTimeInterval

object (TimeInterval)

O período de tempo em que este objeto será considerado válido ou utilizável. Após esse período, o objeto será considerado expirado, o que vai afetar a renderização nos dispositivos do usuário.
imageModulesData[]

object (ImageModuleData)

Dados do módulo de imagem. Somente uma das imagens da classe e outra do nível do objeto serão renderizadas quando ambas forem definidas.
textModulesData[]

object (TextModuleData)

Dados do módulo de texto. Se textModulesData também estiver definido na classe, ambos serão exibidos. O número máximo de campos mostrados é 10 da classe e 10 do objeto.
groupingInfo

object (GroupingInfo)

Informações que controlam como os cartões são agrupados.
smartTapRedemptionValue

string

O valor que será transmitido para um terminal certificado pelo Toque inteligente por NFC para esse objeto. Os campos no nível da turma 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.
rotatingBarcode

object (RotatingBarcode)

As configurações/detalhes do código de barras rotativo.
state

enum (State)

O estado do objeto. Esse campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto inactive é movido para a página "Cartões expirados". nesta seção. Se isso não for fornecido, o objeto será considerado ACTIVE.
hasUsers

boolean

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

object (PassConstraints)

Restrições de transmissão para o objeto. Inclui a limitação de comportamentos de NFC e captura de tela.

GenericType

O tipo do cartão genérico.

Enums
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 Cartão 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óveis
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 somente a ExpiryNotification/nextNotification. expiryNotification tem precedência sobre upcomingNotification. Em outras palavras, se expiryNotification estiver definido, o campo upcomingNotification será ignorado.

Representação JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Campos
expiryNotification

object (ExpiryNotification)

Uma notificação seria acionada em um momento específico antes do cartão expirar.
upcomingNotification

object (UpcomingNotification)

Uma notificação seria acionada em um momento específico antes do uso do cartão.

ExpiryNotification

Indica que o emissor quer que a Carteira do Google envie notificações de vencimento dois dias antes da expiração do cartão.

Representação JSON 
{
  "enableNotification": boolean
}
Campos
enableNotification

boolean

Indica se o objeto precisa ter a notificação de expiração ativada.

UpcomingNotification

Indica que o emissor quer que a Carteira do Google envie uma notificação sobre a validade do cartão um dia antes de o cartão se tornar válido/utilizável.

Representação JSON 
{
  "enableNotification": boolean
}
Campos
enableNotification

boolean

Indica se o objeto precisa ter as próximas notificações ativadas.

Métodos

addmessage

 Adiciona uma mensagem ao objeto genérico indicado pelo ID de objeto fornecido.

get

 Retorna o objeto genérico com o ID de objeto fornecido.

insert

 Insere um objeto genérico com o ID e as propriedades fornecidos.

list

 Retorna uma lista de todos os objetos genéricos de um determinado ID de emissor.

patch

 Atualiza o objeto genérico indicado pelo ID de objeto fornecido.

update

 Atualiza o objeto genérico indicado pelo ID de objeto fornecido.