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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Campi
genericType

enum (GenericType)

Specifica a quale GenericType appartiene la carta.

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 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 del 50% di sconto" o "Tessere 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 viene impostato, viene utilizzato il colore dominante dell'immagine hero e, se non viene impostata alcuna immagine hero, viene utilizzato il colore predominante del logo. Se il logo non viene impostato, Google ne sceglie uno.

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 essere nel 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 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 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 scheda, se presente. L'immagine verrà visualizzata con una larghezza al 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. Verrà visualizzata solo l'immagine della classe e l'altra del livello dell'oggetto quando sono impostate entrambe.

textModulesData[]

object (TextModuleData)

Dati del modulo di testo. Se nel corso è definito anche textModulesData, 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)

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

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 in "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 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.

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 della palestra
GENERIC_LIBRARY_MEMBERSHIP Tessere della biblioteca
GENERIC_RESERVATIONS Prenotazioni
GENERIC_AUTO_INSURANCE Tessere dell'assicurazione auto
GENERIC_HOME_INSURANCE Tessere dell'assicurazione sulla casa
GENERIC_ENTRY_TICKET Biglietti d'ingresso
GENERIC_RECEIPT Ricevute
GENERIC_OTHER Altro tipo

Notifiche

Indica se la notifica deve essere abilitata per l'oggetto. È supportata una sola notifica di scadenza/Notifica imminente. 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à inviata una notifica a un momento specifico prima della scadenza della carta.

upcomingNotification

object (UpcomingNotification)

Verrà inviata una notifica in un momento specifico prima che la carta sia 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 devono essere abilitate le notifiche future.

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.