Esta página foi traduzida pela API Cloud Translation.

REST Resource: giftcardclass

Recurso: GiftCardClass
- Representação JSON
Métodos

Recurso: GiftCardClass

Representação JSON

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`) }, "notifyPreference": enum (`NotificationSettingsForUpdates`), "appLinkData": { object (`AppLinkData`) }, "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "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)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

Campos
`kind (deprecated)`	`string` Este item está obsoleto. Identifica o tipo de recurso. Valor: a string fixa `"walletobjects#giftCardClass"`.
`merchantName`	`string` Nome do comerciante, como "Adam's Apparel". O app pode exibir reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores.
`programLogo`	`object (Image)` O logotipo do programa ou empresa do vale-presente. Esse logotipo é exibido nas visualizações de detalhes e em lista do app.
`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 nº".
`allowBarcodeRedemption`	`boolean` Determina se o comerciante aceita resgate de vale-presente usando código de barras. Se verdadeiro, o app vai mostrar 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 exibir 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 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.
`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 segundo é escolhido por você. Ele precisa incluir apenas caracteres alfanuméricos, ".", "_" ou "-".
`version (deprecated)`	`string (int64 format)` Este item está obsoleto. Suspenso
`issuerName`	`string` Obrigatório. O nome do emissor. O tamanho máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.
`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.
`allowMultipleUsersPerObject (deprecated)`	`boolean` Este item está obsoleto. 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[] (deprecated)`	`object (LatLongPoint)` Este item está obsoleto. Observação: no momento, esse campo não é compatível com o acionamento de 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 inserção, correção ou atualização de API. Depois que o estado da revisão for alterado de `draft`, ele não será alterado novamente para `draft`. Mantenha este campo como `draft` quando a classe estiver em desenvolvimento. Não é possível usar uma classe `draft` para criar nenhum objeto. Defina este campo como `underReview` quando acreditar que a classe está pronta para uso. A plataforma definirá automaticamente esse campo como `approved`, que poderá ser usado imediatamente para criar ou migrar objetos. Ao atualizar uma classe 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)` Este item está obsoleto. Obsoleto. Use textModulesData.
`imageModulesData[]`	`object (ImageModuleData)` Dados do módulo de imagem. O número máximo de 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 de campos exibidos é 10 para o objeto e 10 para a classe.
`linksModuleData`	`object (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[]`	`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 o cartão ofereça suporte ao Toque inteligente.
`countryCode`	`string` Código do país usado para mostrar o país do cartão (quando o usuário não está nesse país), bem como para mostrar o conteúdo localizado quando o conteúdo não está disponível na localidade do usuário
`heroImage`	`object (Image)` Imagem de banner opcional 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)` Este item está obsoleto. Obsoleto.
`enableSmartTap`	`boolean` Identifica se essa classe oferece suporte ao 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 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. O formato é #`rrggbb`, em que `rrggbb` é um trio RGB hexadecimal, como `#ffcc00`. Você também pode usar a versão abreviada do trio RGB, que é o número `rgb`, como `#fc0`.
`localizedIssuerName`	`object (LocalizedString)` Strings traduzidas do issuerName. O tamanho 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 se refere a essa 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.
`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.
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` Confira as opções de requisito de desbloqueio do vale-presente.
`wideProgramLogo`	`object (Image)` O logotipo largo do programa ou empresa do vale-presente. Quando fornecido, ele será usado no lugar do logotipo do programa no canto superior esquerdo da visualização de card.
`notifyPreference`	`enum (NotificationSettingsForUpdates)` Se as atualizações de campo para essa classe precisam acionar notificações. Quando definido como NOTIFY, tentamos acionar uma notificação de atualização de campo para os usuários. Essas notificações só serão enviadas aos usuários se o campo fizer parte de uma lista de permissões. Se não for especificado, nenhuma notificação será acionada. Essa configuração é temporária e precisa ser definida com cada solicitação PATCH ou UPDATE. Caso contrário, uma notificação não será acionada.
`appLinkData`	`object (AppLinkData)` Link opcional de app ou site que será exibido como um botão na parte frontal do cartão. Se AppLinkData for fornecido para o objeto correspondente, que será usado.
`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 de vale-presente indicada pelo ID de classe fornecido.
`get`	Retorna a classe de vale-presente com o ID de classe fornecido.
`insert`	Insere uma classe de vale-presente com o código e as propriedades fornecidos.
`list`	Retorna uma lista de todas as classes de vale-presente de um determinado código 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.

REST Resource: giftcardclass

Recurso: GiftCardClass

Métodos

`addmessage`

`get`

`insert`

`list`

`patch`

`update`