Recurso: OfferClass
Representação JSON |
---|
{ "kind": string, "title": string, "redemptionChannel": enum ( |
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
title |
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 |
Obrigatório. Os canais de resgate aplicáveis a esta oferta. |
provider |
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 |
A imagem do título da oferta. Essa imagem é exibida nas visualizações de detalhes e de lista do app. |
details |
Os detalhes da oferta. |
finePrint |
As letras miúdas ou os termos da oferta, como "20% de desconto em qualquer camiseta da Adam's Apparel". |
helpUri |
O link de ajuda para a oferta, como |
localizedTitle |
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 |
Strings traduzidas do provedor. O comprimento máximo recomendado é 12 caracteres, para garantir que a string inteira seja exibida em telas menores. |
localizedDetails |
Strings traduzidas dos detalhes. |
localizedFinePrint |
Strings traduzidas do FinePrint. |
shortTitle |
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 |
Strings traduzidas do título curto. O tamanho máximo recomendado é de 20 caracteres. |
classTemplateInfo |
Informações de 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 |
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ê. O identificador exclusivo precisa incluir apenas caracteres alfanuméricos, ".", "_" ou "-". |
version |
Suspenso |
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 deste objeto vão receber as mensagens associadas. O número máximo desses campos é 10. |
allowMultipleUsersPerObject |
Obsoleto. Use |
homepageUri |
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[] |
Observação: no momento, este 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 esse campo como Ao atualizar uma classe 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 de 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 pelo ID do emissor. Os emissores de resgate precisam ter pelo menos uma chave de Toque inteligente configurada. Os campos |
countryCode |
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 |
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 |
Obsoleto. |
enableSmartTap |
Identifica se essa classe oferece suporte ao Toque inteligente. Os campos |
hexBackgroundColor |
A cor de fundo do cartão. Se não for 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 |
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 se refere a essa 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 desta classe são qualificados para o callback. |
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 |
Confira as opções de requisitos de desbloqueio para a oferta. |
wideTitleImage |
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. |
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. |
RedemptionChannel
Enums | |
---|---|
REDEMPTION_CHANNEL_UNSPECIFIED |
|
INSTORE |
|
instore |
Alias legado de |
ONLINE |
|
online |
Alias legado de |
BOTH |
|
both |
Alias legado de |
TEMPORARY_PRICE_REDUCTION |
|
temporaryPriceReduction |
Alias legado de |
Métodos |
|
---|---|
|
Adiciona uma mensagem à classe de oferta indicada pelo ID de classe fornecido. |
|
Retorna a classe de oferta com o ID de classe fornecido. |
|
Insere uma classe de oferta com o código e as propriedades fornecidos. |
|
Retorna uma lista de todas as classes de oferta de um determinado ID de emissor. |
|
Atualiza a classe de oferta indicada pelo ID de classe fornecido. |
|
Atualiza a classe de oferta indicada pelo ID de classe fornecido. |