REST Resource: loyaltyobject

Risorsa: LoyaltyObject

Rappresentazione JSON 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Campi
kind
(deprecated)

string

Identifica il tipo di risorsa. Valore: la stringa fissa "walletobjects#loyaltyObject".
classReference

object (LoyaltyClass)

Una copia dei campi ereditati della classe principale. Questi campi vengono recuperati durante una richiesta GET.
accountName

string

Il nome dell'intestatario dell'account fedeltà, ad esempio "Mario Rossi". La lunghezza massima consigliata è di 20 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
accountId

string

L'identificatore dell'account fedeltà. La lunghezza massima consigliata è di 20 caratteri.
loyaltyPoints

object (LoyaltyPoints)

L'etichetta, il saldo e il tipo di punti fedeltà.
linkedOfferIds[]

string

Un elenco di oggetti di offerta collegati a questa carta fedeltà. Gli oggetti di offerta devono già esistere.

Gli ID oggetto offerta devono essere nel formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te.
secondaryLoyaltyPoints

object (LoyaltyPoints)

L'etichetta, il saldo e il tipo di punti fedeltà secondari. Mostrato in aggiunta ai punti fedeltà principali.
id

string

Obbligatorio. L'identificatore univoco di un oggetto. Questo ID deve essere univoco in tutti gli oggetti di un emittente. Questo valore deve seguire il formato issuer ID.identifier: il primo viene emesso da Google, mentre il secondo è scelto da te. L'identificatore univoco deve includere solo caratteri alfanumerici, '.', '_' o '-'.
classId

string

Obbligatorio. La classe associata a questo oggetto. Il corso deve essere dello stesso tipo di questo oggetto, deve già esistere e deve essere approvato.

Gli ID classe devono seguire il formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te.
version
(deprecated)

string (int64 format)

Deprecato
state

enum (State)

Obbligatorio. Lo stato dell'oggetto. Questo campo viene utilizzato per determinare la modalità di visualizzazione di un oggetto nell'app. Ad esempio, un oggetto inactive viene spostato nella sezione "Tessere scadute".
barcode

object (Barcode)

Il tipo e il valore del codice a barre.
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.
validTimeInterval

object (TimeInterval)

Il periodo di tempo in cui questo oggetto sarà active e l'oggetto può essere utilizzato. Lo stato di un oggetto verrà modificato in expired al termine di questo periodo di tempo.
locations[]
(deprecated)

object (LatLongPoint)

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

boolean

Indica se l'oggetto ha utenti. Questo campo è impostato dalla piattaforma.
smartTapRedemptionValue

string

Il valore che verrà trasmesso a un terminale certificato Smart Tap tramite NFC per questo oggetto. Anche i campi a livello di classe enableSmartTap e redemptionIssuers devono essere configurati correttamente affinché la tessera supporti la funzionalità Smart Tap. Sono supportati solo i caratteri ASCII.

Se questo valore non è impostato, ma i campi a livello di classe enableSmartTap e redemptionIssuers sono configurati correttamente, i campi barcode.value o accountId vengono utilizzati come fallback, se presenti.
hasLinkedDevice

boolean

Indica se questo oggetto è attualmente collegato a un singolo dispositivo. Questo campo viene impostato dalla piattaforma quando un utente salva l'oggetto collegandolo al proprio dispositivo. Destinato all'utilizzo da parte di partner selezionati. Contatta l'assistenza per ulteriori informazioni.
disableExpirationNotification

boolean

Indica se le notifiche devono essere soppresse esplicitamente. Se questo campo è impostato su true, indipendentemente dal campo messages, le notifiche di scadenza all'utente verranno eliminate. Per impostazione predefinita, questo campo è impostato su false.

Al momento, questo valore può essere impostato solo per le offerte.
infoModuleData

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

object (RotatingBarcode)

Il tipo e il valore del codice a barre rotante.
heroImage

object (Image)

Immagine del banner facoltativa visualizzata sulla parte anteriore della scheda. Se non è presente, verrà visualizzata l'immagine hero del corso, se presente. Se non è presente nemmeno l'immagine hero del corso, non verrà visualizzata alcuna immagine.
groupingInfo

object (GroupingInfo)

Informazioni che controllano il modo in cui le tessere vengono raggruppate.
passConstraints

object (PassConstraints)

Passa i vincoli per l'oggetto. Sono inclusi i comportamenti di limitazione di NFC e screenshot.
saveRestrictions

object (SaveRestrictions)

Restrizioni relative all'oggetto che devono essere verificate prima che l'utente provi a salvare la tessera. Tieni presente che queste limitazioni verranno applicate solo durante il tempo di salvataggio. Se le limitazioni cambiano dopo che un utente salva la tessera, le nuove limitazioni non verranno applicate a una tessera già salvata.
linkedObjectIds[]

string

linkedObjectIds è un elenco di altri oggetti, come biglietti per eventi, fedeltà, offerta, generico, carta regalo, trasporto pubblico e carta d'imbarco, che devono essere collegati automaticamente a questo oggetto fedeltà. Se un utente avesse salvato questa carta fedeltà, questi linkedObjectId verrebbero inviati automaticamente al suo portafoglio (a meno che non abbia disattivato l'impostazione per ricevere queste tessere collegate).

Assicurati che gli oggetti presenti in LinkedObjectId siano già inseriti; in caso contrario, le chiamate non andranno a buon fine. Una volta collegati, gli oggetti collegati non possono essere scollegati. Non puoi collegare oggetti appartenenti a un altro emittente. Esiste un limite al numero di oggetti che possono essere collegati a un singolo oggetto. Una volta raggiunto il limite, i nuovi oggetti collegati nella chiamata verranno ignorati silenziosamente.

Gli ID oggetto devono seguire il formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te.
notifyPreference

enum (NotificationSettingsForUpdates)

Indica se gli aggiornamenti dei campi di questo oggetto 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 impostato su DO_NOT_NOTIFY o NOTIFICATION_SETTINGS_UNSPECIFIED, 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 sul valore aggiunto. Massimo dieci nell'oggetto.

LoyaltyPoints

Rappresentazione JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Campi
label

string

L'etichetta dei punti fedeltà, ad esempio "Punti". La lunghezza massima consigliata è di 9 caratteri.
balance

object (LoyaltyPointsBalance)

Il saldo dei punti fedeltà del proprietario dell'account, ad esempio "500" o "10,00 $". La lunghezza massima consigliata è di 7 caratteri. Questo è un campo obbligatorio di loyaltyPoints e secondaryLoyaltyPoints.
localizedLabel

object (LocalizedString)

Stringhe tradotte per l'etichetta. La lunghezza massima consigliata è di 9 caratteri.

LoyaltyPointsBalance

Rappresentazione JSON 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
Campi
string

string

La forma di stringa di un saldo. Deve essere compilato solo uno di questi sottotipi (string, int, double, money).
int

integer

La forma intera di un saldo. Deve essere compilato solo uno di questi sottotipi (string, int, double, money).
double

number

La forma doppia di un saldo. Deve essere compilato solo uno di questi sottotipi (string, int, double, money).
money

object (Money)

La forma monetaria di un saldo. Deve essere compilato solo uno di questi sottotipi (string, int, double, money).

Metodi

addmessage

 Aggiunge un messaggio all'oggetto fedeltà a cui fa riferimento l'ID oggetto specificato.

get

 Restituisce l'oggetto fedeltà con l'ID oggetto specificato.

insert

 Inserisce un oggetto fedeltà con l'ID e le proprietà specificati.

list

 Restituisce un elenco di tutti gli oggetti fedeltà per un determinato ID emittente.

modifylinkedofferobjects

 Modifica gli oggetti delle offerte collegate per l'oggetto fedeltà con l'ID specificato.

patch

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

update

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