- Risorsa: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- Stato
- DeviceContext
- Metodi
Risorsa: TransitObject
Rappresentazione JSON |
---|
{ "classReference": { object ( |
Campi | |
---|---|
classReference |
Una copia dei campi ereditati della classe principale. Questi campi vengono recuperati durante una richiesta GET. |
ticketNumber |
Il numero del biglietto. Si tratta di un identificatore univoco per il biglietto nel sistema dell'operatore di trasporto pubblico. |
passengerType |
Il numero di passeggeri. |
passengerNames |
Il nome o i nomi dei passeggeri a cui è assegnato il biglietto. Il campo |
tripId |
Questo ID viene utilizzato per raggruppare i biglietti se l'utente ha salvato più biglietti per la stessa corsa. |
ticketStatus |
Lo stato del biglietto. Per gli stati che influiscono sulla visualizzazione, utilizza invece il campo |
customTicketStatus |
Uno stato personalizzato da utilizzare per il valore dello stato del ticket quando |
concessionCategory |
La categoria della concessione per il biglietto. |
customConcessionCategory |
Una categoria di concessione personalizzata da utilizzare quando |
ticketRestrictions |
Informazioni sul tipo di limitazioni relative all'utilizzo di questo biglietto. Ad esempio, i giorni della settimana in cui deve essere utilizzato o i percorsi che è consentito seguire. |
purchaseDetails |
Dettagli per l'acquisto di questo biglietto. |
ticketLeg |
Un singolo tratto del biglietto contiene informazioni su partenza e arrivo, nonché su imbarco e posti. Se è necessario specificare più di un tratto, utilizza invece il campo |
ticketLegs[] |
Ogni biglietto può contenere uno o più tratti. Ogni tratta contiene informazioni su partenze e arrivi, nonché su imbarco e posti. Se devi specificare un solo tratto, utilizza il campo |
hexBackgroundColor |
Il colore di sfondo della scheda. Se non è impostato, viene utilizzato il colore dominante dell'immagine hero e, se non è impostata alcuna immagine hero, viene utilizzato il colore dominante del logo. Il formato è #rrggbb, dove rrggbb è una tripletta RGB esadecimale, ad esempio |
tripType |
Obbligatorio. Il tipo di corsa rappresentato da questo oggetto di trasporto pubblico. Utilizzato per determinare il titolo della tessera e/o il simbolo da utilizzare tra l'origine e la destinazione. |
id |
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 issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te. L'identificatore univoco deve includere solo caratteri alfanumerici, '.', '_' o '-'. |
classId |
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 seguire il formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te. |
version |
Deprecato |
state |
Obbligatorio. Lo stato dell'oggetto. Questo campo viene utilizzato per determinare la modalità di visualizzazione di un oggetto nell'app. Ad esempio, un oggetto |
barcode |
Il tipo e il valore del codice a barre. |
messages[] |
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 |
Il periodo di tempo in cui questo oggetto sarà |
locations[] |
Nota: al momento questo campo non è supportato per attivare le notifiche geografiche. |
hasUsers |
Indica se l'oggetto ha utenti. Questo campo è impostato dalla piattaforma. |
smartTapRedemptionValue |
Il valore che verrà trasmesso a un terminale certificato Smart Tap tramite NFC per questo oggetto. Anche i campi a livello di classe |
hasLinkedDevice |
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 |
Indica se le notifiche devono essere soppressate esplicitamente. Se questo campo è impostato su true, indipendentemente dal campo Al momento, questo valore può essere impostato solo per le offerte. |
infoModuleData |
Deprecato. Utilizza invece textModulesData. |
imageModulesData[] |
Dati del modulo immagine. Il numero massimo di questi campi visualizzati è 1 a livello di oggetto e 1 a livello di oggetto della classe. |
textModulesData[] |
Dati del modulo di testo. Se nel corso 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. |
linksModuleData |
Collega i dati del modulo. Se i dati del modulo dei link sono definiti anche sul corso, verranno visualizzati entrambi. |
appLinkData |
Link facoltativo a un sito web o un'app che verrà visualizzato come pulsante sulla parte anteriore della tessera. Se viene fornito AppLinkData per l'oggetto della classe corrispondente, verrà visualizzato solo AppLinkData. |
activationStatus |
Lo stato di attivazione dell'oggetto. Obbligatorio se per la classe è impostato |
rotatingBarcode |
Il tipo e il valore del codice a barre rotante. |
deviceContext |
Contesto del dispositivo associato all'oggetto. |
heroImage |
Immagine del banner facoltativa visualizzata sulla parte anteriore della scheda. Se non è presente, verrà visualizzata l'immagine hero del corso, se presente. Se non è presente nemmeno l'immagine hero del corso, non verrà visualizzata alcuna immagine. |
groupingInfo |
Informazioni che controllano il modo in cui le tessere vengono raggruppate. |
passConstraints |
Passa i vincoli per l'oggetto. Sono inclusi i comportamenti di limitazione di NFC e screenshot. |
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 tempo 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. |
linkedObjectIds[] |
linkedObjectIds è un elenco di altri oggetti, come biglietti per eventi, fedeltà, offerte, generici, carte regalo, trasporto pubblico e carte d'imbarco, che devono essere collegati automaticamente a questo oggetto di trasporto pubblico. Se un utente ha salvato questa tessera del trasporto pubblico, questi linkedObjectId verranno 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. |
notifyPreference |
Indica se gli aggiornamenti dei campi di questo oggetto devono attivare o meno le notifiche. Se impostato su NOTIFY, tenteremo di attivare una notifica di aggiornamento del campo per gli utenti. Queste notifiche verranno inviate agli utenti solo se il campo fa parte di una lista consentita. Se impostato su DO_NOT_NOTIFY o NOTIFICATION_SETTINGS_UNSPECIFIED, non verrà attivata alcuna notifica. Questa impostazione è temporanea e deve essere impostata con ogni richiesta PATCH o UPDATE, altrimenti non verrà attivata una notifica. |
valueAddedModuleData[] |
Dati facoltativi del modulo del valore aggiunto. Massimo dieci nell'oggetto. |
merchantLocations[] |
Sedi dei commercianti. L'oggetto può contenere un massimo di dieci elementi. Eventuali altri MerchantLocations aggiunti oltre i 10 verranno rifiutati. Queste località attiveranno una notifica quando un utente entra in un raggio impostato da Google dal punto. Questo campo sostituisce LatLongPoints deprecato. |
PassengerType
Enum | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Alias precedente per |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Alias precedente per |
TicketStatus
Enum | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Alias precedente per |
REFUNDED |
|
refunded |
Alias precedente per |
EXCHANGED |
|
exchanged |
Alias precedente per |
ConcessionCategory
Enum | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Alias precedente per |
CHILD |
|
child |
Alias precedente per |
SENIOR |
|
senior |
Alias precedente per |
TicketRestrictions
Rappresentazione JSON |
---|
{ "routeRestrictions": { object ( |
Campi | |
---|---|
routeRestrictions |
Restrizioni relative ai percorsi che possono essere seguiti. Ad esempio, potrebbe essere la stringa "Solo treni CrossCountry riservati". |
routeRestrictionsDetails |
Maggiori dettagli su |
timeRestrictions |
Limitazioni relative agli orari in cui è possibile utilizzare il biglietto. |
otherRestrictions |
Restrizioni aggiuntive che non rientrano nelle categorie "Percorso" o "Orario". |
PurchaseDetails
Rappresentazione JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Campi | |
---|---|
purchaseReceiptNumber |
Numero/identificatore della ricevuta per monitorare l'acquisto del biglietto tramite l'ente che lo ha venduto. |
purchaseDateTime |
La data e l'ora di acquisto del biglietto. Si tratta di una data/ora nel formato esteso ISO 8601, con o senza un offset. Il tempo può essere specificato con una precisione fino a un nanosecondo. Gli offset possono essere specificati con una precisione di secondi (anche se i secondi di offset non fanno parte di ISO 8601). Ad esempio:
Senza informazioni sull'offset, alcune funzionalità avanzate potrebbero non essere disponibili. |
accountId |
ID dell'account utilizzato per acquistare il biglietto. |
confirmationCode |
Il codice di conferma dell'acquisto. Può essere uguale per più richieste diverse e viene utilizzato per raggrupparle. |
ticketCost |
Il costo del biglietto. |
TicketCost
Rappresentazione JSON |
---|
{ "faceValue": { object ( |
Campi | |
---|---|
faceValue |
Il valore nominale del biglietto. |
purchasePrice |
Il prezzo di acquisto effettivo del biglietto, al netto di tasse e/o sconti. |
discountMessage |
Un messaggio che descrive qualsiasi tipo di sconto applicato. |
TicketLeg
Rappresentazione JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Campi | |
---|---|
originStationCode |
Il codice della stazione di partenza. Questo è obbligatorio se è presente |
originName |
Il nome della stazione di partenza. Questo è obbligatorio se è presente |
destinationStationCode |
Il codice della stazione di destinazione. |
destinationName |
Il nome della destinazione. |
departureDateTime |
La data e l'ora di partenza. Questo valore è obbligatorio se non è impostato alcun intervallo di tempo di validità nell'oggetto di transito. Si tratta di una data/ora nel formato esteso ISO 8601, con o senza un offset. Il tempo può essere specificato con una precisione fino a un nanosecondo. Gli offset possono essere specificati con una precisione di secondi (anche se i secondi di offset non fanno parte di ISO 8601). Ad esempio:
La parte della data/dell'ora senza l'offset è considerata "data/ora locale". Deve essere la data/ora locale della stazione di partenza. Ad esempio, se la partenza avviene alle ore 20:00 del 5 giugno 2018 nella stazione di partenza, la parte della data/dell'ora locale deve essere Senza informazioni sull'offset, alcune funzionalità avanzate potrebbero non essere disponibili. |
arrivalDateTime |
La data e l'ora di arrivo. Si tratta di una data/ora nel formato esteso ISO 8601, con o senza un offset. Il tempo può essere specificato con una precisione fino a un nanosecondo. Gli offset possono essere specificati con una precisione di secondi (anche se i secondi di offset non fanno parte di ISO 8601). Ad esempio:
La parte della data/dell'ora senza l'offset è considerata "data/ora locale". Deve essere la data/ora locale della stazione di destinazione. Ad esempio, se l'evento si verifica alle ore 20:00 del 5 giugno 2018 nella stazione di destinazione, la parte della data/dell'ora locale deve essere Senza informazioni sull'offset, alcune funzionalità avanzate potrebbero non essere disponibili. |
fareName |
Descrizione/nome breve della tariffa per questo tratto di viaggio. Ad esempio "Uso singolo in qualsiasi momento". |
carriage |
Il nome/numero del treno o della nave su cui il passeggero deve salire. |
platform |
La banchina o la porta su cui il passeggero può salire sulla carrozza. |
zone |
La zona di salita all'interno della piattaforma. |
ticketSeat |
Il posto riservato per i passeggeri. Se è necessario specificare più di un posto, utilizza il campo |
ticketSeats[] |
Il posto riservato per i passeggeri. Se devi specificare un solo posto, utilizza il campo |
transitOperatorName |
Il nome dell'operatore di trasporto pubblico che gestisce questa tratta di un viaggio. |
transitTerminusName |
Stazione di arrivo o destinazione del treno/dell'autobus/ecc. |
TicketSeat
Rappresentazione JSON |
---|
{ "fareClass": enum ( |
Campi | |
---|---|
fareClass |
La classe tariffaria del posto per cui è stato acquistato il biglietto. |
customFareClass |
Una classe tariffaria personalizzata da utilizzare se non è applicato alcun |
coach |
L'identificatore del vagone del treno in cui si trova il posto per cui è stato acquistato il biglietto. Ad esempio, "10" |
seat |
L'identificatore della posizione del posto per cui è stato acquistato il biglietto. Ad esempio, "42". Se non è presente un identificatore specifico, utilizza |
seatAssignment |
L'assegnazione del posto del passeggero. Ad esempio, "no specific seat". Da utilizzare quando non è presente un identificatore specifico da utilizzare in |
FareClass
Enum | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Alias precedente per |
FIRST |
|
first |
Alias precedente per |
BUSINESS |
|
business |
Alias precedente per |
TripType
Enum | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Alias precedente per |
ONE_WAY |
|
oneWay |
Alias precedente per |
ActivationStatus
Lo stato di attivazione dell'oggetto. Questo campo include lo stato di attivazione se il valore supporta l'attivazione.
Rappresentazione JSON |
---|
{
"state": enum ( |
Campi | |
---|---|
state |
|
Stato
Enum | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Non attivato, questo è lo stato predefinito |
not_activated |
Alias precedente per |
ACTIVATED |
Attivata |
activated |
Alias precedente per |
DeviceContext
Contesto del dispositivo associato all'oggetto.
Rappresentazione JSON |
---|
{ "deviceToken": string } |
Campi | |
---|---|
deviceToken |
Se impostato, le informazioni sul riscatto verranno restituite al dispositivo specificato solo al momento dell'attivazione dell'oggetto. Non deve essere utilizzato come identificatore stabile per tracciare il dispositivo di un utente. Può variare da una tessera all'altra per lo stesso dispositivo o anche da un'attivazione all'altra per lo stesso dispositivo. Quando impostano questo valore, gli utenti chiamanti devono impostare anche hasLinkedDevice sull'oggetto da attivare. |
Metodi |
|
---|---|
|
Aggiunge un messaggio all'oggetto di trasporto a cui fa riferimento l'ID oggetto specificato. |
|
Restituisce l'oggetto di trasporto pubblico con l'ID oggetto specificato. |
|
Inserisce un oggetto di trasporto pubblico con l'ID e le proprietà specificati. |
|
Restituisce un elenco di tutti gli oggetti di trasporto pubblico per un determinato ID emittente. |
|
Aggiorna l'oggetto di trasporto a cui fa riferimento l'ID oggetto specificato. |
|
Aggiorna l'oggetto di trasporto a cui fa riferimento l'ID oggetto specificato. |