REST Resource: offerclass

Recurso: OfferClass

Representação JSON 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    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),
  "wideTitleImage": {
    object (Image)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Campos
kind
(deprecated)

string

Identifica o tipo de recurso. Valor: a string fixa "walletobjects#offerClass".
title

string

Obrigatório. O título da oferta, como "20% de desconto em qualquer camiseta". O comprimento máximo recomendado é de 60 caracteres, para garantir que a string inteira seja exibida em telas menores.
redemptionChannel

enum (RedemptionChannel)

Obrigatório. Os canais de resgate aplicáveis a esta oferta.
provider

string

Obrigatório. O provedor da oferta (o nome do agregador ou do comerciante). O comprimento máximo recomendado é 12 caracteres, para garantir que a string inteira seja exibida em telas menores.
titleImage

object (Image)

A imagem do título da oferta. Essa imagem é exibida nas visualizações de detalhes e de lista do app.
details

string

Detalhes da oferta.
finePrint

string

As letras miúdas ou os termos da oferta, como "20% de desconto em qualquer camiseta da Adam's Apparel".
helpUri

object (Uri)

O link de ajuda para a oferta, como http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

Strings traduzidas do título. O comprimento máximo recomendado é de 60 caracteres, para garantir que a string inteira seja exibida em telas menores.
localizedProvider

object (LocalizedString)

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

object (LocalizedString)

Strings traduzidas dos detalhes.
localizedFinePrint

object (LocalizedString)

Strings traduzidas do FinePrint.
shortTitle

string

Uma versão abreviada do título da oferta, como "20% de desconto", mostrados aos usuários como referência rápida ao conteúdo da oferta. O tamanho máximo recomendado é de 20 caracteres.
localizedShortTitle

object (LocalizedString)

Strings traduzidas do título curto. O tamanho máximo recomendado é de 20 caracteres.
classTemplateInfo

object (ClassTemplateInfo)

Informações do modelo sobre como a classe deve ser mostrada. Se ela não for definida, o Google usará um conjunto padrão de campos para exibição.
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ê. Ele precisa incluir apenas caracteres alfanuméricos, ".", "_" ou "-".
version
(deprecated)

string (int64 format)

Suspenso
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 deste objeto vão receber as mensagens associadas. O número máximo desses campos é 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Obsoleto. Use multipleDevicesAndHoldersAllowedStatus
homepageUri

object (Uri)

O URI da página inicial do seu aplicativo. Preencher o URI nesse campo resulta exatamente 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, este 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 o status da classe. Esse campo pode ser definido como draft ou underReview usando as chamadas de API de inserção, patch ou atualização. Depois que o estado da avaliaçã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. A classe draft não pode ser usada para criar nenhum objeto.

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

string

Código do país usado para exibir o país do cartão (quando o usuário não está naquele país), bem como para exibir conteúdo localizado quando o conteúdo não está disponível na localidade do usuário.
heroImage

object (Image)

Imagem do banner opcional exibida na parte frontal 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 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, será usada a cor dominante da imagem principal e, se nenhuma imagem principal estiver 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 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 se refere a essa 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 desta classe são qualificados para o callback.
securityAnimation

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

Confira as opções de requisitos de desbloqueio para a oferta.
wideTitleImage

object (Image)

A imagem ampla do título da oferta. Quando fornecido, será usado no lugar da imagem do título no canto superior esquerdo da visualização de card.

RedemptionChannel

Enums
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Alias legado de INSTORE. Obsoleto.
ONLINE
online

Alias legado de ONLINE. Obsoleto.
BOTH
both

Alias legado de BOTH. Obsoleto.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Alias legado de TEMPORARY_PRICE_REDUCTION. Obsoleto.

Métodos

addmessage

 Adiciona uma mensagem à classe de oferta indicada pelo ID de classe fornecido.

get

 Retorna a classe de oferta com o ID de classe fornecido.

insert

 Insere uma classe de oferta com o código e as propriedades fornecidos.

list

 Retorna uma lista de todas as classes de oferta de um determinado ID de emissor.

patch

 Atualiza a classe de oferta indicada pelo ID de classe fornecido.

update

 Atualiza a classe de oferta indicada pelo ID de classe fornecido.