REST Resource: loyaltyclass

{
  "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)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

string

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

string

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.

object (Image)

Obrigatório. O logotipo do programa de fidelidade ou da empresa. Esse logotipo é exibido nos detalhes e nas visualizações de lista do app.

string

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.

string

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.

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.

string

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.

object (LocalizedString)

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.

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

O rótulo do nível secundário de prêmios, como "Nível de prêmios".

object (LocalizedString)

Strings traduzidas do secondaryRecompensasTierLabel.

string

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

object (LocalizedString)

Strings traduzidas do secondaryRewardsTier.

object (DiscoverableProgram)

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

object (ClassTemplateInfo)

Informações de modelo sobre como a classe deve ser exibida. Se não estiver definido, o Google vai usar um conjunto padrão de campos a serem exibidos.

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 segundo é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos, '.', '_' ou '-'.

string (int64 format)

Suspenso

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.

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

boolean

Obsoleto. Use multipleDevicesAndHoldersAllowedStatus.

object (Uri)

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.

object (LatLongPoint)

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

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

Mantenha este campo como draft quando a classe estiver em desenvolvimento. Não é possível usar uma classe draft para criar nenhum objeto.

Defina esse campo como underReview quando acreditar que a classe está pronta para uso. 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, continue definindo este campo como underReview.

object (Review)

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

object (InfoModuleData)

Obsoleto. Use textModulesData.

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

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 de campos exibidos é 10 para o objeto e 10 para a classe.

object (LinksModuleData)

Dados do módulo de links. Se os dados do módulo de links também estiverem definidos no objeto, ambos serão exibidos.

string (int64 format)

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 enableSmartTap e um dos smartTapRedemptionValue no nível do objeto (código de barras.value, oraccountId`) também precisam ser configurados corretamente para que um cartão aceite o Toque inteligente.

string

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

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

object (Image)

Obsoleto.

boolean

Identifica se essa classe oferece suporte ao Toque inteligente. Os campos redemptionIssuers e um dos campos smartTapRedemptionLevel, barcode.value, or accountId no nível do objeto também precisam ser configurados corretamente para que um cartão ofereça suporte ao Toque inteligente.

string

A cor de fundo do card. Se não estiver definida, será usada a cor dominante da imagem principal e, se nenhuma imagem principal estiver definida, a cor predominante do logotipo será usada. O formato é #rrggbb, em que rrggbb é um trio hexadecimal RGB, como #ffcc00. Você também pode usar a versão abreviada do trio RGB, que é o número rgb, como #fc0.

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica se vários usuários e dispositivos salvarão o mesmo objeto que se refere a essa classe.

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

object (SecurityAnimation)

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.

enum (ViewUnlockRequirement)

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

object (Image)

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.

enum (NotificationSettingsForUpdates)

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.

object (AppLinkData)

Link opcional de app ou site que será exibido como um botão na parte frontal do cartão. Se AppLinkData for fornecido para o objeto correspondente, que será usado.

object (ValueAddedModuleData)

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.