Índice
AddMessageRequest
(mensagem)AppLinkData
(mensagem)AppLinkData.AppLinkInfo
(mensagem)AppLinkData.AppLinkInfo.AppTarget
(mensagem)Barcode
(mensagem)BarcodeRenderEncoding
(enum)BarcodeType
(enum)CallbackOptions
(mensagem)DateTime
(mensagem)DiscoverableProgram
(mensagem)DiscoverableProgram.State
(enum)DiscoverableProgramMerchantSigninInfo
(mensagem)DiscoverableProgramMerchantSignupInfo
(mensagem)DiscoverableProgramMerchantSignupInfo.SharedDataType
(enum)GroupingInfo
(mensagem)Image
(mensagem)ImageModuleData
(mensagem)ImageUri
(mensagem)InfoModuleData
(mensagem)LabelValue
(mensagem)LabelValueRow
(mensagem)LatLongPoint
(mensagem)LinksModuleData
(mensagem)LocalizedString
(mensagem)Message
(mensagem)Message.MessageType
(enum)ModifyLinkedOfferObjects
(mensagem)ModifyLinkedOfferObjectsRequest
(mensagem)Money
(mensagem)MultipleDevicesAndHoldersAllowedStatus
(enum)Pagination
(mensagem)Review
(mensagem)ReviewStatus
(enum)State
(enum)TextModuleData
(mensagem)TimeInterval
(mensagem)TranslatedString
(mensagem)Uri
(mensagem)
AddMessageRequest
Recurso usado quando os endpoints AddMessage são chamados.
Campos | |
---|---|
message |
AppLinkData
Campos | |
---|---|
android_app_link_info |
Informações opcionais sobre o link do app do parceiro. Se incluído, o módulo de link do app será renderizado com detalhes valiosos no cliente Android. |
ios_app_link_info |
Informações opcionais sobre o link do app do parceiro. Se incluído, o módulo de link do app será renderizado com detalhes valiosos no cliente iOS. |
web_app_link_info |
Informações opcionais sobre o link do app do parceiro. Se incluído, o módulo de link do app será renderizado com detalhes valiosos no cliente Web. |
AppLinkInfo
Campos | |
---|---|
app_logo_image |
Imagem opcional a ser exibida no módulo de link do app |
title |
String a ser exibida no título do módulo de link do app obrigatório |
description |
String a ser exibida na descrição do módulo de link do app obrigatório |
app_target |
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 |
Barcode
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
type |
O tipo de código de barras. |
render_encoding |
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 |
O valor codificado no código de barras. |
alternate_text |
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 |
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 |
CODE_39 |
|
code39 |
Alias legado de |
CODE_128 |
|
code128 |
Alias legado de |
CODABAR |
|
codabar |
Alias legado de |
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 |
EAN_8 |
|
ean8 |
Alias legado de |
EAN_13 |
|
ean13 |
Alias legado de |
EAN13 |
Alias legado de |
ITF_14 |
Código ITF de 14 dígitos |
itf14 |
Alias legado de |
PDF_417 |
|
pdf417 |
Alias legado de |
PDF417 |
Alias legado de |
QR_CODE |
|
qrCode |
Alias legado de |
qrcode |
Alias legado de |
UPC_A |
Códigos de 11 ou 12 dígitos |
upcA |
Alias legado de |
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 |
CallbackOptions
Campos | |
---|---|
url |
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. |
DateTime
Campos | |
---|---|
date |
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:
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 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 |
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 |
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 |
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 |
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 |
LIVE |
Visível a todos. |
live |
Alias legado de |
DISABLED |
Não visível. |
disabled |
Alias legado de |
DiscoverableProgramMerchantSigninInfo
Informações sobre o fluxo de login hospedado pelo comerciante para um programa.
Campos | |
---|---|
signin_website |
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 |
O URL para direcionar o usuário ao site de inscrição do comerciante. |
signup_shared_datas[] |
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. |
GroupingInfo
NEXT_ID: 2
Campos | |
---|---|
sort_index |
Í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 |
Identifica o tipo de recurso. Valor: a string fixa |
source_uri |
URI da imagem. |
ImageModuleData
Campos | |
---|---|
main_image |
Uma imagem com 100% de largura. |
id |
O ID associado a um módulo de imagem. Este campo serve para facilitar o gerenciamento de módulos de imagem. |
ImageUri
Campos | |
---|---|
uri |
Localização da imagem. Os URIs precisam ter um esquema. |
description |
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 |
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[] |
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 |
|
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 |
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 |
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 |
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 |
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[] |
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 |
Identifica o tipo de recurso. Valor: a string fixa |
latitude |
A latitude especificada como qualquer valor no intervalo de -90,0 a +90,0, inclusive. Valores fora desses limites serão rejeitados. |
longitude |
A longitude especificada no intervalo de -180,0 a +180,0, inclusive. Valores fora desses limites serão rejeitados. |
LinksModuleData
Campos | |
---|---|
uris[] |
A lista de URIs. |
LocalizedString
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
translated_values[] |
Contém as traduções da string. |
default_value |
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 |
Identifica o tipo de recurso. Valor: a string fixa |
header |
O cabeçalho da mensagem. |
body |
O corpo da mensagem. |
display_interval |
O período em que a mensagem será exibida aos usuários. É possível definir um |
id |
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 |
O tipo de mensagem. Atualmente, só é possível definir isso para ofertas. |
localized_header |
Strings traduzidas para o cabeçalho da mensagem. |
localized_body |
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 |
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 |
ModifyLinkedOfferObjects
Campos | |
---|---|
add_linked_offer_object_ids[] |
Os IDs de objeto de oferta vinculados a serem adicionados ao objeto. |
remove_linked_offer_object_ids[] |
Os IDs de objeto de oferta vinculados a serem removidos do objeto. |
ModifyLinkedOfferObjectsRequest
Campos | |
---|---|
linked_offer_object_ids |
Os IDs de objeto de oferta vinculados a serem adicionados ou removidos do objeto. |
Money
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
micros |
A unidade do valor monetário em micros. Por exemplo, 1 USD seria representado como 1.000.000 de micros. |
currency_code |
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 |
ONE_USER_ALL_DEVICES |
É permitido um usuário em vários dispositivos. |
oneUserAllDevices |
Alias legado de |
ONE_USER_ONE_DEVICE |
Destinado ao uso por parceiros selecionados em circunstâncias específicas. Entre em contato com o suporte para mais informações. |
oneUserOneDevice |
Alias legado de |
Pagination
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
results_per_page |
Número de resultados retornados nesta página. |
next_page_token |
Token de página a ser enviado para buscar a próxima página. |
Review
Campos | |
---|---|
comments |
|
ReviewStatus
Enums | |
---|---|
REVIEW_STATUS_UNSPECIFIED |
|
UNDER_REVIEW |
|
underReview |
Alias legado de |
APPROVED |
|
approved |
Alias legado de |
REJECTED |
|
rejected |
Alias legado de |
DRAFT |
|
draft |
Alias legado de |
State
Enums | |
---|---|
STATE_UNSPECIFIED |
|
ACTIVE |
O objeto está ativo e é exibido com outros objetos ativos. |
active |
Alias legado de |
COMPLETED |
|
completed |
Alias legado de |
EXPIRED |
O objeto não é mais válido (validTimeInterval expirou). |
expired |
Alias legado de |
INACTIVE |
|
inactive |
Alias legado de |
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 |
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 |
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 |
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 |
Strings traduzidas do corpo. O comprimento máximo recomendado é 500 caracteres, para garantir que a string inteira seja exibida em telas menores. |
id |
O ID associado a um módulo de texto. Este campo serve para facilitar o gerenciamento de módulos de texto. |
TimeInterval
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
start |
Horário de início do intervalo. Não é necessário compensar. Caso o horário |
end |
Horário de término do intervalo. Não é necessário compensar. Caso o horário |
TranslatedString
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
language |
Representa a tag de idioma BCP 47. Exemplos de valores: "en-US", "en-GB", "de" ou "de-AT". |
value |
A string traduzida codificada em UTF-8. |
URI
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
uri |
A localização de uma página da Web, imagem ou outro recurso. Os URIs no módulo |
description |
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 |
localized_description |
Strings traduzidas da descrição. O máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
id |
O código associado a um URI. Este campo serve para facilitar o gerenciamento de URIs. |