REST Resource: genericobject

Risorsa: GenericObject

Oggetto generico

Rappresentazione JSON 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Campi
genericType

enum (GenericType)

Specifica a quale GenericType appartiene la scheda.
cardTitle

object (LocalizedString)

Obbligatorio. L'intestazione della tessera. In genere si tratta del nome dell'attività, ad esempio "XXX Palestra", "Assicurazione AAA". Questo campo è obbligatorio e viene visualizzato nella riga di intestazione nella parte superiore della tessera.
subheader

object (LocalizedString)

L'etichetta del titolo della tessera, ad esempio la posizione in cui è possibile utilizzare la tessera. Viene visualizzato proprio sopra il titolo nella riga del titolo nella visualizzazione dei dettagli della tessera.
header

object (LocalizedString)

Obbligatorio. Il titolo della tessera, ad esempio "Coupon 50% di sconto", "Tessera della biblioteca" o "Voucher". Questo campo è obbligatorio e viene visualizzato nella riga del titolo della visualizzazione dei dettagli della tessera.
hexBackgroundColor

string

Il colore di sfondo della scheda. Se non è impostato, viene utilizzato il colore dominante dell'immagine hero. Se non è impostata un'immagine hero, viene utilizzato il colore dominante del logo. Se il logo non è impostato, Google sceglierà un colore.
notifications

object (Notifications)

Le impostazioni di notifica abilitate per questo oggetto.
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 issuerID.identifier, dove issuerID è emesso da Google e identifier è scelto da te. L'identificatore univoco può 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 essere nel formato issuerID.identifier, se il codice issuerID è stato emesso da Google e sei tu a scegliere il valore identifier.
barcode

object (Barcode)

Il tipo e il valore del codice a barre. Se la tessera non ha un codice a barre, possiamo consentire all'emittente di impostare Barcode.alternate_text e visualizzare solo questo.
heroImage

object (Image)

Immagine del banner visualizzata sulla parte anteriore della carta, se presente. L'immagine verrà visualizzata con una larghezza del 100%.
validTimeInterval

object (TimeInterval)

Il periodo di tempo in cui questo oggetto sarà considerato valido o utilizzabile. Una volta trascorso questo periodo, l'oggetto verrà considerato scaduto, con ripercussioni sul rendering sui dispositivi dell'utente.
imageModulesData[]

object (ImageModuleData)

Dati del modulo immagine. Se sono impostati entrambi, verrà visualizzata solo un'immagine a livello di classe e una a livello di oggetto.
textModulesData[]

object (TextModuleData)

Dati del modulo di testo. Se textModulesData è definito anche nel corso, verranno visualizzati entrambi. Il numero massimo di questi campi visualizzati è 10 dalla classe e 10 dall'oggetto.
groupingInfo

object (GroupingInfo)

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

string

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

object (RotatingBarcode)

Impostazioni/dettagli del codice a barre rotante.
state

enum (State)

Lo stato dell'oggetto. Questo campo viene utilizzato per determinare come un oggetto viene visualizzato nell'app. Ad esempio, un oggetto inactive viene spostato nella sezione "Tessere scadute". Se non viene fornito, l'oggetto verrà considerato ACTIVE.
hasUsers

boolean

Indica se l'oggetto ha utenti. Questo campo è impostato dalla piattaforma.
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.
passConstraints

object (PassConstraints)

Passa i vincoli per l'oggetto. Include la limitazione dei comportamenti dell'NFC e degli 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 periodo di salvataggio. Se le limitazioni sono cambiate dopo che un utente ha salvato la tessera, le nuove limitazioni non verranno applicate a una tessera già salvata.
valueAddedModuleData[]

object (ValueAddedModuleData)

Dati facoltativi del modulo a valore aggiunto. Massimo dieci nell'oggetto.
linkedObjectIds[]

string

Gli oggetti LinkedObjectId sono un elenco di altri oggetti che devono essere automaticamente associati a questo oggetto generico, ad esempio biglietto per un evento, fedeltà, offerte, prodotti generici, carte regalo, trasporto pubblico e carta d'imbarco. Se un utente avesse salvato questa scheda generica, 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 linkedObjectIds 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.

GenericType

Il tipo di carta generica.

Enum
GENERIC_TYPE_UNSPECIFIED Tipo generico non specificato.
GENERIC_SEASON_PASS Pass per la stagione
GENERIC_UTILITY_BILLS Bollette
GENERIC_PARKING_PASS Tessere per il parcheggio
GENERIC_VOUCHER Coupon
GENERIC_GYM_MEMBERSHIP Tessere della palestra
GENERIC_LIBRARY_MEMBERSHIP Tessere della biblioteca
GENERIC_RESERVATIONS Prenotazioni
GENERIC_AUTO_INSURANCE Tessere di assicurazione auto
GENERIC_HOME_INSURANCE Tessere di assicurazione sulla casa
GENERIC_ENTRY_TICKET Biglietti d'ingresso
GENERIC_RECEIPT Ricevute
GENERIC_LOYALTY_CARD Carte fedeltà. Tieni presente che è consigliabile utilizzare un tipo di carta fedeltà dedicato anziché questo tipo generico. Un tipo di tessera fedeltà dedicato offre più funzionalità rispetto a un tipo di tessera generica.
GENERIC_OTHER Altro tipo

Notifiche

Indica se per l'oggetto è necessario attivare la notifica. Supportiamo solo uno di ExpiryNotification/UpcomingNotification. expiryNotification ha la precedenza su upcomingNotification. In altre parole, se expiryNotification è impostato, il campo upcomingNotification viene ignorato.

Rappresentazione JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Campi
expiryNotification

object (ExpiryNotification)

Verrà attivata una notifica in un momento specifico prima della scadenza della carta.
upcomingNotification

object (UpcomingNotification)

Verrà attivata una notifica in un momento specifico prima che la carta diventi utilizzabile.

ExpiryNotification

Indica che l'emittente vuole che Google Wallet invii notifiche di scadenza 2 giorni prima della scadenza della carta.

Rappresentazione JSON 
{
  "enableNotification": boolean
}
Campi
enableNotification

boolean

Indica se per l'oggetto deve essere abilitata la notifica di scadenza.

UpcomingNotification

Indica che l'emittente vuole che Google Wallet invii un'imminente notifica di validità della carta un giorno prima che la carta diventi valida/utilizzabile.

Rappresentazione JSON 
{
  "enableNotification": boolean
}
Campi
enableNotification

boolean

Indica se per l'oggetto è necessario attivare la notifica di eventi imminenti.

Metodi

addmessage

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

get

 Restituisce l'oggetto generico con l'ID oggetto specificato.

insert

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

list

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

patch

 Aggiorna l'oggetto generico a cui fa riferimento l'ID oggetto specificato.

update

 Aggiorna l'oggetto generico a cui fa riferimento l'ID oggetto specificato.