REST Resource: loyaltyclass

Recurso: LoyaltyClass

Representação JSON 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  }
}
Campos
kind
(deprecated)

string

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

string

Obrigatório. O nome do programa, como "Adam's Apparel". O app pode mostrar reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores.
accountNameLabel

string

O rótulo do nome da conta, como "Nome do membro". O tamanho máximo recomendado é 15 caracteres, para garantir que a string inteira seja exibida em telas menores.
accountIdLabel

string

O rótulo do ID da conta, como "ID do membro". O tamanho máximo recomendado é 15 caracteres, para garantir que a string inteira seja exibida em telas menores.
rewardsTierLabel

string

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

string

O nível de recompensas, como "Ouro" ou "Platina". O tamanho máximo recomendado é 7 caracteres, para garantir que a string inteira seja exibida em telas menores.
localizedProgramName

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

O rótulo do nível secundário de recompensas, como "Nível de recompensas".
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Strings traduzidas do secondary RewardssTierLabel.
secondaryRewardsTier

string

O nível secundário de recompensas, como "Ouro" ou "Platina".
localizedSecondaryRewardsTier

object (LocalizedString)

Strings traduzidas do secondary RewardssTier.
discoverableProgram

object (DiscoverableProgram)

Informações sobre como a classe pode ser descoberta e instanciada no app Google Pay.
classTemplateInfo

object (ClassTemplateInfo)

Informações do modelo sobre como a classe deve ser exibida. Se ela não for definida, o Google usará um conjunto padrão de campos para exibir.
id

string

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 último é escolhido por você. Seu identificador exclusivo deve incluir apenas caracteres alfanuméricos, ".", "_" ou "-".
version
(deprecated)

string (int64 format)

Descontinuado
issuerName

string

Obrigatório. O nome do emissor. O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.
messages[]

object (Message)

Uma matriz de mensagens exibidas no app. Todos os usuários desse objeto vão receber as mensagens associadas. O número máximo destes campos é 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Obsoleto. Use multipleDevicesAndHoldersAllowedStatus
homepageUri

object (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 considerado a seção linksModuleData do objeto.
locations[]

object (LatLongPoint)

Observação: no momento, esse campo não é suportado para acionar notificações geográficas.
reviewStatus

enum (ReviewStatus)

Obrigatório. O status da classe. Este campo pode ser definido como draft ou underReview usando as chamadas de API insert, patch ou update. Depois que o estado da revisão for alterado de draft, ele não poderá ser alterado de volta para draft.

Mantenha esse campo como draft quando a classe estiver em desenvolvimento. Uma classe draft não pode ser usada para criar objetos.

Defina este campo como underReview quando achar que a classe está pronta para uso. A plataforma vai definir automaticamente esse campo como approved, e ele poderá ser usado imediatamente para criar ou migrar objetos.

Ao atualizar uma classe que já approved, continue definindo este campo como underReview.
review

object (Review)

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

object (InfoModuleData)

Obsoleto. Use textModulesData.
imageModulesData[]

object (ImageModuleData)

Dados do módulo de imagem. O número máximo destes campos exibidos é 1 no nível do objeto e 1 no nível do objeto da classe.
textModulesData[]

object (TextModuleData)

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 desses campos exibidos é 10 para o objeto e 10 para a classe.
redemptionIssuers[]

string (int64 format)

Identifica quais emissores de resgate podem resgatar o cartão pelo Toque inteligente. Os emissores de resgate são identificados por seu ID de emissor. Os emissores de resgate precisam ter pelo menos uma chave do Toque inteligente configurada.

O enableSmartTap e um dos campos smartTapRedemptionValue, encryption.value, oraccountId no nível do objeto também precisam ser configurados corretamente para que um cartão seja compatível com o Toque inteligente.
countryCode

string

Código de país usado para exibir o país do cartão (quando o usuário não está nesse país), bem como para mostrar conteúdo localizado quando o conteúdo não está disponível na localidade do usuário.
heroImage

object (Image)

Imagem opcional do banner exibida na frente do cartão. Se nenhum estiver presente, nada será exibido. A imagem será exibida com 100% de largura.
wordMark
(deprecated)

object (Image)

Obsoleto.
enableSmartTap

boolean

Identifica se essa classe é compatível com o Toque inteligente. O redemptionIssuers e um dos campos smartTapRedemptionLevel, encryption.value, or accountId no nível do objeto também precisam ser configurados corretamente para que um cartão seja compatível com o Toque inteligente.
hexBackgroundColor

string

A cor de fundo do cartão. Se ela não estiver definida, a cor dominante da imagem principal será usada. Se não houver uma imagem principal definida, a cor dominante 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.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica se vários usuários e dispositivos salvarão o mesmo objeto que referencia esta classe.
callbackOptions

object (CallbackOptions)

Opções de callback a serem usadas para chamar o emissor de volta para cada salvamento/exclusão de um objeto desta classe pelo usuário final. Todos os objetos dessa classe são qualificados para o callback.
securityAnimation

object (SecurityAnimation)

Informações opcionais sobre a animação de segurança. Se isso for definido, uma animação de segurança vai ser renderizada nos detalhes do cartão.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Consulte as opções do requisito de desbloqueio para o cartão de fidelidade.

DiscoverableProgram

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

Representação JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Campos
merchantSignupInfo

object (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_IS está ativado.
merchantSigninInfo

object (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

enum (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 (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Campos
signupWebsite

object (Uri)

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

enum (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 inscrever 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

DiscoverableProgramMerchantSigninInfo

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

Representação JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
Campos
signinWebsite

object (Uri)

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

Estado

Enums
STATE_UNSPECIFIED
TRUSTED_TESTERS Visível apenas para testadores que têm acesso à conta do emissor.
trustedTesters

Alias legado de TRUSTED_TESTERS. Obsoleto.
LIVE Visível para todos.
live

Alias legado de LIVE. Obsoleto.
DISABLED Não visível.
disabled

Alias legado de DISABLED. Obsoleto.

Métodos

addmessage

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

get

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

insert

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

list

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

patch

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

update

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