REST Resource: genericclass

Recurso: GenericClass

Classe genérica

Representação JSON
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "enableSmartTap": boolean,
  "redemptionIssuers": [
    string
  ],
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "messages": [
    {
      object (Message)
    }
  ],
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Campos
id

string

Obrigatório. O identificador exclusivo da classe. Esse ID precisa ser exclusivo entre todos os cartões 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 -.

classTemplateInfo

object (ClassTemplateInfo)

Informações de modelo sobre como a classe deve ser exibida. Se não estiver definido, o Google vai usar um conjunto padrão de campos a serem exibidos.

imageModulesData[]

object (ImageModuleData)

Dados do módulo de imagem. Se imageModulesData também estiver definido no objeto, ambos serão exibidos. 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 no objeto, ambos serão exibidos. O número máximo de campos exibidos é 10 da classe e 10 do objeto.

enableSmartTap

boolean

Disponível apenas para parceiros que aceitam o Toque inteligente. Entre em contato com o suporte para receber mais orientações.

redemptionIssuers[]

string (int64 format)

Identifica quais emissores de resgate podem resgatar o cartão pelo Toque inteligente. Os emissores de resgate são identificados pelo ID do emissor. Os emissores de resgate precisam ter pelo menos uma chave de Toque inteligente configurada.

Os campos enableSmartTap e smartTapRedemptionLevel no nível do objeto também precisam ser configurados corretamente para que um cartão seja compatível com o Toque inteligente.

securityAnimation

object (SecurityAnimation)

Informações opcionais sobre a animação de segurança. Se estiver definido, uma animação de segurança será renderizada nos detalhes do cartão.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica se vários usuários e dispositivos vão salvar o mesmo objeto que faz referência a esta classe.

callbackOptions

object (CallbackOptions)

Opções de callback a serem usadas para retornar ao emissor em cada salvamento/exclusão de um objeto desta classe pelo usuário final. Todos os objetos desta classe são qualificados para o callback.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Confira as opções de requisito de desbloqueio para o cartão genérico.

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 destes campos é 10.

valueAddedModuleData[]

object (ValueAddedModuleData)

Dados opcionais do módulo de valor agregado. No máximo dez na turma. Para um cartão, apenas dez serão exibidos, priorizando os do objeto.

Métodos

addmessage

Adiciona uma mensagem à classe genérica referenciada pelo ID de classe fornecido.

get

Retorna a classe genérica com o ID de classe fornecido.

insert

Insere uma classe genérica com o ID e as propriedades fornecidos.

list

Retorna uma lista de todas as classes genéricas de um determinado ID de emissor.

patch

Atualiza a classe genérica indicada pelo ID de classe fornecido.

update

Atualiza a classe genérica referenciada pelo ID de classe fornecido.