Pacote google.walletobjects.v1.giftcard

Índice

GiftCardClassService

AddMessage

rpc AddMessage(GiftCardClassAddMessageRequest) returns (GiftCardClassAddMessageResponse)

Adiciona uma mensagem à classe de vale-presente indicada pelo código de classe fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc Get(GiftCardClassGetRequest) returns (GiftCardClass)

Retorna a classe do vale-presente com o código de classe fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc Insert(GiftCardClassInsertRequest) returns (GiftCardClass)

Insere uma classe de vale-presente com o código e as propriedades fornecidos.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc List(GiftCardClassListRequest) returns (GiftCardClassListResponse)

Retorna uma lista com todas as classes de vale-presente de um determinado código de emissor.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc Patch(GiftCardClassPatchRequest) returns (GiftCardClass)

Atualiza a classe de vale-presente indicada pelo código 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(GiftCardClassUpdateRequest) returns (GiftCardClass)

Atualiza a classe de vale-presente indicada pelo código de classe fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

GiftCardObjectService

AddMessage

rpc AddMessage(GiftCardObjectAddMessageRequest) returns (GiftCardObjectAddMessageResponse)

Adiciona uma mensagem ao objeto de vale-presente indicado pelo código de objeto fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc Get(GiftCardObjectGetRequest) returns (GiftCardObject)

Retorna o objeto de vale-presente com o código de objeto fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc Insert(GiftCardObjectInsertRequest) returns (GiftCardObject)

Insere um objeto de vale-presente com o código e as propriedades fornecidos.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc List(GiftCardObjectListRequest) returns (GiftCardObjectListResponse)

Retorna uma lista de todos os objetos de vale-presente de um determinado código de emissor.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

rpc Patch(GiftCardObjectPatchRequest) returns (GiftCardObject)

Atualiza o objeto de vale-presente indicado pelo código 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(GiftCardObjectUpdateRequest) returns (GiftCardObject)

Atualiza o objeto de vale-presente indicado pelo código de objeto fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

GiftCardClass

Campos
kind
(deprecated)

string

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

merchant_name

string

Nome do comerciante, como "Adam's Apparel". O app pode exibir reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores.

pin_label

string

O rótulo a ser exibido para o PIN, como "PIN de 4 dígitos".

event_number_label

string

O rótulo a ser exibido para o número do evento, como "Evento de destino nº".

allow_barcode_redemption

bool

Determina se o comerciante aceita resgate de vale-presente usando código de barras. Se verdadeiro, o app exibirá um código de barras do vale-presente na tela de detalhes do vale-presente. Se falso, o código de barras não será exibido.

localized_merchant_name

LocalizedString

Strings traduzidas do merchant_name. O app pode exibir reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores.

localized_pin_label

LocalizedString

Strings traduzidas do pin_label.

localized_event_number_label

LocalizedString

Strings traduzidas do event_number_label.

card_number_label

string

O rótulo a ser exibido como número do cartão, como "Número do cartão".

localized_card_number_label

LocalizedString

Strings traduzidas do card_number_label.

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

GiftCardClassAddMessageRequest

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.

GiftCardClassAddMessageResponse

Campos
resource

GiftCardClass

O recurso GiftCardClass atualizado.

GiftCardClassGetRequest

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

GiftCardClassInsertRequest

Campos
resource

GiftCardClass

Corpo da solicitação.

GiftCardClassListRequest

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.

GiftCardClassListResponse

Campos
resources[]

GiftCardClass

Recursos correspondentes à solicitação de lista.

pagination

Pagination

Paginação da resposta.

GiftCardClassPatchRequest

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

GiftCardClass

Corpo da solicitação.

GiftCardClassUpdateRequest

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

GiftCardClass

Corpo da solicitação.

GiftCardObject

Campos
kind
(deprecated)

string

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

class_reference

GiftCardClass

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

card_number

string

Obrigatório. O número do cartão.

pin

string

O PIN do cartão.

balance

Money

O saldo monetário do cartão.

balance_update_time

DateTime

A data e hora em que o saldo foi atualizado pela última vez.

A compensação é obrigatória.

Se o saldo for atualizado e esta propriedade não for fornecida, o sistema assumirá o horário atual como padrão.

event_number

string

O número do evento do cartão, um campo opcional usado por alguns vales-presente.

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.

GiftCardObjectAddMessageRequest

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.

GiftCardObjectAddMessageResponse

Campos
resource

GiftCardObject

O recurso GiftCardObject atualizado.

GiftCardObjectGetRequest

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

GiftCardObjectInsertRequest

Campos
resource

GiftCardObject

Corpo da solicitação.

GiftCardObjectListRequest

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.

GiftCardObjectListResponse

Campos
resources[]

GiftCardObject

Recursos correspondentes à solicitação de lista.

pagination

Pagination

Paginação da resposta.

GiftCardObjectPatchRequest

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

GiftCardObject

Corpo da solicitação.

GiftCardObjectUpdateRequest

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

GiftCardObject

Corpo da solicitação.