Recurso: LoyaltyClass
Representação JSON |
---|
{ "kind": string, "programName": string, "programLogo": { object ( |
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
program |
Obrigatório. O nome do programa, 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. |
program |
Obrigatório. O logotipo do programa de fidelidade ou da empresa. Esse logotipo é exibido nas visualizações de detalhes e em lista do app. |
account |
O rótulo do nome da conta, como "Nome do membro". O comprimento máximo recomendado é 15 caracteres, para garantir que a string inteira seja exibida em telas menores. |
account |
O rótulo do ID da conta, como "ID do membro". O comprimento máximo recomendado é 15 caracteres, para garantir que a string inteira seja exibida em telas menores. |
rewards |
O rótulo do nível de prêmios, como "Nível de prêmios". O comprimento máximo recomendado é 9 caracteres, para garantir que a string inteira seja exibida em telas menores. |
rewards |
O nível de recompensas, como "Ouro" ou "Platinum". O comprimento máximo recomendado é 7 caracteres, para garantir que a string inteira seja exibida em telas menores. |
localized |
Strings traduzidas do programName. O app pode exibir reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores. |
localized |
Strings traduzidas do accountNameLabel. O comprimento máximo recomendado é 15 caracteres, para garantir que a string inteira seja exibida em telas menores. |
localized |
Strings traduzidas do accountIdLabel. O comprimento máximo recomendado é 15 caracteres, para garantir que a string inteira seja exibida em telas menores. |
localized |
Strings traduzidas do rewardsTierLabel. O comprimento máximo recomendado é 9 caracteres, para garantir que a string inteira seja exibida em telas menores. |
localized |
Strings traduzidas do RewardsTier. O comprimento máximo recomendado é 7 caracteres, para garantir que a string inteira seja exibida em telas menores. |
secondary |
O rótulo do nível secundário de prêmios, como "Nível de prêmios". |
localized |
Strings traduzidas do secondaryRewardsTierLabel. |
secondary |
O nível secundário de recompensas, como "Ouro" ou "Platinum". |
localized |
Strings traduzidas do secondaryRewardsTier. |
discoverable |
Informações sobre como a classe pode ser descoberta e instanciada no app Google Pay. |
class |
Informações do modelo sobre como a classe deve ser mostrada. Se não estiver definido, o Google vai usar um conjunto padrão de campos a serem exibidos. |
id |
Obrigatório. O identificador exclusivo de uma classe. Esse 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 segundo é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos, '.', '_' ou '-'. |
version |
Suspenso |
issuer |
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[] |
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 |
Obsoleto. Use |
homepage |
O URI da página inicial do seu aplicativo. Preencher o URI nesse campo resulta exatamente 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 considerado a seção linksModuleData do objeto. |
locations[] |
Observação: no momento, esse campo não é compatível com o acionamento de notificações geográficas. |
review |
Obrigatório. O status da classe. Este campo pode ser definido como Mantenha este campo como Defina este campo como Ao atualizar uma classe já |
review |
Os comentários de revisão definidos pela plataforma quando uma classe é marcada como |
infoModuleData |
Obsoleto. Use textModulesData. |
image |
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 |
Dados do módulo de texto. Se os dados do módulo de texto 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. |
links |
Dados do módulo de links. Se os dados do módulo de links também estiverem definidos no objeto, ambos serão exibidos. |
redemption |
Identifica quais emissores de resgate podem resgatar o cartão pelo Toque inteligente. Os emissores de resgate são identificados pelo ID do emissor. Os emissores de resgate precisam ter pelo menos uma chave do Toque inteligente configurada. Os campos |
country |
Código do país usado para mostrar o país do cartão (quando o usuário não está nesse país), bem como para mostrar o conteúdo localizado quando o conteúdo não está disponível na localidade do usuário |
hero |
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 |
Obsoleto. |
enable |
Identifica se essa classe oferece suporte ao Toque inteligente. Os campos |
hex |
A cor de fundo do card. 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 RGB hexadecimal, como |
localized |
Strings traduzidas do issuerName. O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
multiple |
Identifica se vários usuários e dispositivos salvarão o mesmo objeto que se refere a essa classe. |
callback |
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 o callback. |
security |
Informações opcionais sobre a animação de segurança. Se estiver definido, uma animação de segurança será renderizada nos detalhes do cartão. |
view |
Confira as opções de requisitos de desbloqueio do cartão de fidelidade. |
wide |
O logotipo amplo do programa de fidelidade ou da empresa. Quando fornecido, ele é usado no lugar do logotipo do programa no canto superior esquerdo da visualização do card. |
notify |
Se as atualizações de campo para essa classe precisam acionar notificações. Quando definido como NOTIFY, tentamos acionar uma notificação de atualização de campo para os usuários. Essas notificações só serão enviadas aos usuários se o campo fizer parte de uma lista de permissões. Se não for especificado, nenhuma notificação será acionada. Essa configuração é temporária e precisa ser definida com cada solicitação PATCH ou UPDATE. Caso contrário, uma notificação não será acionada. |
app |
Link opcional do app ou site que vai aparecer como um botão na frente do cartão. Se AppLinkData for fornecido para o objeto correspondente, que será usado. |
value |
Dados opcionais do módulo de valor agregado. No máximo dez na turma. Para um cartão, apenas dez serão exibidos, priorizando os do objeto. |
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.
Representação JSON |
---|
{ "merchantSignupInfo": { object ( |
Campos | |
---|---|
merchant |
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 |
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. |
DiscoverableProgramMerchantSignupInfo
Informações sobre o fluxo de inscrição hospedado pelo comerciante para um programa.
Representação JSON |
---|
{ "signupWebsite": { object ( |
Campos | |
---|---|
signup |
O URL para direcionar o usuário ao site de inscrição do comerciante. |
signup |
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. |
DiscoverableProgramMerchantSigninInfo
Informações sobre o fluxo de login hospedado pelo comerciante para um programa.
Representação JSON |
---|
{
"signinWebsite": {
object ( |
Campos | |
---|---|
signin |
O URL para direcionar o usuário para o site de login do comerciante. |
Estado
Enums | |
---|---|
STATE_UNSPECIFIED |
|
TRUSTED_TESTERS |
Visível apenas para testers com acesso à conta do emissor. |
trustedTesters |
Alias legado de |
LIVE |
Visível para todos. |
live |
Alias legado de |
DISABLED |
Não está visível. |
disabled |
Alias legado de |
Métodos |
|
---|---|
|
Adiciona uma mensagem à classe de fidelidade indicada pelo ID de classe fornecido. |
|
Retorna a classe de fidelidade com o ID de classe fornecido. |
|
Insere uma classe de fidelidade com o ID e as propriedades fornecidos. |
|
Retorna uma lista de todas as classes de fidelidade de um determinado ID de emissor. |
|
Atualiza a classe de fidelidade indicada pelo ID de classe fornecido. |
|
Atualiza a classe de fidelidade indicada pelo ID de classe fornecido. |