REST Resource: transitobject

{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}

object (TransitClass)

Una copia dei campi ereditati della classe principale. Questi campi vengono recuperati durante una richiesta GET.

string

Il numero del ticket. Si tratta di un identificatore univoco del biglietto nel sistema dell'operatore di trasporto pubblico.

enum (PassengerType)

Il numero di passeggeri.

string

Il nome o i nomi dei passeggeri a cui è assegnato il biglietto. Il campo passengerType riportato sopra ha lo scopo di fornire a Google contesto su questo campo.

string

Questo ID viene utilizzato per raggruppare i biglietti se l'utente ha salvato più biglietti per la stessa corsa.

enum (TicketStatus)

Lo stato del ticket. Per gli stati che influiscono sulla visualizzazione, utilizza invece il campo state.

object (LocalizedString)

Uno stato personalizzato da utilizzare per il valore dello stato del ticket quando ticketStatus non offre l'opzione giusta. Impossibile impostare ticketStatus e customTicketStatus.

enum (ConcessionCategory)

La categoria di concessione per il biglietto.

object (LocalizedString)

Una categoria di concessione personalizzata da utilizzare quando concessionCategory non offre l'opzione giusta. Impossibile impostare concessionCategory e customConcessionCategory.

object (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.

object (PurchaseDetails)

Dettagli per l'acquisto di questo biglietto.

object (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. Impossibile impostare ticketLeg e ticketLegs.

object (TicketLeg)

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 ticketLeg. Impossibile impostare ticketLeg e ticketLegs.

string

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 #ffcc00. Puoi anche utilizzare la versione abbreviata della terzina RGB che è il numero rgb, ad esempio #fc0.

enum (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.

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 issuer ID.identifier: il primo viene emesso da Google, mentre il secondo è scelto da te. L'identificatore univoco deve includere solo caratteri alfanumerici, ".", "_" o "-".

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 issuer ID.identifier: il primo viene emesso da Google, mentre il secondo è scelto da te.

string (int64 format)

Deprecato

enum (State)

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

object (Barcode)

Il tipo e il valore del codice a barre.

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.

object (TimeInterval)

Il periodo di tempo in cui questo oggetto sarà active e potrà essere utilizzato l'oggetto. Al termine di questo periodo di tempo, lo stato di un oggetto verrà modificato in expired.

object (LatLongPoint)

Nota: al momento questo campo non è supportato per attivare le notifiche geografiche.

boolean

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

string

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

boolean

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.

boolean

Indica se le notifiche devono essere soppresse esplicitamente. Se questo campo viene impostato su true, indipendentemente dal campo messages, le notifiche di scadenza per l'utente verranno soppresse. Per impostazione predefinita, questo campo è impostato su false.

Al momento, questa opzione può essere impostata solo per le offerte.

object (InfoModuleData)

Deprecato. Usa invece textModulesData.

object (ImageModuleData)

Dati del modulo immagine. Il numero massimo di questi campi visualizzati è 1 a livello di oggetto e 1 a livello di oggetto di classe.

object (TextModuleData)

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.

object (LinksModuleData)

Collega i dati del modulo. Se i dati del modulo Link sono definiti anche nel corso, verranno visualizzati entrambi.

object (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.

object (ActivationStatus)

Lo stato di attivazione dell'oggetto. Obbligatorio se per il corso è impostato activationOptions.

object (RotatingBarcode)

Il tipo e il valore del codice a barre in rotazione.

object (DeviceContext)

Contesto del dispositivo associato all'oggetto.

object (Image)

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.

object (GroupingInfo)

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

object (PassConstraints)

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

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.

{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}

object (LocalizedString)

Restrizioni relative alle route che possono essere seguite. Potrebbe essere, ad esempio, la stringa "Solo treni nazionali prenotati".

object (LocalizedString)

Maggiori dettagli su quanto sopra routeRestrictions.

object (LocalizedString)

Restrizioni relative agli orari in cui potrebbe essere utilizzato questo biglietto.

object (LocalizedString)

Restrizioni aggiuntive che non rientrano nel "percorso" o "tempo" categorie.

{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}

string

Numero/identificatore della ricevuta per il monitoraggio dell'acquisto del biglietto tramite la banca che ha venduto il biglietto.

string

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:

1985-04-12T23:20:50.52Z sarebbe 20 minuti e 50, 52 secondi dopo la 23a ora del 12 aprile 1985 in UTC.

1985-04-12T19:20:50.52-04:00 corrisponderebbe a 20 minuti e 50, 52 secondi dopo la 19a ora del 12 aprile 1985, 4 ore prima del fuso orario UTC (stesso istante dell'esempio riportato sopra). Se l'evento si verificasse a New York, equivale all'ora legale della costa orientale (EDT). Ricorda che l'offset varia nelle regioni che osservano l'ora legale (o ora legale), a seconda del periodo dell'anno.

1985-04-12T19:20:50.52 sarebbe 20 minuti e 50, 52 secondi dopo la 19a ora del 12 aprile 1985 senza informazioni sull'offset.

Senza le informazioni sull'offset, alcune caratteristiche avanzate potrebbero non essere disponibili.

string

ID dell'account utilizzato per acquistare il biglietto.

string

Il codice di conferma dell'acquisto. Può essere lo stesso per più biglietti diversi e viene utilizzato per raggruppare i biglietti.

object (TicketCost)

Il costo del biglietto.

{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}

object (Money)

Il valore nominale del biglietto.

object (Money)

Il prezzo effettivo di acquisto del biglietto, al netto delle imposte e/o degli sconti.

object (LocalizedString)

Un messaggio che descrive qualsiasi tipo di sconto applicato.

{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}

string

Il codice della stazione di partenza. Questa operazione è necessaria se destinationStationCode è presente o se originName non è presente.

object (LocalizedString)

Il nome della stazione di partenza. Questa operazione è necessaria se desinationName è presente o se originStationCode non è presente.

string

Il codice della stazione di destinazione.

object (LocalizedString)

Il nome della destinazione.

string

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:

1985-04-12T23:20:50.52Z sarebbe 20 minuti e 50, 52 secondi dopo la 23a ora del 12 aprile 1985 in UTC.

1985-04-12T19:20:50.52-04:00 corrisponderebbe a 20 minuti e 50, 52 secondi dopo la 19a ora del 12 aprile 1985, 4 ore prima del fuso orario UTC (stesso istante dell'esempio riportato sopra). Se l'evento si verificasse a New York, equivale all'ora legale della costa orientale (EDT). Ricorda che l'offset varia nelle regioni che osservano l'ora legale (o ora legale), a seconda del periodo dell'anno.

1985-04-12T19:20:50.52 sarebbe 20 minuti e 50, 52 secondi dopo la 19a ora del 12 aprile 1985 senza informazioni sull'offset.

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 2018-06-05T20:00:00. Se la data e l'ora locali nella stazione di origine sono quattro ore prima dell'UTC, potrebbe essere aggiunto un offset di -04:00.

Senza le informazioni sull'offset, alcune caratteristiche avanzate potrebbero non essere disponibili.

string

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:

1985-04-12T23:20:50.52Z sarebbe 20 minuti e 50, 52 secondi dopo la 23a ora del 12 aprile 1985 in UTC.

1985-04-12T19:20:50.52-04:00 corrisponderebbe a 20 minuti e 50, 52 secondi dopo la 19a ora del 12 aprile 1985, 4 ore prima del fuso orario UTC (stesso istante dell'esempio riportato sopra). Se l'evento si verificasse a New York, equivale all'ora legale della costa orientale (EDT). Ricorda che l'offset varia nelle regioni che osservano l'ora legale (o ora legale), a seconda del periodo dell'anno.

1985-04-12T19:20:50.52 sarebbe 20 minuti e 50, 52 secondi dopo la 19a ora del 12 aprile 1985 senza informazioni sull'offset.

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 2018-06-05T20:00:00. Se la data e l'ora locali nella stazione di destinazione sono quattro ore prima dell'ora UTC, è possibile aggiungere un offset di -04:00.

Senza le informazioni sull'offset, alcune caratteristiche avanzate potrebbero non essere disponibili.

object (LocalizedString)

Breve descrizione/nome della tariffa per questa tratta di viaggio. Ad esempio, "In qualsiasi momento a uso singolo".

string

Il nome/numero del treno o della nave su cui il passeggero deve imbarcarsi.

string

La piattaforma o il cancello su cui il passeggero può salire a bordo della carrozza.

string

La zona di imbarco all'interno della piattaforma.

object (TicketSeat)

Il posto riservato per il passeggero o i passeggeri. Se è necessario specificare più di un posto, utilizza il campo ticketSeats. Impossibile impostare ticketSeat e ticketSeats.

object (TicketSeat)

Il posto riservato per il passeggero o i passeggeri. Se deve essere specificato un solo posto, utilizza il campo ticketSeat. Impossibile impostare ticketSeat e ticketSeats.

object (LocalizedString)

Il nome dell'operatore di trasporto pubblico che effettua questa tratta di una corsa.

object (LocalizedString)

Stazione capolinea o destinazione del treno/autobus/ecc.

{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}

enum (FareClass)

La classe tariffaria del posto acquistato.

object (LocalizedString)

Una classe tariffaria personalizzata da utilizzare in assenza di fareClass. Impossibile impostare fareClass e customFareClass.

string

L'identificatore del vagone o del vagone in cui si trova il posto acquistato. Ad es. "10"

string

L'identificatore della località in cui si trova il posto acquistato. Ad es. "42". Se non esiste un identificatore specifico, usa seatAssigment.

object (LocalizedString)

L'assegnazione del posto al passeggero. Ad es. "nessun posto specifico". Da utilizzare quando non esistono identificatori specifici da usare in seat.

{
  "state": enum (State)
}

enum (State)

{
  "deviceToken": string
}

string

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.