REST Resource: providers.trips

Risorsa: Viaggio

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 la corsa.

tripStatus

enum (TripStatus)

Stato attuale della corsa.

tripType

enum (TripType)

Il tipo di viaggio.

pickupPoint

object (TerminalLocation)

Località in cui il cliente indica che verrà ritirato.

actualPickupPoint

object (StopLocation)

Solo input. Il luogo effettivo di quando e dove il cliente è stato ritirato. Questo campo consente al fornitore di fornire un feedback sulle effettive informazioni sul ritiro.

actualPickupArrivalPoint

object (StopLocation)

Solo input. L'ora e il luogo effettivi dell'arrivo del conducente al punto di prelievo. Questo campo consente al fornitore di fornire un feedback sulle informazioni effettive sull'arrivo al punto di prelievo.

pickupTime

string (Timestamp format)

Solo output. L'orario futuro stimato in cui verranno ritirati i passeggeri o l'ora effettiva in cui sono stati prelevati.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

intermediateDestinations[]

object (TerminalLocation)

Fermate intermedie in ordine di richiesta della corsa (oltre a partenza e 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 a UpdateTripRequest quando aggiorna intermediateDestinationIndex per garantire che intermediateDestinations non venga modificato.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

intermediateDestinationIndex

integer

Quando TripStatus è ENROUTE_TO_INTERMEDIATE_DESTINATION, un numero compreso tra [0..N-1] e [0..N-1] indica la destinazione intermedia che verrà attraversata dal veicolo. Quando TripStatus è ARRIVED_AT_INTERMEDIATE_DESTINATION, un numero compreso tra [0..N-1] e [0..N-1] indica la destinazione intermedia in cui si trova il veicolo. Il provider imposta questo valore. Se non sono presenti intermediateDestinations, questo campo viene ignorato.

actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Solo input. L'ora e il luogo effettivi in cui arriva il conducente a una destinazione intermedia. Questo campo consente al fornitore di fornire un feedback sulle informazioni effettive sull'arrivo alle destinazioni intermedie.

actualIntermediateDestinations[]

object (StopLocation)

Solo input. L'ora e il luogo effettivi in cui il cliente è stato prelevato da una destinazione intermedia. Questo campo consente al fornitore di fornire un feedback sulle informazioni effettive sul ritiro presso le destinazioni intermedie.

dropoffPoint

object (TerminalLocation)

Località in cui il cliente indica che verrà riconsegnato.

actualDropoffPoint

object (StopLocation)

Solo input. L'ora e il luogo effettivi in cui e dove il cliente è stato riconsegnato. Questo campo consente al fornitore di fornire un feedback sulle effettive informazioni sull'abbandono.

dropoffTime

string (Timestamp format)

Solo output. L'orario futuro stimato in cui i passeggeri verranno riconsegnati alla destinazione finale o l'ora effettiva in cui sono stati riconsegnati.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

remainingWaypoints[]

object (TripWaypoint)

Solo output. Il percorso completo dalla posizione corrente al punto di discesa, incluso. Questo percorso potrebbe includere tappe di altre corse.

vehicleWaypoints[]

object (TripWaypoint)

Questo campo supporta l'ordinamento manuale delle tappe della corsa. Contiene tutte le tappe rimanenti per il veicolo assegnato, nonché le tappe di partenza e arrivo per questa corsa. 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 durante le chiamate trips.update e trips.create, NON per le chiamate trips.get.

route[]

object (LatLng)

Solo output. Percorso previsto per questo viaggio al primo ingresso nei waypoint rimanenti. Tieni presente che la prima tappa potrebbe appartenere a una corsa diversa.

currentRouteSegment

string

Solo output. Un percorso codificato alla tappa successiva.

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.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

Solo output. Indica le condizioni del traffico lungo il currentRouteSegment quando sono 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.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

currentRouteSegmentEndPoint

object (TripWaypoint)

Solo output. Il waypoint dove finisce 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 oppure se la corsa è stata completata o annullata.

etaToFirstWaypoint

string (Timestamp format)

Solo output. L'orario di arrivo stimato alla tappa successiva (la prima voce nel campo remainingWaypoints). Il valore non è specificato se la corsa non è assegnata a un veicolo o se la corsa non è attiva (completata o annullata).

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

remainingTimeToFirstWaypoint

string (Duration format)

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

Durata in secondi con un massimo di nove cifre frazionarie e termina con "s". Esempio: "3.5s".

remainingWaypointsVersion

string (Timestamp format)

Solo output. Indica l'ultima volta che remainingWaypoints è stato modificato (una tappa è stata aggiunta, rimossa o modificata).

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

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 trasmetterlo a GetTripRequest per garantire che i percorsi e il traffico per remainingWaypoints vengano restituiti solo se aggiornati.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

numberOfPassengers

integer

Immutabile. Indica il numero di passeggeri di questa corsa e non include il conducente. Un veicolo deve avere 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 l'elemento lastLocation del veicolo può essere agganciato al segmentoRouteSegment corrente. Falso se lastLocation o currentRouteSegment non esiste. Viene calcolato da Fleet Engine. Eventuali aggiornamenti dei client verranno ignorati.

view

enum (TripView)

Il sottoinsieme di campi Trip compilati e come devono essere interpretati.

TripStatus

Lo stato di una corsa che indica l'avanzamento.

Enum
UNKNOWN_TRIP_STATUS Valore predefinito, utilizzato per lo stato della corsa non specificato o non riconosciuto.
NEW Viaggio appena creato.
ENROUTE_TO_PICKUP L'autista si sta dirigendo verso il punto di prelievo.
ARRIVED_AT_PICKUP L'autista è arrivato al punto di prelievo.
ARRIVED_AT_INTERMEDIATE_DESTINATION L'autista è arrivato a una destinazione intermedia e sta aspettando il corridore.
ENROUTE_TO_INTERMEDIATE_DESTINATION Il conducente si sta dirigendo verso una destinazione intermedia (non il punto di consegna).
ENROUTE_TO_DROPOFF L'autista ha preso il passeggero ed è in viaggio verso la prossima destinazione.
COMPLETE Il passeggero è stato lasciato e la corsa è terminata.
CANCELED La corsa è stata annullata prima del ritiro da parte dell'autista, del passeggero o del fornitore di ridesharing.

StopLocation

Il luogo effettivo in cui si è verificata una fermata (ritiro/consegna).

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 è verificata l'interruzione.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

stopTime
(deprecated)

string (Timestamp format)

Solo input. Deprecato. Utilizza il campo timestamp.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

TripView

Selettore per diversi insiemi di campi Viaggio in una risposta trips.get. Per ulteriori informazioni, vedi AIP-157. È probabile che verranno aggiunte altre visualizzazioni.

Enum
TRIP_VIEW_UNSPECIFIED Il valore predefinito. Per la compatibilità con le versioni precedenti, l'API utilizzerà per impostazione predefinita una vista 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 supportate dalle librerie disponibili pubblicamente.
JOURNEY_SHARING_V1S I campi dei viaggi vengono compilati per il caso d'uso della condivisione del percorso. Questa visualizzazione è pensata per le comunicazioni server-server.

Metodi

create

Crea una corsa in Fleet Engine e restituisce la nuova corsa.

get

Ricevere informazioni su un singolo viaggio.
Visualizza tutti i viaggi per un veicolo specifico.

update

Aggiorna i dati dei percorsi.