Pacote google.walletobjects.v1.offer

Índice

OfferClassService

AddMessage

rpc AddMessage(OfferClassAddMessageRequest) returns (OfferClassAddMessageResponse)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(OfferClassGetRequest) returns (OfferClass)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(OfferClassInsertRequest) returns (OfferClass)

Insere uma classe de oferta com o ID e as propriedades fornecidos.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(OfferClassListRequest) returns (OfferClassListResponse)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(OfferClassPatchRequest) returns (OfferClass)

Atualiza a classe de oferta indicada pelo ID de classe fornecido. Este método é compatível com a semântica de patch.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(OfferClassUpdateRequest) returns (OfferClass)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer

OfferObjectService

AddMessage

rpc AddMessage(OfferObjectAddMessageRequest) returns (OfferObjectAddMessageResponse)

Adiciona uma mensagem ao objeto de oferta indicado pelo ID de objeto fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(OfferObjectGetRequest) returns (OfferObject)

Retorna o objeto de oferta com o ID de objeto fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(OfferObjectInsertRequest) returns (OfferObject)

Insere um objeto de oferta com o ID e as propriedades fornecidos.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(OfferObjectListRequest) returns (OfferObjectListResponse)

Retorna uma lista de todos os objetos de oferta de um determinado ID de emissor.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(OfferObjectPatchRequest) returns (OfferObject)

Atualiza o objeto de oferta indicado pelo ID de objeto fornecido. Este método é compatível com a semântica de patch.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(OfferObjectUpdateRequest) returns (OfferObject)

Atualiza o objeto de oferta indicado pelo ID de objeto fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer

OfferClass

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.
redemption_channel

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.
title_image

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.
fine_print

string

Restrições ou termos da oferta, como "20% de desconto em qualquer camiseta da Adam's Apparel".
help_uri

Uri

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

LocalizedString

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

LocalizedString

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

LocalizedString

Strings traduzidas dos detalhes.
localized_fine_print

LocalizedString

Strings traduzidas de fine_print.
short_title

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.
localized_short_title

LocalizedString

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

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)

int64

Obsoleto
issuer_name

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[]

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.
allow_multiple_users_per_object
(deprecated)

bool

Obsoleto. Use multipleDevicesAndHoldersAllowedStatus.
homepage_uri

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[]

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.
review_status

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

Review

Os comentários de revisão definidos pela plataforma quando uma classe é marcada como approved ou rejected.
info_module_data
(deprecated)

InfoModuleData

Obsoleto. Use textModulesData.
image_modules_data[]

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.
text_modules_data[]

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.
redemption_issuers[]

int64

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

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
hero_image

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.
word_mark
(deprecated)

Image

Obsoleto.
enable_smart_tap

bool

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

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.
localized_issuer_name

LocalizedString

Strings traduzidas do issuer_name. O tamanho máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.
multiple_devices_and_holders_allowed_status

MultipleDevicesAndHoldersAllowedStatus

Identifica se vários usuários e dispositivos salvarão o mesmo objeto que faz referência a esta classe.
callback_options

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.

OfferClassAddMessageRequest

Campos
resource_id

string

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 "-".
add_message_request

AddMessageRequest

Corpo da solicitação.

OfferClassAddMessageResponse

Campos
resource

OfferClass

O recurso OfferClass atualizado.

OfferClassGetRequest

Campos
resource_id

string

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 "-".

OfferClassInsertRequest

Campos
resource

OfferClass

Corpo da solicitação.

OfferClassListRequest

Campos
issuer_id

int64

O ID do emissor autorizado a listar classes.
token

string

Usado para conseguir o próximo conjunto de resultados se maxResults for especificado, mas mais de maxResults classes estiverem disponíveis em uma lista. Por exemplo, se você tiver uma lista de 200 classes e chamar a lista com maxResults definido como 20, a lista retornará as primeiras 20 classes e um token. Chame a lista novamente com maxResults definido como 20 e o token para receber as 20 próximas classes.
max_results

int32

Identifica o número máximo de resultados retornados por uma lista. Todos os resultados serão retornados se maxResults não estiver definido.

OfferClassListResponse

Campos
resources[]

OfferClass

Recursos correspondentes à solicitação de lista.
pagination

Pagination

Paginação da resposta.

OfferClassPatchRequest

Campos
resource_id

string

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 "-".
resource

OfferClass

Corpo da solicitação.

OfferClassUpdateRequest

Campos
resource_id

string

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 "-".
resource

OfferClass

Corpo da solicitação.

OfferObject

Campos
kind
(deprecated)

string

Identifica o tipo de recurso. Valor: a string fixa "walletobjects#offerObject".
class_reference

OfferClass

Uma cópia dos campos herdados da classe pai. Estes campos são recuperados durante um GET.
id

string

Obrigatório. O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos 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 "-".
class_id

string

Obrigatório. A classe associada a este objeto. É preciso que a classe seja do mesmo tipo que este objeto, já existente e aprovada.

Os IDs de classe precisam seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você.
version
(deprecated)

int64

Obsoleto
state

State

Obrigatório. O estado do objeto. Este campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto inactive é movido para a seção "Cartões expirados".
barcode

Barcode

O tipo e o valor do código de barras.
messages[]

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.
valid_time_interval

TimeInterval

O período em que esse objeto fica active e pode ser usado. O estado de um objeto será alterado para expired quando esse período acabar.
locations[]

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.
has_users

bool

Indica se o objeto tem usuários. Este campo é definido pela plataforma.
smart_tap_redemption_value

string

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

bool

Se este objeto está atualmente vinculado a um único dispositivo. Este campo é definido pela plataforma quando um usuário salva o objeto, vinculando-o ao dispositivo. Destinado ao uso por parceiros selecionados. Entre em contato com o suporte para mais informações.
disable_expiration_notification

bool

Indica se as notificações devem ser explicitamente suprimidas. Se esse campo estiver definido como verdadeiro, independentemente do campo messages, as notificações de expiração enviadas para o usuário serão suprimidas. Por padrão, esse campo é definido como falso.

Atualmente, só é possível definir isso para ofertas.
info_module_data

InfoModuleData

Obsoleto. Use textModulesData.
image_modules_data[]

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.
text_modules_data[]

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.

OfferObjectAddMessageRequest

Campos
resource_id

string

O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos 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 "-".
add_message_request

AddMessageRequest

Corpo da solicitação.

OfferObjectAddMessageResponse

Campos
resource

OfferObject

O recurso OfferObject atualizado.

OfferObjectGetRequest

Campos
resource_id

string

O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos 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 "-".

OfferObjectInsertRequest

Campos
resource

OfferObject

Corpo da solicitação.

OfferObjectListRequest

Campos
class_id

string

O ID da classe que terá objetos listados.
token

string

Usado para conseguir o próximo conjunto de resultados se maxResults for especificado, mas mais de maxResults objetos estiverem disponíveis em uma lista. Por exemplo, se você tiver uma lista de 200 objetos e chamar a lista com maxResults definido como 20, a lista retornará os primeiros 20 objetos e um token. Chame a lista novamente com maxResults definido como 20 e o token para receber os próximos 20 objetos.
max_results

int32

Identifica o número máximo de resultados retornados por uma lista. Todos os resultados serão retornados se maxResults não estiver definido.

OfferObjectListResponse

Campos
resources[]

OfferObject

Recursos correspondentes à solicitação de lista.
pagination

Pagination

Paginação da resposta.

OfferObjectPatchRequest

Campos
resource_id

string

O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos 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 "-".
resource

OfferObject

Corpo da solicitação.

OfferObjectUpdateRequest

Campos
resource_id

string

O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos 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 "-".
resource

OfferObject

Corpo da solicitação.