REST Resource: giftcardclass

Recurso: GiftCardClass

Representação JSON 
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  }
}
Campos
kind
(deprecated)

string

Identifica o tipo de recurso. Valor: a string fixa "walletobjects#giftCardClass".
merchantName

string

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.
pinLabel

string

O rótulo a ser exibido para o PIN, como "PIN de 4 dígitos".
eventNumberLabel

string

O rótulo a ser exibido para o número do evento, como "Evento de destino no".
allowBarcodeRedemption

boolean

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

object (LocalizedString)

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

object (LocalizedString)

Strings traduzidas do pinLabel.
localizedEventNumberLabel

object (LocalizedString)

Strings traduzidas do eventNumberLabel.
cardNumberLabel

string

O rótulo a ser exibido para o número do cartão, como "Número do cartão".
localizedCardNumberLabel

object (LocalizedString)

Strings traduzidas do cardNumberLabel.
classTemplateInfo

object (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

string

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
(deprecated)

string (int64 format)

Descontinuado
issuerName

string

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[]

object (Message)

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
(deprecated)

boolean

Obsoleto. Use multipleDevicesAndHoldersAllowedStatus
homepageUri

object (Uri)

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[]

object (LatLongPoint)

Observação: no momento, esse campo não é suportado para acionar notificações geográficas.
reviewStatus

enum (ReviewStatus)

Obrigatório. O status da classe. Este campo pode ser definido como draft ou underReview usando as chamadas de API insert, patch ou update. Depois que o estado da revisão for alterado de draft, ele não poderá ser alterado de volta para draft.

Mantenha esse campo como draft quando a classe estiver em desenvolvimento. Uma classe draft não pode ser usada para criar objetos.

Defina este campo como underReview quando achar que a classe está pronta para uso. A plataforma vai definir automaticamente esse campo como approved, e ele poderá ser usado imediatamente para criar ou migrar objetos.

Ao atualizar uma classe que já approved, continue definindo este campo como underReview.
review

object (Review)

Os comentários de revisão definidos pela plataforma quando uma classe é marcada como approved ou rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Obsoleto. Use textModulesData.
imageModulesData[]

object (ImageModuleData)

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[]

object (TextModuleData)

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.
redemptionIssuers[]

string (int64 format)

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 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.
countryCode

string

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

object (Image)

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
(deprecated)

object (Image)

Obsoleto.
enableSmartTap

boolean

Identifica se essa classe é compatível com o Toque inteligente. Os campos redemptionIssuers 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.
hexBackgroundColor

string

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 #ffcc00. Também é possível usar a versão abreviada do trio RGB, que é #rgb, como #fc0.
localizedIssuerName

object (LocalizedString)

Strings traduzidas do emissorName. O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica se vários usuários e dispositivos salvarão o mesmo objeto que referencia esta classe.
callbackOptions

object (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

object (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

enum (ViewUnlockRequirement)

Consulte as opções de requisitos de desbloqueio para o vale-presente.

Métodos

addmessage

 Adiciona uma mensagem à classe de vale-presente indicada pelo ID de classe fornecido.

get

 Retorna a classe do vale-presente com o ID de classe fornecido.

insert

 Insere uma classe de vale-presente com o ID e as propriedades fornecidos.

list

 Retorna uma lista de todas as classes de vale-presente de um determinado ID de emissor.

patch

 Atualiza a classe de vale-presente indicada pelo ID de classe fornecido.

update

 Atualiza a classe de vale-presente indicada pelo ID de classe fornecido.