REST Resource: giftcardobject

Risorsa: giftCardObject

Rappresentazione JSON 
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "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)
  }
}
Campi
kind
(deprecated)

string

Identifica di che tipo di risorsa si tratta. Valore: la stringa fissa "walletobjects#giftCardObject".
classReference

object (GiftCardClass)

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

string

Obbligatorio. Il numero della carta.
pin

string

Il PIN della carta.
balance

object (Money)

Il saldo monetario della carta.
balanceUpdateTime

object (DateTime)

La data e l'ora dell'ultimo aggiornamento del saldo.

L'offset è obbligatorio.

Se il saldo viene aggiornato e questa proprietà non viene fornita, il sistema utilizzerà per impostazione predefinita l'ora corrente.
eventNumber

string

Il numero dell'evento della carta, un campo facoltativo utilizzato da alcune carte regalo.
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: 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 all'oggetto. La classe deve essere dello stesso tipo dell'oggetto, deve esistere già e deve essere approvata.

Gli ID classe devono essere nel formato issuer ID.identifier: il primo viene emesso da Google, mentre 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 come un oggetto viene visualizzato nell'app. Ad esempio, un oggetto inactive viene spostato in "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 potrà essere utilizzato l'oggetto. Al termine di questo periodo di tempo, lo stato di un oggetto verrà modificato in expired.
locations[]

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 enableSmartTap e redemptionIssuers a livello di corso devono essere configurati correttamente affinché la tessera supporti Smart Tap. Sono supportati solo i caratteri ASCII.
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 a 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, questa opzione 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 di classe.
textModulesData[]

object (TextModuleData)

Dati del modulo di testo. Se i dati dei moduli di testo sono definiti anche per il corso, 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 in rotazione.
heroImage

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

Restrizioni per l'oggetto che deve essere verificato prima che l'utente provi a salvare la tessera. Tieni presente che queste limitazioni verranno applicate solo durante il periodo di salvataggio. Se le limitazioni cambiano dopo che un utente ha salvato la tessera, le nuove limitazioni non verranno applicate a una tessera già salvata.

Metodi

addmessage

 Aggiunge un messaggio all'oggetto carta regalo a cui fa riferimento l'ID oggetto specificato.

get

 Restituisce l'oggetto della carta regalo con l'ID oggetto specificato.

insert

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

list

 Restituisce un elenco di tutti gli oggetti di carte regalo per un determinato ID emittente.

patch

 Consente di aggiornare l'oggetto carta regalo a cui fa riferimento l'ID oggetto specificato.

update

 Consente di aggiornare l'oggetto carta regalo a cui fa riferimento l'ID oggetto specificato.