Recurso REST: 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)
  }
}
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 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. Esta 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 é 20 caracteres.

classTemplateInfo

object (ClassTemplateInfo)

Informações de modelo sobre como a classe deve ser exibida. Se não estiver definido, o Google usará como alternativa um conjunto padrão de campos a serem exibidos.

id

string

Obrigatório. O identificador exclusivo de uma classe. Este 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 deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-".

version
(deprecated)

string (int64 format)

Obsoleto

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 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 considerada a seção linksModuleData do objeto.

locations[]

object (LatLongPoint)

A lista de locais em que o objeto pode ser usado. A plataforma usa estas informações para acionar notificações de geolocalização para os usuários. Observe que os locais no objeto modificam os locais na classe, que por sua vez modificam os locais no ID do Google Places.

reviewStatus

enum (ReviewStatus)

Obrigatório. O status da classe. Este campo pode ser definido como draft ou 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.

Você precisa manter esse campo como draft quando a classe estiver em desenvolvimento. Não é possível usar uma classe draft para criar nenhum objeto.

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

Ao atualizar uma classe já approved, é preciso continuar configurando 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 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 esses dados 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.

redemptionIssuers[]

string (int64 format)

Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações.

countryCode

string

ID do país, usado para exibir o país do cartão (quando o usuário não está nesse país), bem como para exibir 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)

Obsoleto.

enableSmartTap

boolean

Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações.

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 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 salvarão o mesmo objeto que faz referência a esta 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 callback.

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 ID 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 código de classe especificado.