REST Resource: loyaltyclass

Risorsa: LoyaltyClass

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

string

Identifica il tipo di risorsa. Valore: la stringa fissa "walletobjects#loyaltyClass".
programName

string

Obbligatorio. Il nome del programma, ad esempio "Abbigliamento di Adam". L'app potrebbe mostrare tre puntini dopo i primi 20 caratteri per assicurarsi che la stringa completa venga visualizzata su schermi più piccoli.
accountNameLabel

string

L'etichetta del nome dell'account, ad esempio "Nome membro". La lunghezza massima consigliata è di 15 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
accountIdLabel

string

L'etichetta dell'ID account, ad esempio "ID membro". La lunghezza massima consigliata è di 15 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
rewardsTierLabel

string

L'etichetta del livello dei premi, ad esempio "Livello dei premi". La lunghezza massima consigliata è di 9 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
rewardsTier

string

Il livello dei premi, ad esempio "Oro" o "Platino". La lunghezza massima consigliata è di 7 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
localizedProgramName

object (LocalizedString)

Stringhe tradotte per il programmaName. L'app potrebbe mostrare tre puntini dopo i primi 20 caratteri per assicurarsi che la stringa completa venga visualizzata su schermi più piccoli.
localizedAccountNameLabel

object (LocalizedString)

Stringhe tradotte per l'attributo accountNameLabel. La lunghezza massima consigliata è di 15 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
localizedAccountIdLabel

object (LocalizedString)

Stringhe tradotte per l'attributo accountIdLabel. La lunghezza massima consigliata è di 15 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
localizedRewardsTierLabel

object (LocalizedString)

Stringhe tradotte per rewardsTierLabel. La lunghezza massima consigliata è di 9 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
localizedRewardsTier

object (LocalizedString)

Stringhe tradotte per il livello dei premi. La lunghezza massima consigliata è di 7 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
secondaryRewardsTierLabel

string

L'etichetta del livello premi secondario, ad esempio "Livello premi".
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Stringhe tradotte per secondaryRewardsTierLabel.
secondaryRewardsTier

string

Il livello dei premi secondari, ad esempio "Oro" o "Platino".
localizedSecondaryRewardsTier

object (LocalizedString)

Stringhe tradotte per il livelloRewards secondario.
discoverableProgram

object (DiscoverableProgram)

Informazioni su come la classe può essere rilevata e creata all'interno dell'app Google Pay.
classTemplateInfo

object (ClassTemplateInfo)

Informazioni sul modello relative alla visualizzazione del corso. Se non viene impostato, Google utilizzerà un insieme predefinito di campi da visualizzare.
id

string

Obbligatorio. L'identificatore univoco di un corso. Questo ID deve essere univoco per tutte le classi di un emittente. Questo valore deve seguire il formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te. L'identificatore univoco deve includere solo caratteri alfanumerici, ".", "_" o "-".
version
(deprecated)

string (int64 format)

Deprecato
issuerName

string

Obbligatorio. Il nome dell'emittente. La lunghezza massima consigliata è di 20 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
messages[]

object (Message)

Un array di messaggi visualizzati nell'app. Tutti gli utenti di questo oggetto riceveranno i messaggi associati. Il numero massimo di questi campi è 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Deprecato. Utilizza invece multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

L'URI della home page dell'applicazione. Se compili l'URI in questo campo, il comportamento è esattamente lo stesso di quello che si ottiene compilando un URI in linksModuleData (quando viene visualizzato un oggetto, viene mostrato un link alla home page nella sezione linksModuleData dell'oggetto).
locations[]
(deprecated)

object (LatLongPoint)

Nota: al momento questo campo non è supportato per attivare le notifiche geografiche.
reviewStatus

enum (ReviewStatus)

Obbligatorio. Lo stato del corso. Questo campo può essere impostato su draft o underReview utilizzando le chiamate API insert, patch o update. Una volta modificato lo stato della revisione da draft, non è possibile ripristinare draft.

Quando il corso è in fase di sviluppo, devi mantenere questo campo su draft. Non è possibile utilizzare una classe draft per creare alcun oggetto.

Devi impostare questo campo su underReview quando ritieni che il corso sia pronto per l'uso. La piattaforma imposterà automaticamente questo campo su approved e potrà essere utilizzato immediatamente per creare o eseguire la migrazione di oggetti.

Quando aggiorni un corso già approved, devi continuare a impostare questo campo su underReview.
review

object (Review)

I commenti della recensione impostati dalla piattaforma quando un corso è contrassegnato come approved o rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Deprecato. Utilizza invece textModulesData.
imageModulesData[]

object (ImageModuleData)

Dati del modulo immagine. Il numero massimo di questi campi visualizzati è 1 a livello di oggetto e 1 a livello di oggetto della classe.
textModulesData[]

object (TextModuleData)

Dati del modulo di testo. Se nel corso sono definiti anche i dati del modulo di testo, verranno visualizzati entrambi. Il numero massimo di questi campi visualizzati è 10 dall'oggetto e 10 dalla classe.
redemptionIssuers[]

string (int64 format)

Identifica gli emittenti di coupon che possono utilizzare la tessera tramite Smart Tap. Gli emittenti dei premi sono identificati dal relativo ID emittente. Gli emittenti di premi devono avere configurato almeno una chiave Smart Tap.

Affinché una tessera supporti la funzionalità Smart Tap, è necessario configurare correttamente anche i campi enableSmartTap e uno dei campi a livello di oggetto smartTapRedemptionValue, barcode.value, oraccount_id.
countryCode

string

Codice paese utilizzato per visualizzare il paese della scheda (se l'utente non si trova in quel paese) e per visualizzare i contenuti localizzati quando non sono disponibili nella lingua dell'utente.
heroImage

object (Image)

Immagine del banner facoltativa visualizzata sulla parte anteriore della scheda. Se non è presente, non verrà visualizzato nulla. L'immagine verrà visualizzata al 100% della larghezza.
wordMark
(deprecated)

object (Image)

Deprecato.
enableSmartTap

boolean

Indica se questa classe supporta il tocco intelligente. Affinché una tessera supporti la funzionalità Smart Tap, è necessario configurare correttamente anche i campi redemptionIssuers e uno dei campi a livello di oggetto smartTapRedemptionLevel, barcode.value, or account_id.
hexBackgroundColor

string

Il colore di sfondo della scheda. Se non è impostato, viene utilizzato il colore dominante dell'immagine hero e, se non è impostata alcuna immagine hero, viene utilizzato il colore dominante del logo. Il formato è #rrggbb, dove rrggbb è una tripletta RGB esadecimale, ad esempio #ffcc00. Puoi anche utilizzare la versione abbreviata della tripletta RGB, ovvero #rgb, ad esempio #fc0.
localizedIssuerName

object (LocalizedString)

Stringhe tradotte per issuerName. La lunghezza massima consigliata è di 20 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica se più utenti e dispositivi salveranno lo stesso oggetto che fa riferimento a questa classe.
callbackOptions

object (CallbackOptions)

Opzioni di callback da utilizzare per richiamare l'emittente per ogni salvataggio/eliminazione di un oggetto per questa classe da parte dell'utente finale. Tutti gli oggetti di questa classe sono idonei per il callback.
securityAnimation

object (SecurityAnimation)

Informazioni facoltative sull'animazione di sicurezza. Se questa opzione è impostata, verrà visualizzata un'animazione di sicurezza nei dettagli della tessera.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Visualizza le opzioni per i requisiti di sblocco della carta fedeltà.
notifyPreference

enum (NotificationSettingsForUpdates)

Indica se gli aggiornamenti dei campi di questa classe devono attivare o meno le notifiche. Se impostato su NOTIFY, tenteremo di attivare una notifica di aggiornamento del campo per gli utenti. Queste notifiche verranno inviate agli utenti solo se il campo fa parte di una lista consentita. Se non viene specificato, non verrà attivata alcuna notifica. Questa impostazione è temporanea e deve essere impostata con ogni richiesta PATCH o UPDATE, altrimenti non verrà attivata una notifica.
valueAddedModuleData[]

object (ValueAddedModuleData)

Dati facoltativi del modulo del valore aggiunto. Massimo dieci per corso. Per un passaggio ne verranno visualizzati solo dieci, dando la priorità a quelli dell'oggetto.

DiscoverableProgram

Informazioni su come una classe può essere scoperta e creata all'interno dell'app Android Pay. Questo viene fatto cercando un programma fedeltà o una carta regalo e scansionando o inserendo manualmente.

Rappresentazione JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Campi
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Informazioni sulla possibilità di registrarsi e aggiungere un valore per questo programma tramite un sito del commerciante. Utilizzato quando MERCHANT_HOSTED_SIGNUP è abilitato.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Informazioni sulla possibilità di accedere e aggiungere un valore per questo programma tramite un sito del commerciante. Utilizzato quando MERCHANT_HOSTED_SIGNIN è abilitato.
state

enum (State)

Stato di visibilità del programma rilevabile.

DiscoverableProgramMerchantSignupInfo

Informazioni sul flusso di registrazione ospitato dal commerciante per un programma.

Rappresentazione JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Campi
signupWebsite

object (Uri)

L'URL a cui indirizzare l'utente per il sito di registrazione del commerciante.
signupSharedDatas[]

enum (SharedDataType)

Dati utente inviati in una richiesta POST all'URL del sito web di registrazione. Queste informazioni vengono codificate e poi condivise in modo che il sito web del commerciante possa precompilare i campi utilizzati per registrare l'utente al programma di visibilità.

SharedDataType

Enum
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS campo indirizzo a una riga
ADDRESS_LINE_1 campi indirizzo multilinea
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Informazioni sulla procedura di accesso ospitata dal commerciante per un programma.

Rappresentazione JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
Campi
signinWebsite

object (Uri)

L'URL a cui indirizzare l'utente per il sito di accesso del commerciante.

Stato

Enum
STATE_UNSPECIFIED
TRUSTED_TESTERS Visibile solo ai tester che hanno accesso all'account dell'emittente.
trustedTesters

Alias precedente per TRUSTED_TESTERS. Deprecato.
LIVE Visibile a tutti.
live

Alias precedente per LIVE. Deprecato.
DISABLED Non visibile.
disabled

Alias precedente per DISABLED. Deprecato.

Metodi

addmessage

 Aggiunge un messaggio al livello fedeltà a cui fa riferimento l'ID livello specificato.

get

 Restituisce la classe fedeltà con l'ID classe specificato.

insert

 Inserisce una classe fedeltà con l'ID e le proprietà specificati.

list

 Restituisce un elenco di tutti i livelli fedeltà per un determinato ID emittente.

patch

 Aggiorna la classe fedeltà a cui fa riferimento l'ID classe specificato.

update

 Aggiorna la classe fedeltà a cui fa riferimento l'ID classe specificato.