REST Resource: genericobject

Risorsa: GenericObject

ID successivo oggetto generico: 121

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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  }
}
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 il luogo in cui è possibile utilizzarla. Appare subito sopra il titolo nella riga del titolo nella visualizzazione dei dettagli della tessera.

header

object (LocalizedString)

obbligatorio. Il titolo della tessera, ad esempio "Coupon di sconto del 50%", "Scheda della biblioteca" o "Coupon". 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 il criterio non viene impostato, viene utilizzato il colore dominante dell'immagine hero; inoltre, se non viene impostata alcuna immagine hero, viene utilizzato il colore dominante del logo. Se il logo non viene impostato, Google sceglie 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 avere il formato issuerID.identifier, dove issuerID viene emesso da Google e identifier viene scelto da te. L'identificatore univoco può 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 dei corsi devono avere il formato issuerID.identifier, dove issuerID viene emesso da Google e identifier viene scelto da te.

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 scheda, se presente. L'immagine verrà visualizzata al 100% di larghezza.

validTimeInterval

object (TimeInterval)

Il periodo di tempo in cui questo oggetto verrà considerato valido o utilizzabile. Una volta trascorso questo periodo, l'oggetto viene considerato scaduto e questo influisce sul rendering sui dispositivi dell'utente.

imageModulesData[]

object (ImageModuleData)

Dati del modulo Immagine. Verrà visualizzata una sola immagine della classe e una sola a livello di oggetto quando sono entrambe impostate.

textModulesData[]

object (TextModuleData)

Dati dei moduli di testo. Se nel corso è definito anche textModulesData, verranno visualizzati entrambi. Il numero massimo di questi campi visualizzati è 10 da classe e 10 da oggetto.

groupingInfo

object (GroupingInfo)

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

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.

rotatingBarcode

object (RotatingBarcode)

Le impostazioni e i dettagli del codice a barre a rotazione.

state

enum (State)

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". Se non viene specificato, l'oggetto viene considerato ACTIVE.

hasUsers

boolean

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

passConstraints

object (PassConstraints)

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

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 Pass per il parcheggio
GENERIC_VOUCHER Coupon
GENERIC_GYM_MEMBERSHIP Tessere di iscrizione palestra
GENERIC_LIBRARY_MEMBERSHIP Tessere di iscrizione alle biblioteche
GENERIC_RESERVATIONS Prenotazioni
GENERIC_AUTO_INSURANCE Tessere di assicurazione automatica
GENERIC_HOME_INSURANCE Tessere per assicurazioni sulla casa
GENERIC_ENTRY_TICKET Biglietti d'ingresso
GENERIC_RECEIPT Ricevute
GENERIC_OTHER Altro tipo

Notifiche

Indica se per l'oggetto è necessario abilitare le notifiche. È supportata solo una delle seguenti notifiche. 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 a un orario specifico prima della scadenza della scheda.

upcomingNotification

object (UpcomingNotification)

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

ExpiryNotification

Indica che l'emittente desidera 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 è necessario abilitare la notifica di scadenza.

UpcomingNotification

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

Rappresentazione JSON
{
  "enableNotification": boolean
}
Campi
enableNotification

boolean

Indica se per l'oggetto è necessario abilitare la notifica imminente.

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.