Recurso: GiftCardClass
Representação JSON |
---|
{ "kind": string, "merchantName": string, "programLogo": { object ( |
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
merchantName |
Nome do comerciante, como "Adam's Apparel". O app pode mostrar reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores. |
programLogo |
O logotipo do programa ou da empresa de vale-presente. Esse logotipo é exibido nos detalhes e nas visualizações em lista do app. |
pinLabel |
O rótulo a ser exibido para o PIN, como "PIN de 4 dígitos". |
eventNumberLabel |
O rótulo a ser exibido para o número do evento, como "Evento de destino no". |
allowBarcodeRedemption |
Determina se o comerciante aceita resgate de vale-presente usando código de barras. Se verdadeiro, o app exibirá um código de barras do vale-presente na tela de detalhes do vale-presente. Se for falso, o código de barras não será exibido. |
localizedMerchantName |
Strings traduzidas do merchantName. O app pode mostrar reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores. |
localizedPinLabel |
Strings traduzidas do pinLabel. |
localizedEventNumberLabel |
Strings traduzidas do eventNumberLabel. |
cardNumberLabel |
O rótulo a ser exibido para o número do cartão, como "Número do cartão". |
localizedCardNumberLabel |
Strings traduzidas do cardNumberLabel. |
classTemplateInfo |
Informações do modelo sobre como a classe deve ser exibida. Se ela não for definida, o Google usará um conjunto padrão de campos para exibir. |
id |
Obrigatório. O identificador exclusivo de uma classe. Esse ID precisa ser exclusivo entre todas as classes 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ê. Seu identificador exclusivo deve incluir apenas caracteres alfanuméricos, ".", "_" ou "-". |
version |
Descontinuado |
issuerName |
Obrigatório. O nome do emissor. O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
messages[] |
Uma matriz de mensagens exibidas no app. Todos os usuários desse objeto vão receber as mensagens associadas. O número máximo destes campos é 10. |
allowMultipleUsersPerObject |
Obsoleto. Use |
homepageUri |
O URI da página inicial do seu aplicativo. Preencher o URI neste campo resulta no mesmo comportamento que o preenchimento de um URI em linksModuleData. Quando um objeto é renderizado, um link para a página inicial é mostrado no que normalmente seria considerado a seção linksModuleData do objeto. |
locations[] |
Observação: no momento, esse campo não é suportado para acionar notificações geográficas. |
reviewStatus |
Obrigatório. O status da classe. Este campo pode ser definido como Mantenha esse campo como Defina este campo como Ao atualizar uma classe que já |
review |
Os comentários de revisão definidos pela plataforma quando uma classe é marcada como |
infoModuleData |
Obsoleto. Use textModulesData. |
imageModulesData[] |
Dados do módulo de imagem. O número máximo destes 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 no objeto, ambos serão exibidos. |
redemptionIssuers[] |
Identifica quais emissores de resgate podem resgatar o cartão pelo Toque inteligente. Os emissores de resgate são identificados por seu ID de emissor. Os emissores de resgate precisam ter pelo menos uma chave do Toque inteligente configurada. Os campos |
countryCode |
Código de país usado para exibir o país do cartão (quando o usuário não está nesse país), bem como para mostrar conteúdo localizado quando o conteúdo não está disponível na localidade do usuário. |
heroImage |
Imagem opcional do banner exibida na frente do cartão. Se nenhum estiver presente, nada será exibido. A imagem será exibida com 100% de largura. |
wordMark |
Obsoleto. |
enableSmartTap |
Identifica se essa classe é compatível com o Toque inteligente. Os campos |
hexBackgroundColor |
A cor de fundo do cartão. Se ela não estiver definida, a cor dominante da imagem principal será usada. Se não houver uma imagem principal definida, a cor dominante do logotipo será usada. O formato é #rrggbb, em que rrggbb é um trio hexadecimal RGB, como |
localizedIssuerName |
Strings traduzidas do emissorName. O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
multipleDevicesAndHoldersAllowedStatus |
Identifica se vários usuários e dispositivos salvarão o mesmo objeto que referencia esta classe. |
callbackOptions |
Opções de callback a serem usadas para chamar o emissor de volta para cada salvamento/exclusão de um objeto desta classe pelo usuário final. Todos os objetos dessa classe são qualificados para o callback. |
securityAnimation |
Informações opcionais sobre a animação de segurança. Se isso for definido, uma animação de segurança vai ser renderizada nos detalhes do cartão. |
viewUnlockRequirement |
Consulte as opções de requisitos de desbloqueio para o vale-presente. |
wideProgramLogo |
O logotipo largo do programa ou da empresa de vale-presente. Quando fornecido, ele será usado no lugar do logotipo do programa no canto superior esquerdo da visualização de card. |
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 correspondente que será usado. |
Métodos |
|
---|---|
|
Adiciona uma mensagem à classe de vale-presente indicada pelo ID de classe fornecido. |
|
Retorna a classe do vale-presente com o ID de classe fornecido. |
|
Insere uma classe de vale-presente com o ID e as propriedades fornecidos. |
|
Retorna uma lista de todas as classes de vale-presente de um determinado ID de emissor. |
|
Atualiza a classe de vale-presente indicada pelo ID de classe fornecido. |
|
Atualiza a classe de vale-presente indicada pelo ID de classe fornecido. |