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)
  }
}
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 Federico". L'app potrebbe mostrare dei puntini di sospensione dopo i primi 20 caratteri per garantire la visualizzazione dell'intera stringa 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 la visualizzazione dell'intera stringa su schermi più piccoli.

accountIdLabel

string

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

rewardsTierLabel

string

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

rewardsTier

string

Il livello premi, ad esempio "Oro" o "Platino". La lunghezza massima consigliata è di 7 caratteri per garantire la visualizzazione dell'intera stringa su schermi più piccoli.

localizedProgramName

object (LocalizedString)

Stringhe tradotte per programName. L'app potrebbe mostrare dei puntini di sospensione dopo i primi 20 caratteri per garantire la visualizzazione dell'intera stringa su schermi più piccoli.

localizedAccountNameLabel

object (LocalizedString)

Stringhe tradotte per accountNameLabel. La lunghezza massima consigliata è di 15 caratteri per garantire la visualizzazione dell'intera stringa su schermi più piccoli.

localizedAccountIdLabel

object (LocalizedString)

Stringhe tradotte per accountIdLabel. La lunghezza massima consigliata è di 15 caratteri per garantire la visualizzazione dell'intera stringa su schermi più piccoli.

localizedRewardsTierLabel

object (LocalizedString)

Stringhe tradotte per il valore RewardsTierLabel. La lunghezza massima consigliata è di 9 caratteri per garantire che l'intera stringa venga visualizzata su schermi più piccoli.

localizedRewardsTier

object (LocalizedString)

Stringhe tradotte per il RewardsTier. La lunghezza massima consigliata è di 7 caratteri per garantire la visualizzazione dell'intera stringa su schermi più piccoli.

secondaryRewardsTierLabel

string

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

localizedSecondaryRewardsTierLabel

object (LocalizedString)

Stringhe tradotte per il valore secondarioRewardsTierLabel.

secondaryRewardsTier

string

Il livello premio secondario, ad esempio "Oro" o "Platino".

localizedSecondaryRewardsTier

object (LocalizedString)

Stringhe tradotte per il valore secondarioRewardsTier.

discoverableProgram

object (DiscoverableProgram)

Informazioni su come la classe può essere rilevata e creata un'istanza dall'interno dell'app Google Pay.

classTemplateInfo

object (ClassTemplateInfo)

Informazioni sul modello su come deve essere visualizzato il corso. Se il criterio non viene configurato, Google utilizzerà un insieme predefinito di campi da visualizzare.

id

string

obbligatorio. L'identificatore univoco di una classe. Questo ID deve essere univoco per tutti i corsi di un emittente. Questo valore deve essere nel formato issuer ID.identifier, dove la prima è rilasciata da Google e la seconda è scelta da te. L'identificatore univoco deve includere solo caratteri alfanumerici, ".", "_" o "-".

version
(deprecated)

string (int64 format)

Deprecata

issuerName

string

obbligatorio. Il nome dell'emittente. La lunghezza massima consigliata è di 20 caratteri per garantire che l'intera stringa 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. Usa invece il criterio multipleDevicesAndHoldersAllowedStatus.

homepageUri

object (Uri)

L'URI della home page dell'applicazione. Il completamento dell'URI in questo campo comporta lo stesso comportamento di un URI in linksModuleData (quando viene visualizzato un oggetto, viene mostrato un link alla home page in quella che solitamente viene considerata la sezione linksModuleData dell'oggetto).

locations[]

object (LatLongPoint)

Nota: questo campo non è attualmente 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 di inserimento, patch o aggiornamento. Una volta che lo stato della revisione passa da draft, non può essere reimpostato su draft.

Dovresti mantenere questo campo su draft quando il corso è in fase di sviluppo. Non è possibile utilizzare una classe draft per creare oggetti.

Imposta 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 migrare gli oggetti.

Quando aggiorni una classe 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. Usa 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 classe.

textModulesData[]

object (TextModuleData)

Dati dei moduli di testo. Se nella classe 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 quali emittenti di promozioni possono utilizzare la tessera tramite Smart Tap. Gli emittenti di rimborsi sono identificati in base al loro ID emittente. Gli emittenti di promozioni devono avere almeno una chiave Smart Tap configurata.

Anche i campi enableSmartTap e uno dei smartTapRedemptionValue a livello di oggetto barcode.value, oraccountId" devono essere configurati correttamente affinché una tessera supporti la funzionalità Smart Tap.

countryCode

string

Codice paese utilizzato per visualizzare il paese della scheda (quando l'utente non si trova in quel paese) e per visualizzare 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% di larghezza.

wordMark
(deprecated)

object (Image)

Deprecato.

enableSmartTap

boolean

Identifica se questo corso supporta Smart Tap. Anche i campi redemptionIssuers e uno dei smartTapRedemptionLevel a livello di oggetto barcode.value, or accountId" devono essere configurati correttamente affinché una tessera supporti la funzionalità Smart Tap.

hexBackgroundColor

string

Il colore di sfondo della scheda. Se non viene 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 usare la versione abbreviata della terzina RGB, che è #rgb, ad esempio #fc0.

localizedIssuerName

object (LocalizedString)

Stringhe tradotte per l'emittenteName. La lunghezza massima consigliata è di 20 caratteri per garantire che l'intera stringa venga visualizzata su schermi più piccoli.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

Opzioni di callback da utilizzare per richiamare l'emittente a 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 impostazione è impostata, verrà visualizzata un'animazione di sicurezza nei dettagli del pass.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Visualizza le opzioni dei requisiti di sblocco per la carta fedeltà.

DiscoverableProgram

Informazioni su come un corso può essere trovato e creato un'istanza dall'app Android Pay. A questo scopo, cerca un programma fedeltà o carta regalo e scansionalo o inseriscilo 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 importante a questo programma tramite il sito di un commerciante. Utilizzato quando MERCHANT_HOSTED_messaggi è attivato.

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

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

state

enum (State)

Stato di visibilità del programma rilevabile.

DiscoverableProgramMerchantSignupInfo

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

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 della 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 rilevabile.

SharedDataType

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

DiscoverableProgramMerchantSigninInfo

Informazioni sul flusso di accesso ospitato 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 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 alla classe fedeltà a cui fa riferimento l'ID corso 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 tutte le classi fedeltà per uno specifico ID emittente.

patch

Consente di aggiornare la classe fedeltà a cui fa riferimento l'ID corso specificato.

update

Consente di aggiornare la classe fedeltà a cui fa riferimento l'ID corso specificato.