Pacote google.walletobjects.v1

Índice

AddMessageRequest

Recurso usado quando os endpoints AddMessage são chamados.

Campos
message

Message

AppLinkData

Campos

AppLinkInfo

Campos
app_logo_image

Image

Imagem opcional a ser exibida no módulo de link do app

title

LocalizedString

String a ser exibida no título do módulo de link do app obrigatório

description

LocalizedString

String a ser exibida na descrição do módulo de link do app obrigatório

app_target

AppTarget

URL que será seguido ao abrir o módulo de link do app nos clientes. Ele será usado pelos parceiros para abrir a página da Web ou o link direto no aplicativo.

AppTarget

Campos
target_uri

Uri

Barcode

Campos
kind
(deprecated)

string

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

type

BarcodeType

O tipo de código de barras.

render_encoding

BarcodeRenderEncoding

A codificação de renderização do código de barras. Quando especificado, o código de barras é renderizado na codificação informada. Caso contrário, o Google escolhe a codificação mais conhecida.

value

string

O valor codificado no código de barras.

alternate_text

string

Um texto opcional que substituirá o texto padrão exibido abaixo do código de barras. Esse campo é destinado a um valor equivalente ao código de barras que possa ser lido por humanos, quando não for possível ler o código de barras.

show_code_text

LocalizedString

Texto opcional que será exibido quando o código de barras estiver oculto atrás de uma ação de clique. Isso acontece nos casos em que um cartão tem o Smart Tap ativado. Se não for especificado, o Google escolhe um padrão.

BarcodeRenderEncoding

Enums
RENDER_ENCODING_UNSPECIFIED
UTF_8 Codificação UTF_8 para códigos de barras. Compatível apenas para o tipo de código de barras qrCode.

BarcodeType

Enums
BARCODE_TYPE_UNSPECIFIED
AZTEC
aztec

Alias legado de AZTEC. Obsoleto.

CODE_39
code39

Alias legado de CODE_39. Obsoleto.

CODE_128
code128

Alias legado de CODE_128. Obsoleto.

CODABAR
codabar

Alias legado de CODABAR. Obsoleto.

DATA_MATRIX Um código de barras da matriz 2D em preto e branco. As células ou módulos são organizados na forma de um quadrado ou retângulo.
dataMatrix

Alias legado de DATA_MATRIX. Obsoleto.

EAN_8
ean8

Alias legado de EAN_8. Obsoleto.

EAN_13
ean13

Alias legado de EAN_13. Obsoleto.

EAN13

Alias legado de EAN_13. Obsoleto.

ITF_14 Código ITF de 14 dígitos
itf14

Alias legado de ITF_14. Obsoleto.

PDF_417
pdf417

Alias legado de PDF_417. Obsoleto.

PDF417

Alias legado de PDF_417. Obsoleto.

QR_CODE
qrCode

Alias legado de QR_CODE. Obsoleto.

qrcode

Alias legado de QR_CODE. Obsoleto.

UPC_A Códigos de 11 ou 12 dígitos
upcA

Alias legado de UPC_A. Obsoleto.

TEXT_ONLY Renderiza o campo como um campo de texto. Não é possível usar o campo alternateText com um código de barras do tipo textOnly.
textOnly

Alias legado de TEXT_ONLY. Obsoleto.

CallbackOptions

Campos
url

string

O URL HTTPS configurado pelo comerciante. O URL deve estar hospedado em HTTPS e o robots.txt deve permitir que o caminho do URL seja acessível pelo UserAgent:Google-Valuables.

update_request_url

string

URL do endpoint do comerciante que seria chamado para solicitar atualizações. O URL precisa estar hospedado em HTTPS, e o robots.txt precisa permitir que o caminho do URL seja acessível pelo UserAgent:Google-Valuables.

Entre em contato com o suporte do Google antes de usar este campo.

DateTime

Campos
date

string

Uma data/hora com formato estendido ISO 8601. Pode ser necessário fazer a compensação das horas. Consulte a documentação do campo pai. O horário pode ser especificado com precisão de nanossegundos. As compensações podem ser especificadas com precisão de segundos, mesmo que os segundos de compensação não façam parte do padrão ISO 8601.

Exemplo:

1985-04-12T23:20:50.52Z seria 20 minutos e 50,52 segundos após as 23h de 12 de abril de 1985 no UTC.

1985-04-12T19:20:50.52-04:00 seria 20 minutos e 50,52 segundos após a 19ª hora de 12 de abril de 1985, quatro horas antes do UTC (no mesmo instante que o do exemplo acima). Se a data/hora for destinada a um local físico em Nova York, seria o equivalente ao horário de verão do leste dos EUA (EDT, na sigla em inglês). Lembre-se de que a compensação varia em regiões que seguem o horário de verão, dependendo da época do ano.

1985-04-12T19:20:50.52 seria 20 minutos e 50,52 segundos após a 19ª hora de 12 de abril de 1985, sem informações de compensação.

Fornecer uma compensação faz deste um instante absoluto no tempo em todo o mundo. A data/hora será ajustada com base no fuso horário do usuário. Por exemplo, o horário 2018-06-19T18:30:00-04:00 será 18h30m00s para um usuário em Nova York e 15h30m00s para um usuário em Los Angeles.

A omissão da compensação faz desta uma data/hora local, representando vários instantes no tempo em todo o mundo. A data/hora sempre estará no fuso horário atual do usuário. Por exemplo, o horário 2018-06-19T18:30:00 será às 18h30m00s para um usuário em Nova York e também 18h30m00s para um usuário em Los Angeles. Isso é útil quando a mesma data/hora local deve ser aplicada a muitos locais físicos em vários fusos horários.

DiscoverableProgram

Informações sobre como uma classe pode ser descoberta e instanciada no app Android Pay. Isso é feito pesquisando-se um programa de fidelidade ou vale-presente e digitalizando-o ou inserindo-o manualmente.

Campos
merchant_signup_info

DiscoverableProgramMerchantSignupInfo

Informações sobre a capacidade de se inscrever e adicionar algo valioso a este programa por meio de um site comercial. Usado quando MERCHANT_HOSTED_SIGNUP está ativado.

merchant_signin_info

DiscoverableProgramMerchantSigninInfo

Informações sobre a capacidade de fazer login e adicionar algo valioso a este programa por meio de um site comercial. Usado quando MERCHANT_HOSTED_SIGNIN está ativado.

state

State

Estado de visibilidade do programa detectável.

State

Enums
STATE_UNSPECIFIED
TRUSTED_TESTERS Visível apenas para testers com acesso à conta do emissor.
trustedTesters

Alias legado de TRUSTED_TESTERS. Obsoleto.

LIVE Visível a todos.
live

Alias legado de LIVE. Obsoleto.

DISABLED Não visível.
disabled

Alias legado de DISABLED. Obsoleto.

DiscoverableProgramMerchantSigninInfo

Informações sobre o fluxo de login hospedado pelo comerciante para um programa.

Campos
signin_website

Uri

O URL para direcionar o usuário para o site de login do comerciante.

DiscoverableProgramMerchantSignupInfo

Informações sobre o fluxo de inscrição hospedado pelo comerciante para um programa.

Campos
signup_website

Uri

O URL para direcionar o usuário para o site de inscrição do comerciante.

signup_shared_datas[]

SharedDataType

Dados do usuário que são enviados em uma solicitação POST ao URL do site de inscrição. Essas informações são codificadas e compartilhadas para que o site do comerciante preencha previamente os campos usados para registrar o usuário no programa detectável.

SharedDataType

Enums
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS campo de endereço de linha única
ADDRESS_LINE_1 campos de endereço de várias linhas
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

GroupingInfo

NEXT_ID: 2

Campos
sort_index

int32

Índice opcional para classificar os cartões quando eles são agrupados com outros cartões. Os cartões com menor índice de classificação são mostrados antes daqueles com maior índice. Se não especificado, será usado o valor INT_MAX. Para dois cartões com o mesmo índice de classificação, o comportamento da classificação é indefinido.

Imagem

Tipo de quebra automática para imagens hospedadas no Google.

Campos
kind
(deprecated)

string

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

source_uri

ImageUri

URI da imagem.

ImageModuleData

Campos
main_image

Image

Uma imagem com 100% de largura.

id

string

O ID associado a um módulo de imagem. Este campo serve para facilitar o gerenciamento de módulos de imagem.

ImageUri

Campos
uri

string

Localização da imagem. Os URIs precisam ter um esquema.

description
(deprecated)

string

Outras informações sobre a imagem que não são usadas e são mantidas apenas para garantir a compatibilidade com versões anteriores.

localized_description
(deprecated)

LocalizedString

Strings traduzidas da descrição que não são usadas e são mantidas apenas para garantir a compatibilidade com versões anteriores.

InfoModuleData

Campos
label_value_rows[]

LabelValueRow

Uma lista de coleções de rótulos e valores. Eles serão exibidos um após o outro em uma única coluna.

show_last_update_time
(deprecated)

bool

LabelValue

Um par de strings de texto que serão exibidas na visualização de detalhes. Observe que não exibimos mais LabelValue/LabelValueRow em forma de tabela, mas sim como uma lista de itens.

Campos
label

string

O rótulo para uma linha e coluna específicas. O máximo recomendado é de 15 caracteres para um layout de duas colunas e 30 caracteres para um layout de uma coluna.

value

string

O valor para uma linha e coluna específicas. O máximo recomendado é de 15 caracteres para um layout de duas colunas e 30 caracteres para um layout de uma coluna.

localized_label

LocalizedString

Strings traduzidas do rótulo. O máximo recomendado é de 15 caracteres para um layout de duas colunas e 30 caracteres para um layout de uma coluna.

localized_value

LocalizedString

Strings traduzidas do valor. O máximo recomendado é de 15 caracteres para um layout de duas colunas e 30 caracteres para um layout de uma coluna.

LabelValueRow

Campos
columns[]

LabelValue

Uma lista de rótulos e valores. Apesar do nome do campo, eles serão exibidos um após o outro em uma única coluna, não em várias colunas.

LatLongPoint

Campos
kind
(deprecated)

string

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

latitude

double

A latitude especificada como qualquer valor no intervalo de -90,0 a +90,0, inclusive. Valores fora desses limites serão rejeitados.

longitude

double

A longitude especificada no intervalo de -180,0 a +180,0, inclusive. Valores fora desses limites serão rejeitados.

LinksModuleData

Campos
uris[]

Uri

A lista de URIs.

LocalizedString

Campos
kind
(deprecated)

string

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

translated_values[]

TranslatedString

Contém as traduções da string.

default_value

TranslatedString

Contém a string a ser exibida caso não haja tradução apropriada disponível.

Message

Uma mensagem que será exibida com um valor.

Campos
kind
(deprecated)

string

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

header

string

O cabeçalho da mensagem.

body

string

O corpo da mensagem.

display_interval

TimeInterval

O período em que a mensagem será exibida aos usuários. É possível definir um startTime e um endTime para cada mensagem. Aparecerá uma mensagem imediatamente após a inserção de um objeto Wallet, a menos que um startTime seja definido. Se o endTime não for informado, a mensagem será exibida em uma lista de mensagens indefinidamente.

id

string

O ID associado a uma mensagem. Este campo serve para facilitar o gerenciamento de mensagens. Observe que os valores de ID poderiam ser copiados em várias mensagens na mesma classe/instância. Tenha cuidado para selecionar um ID razoável para cada mensagem.

message_type

MessageType

O tipo de mensagem. Atualmente, só é possível definir isso para ofertas.

localized_header

LocalizedString

Strings traduzidas para o cabeçalho da mensagem.

localized_body

LocalizedString

Strings traduzidas para o corpo da mensagem.

MessageType

Enums
MESSAGE_TYPE_UNSPECIFIED
TEXT Renderiza a mensagem como texto na tela de detalhes do cartão. Este é o tipo de mensagem padrão.
text

Alias legado de TEXT. Obsoleto.

EXPIRATION_NOTIFICATION Notificação exibida quando uma oferta expira. displayInterval.start.date define o horário em que a notificação será exibida. Ela pode ser configurada até 30 dias antes da data de expiração. Se um período maior que esse for especificado, a notificação será acionada na marca de 30 dias.
expirationNotification

Alias legado de EXPIRATION_NOTIFICATION. Obsoleto.

ModifyLinkedOfferObjects

Campos
add_linked_offer_object_ids[]

string

Os IDs de objeto de oferta vinculados a serem adicionados ao objeto.

remove_linked_offer_object_ids[]

string

Os IDs de objeto de oferta vinculados a serem removidos do objeto.

ModifyLinkedOfferObjectsRequest

Campos
linked_offer_object_ids

ModifyLinkedOfferObjects

Os IDs de objeto de oferta vinculados a serem adicionados ou removidos do objeto.

Money

Campos
kind
(deprecated)

string

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

micros

int64

A unidade do valor monetário em micros. Por exemplo, 1 USD seria representado como 1.000.000 de micros.

currency_code

string

O código da moeda, como "USD" ou "EUR".

MultipleDevicesAndHoldersAllowedStatus

Enums
STATUS_UNSPECIFIED
MULTIPLE_HOLDERS São permitidos vários usuários em diversos dispositivos.
multipleHolders

Alias legado de MULTIPLE_HOLDERS. Obsoleto.

ONE_USER_ALL_DEVICES É permitido um usuário em vários dispositivos.
oneUserAllDevices

Alias legado de ONE_USER_ALL_DEVICES. Obsoleto.

ONE_USER_ONE_DEVICE Destinado ao uso por parceiros selecionados. Entre em contato com o suporte para mais informações.
oneUserOneDevice

Alias legado de ONE_USER_ONE_DEVICE. Obsoleto.

Pagination

Campos
kind
(deprecated)

string

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

results_per_page

int32

Número de resultados retornados nesta página.

next_page_token

string

Token de página a ser enviado para buscar a próxima página.

Review

Campos
comments

string

ReviewStatus

Enums
REVIEW_STATUS_UNSPECIFIED
UNDER_REVIEW
underReview

Alias legado de UNDER_REVIEW. Obsoleto.

APPROVED
approved

Alias legado de APPROVED. Obsoleto.

REJECTED
rejected

Alias legado de REJECTED. Obsoleto.

DRAFT
draft

Alias legado de DRAFT. Obsoleto.

State

Enums
STATE_UNSPECIFIED
ACTIVE O objeto está ativo e é exibido com outros objetos ativos.
active

Alias legado de ACTIVE. Obsoleto.

COMPLETED
completed

Alias legado de COMPLETED. Obsoleto.

EXPIRED O objeto não é mais válido (validTimeInterval expirou).
expired

Alias legado de EXPIRED. Obsoleto.

INACTIVE
inactive

Alias legado de INACTIVE. Obsoleto.

TextModuleData

Dados do módulo de texto. Todos os campos são opcionais. O cabeçalho será exibido, se disponível. Diferentes tipos de corpos serão concatenados, se forem definidos.

Campos
header

string

O cabeçalho do módulo de texto. O comprimento máximo recomendado é 35 caracteres, para garantir que a string inteira seja exibida em telas menores.

body

string

O corpo do módulo de texto, que é definido como uma string ininterrupta. O comprimento máximo recomendado é 500 caracteres, para garantir que a string inteira seja exibida em telas menores.

localized_header

LocalizedString

Strings traduzidas do cabeçalho. O comprimento máximo recomendado é 35 caracteres, para garantir que a string inteira seja exibida em telas menores.

localized_body

LocalizedString

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

id

string

O ID associado a um módulo de texto. Este campo serve para facilitar o gerenciamento de módulos de texto.

TimeInterval

Campos
kind
(deprecated)

string

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

start

DateTime

Horário de início do intervalo.

Não é necessário compensar. Caso o horário end seja compensado, end também precisa incluir essa compensação.

end

DateTime

Horário de término do intervalo.

Não é necessário compensar. Caso o horário start seja compensado, start também precisa incluir essa compensação.

TranslatedString

Campos
kind
(deprecated)

string

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

language

string

Representa a tag de idioma BCP 47. Exemplos de valores: "en-US", "en-GB", "de" ou "de-AT".

value

string

A string traduzida codificada em UTF-8.

URI

Campos
kind
(deprecated)

string

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

uri

string

A localização de uma página da Web, imagem ou outro recurso. Os URIs no módulo LinksModuleData podem ter prefixos diferentes, indicando o tipo de URI (um link para uma página da Web, um link para um mapa, um número de telefone ou um endereço de e-mail). Os URIs precisam ter um esquema.

description

string

O título do URI que aparece no app como texto. O máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.

Este texto não é usado em alguns contextos, como quando a description faz parte de uma imagem.

localized_description

LocalizedString

Strings traduzidas da descrição. O máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.

id

string

O código associado a um URI. Este campo serve para facilitar o gerenciamento de URIs.