REST Resource: providers.trips

Risorsa: Trip

Metadati dei viaggi.

Rappresentazione JSON
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
Campi
name

string

Solo output. Nel formato "providers/{provider}/trips/{trip}"

vehicleId

string

ID del veicolo che effettua il viaggio.

tripStatus

enum (TripStatus)

Stato attuale della corsa.

tripType

enum (TripType)

Il tipo di viaggio.

pickupPoint

object (TerminalLocation)

Località in cui il cliente indica di essere disponibile per il ritiro.

actualPickupPoint

object (StopLocation)

Solo input. La posizione effettiva in cui e quando il cliente è stato ritirato. Questo campo è destinato al fornitore per fornire un feedback sulle informazioni effettive sul ritiro.

actualPickupArrivalPoint

object (StopLocation)

Solo input. L'ora e la posizione effettive dell'arrivo del conducente al punto di ritiro. Questo campo è destinato al fornitore per fornire feedback sulle informazioni effettive sull'arrivo al punto di ritiro.

pickupTime

string (Timestamp format)

Solo output. L'ora futura stimata in cui i passeggeri verranno raccolti o l'ora effettiva in cui sono stati raccolti.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

intermediateDestinations[]

object (TerminalLocation)

Fermate intermedie richieste per la corsa (oltre a quelle di partenza e di arrivo). Inizialmente, questa funzionalità non sarà supportata per i viaggi condivisi.

intermediateDestinationsVersion

string (Timestamp format)

Indica l'ultima volta che intermediateDestinations è stato modificato. Il server deve memorizzare nella cache questo valore e passarlo in UpdateTripRequest quando aggiorna intermediateDestinationIndex per assicurarsi che intermediateDestinations non venga modificato.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

intermediateDestinationIndex

integer

Quando TripStatus è ENROUTE_TO_INTERMEDIATE_DESTINATION, un numero compreso tra [0..N-1] che indica la prossima destinazione intermedia che il veicolo attraverserà. Quando TripStatus è ARRIVED_AT_INTERMEDIATE_DESTINATION, un numero compreso tra [0..N-1] che indica la destinazione intermedia in cui si trova il veicolo. Questo valore viene impostato dal fornitore. Se non sono presenti intermediateDestinations, questo campo viene ignorato.

actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Solo input. L'ora e la posizione effettive dell'arrivo del conducente a una destinazione intermedia. Questo campo è destinato al fornitore per fornire feedback sulle informazioni di arrivo effettive nelle destinazioni intermedie.

actualIntermediateDestinations[]

object (StopLocation)

Solo input. L'ora e la posizione effettive in cui e quando il cliente è stato ritirato da una destinazione intermedia. Questo campo consente al fornitore di fornire un feedback sulle informazioni effettive sul ritiro nelle destinazioni intermedie.

dropoffPoint

object (TerminalLocation)

Località in cui il cliente indica di essere lasciato.

actualDropoffPoint

object (StopLocation)

Solo input. L'ora e la posizione effettive in cui il cliente è stato lasciato. Questo campo è destinato al fornitore per fornire feedback sulle informazioni effettive sul dropoff.

dropoffTime

string (Timestamp format)

Solo output. L'ora futura stimata in cui i passeggeri verranno lasciati alla destinazione finale o l'ora effettiva in cui sono stati lasciati.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

remainingWaypoints[]

object (TripWaypoint)

Solo output. Il percorso completo dalla posizione corrente al punto di consegna, incluso. Questo percorso potrebbe includere waypoint di altri viaggi.

vehicleWaypoints[]

object (TripWaypoint)

Questo campo supporta l'ordinamento manuale dei waypoint per il viaggio. Contiene tutti i waypoint rimanenti per il veicolo assegnato, nonché i waypoint di ritiro e riconsegna per questo viaggio. Se la corsa non è stata assegnata a un veicolo, Fleet Engine ignora questo campo. Per motivi di privacy, questo campo viene compilato dal server solo per le chiamate trips.update e trips.create, NON per le chiamate trips.get.

route[]

object (LatLng)

Solo output. Percorso previsto per questo viaggio fino alla prima voce in remainingWaypoints. Tieni presente che il primo waypoint potrebbe appartenere a un viaggio diverso.

currentRouteSegment

string

Solo output. Un percorso codificato per il waypoint successivo.

Nota: questo campo è destinato esclusivamente all'utilizzo da parte dell'SDK Driver e dell'SDK Consumer. La decodifica non è ancora supportata.

currentRouteSegmentVersion

string (Timestamp format)

Solo output. Indica l'ultima volta che il percorso è stato modificato.

Nota: questo campo è destinato esclusivamente all'utilizzo da parte dell'SDK Driver e dell'SDK Consumer.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

Solo output. Indica le condizioni del traffico lungo la currentRouteSegment, se disponibili.

Nota: questo campo è destinato esclusivamente all'utilizzo da parte dell'SDK Driver e dell'SDK Consumer.

currentRouteSegmentTrafficVersion

string (Timestamp format)

Solo output. Indica l'ultima volta che currentRouteSegmentTraffic è stato modificato.

Nota: questo campo è destinato esclusivamente all'utilizzo da parte dell'SDK Driver e dell'SDK Consumer.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

currentRouteSegmentEndPoint

object (TripWaypoint)

Solo output. Il waypoint in cui termina currentRouteSegment.

remainingDistanceMeters

integer

Solo output. La distanza di guida rimanente nel campo currentRouteSegment. Il valore non è specificato se la corsa non è assegnata a un veicolo o se è completata o annullata.

etaToFirstWaypoint

string (Timestamp format)

Solo output. L'orario di arrivo stimato al waypoint successivo (la prima voce nel campo remainingWaypoints). Il valore non è specificato se la corsa non è assegnata a un veicolo o se è inattiva (completata o annullata).

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

remainingTimeToFirstWaypoint

string (Duration format)

Solo output. La durata dal momento in cui vengono restituiti i dati del viaggio fino all'ora in Trip.eta_to_first_waypoint. Il valore non è specificato se la corsa non è assegnata a un veicolo o se è inattiva (completata o annullata).

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

remainingWaypointsVersion

string (Timestamp format)

Solo output. Indica l'ultima volta che remainingWaypoints è stato modificato (è stato aggiunto, rimosso o modificato un waypoint).

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

remainingWaypointsRouteVersion

string (Timestamp format)

Solo output. Indica l'ultima volta che remainingWaypoints.path_to_waypoint e remainingWaypoints.traffic_to_waypoint sono stati modificati. L'app client deve memorizzare nella cache questo valore e passarlo in GetTripRequest per assicurarsi che i percorsi e il traffico per remainingWaypoints vengano restituiti solo se aggiornati.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

numberOfPassengers

integer

Immutabile. Indica il numero di passeggeri di questo viaggio e non include il conducente. Un veicolo deve avere una capacità disponibile per essere restituito in una risposta vehicles.search.

lastLocation

object (VehicleLocation)

Solo output. Indica l'ultima posizione segnalata del veicolo lungo il percorso.

lastLocationSnappable

boolean

Solo output. Indica se il lastLocation del veicolo può essere agganciato a currentRouteSegment. False se lastLocation o currentRouteSegment non esiste. Viene calcolato da Fleet Engine. Eventuali aggiornamenti dei clienti verranno ignorati.

view

enum (TripView)

Il sottoinsieme di campi relativi alla corsa che vengono compilati e come devono essere interpretati.

TripStatus

Lo stato di una corsa che ne indica l'avanzamento.

Enum
UNKNOWN_TRIP_STATUS Valore predefinito, utilizzato per lo stato di viaggio non specificato o non riconosciuto.
NEW Corsa appena creata.
ENROUTE_TO_PICKUP Il conducente è in viaggio verso il punto di ritiro.
ARRIVED_AT_PICKUP Il conducente è arrivato al punto di ritiro.
ARRIVED_AT_INTERMEDIATE_DESTINATION Il conducente è arrivato a una destinazione intermedia e sta aspettando il passeggero.
ENROUTE_TO_INTERMEDIATE_DESTINATION L'autista è in viaggio verso una destinazione intermedia (non il punto di consegna).
ENROUTE_TO_DROPOFF Il conducente ha caricato il passeggero ed è in viaggio verso la prossima destinazione.
COMPLETE Il passeggero è stato lasciato a destinazione e la corsa è stata completata.
CANCELED La corsa è stata annullata prima del ritiro dal conducente, dal passeggero o dal fornitore di servizi di ridesharing.

StopLocation

La posizione effettiva in cui si è verificato un arresto (prelievo/ritorno).

Rappresentazione JSON
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
Campi
point

object (LatLng)

Obbligatorio. Indica la posizione effettiva.

timestamp

string (Timestamp format)

Indica quando si è verificato l'arresto.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

stopTime
(deprecated)

string (Timestamp format)

Solo input. Deprecato. Utilizza il campo timestamp.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

TripView

Selettore per diversi insiemi di campi di viaggio in una risposta trips.get. Per maggiori informazioni, consulta l'articolo AIP-157. È probabile che vengano aggiunte altre visualizzazioni.

Enum
TRIP_VIEW_UNSPECIFIED Il valore predefinito. Per la compatibilità con le versioni precedenti, l'API utilizzerà per impostazione predefinita una visualizzazione SDK. Per garantire stabilità e assistenza, consigliamo ai clienti di selezionare un TripView diverso da SDK.
SDK Sono inclusi i campi che potrebbero non essere interpretabili o supportabili utilizzando le librerie disponibili pubblicamente.
JOURNEY_SHARING_V1S I campi relativi alle corse vengono compilati per il caso d'uso Condivisione del percorso. Questa visualizzazione è destinata alle comunicazioni server-to-server.

Metodi

create

Crea un viaggio nel motore del parco risorse e restituisce il nuovo viaggio.

get

Ricevere informazioni su un singolo viaggio.
Visualizza tutte le corse di un veicolo specifico.

update

Aggiorna i dati della corsa.