Esta página foi traduzida pela API Cloud Translation.

REST Resource: offerclass

Recurso: OfferClass
- Representação JSON
- RedemptionChannel
Métodos

Recurso: OfferClass

Representação JSON

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

{
  "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)
  },
  "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#offerClass"`.
`title`	`string` Obrigatório. O título da oferta, como "20% de desconto em qualquer camiseta". O tamanho máximo recomendado é 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 nos detalhes e nas visualizações de lista do app.
`details`	`string` Os detalhes da oferta.
`finePrint`	`string` Restrições ou 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 tamanho máximo recomendado é 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 de finePrint.
`shortTitle`	`string` Uma versão abreviada do título da oferta, como "20% de desconto", exibida aos usuários como referência rápida ao conteúdo da oferta. O tamanho máximo recomendado é 20 caracteres.
`localizedShortTitle`	`object (LocalizedString)` Strings traduzidas do título curto. O tamanho máximo recomendado é de 20 caracteres.
`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ê. O identificador exclusivo deve 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 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 revisão for alterado de `draft`, ele não será alterado novamente para `draft`. Mantenha esse 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 do 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 não houver nenhuma, 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 card. 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 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 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 vão salvar o mesmo objeto que faz referência a 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 desta classe são qualificados para callback.
`securityAnimation`	`object (SecurityAnimation)` Informações opcionais sobre a animação de segurança. Se essa opção for definida, uma animação de segurança será renderizada nos detalhes do cartão.
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` Confira as opções de requisito de desbloqueio da oferta.
`wideTitleImage`	`object (Image)` A imagem de título ampla da oferta. Quando fornecido, será usado no lugar da imagem do título 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 definida como NOTIFY, tentaremos 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 do app ou site que vai aparecer como um botão na frente 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.

RedemptionChannel

Enums
`REDEMPTION_CHANNEL_UNSPECIFIED`
`INSTORE`
`instore`	Alias legado de `INSTORE`. Obsoleto. Este item está obsoleto.
`ONLINE`
`online`	Alias legado de `ONLINE`. Obsoleto. Este item está obsoleto.
`BOTH`
`both`	Alias legado de `BOTH`. Obsoleto. Este item está obsoleto.
`TEMPORARY_PRICE_REDUCTION`
`temporaryPriceReduction`	Alias legado de `TEMPORARY_PRICE_REDUCTION`. Obsoleto. Este item está 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.

REST Resource: offerclass

Recurso: OfferClass

RedemptionChannel

Métodos

`addmessage`

`get`

`insert`

`list`

`patch`

`update`