REST Resource: transitobject

Risorsa: TransitObject

Rappresentazione JSON 
{
  "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)
  }
}
Campi
classReference

object (TransitClass)

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

string

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

enum (PassengerType)

Il numero di passeggeri.
passengerNames

string

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

string

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

enum (TicketStatus)

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

object (LocalizedString)

Uno stato personalizzato da utilizzare per il valore dello stato del biglietto quando ticketStatus non offre l'opzione corretta. Non è possibile impostare sia ticketStatus che customTicketStatus.
concessionCategory

enum (ConcessionCategory)

La categoria della concessione del biglietto.
customConcessionCategory

object (LocalizedString)

Una categoria di concessione personalizzata da utilizzare quando concessionCategory non offre l'opzione corretta. Non è possibile impostare sia concessionCategory che customConcessionCategory.
ticketRestrictions

object (TicketRestrictions)

Informazioni sul tipo di restrizioni applicate all'utilizzo di questo biglietto. Ad esempio, in quali giorni della settimana deve essere utilizzato o quali percorsi è consentito.
purchaseDetails

object (PurchaseDetails)

Dettagli per l'acquisto di questo biglietto.
ticketLeg

object (TicketLeg)

Una tratta con biglietto singolo contiene informazioni su partenze e arrivo, oltre a informazioni su imbarco e posti a sedere. Se è necessario specificare più di un tratto, utilizza il campo ticketLegs. Non è possibile impostare sia ticketLeg che ticketLegs.
ticketLegs[]

object (TicketLeg)

Ciascun biglietto può contenere una o più tappe. Ogni tratta contiene informazioni su partenze e arrivo, oltre a informazioni su imbarco e posto a sedere. Se è necessario specificare un solo tratto, utilizza invece il campo ticketLeg. Non è possibile impostare sia ticketLeg che ticketLegs.
hexBackgroundColor

string

Il colore di sfondo della scheda. Se non viene 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 #ffcc00. Puoi anche usare la versione abbreviata della terzina RGB, che è #rgb, ad esempio #fc0.
tripType

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

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, dove la prima è rilasciata da Google e la seconda è scelta da te. L'identificatore univoco deve 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 classe devono essere nel formato issuer ID.identifier, dove la prima è rilasciata da Google e la seconda è scelta da te.
version
(deprecated)

string (int64 format)

Deprecata
state

enum (State)

obbligatorio. 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".
barcode

object (Barcode)

Il tipo e il valore del codice a barre.
messages[]

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.
validTimeInterval

object (TimeInterval)

Il periodo di tempo in cui questo oggetto sarà active e può essere utilizzato. Lo stato di un oggetto verrà modificato in expired una volta trascorso questo periodo di tempo.
locations[]

object (LatLongPoint)

Nota: questo campo non è attualmente supportato per attivare le notifiche geografiche.
hasUsers

boolean

Indica se l'oggetto ha utenti. Questo campo è impostato dalla piattaforma.
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.
hasLinkedDevice

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 all'utilizzo da parte di partner selezionati. Contatta l'assistenza per ulteriori informazioni.
disableExpirationNotification

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, può essere impostata solo per le offerte.
infoModuleData

object (InfoModuleData)

Deprecato. Usa invece textModulesData.
imageModulesData[]

object (ImageModuleData)

Dati del modulo Immagine. Il numero massimo di questi campi visualizzati è 1 a livello di oggetto e 1 a livello di oggetto classe.
textModulesData[]

object (TextModuleData)

Dati dei moduli di testo. Se nella classe 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.
activationStatus

object (ActivationStatus)

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

object (RotatingBarcode)

Il tipo e il valore del codice a barre rotante.
deviceContext

object (DeviceContext)

Contesto del dispositivo associato all'oggetto.
heroImage

object (Image)

Immagine del banner facoltativa visualizzata sulla parte anteriore della scheda. Se non è presente, verrà visualizzata un'immagine promozionale della classe, se presente. Se non è presente neanche l'immagine hero della classe, non verrà visualizzato nulla.
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

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

PassengerType

Enum
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

Alias precedente per SINGLE_PASSENGER. Deprecato.
MULTIPLE_PASSENGERS
multiplePassengers

Alias precedente per MULTIPLE_PASSENGERS. Deprecato.

TicketStatus

Enum
TICKET_STATUS_UNSPECIFIED
USED
used

Alias precedente per USED. Deprecato.
REFUNDED
refunded

Alias precedente per REFUNDED. Deprecato.
EXCHANGED
exchanged

Alias precedente per EXCHANGED. Deprecato.

ConcessionCategory

Enum
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Alias precedente per ADULT. Deprecato.
CHILD
child

Alias precedente per CHILD. Deprecato.
SENIOR
senior

Alias precedente per SENIOR. Deprecato.

TicketRestrictions

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

object (LocalizedString)

Limitazioni relative ai percorsi che è possibile seguire. Ad esempio, potrebbe essere la stringa "Solo treni CrossCountry riservati".
routeRestrictionsDetails

object (LocalizedString)

Ulteriori dettagli su routeRestrictions sopra.
timeRestrictions

object (LocalizedString)

Limitazioni relative agli orari di utilizzo di questo biglietto.
otherRestrictions

object (LocalizedString)

Ulteriori limitazioni che non rientrano nelle categorie "percorso" o "tempo".

PurchaseDetails

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

string

Numero/identificatore ricevuta per monitorare l'acquisto del biglietto tramite il corpo che lo ha venduto.
purchaseDateTime

string

La data e l'ora di acquisto del biglietto.

Si tratta di un formato di data e ora in formato ISO 8601 esteso, con o senza un offset. Il tempo può essere specificato con una precisione fino a un nanosecondo. Gli offset possono essere specificati con precisione in secondi (anche se l'offset in secondi non fa parte di ISO 8601).

Ad esempio:

1985-04-12T23:20:50.52Z corrisponderà a 20 minuti e 50, 52 secondi dopo la 23a ora del 12 aprile 1985 nel fuso orario UTC.

1985-04-12T19:20:50.52-04:00 corrisponde a 20 minuti e 50, 52 secondi dopo la 19 ora del 12 aprile 1985, 4 ore prima di UTC (lo stesso istante dell'esempio riportato sopra). Se l'evento si trovasse a New York, sarebbe l'ora legale della costa orientale (EDT). Ricorda che l'offset varia nelle regioni in cui è osservata l'ora legale, a seconda del periodo dell'anno.

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

Senza informazioni di offset, alcune funzionalità avanzate potrebbero non essere disponibili.
accountId

string

ID dell'account utilizzato per acquistare il biglietto.
confirmationCode

string

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

object (TicketCost)

Il costo del biglietto.

TicketCost

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

object (Money)

Il valore nominale del biglietto.
purchasePrice

object (Money)

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

object (LocalizedString)

Un messaggio che descrive ogni tipo di sconto applicato.

TicketLeg

Rappresentazione JSON 
{
  "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)
  }
}
Campi
originStationCode

string

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

object (LocalizedString)

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

string

Il codice della stazione di destinazione.
destinationName

object (LocalizedString)

Il nome della destinazione.
departureDateTime

string

La data e l'ora di partenza. Questa operazione è obbligatoria se non è impostato alcun intervallo di tempo di validità per l'oggetto in transito.

Si tratta di un formato di data e ora in formato ISO 8601 esteso, con o senza un offset. Il tempo può essere specificato con una precisione fino a un nanosecondo. Gli offset possono essere specificati con precisione in secondi (anche se l'offset in secondi non fa parte di ISO 8601).

Ad esempio:

1985-04-12T23:20:50.52Z corrisponderà a 20 minuti e 50, 52 secondi dopo la 23a ora del 12 aprile 1985 nel fuso orario UTC.

1985-04-12T19:20:50.52-04:00 corrisponde a 20 minuti e 50, 52 secondi dopo la 19 ora del 12 aprile 1985, 4 ore prima di UTC (lo stesso istante dell'esempio riportato sopra). Se l'evento si trovasse a New York, sarebbe l'ora legale della costa orientale (EDT). Ricorda che l'offset varia nelle regioni in cui è osservata l'ora legale, a seconda del periodo dell'anno.

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

La parte di data/ora senza lo scarto è considerata la "data/ora locale". Deve essere la data e l'ora locali della stazione di partenza. Ad esempio, se la partenza avviene il 20 del 5 giugno 2018 presso la stazione di partenza, la parte locale di data/ora deve essere 2018-06-05T20:00:00. Se la data e l'ora locali nella stazione di partenza sono 4 ore prima dell'UTC, può essere aggiunto uno scarto pari a -04:00.

Senza informazioni di offset, alcune funzionalità avanzate potrebbero non essere disponibili.
arrivalDateTime

string

La data e l'ora di arrivo.

Si tratta di un formato di data e ora in formato ISO 8601 esteso, con o senza un offset. Il tempo può essere specificato con una precisione fino a un nanosecondo. Gli offset possono essere specificati con precisione in secondi (anche se l'offset in secondi non fa parte di ISO 8601).

Ad esempio:

1985-04-12T23:20:50.52Z corrisponderà a 20 minuti e 50, 52 secondi dopo la 23a ora del 12 aprile 1985 nel fuso orario UTC.

1985-04-12T19:20:50.52-04:00 corrisponde a 20 minuti e 50, 52 secondi dopo la 19 ora del 12 aprile 1985, 4 ore prima di UTC (lo stesso istante dell'esempio riportato sopra). Se l'evento si trovasse a New York, sarebbe l'ora legale della costa orientale (EDT). Ricorda che l'offset varia nelle regioni in cui è osservata l'ora legale, a seconda del periodo dell'anno.

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

La parte di data/ora senza lo scarto è considerata la "data/ora locale". Deve essere la data e l'ora locali della stazione di destinazione. Ad esempio, se l'evento si verifica il 20 del 5 giugno 2018 nella stazione di destinazione, la parte locale di data/ora deve essere 2018-06-05T20:00:00. Se la data e l'ora locali nella stazione di destinazione sono 4 ore prima dell'UTC, può essere aggiunto uno scarto pari a -04:00.

Senza informazioni di offset, alcune funzionalità avanzate potrebbero non essere disponibili.
fareName

object (LocalizedString)

Breve descrizione/nome della tariffa per questa tratta del viaggio. Ad esempio, "Uso singolo in qualsiasi momento".
carriage

string

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

string

La piattaforma o il gate da cui il passeggero può salire a bordo della carrozza.
zone

string

La zona di imbarco all'interno della piattaforma.
ticketSeat

object (TicketSeat)

Il posto riservato ai passeggeri. Se devi specificare più di un posto, utilizza il campo ticketSeats. Non è possibile impostare sia ticketSeat che ticketSeats.
ticketSeats[]

object (TicketSeat)

Il posto riservato ai passeggeri. Se è necessario specificare un solo posto, utilizza invece il campo ticketSeat. Non è possibile impostare sia ticketSeat che ticketSeats.
transitOperatorName

object (LocalizedString)

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

object (LocalizedString)

Stazione di capolinea o destinazione di treno/autobus e così via.

TicketSeat

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

enum (FareClass)

La classe tariffaria del posto con biglietto.
customFareClass

object (LocalizedString)

Una classe tariffaria personalizzata da utilizzare se non si applica fareClass. Non è possibile impostare sia fareClass che customFareClass.
coach

string

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

string

L'identificatore del posto in cui si trova il biglietto. Ad es. "42". In assenza di un identificatore specifico, utilizza seatAssigment.
seatAssignment

object (LocalizedString)

L'assegnazione del posto al passeggero. Ad es. "nessun posto specifico". Da utilizzare quando non esiste un identificatore specifico da utilizzare in seat.

FareClass

Enum
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Alias precedente per ECONOMY. Deprecato.
FIRST
first

Alias precedente per FIRST. Deprecato.
BUSINESS
business

Alias precedente per BUSINESS. Deprecato.

TripType

Enum
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Alias precedente per ROUND_TRIP. Deprecato.
ONE_WAY
oneWay

Alias precedente per ONE_WAY. Deprecato.

ActivationStatus

Lo stato di attivazione dell'oggetto. Questo campo include lo stato di attivazione se il valore supporta l'attivazione.

Rappresentazione JSON 
{
  "state": enum (State)
}
Campi
state

enum (State)

Stato

Enum
UNKNOWN_STATE
NOT_ACTIVATED Non attivato, questo è lo stato predefinito.
not_activated

Alias precedente per NOT_ACTIVATED. Deprecato.
ACTIVATED Attivata
activated

Alias precedente per ACTIVATED. Deprecato.

DeviceContext

Contesto del dispositivo associato all'oggetto.

Rappresentazione JSON 
{
  "deviceToken": string
}
Campi
deviceToken

string

Se impostate, le informazioni sull'utilizzo verranno restituite al dispositivo in questione soltanto al momento dell'attivazione dell'oggetto. Non deve essere utilizzato come identificatore stabile per tracciare il dispositivo di un utente. Può cambiare nei diversi pass per lo stesso dispositivo o per attivazioni diverse per lo stesso dispositivo. Quando questa impostazione è attiva, i chiamanti devono impostare anche hasLinkedDevice sull'oggetto da attivare.

Metodi

addmessage

 Aggiunge un messaggio all'oggetto di transito a cui fa riferimento l'ID oggetto specificato.

get

 Restituisce l'oggetto di transito con l'ID oggetto specificato.

insert

 Inserisce un oggetto di transito con l'ID e le proprietà specificati.

list

 Restituisce un elenco di tutti gli oggetti di transito per uno specifico ID emittente.

patch

 Aggiorna l'oggetto di transito a cui fa riferimento l'ID oggetto specificato.

update

 Aggiorna l'oggetto di transito a cui fa riferimento l'ID oggetto specificato.