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)
  }
}
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 del titolare dell'account fedeltà, ad esempio "Sara Rossi". La lunghezza massima consigliata è di 20 caratteri per garantire che l'intera stringa venga visualizzata su schermi più piccoli.
accountId

string

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

object (LoyaltyPoints)

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

string

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

Gli ID oggetto delle offerte devono essere nel formato issuer ID.identifier, dove la prima è rilasciata da Google e la seconda è scelta da te.
secondaryLoyaltyPoints

object (LoyaltyPoints)

L'etichetta secondaria dei punti fedeltà, il saldo e il tipo. Vengono mostrati 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 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 "-".
classId

string

obbligatorio. La classe associata all'oggetto. La classe deve essere dello stesso tipo di questo oggetto, deve già esistere e deve essere approvata.

Gli ID classe devono essere nel formato issuer ID.identifier, dove la prima è rilasciata da Google e la seconda è scelta da te.
version
(deprecated)

string (int64 format)

Deprecata
state

enum (State)

obbligatorio. Lo stato dell'oggetto. Questo campo viene utilizzato per determinare in che modo un oggetto viene visualizzato 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 può essere utilizzato. Lo stato di un oggetto verrà modificato in expired una volta trascorso questo periodo di tempo.
locations[]

object (LatLongPoint)

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

boolean

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

string

Il valore che per questo oggetto verrà trasmesso a un terminale certificato Smart Tap tramite NFC. Anche i campi a livello di corso enableSmartTap e redemptionIssuers devono essere configurati correttamente affinché il pass 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 riserva, 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 viene impostato su true, indipendentemente dal campo messages, le notifiche di scadenza per l'utente verranno soppresse. Per impostazione predefinita, questo campo è impostato su false.

Al momento, può essere impostata solo per le offerte.
infoModuleData

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.
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 un'immagine promozionale della classe, se presente. Se non è presente neanche l'immagine hero della classe, non verrà visualizzato nulla.
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

Passa i vincoli per l'oggetto. Include la limitazione dei comportamenti di NFC e screenshot.

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 è 9 caratteri.
balance

object (LoyaltyPointsBalance)

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

object (LocalizedString)

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

LoyaltyPointsBalance

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

string

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

integer

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

number

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

object (Money)

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

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 dell'offerta collegati 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.