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,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Campos
genericType

enum (GenericType)

Especifique a que GenericType o cartão pertence.
cardTitle

object (LocalizedString)

Obrigatório. O cabeçalho do cartão. Geralmente, é o nome da empresa, como "XXX Gym" ou "AAA Insurance". Esse campo é obrigatório e aparece na linha do cabeçalho, na parte de cima 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 de 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", "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.
hexBackgroundColor

string

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

object (Notifications)

As configurações de notificação ativadas para esse 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, poderemos permitir que o emissor defina Barcode.alternate_text e exiba 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 em que esse objeto será considerado válido ou utilizável. Quando o período de tempo passar, o objeto será considerado expirado, o que afetará a renderização nos dispositivos do usuário.
imageModulesData[]

object (ImageModuleData)

Dados do módulo de imagem. Apenas uma das imagens da classe e uma do nível do objeto serão renderizadas quando ambas estiverem 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 exibidos é 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 este objeto. Os campos de nível de classe enableSmartTap e redemptionIssuers também precisam ser configurados corretamente para que o cartão ofereça suporte ao 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. Este campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto inactive é movido para a seção "Cartões expirados". Se não for fornecido, o objeto será considerado ACTIVE.
hasUsers

boolean

Indica se o objeto tem usuários. Este campo é definido pela plataforma.
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 desses campos é 10.
passConstraints

object (PassConstraints)

Transmitir restrições para o objeto. Inclui a limitação de comportamentos de NFC e captura de tela.
saveRestrictions

object (SaveRestrictions)

Restrições ao objeto que precisam ser verificadas antes que o usuário tente salvar o cartão. Essas restrições só serão aplicadas durante o tempo de gravação. Se as restrições mudarem depois que um usuário salvar o cartão, as novas restrições não serão aplicadas a um cartão já salvo.
valueAddedModuleData[]

object (ValueAddedModuleData)

Dados opcionais do módulo de valor agregado. Máximo de dez no objeto.
linkedObjectIds[]

string

Os linkedObjectIds são uma lista de outros objetos, como ingresso de evento, fidelidade, oferta, genérico, vale-presente, transporte público e cartão de embarque, que precisam ser anexados automaticamente a esse objeto genérico. Se um usuário tivesse salvo esse cartão genérico, esses linkedObjectIds seriam enviados automaticamente para a carteira do usuário, a menos que ele desativasse a configuração para receber esses cartões vinculados.

Certificar-se de que os objetos presentes em linkedObjectIds já estejam inseridos. Caso contrário, as chamadas falharão. Depois de vincular, não é possível desvincular os objetos. Não é possível vincular objetos que pertencem a outro emissor. Há um limite para o número de objetos que podem ser vinculados a um único objeto. Quando o limite for atingido, os novos objetos vinculados na chamada serão ignorados silenciosamente.

Os IDs de objeto precisam seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o segundo é escolhido por você.

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_LOYALTY_CARD Cartões de fidelidade. É aconselhável usar um tipo de cartão de fidelidade dedicado em vez desse tipo genérico. Um tipo de cartão de fidelidade dedicado oferece mais recursos e funcionalidades do que um tipo genérico.
GENERIC_OTHER Outro tipo

Notificações

Indica se o objeto precisa ter a notificação ativada. Oferecemos suporte apenas a uma das notificações de expiração/próximos. 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 horário específico antes do cartão expirar.
upcomingNotification

object (UpcomingNotification)

Uma notificação seria acionada em um horário específico antes que o cartão se torne utilizável.

ExpiryNotification

Indica que o emissor quer que a Carteira do Google envie notificações de expiração dois dias antes da data de validade 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 de validade do cartão um dia antes de ele ser válido/utilizável.

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

boolean

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

Métodos

addmessage

 Adiciona uma mensagem ao objeto genérico referenciado 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 referenciado pelo ID de objeto fornecido.