- 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 ticket. Si tratta di un identificatore univoco del 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 ticket. 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 di concessione per il biglietto. |
customConcessionCategory |
Una categoria di concessione personalizzata da utilizzare quando |
ticketRestrictions |
Informazioni sul tipo di limitazioni relative all'utilizzo di questo ticket. Ad esempio, in quali giorni della settimana deve essere utilizzato o quali percorsi è consentito seguire. |
purchaseDetails |
Dettagli per l'acquisto di questo biglietto. |
ticketLeg |
Una singola tratta del biglietto contiene le informazioni su partenze e arrivi, oltre a informazioni di imbarco e posti a sedere. Se è necessario specificare più di un ramo, utilizza invece il campo |
ticketLegs[] |
Ogni biglietto può contenere una o più tratte. Ogni tratta contiene le informazioni su partenza e arrivo, oltre a informazioni di imbarco e posti a sedere. Se deve essere specificata una sola gamba, utilizza invece il campo |
hexBackgroundColor |
Il colore di sfondo della scheda. Se non viene impostato il colore dominante dell'immagine hero, se non viene impostata alcuna immagine hero, viene utilizzato il colore dominante del logo. Il formato è #rrggbb, dove rrggbb è una terzina RGB esadecimale, ad esempio |
tripType |
Obbligatorio. Il tipo di corsa rappresentato da questo oggetto di transito. Utilizzato per determinare il titolo della tessera e/o il simbolo da utilizzare tra il luogo di partenza 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 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 |
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 |
Deprecato |
state |
Obbligatorio. Lo stato dell'oggetto. Questo campo viene utilizzato per determinare come un oggetto viene visualizzato 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. Affinché la tessera supporti Smart Tap, anche i campi a livello di corso |
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 a partner selezionati. Contatta l'assistenza per ulteriori informazioni. |
disableExpirationNotification |
Indica se le notifiche devono essere soppresse esplicitamente. Se questo campo viene impostato su true, indipendentemente dal campo Al momento, questa opzione può essere impostata solo per le offerte. |
infoModuleData |
Deprecato. Usa 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 di classe. |
textModulesData[] |
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. |
linksModuleData |
Collega i dati del modulo. Se i dati del modulo Link sono definiti anche nel corso, verranno visualizzati entrambi. |
appLinkData |
Link facoltativo all'app o al sito web che verrà mostrato sotto forma di pulsante sulla parte anteriore della tessera. Se AppLinkData viene fornito per l'oggetto solo della classe corrispondente, verrà visualizzato AppLinkData. |
activationStatus |
Lo stato di attivazione dell'oggetto. Obbligatorio se per il corso è impostato |
rotatingBarcode |
Il tipo e il valore del codice a barre in rotazione. |
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 della classe, se presente. Se non è presente anche l'immagine hero del corso, non verrà visualizzato nulla. |
groupingInfo |
Informazioni che controllano il modo in cui le tessere vengono raggruppate. |
passConstraints |
Passa i vincoli per l'oggetto. Include la limitazione dei comportamenti dell'NFC e degli screenshot. |
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. |
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 alle route che possono essere seguite. Potrebbe essere, ad esempio, la stringa "Solo treni nazionali prenotati". |
routeRestrictionsDetails |
Maggiori dettagli su quanto sopra |
timeRestrictions |
Restrizioni relative agli orari in cui potrebbe essere utilizzato questo biglietto. |
otherRestrictions |
Restrizioni aggiuntive che non rientrano nel "percorso" o "tempo" categorie. |
PurchaseDetails
Rappresentazione JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Campi | |
---|---|
purchaseReceiptNumber |
Numero/identificatore della ricevuta per il monitoraggio dell'acquisto del biglietto tramite la banca che ha venduto il biglietto. |
purchaseDateTime |
La data e l'ora di acquisto del biglietto. Data/ora nel formato esteso ISO 8601, con o senza offset. Il tempo può essere specificato con una precisione fino a nanosecondi. Gli offset possono essere specificati con la precisione in secondi (anche se i secondi di offset non fanno parte di ISO 8601). Ad esempio:
Senza le informazioni sull'offset, alcune caratteristiche avanzate potrebbero non essere disponibili. |
accountId |
ID dell'account utilizzato per acquistare il biglietto. |
confirmationCode |
Il codice di conferma dell'acquisto. Può essere lo stesso per più biglietti diversi e viene utilizzato per raggruppare i biglietti. |
ticketCost |
Il costo del biglietto. |
TicketCost
Rappresentazione JSON |
---|
{ "faceValue": { object ( |
Campi | |
---|---|
faceValue |
Il valore nominale del biglietto. |
purchasePrice |
Il prezzo effettivo di acquisto del biglietto, al netto delle imposte e/o degli 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. Questa operazione è necessaria se |
originName |
Il nome della stazione di partenza. Questa operazione è necessaria se |
destinationStationCode |
Il codice della stazione di destinazione. |
destinationName |
Il nome della destinazione. |
departureDateTime |
Data e ora di partenza. Questa informazione è obbligatoria se non è impostato un intervallo di tempo di validità per l'oggetto di transito. Data/ora nel formato esteso ISO 8601, con o senza offset. Il tempo può essere specificato con una precisione fino a nanosecondi. Gli offset possono essere specificati con la precisione in secondi (anche se i secondi di offset non fanno parte di ISO 8601). Ad esempio:
La parte della data e dell'ora senza la differenza è considerata come la "data e ora locale". Deve essere la data e l'ora locali presso la stazione di partenza. Ad esempio, se la partenza avviene alla 20a ora del 5 giugno 2018 presso la stazione di partenza, la porzione di data e ora locale deve essere Senza le informazioni sull'offset, alcune caratteristiche avanzate potrebbero non essere disponibili. |
arrivalDateTime |
Data e ora dell'arrivo. Data/ora nel formato esteso ISO 8601, con o senza offset. Il tempo può essere specificato con una precisione fino a nanosecondi. Gli offset possono essere specificati con la precisione in secondi (anche se i secondi di offset non fanno parte di ISO 8601). Ad esempio:
La parte della data e dell'ora senza la differenza è considerata come la "data e ora locale". Deve essere la data e l'ora locali presso la stazione di destinazione. Ad esempio, se l'evento si verifica alla 20a ora del 5 giugno 2018 presso la stazione di destinazione, la parte di data e ora locale deve essere Senza le informazioni sull'offset, alcune caratteristiche avanzate potrebbero non essere disponibili. |
fareName |
Breve descrizione/nome della tariffa per questa tratta di viaggio. Ad esempio, "In qualsiasi momento a uso singolo". |
carriage |
Il nome/numero del treno o della nave su cui il passeggero deve imbarcarsi. |
platform |
La piattaforma o il cancello su cui il passeggero può salire a bordo della carrozza. |
zone |
La zona di imbarco all'interno della piattaforma. |
ticketSeat |
Il posto riservato per il passeggero o i passeggeri. Se è necessario specificare più di un posto, utilizza il campo |
ticketSeats[] |
Il posto riservato per il passeggero o i passeggeri. Se deve essere specificato un solo posto, utilizza il campo |
transitOperatorName |
Il nome dell'operatore di trasporto pubblico che effettua questa tratta di una corsa. |
transitTerminusName |
Stazione capolinea o destinazione del treno/autobus/ecc. |
TicketSeat
Rappresentazione JSON |
---|
{ "fareClass": enum ( |
Campi | |
---|---|
fareClass |
La classe tariffaria del posto acquistato. |
customFareClass |
Una classe tariffaria personalizzata da utilizzare in assenza di |
coach |
L'identificatore del vagone o del vagone in cui si trova il posto acquistato. Ad es. "10" |
seat |
L'identificatore della località in cui si trova il posto acquistato. Ad es. "42". Se non esiste un identificatore specifico, usa |
seatAssignment |
L'assegnazione del posto al passeggero. Ad es. "nessun posto specifico". Da utilizzare quando non esistono identificatori specifici da usare 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 utile 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 sull'utilizzo 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ò cambiare in diverse tessere per lo stesso dispositivo o anche tra diverse attivazioni per lo stesso dispositivo. Quando si imposta questa opzione, i chiamanti devono impostare anche hasLinkedDevice per l'oggetto che viene attivato. |
Metodi |
|
---|---|
|
Aggiunge un messaggio all'oggetto di transito a cui fa riferimento l'ID oggetto specificato. |
|
Restituisce l'oggetto di transito con l'ID oggetto specificato. |
|
Inserisce un oggetto di transito con l'ID e le proprietà specificati. |
|
Restituisce un elenco di tutti gli oggetti di transito per un determinato ID emittente. |
|
Aggiorna l'oggetto di transito a cui fa riferimento l'ID oggetto specificato. |
|
Aggiorna l'oggetto di transito a cui fa riferimento l'ID oggetto specificato. |