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

pickupPoint

object (TerminalLocation)

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

actualPickupPoint

object (StopLocation)

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

actualPickupArrivalPoint

object (StopLocation)

Solo input. L'ora e la posizione 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'ora futura stimata in cui verranno prelevati i passeggeri oppure l'ora effettiva in cui sono stati prelevati.

Un timestamp in formato "Zulu" UTC RFC3339, 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 modo che la corsa richieda (oltre a prelievo e discesa). All'inizio questa funzionalità non sarà supportata per le corse condivise.

intermediateDestinationsVersion

string (Timestamp format)

Indica l'ultima volta che intermediateDestinations è stato modificato. Il server deve memorizzare nella cache questo valore e trasmetterlo in UpdateTripRequest durante l'aggiornamento di intermediateDestinationIndex per garantire che intermediateDestinations non venga modificato.

Un timestamp in formato "Zulu" UTC RFC3339, 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 indica la destinazione intermedia che il veicolo attraverserà. Quando TripStatus è ARRIVED_AT_INTERMEDIATE_DESTINATION, un numero compreso tra [0..N-1] e 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 la posizione effettivi dell'arrivo del conducente a una destinazione intermedia. Questo campo consente al fornitore di fornire un feedback sulle informazioni relative agli arrivi effettivi a destinazioni intermedie.

actualIntermediateDestinations[]

object (StopLocation)

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

dropoffPoint

object (TerminalLocation)

Località in cui il cliente indica che verranno lasciati.

actualDropoffPoint

object (StopLocation)

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

dropoffTime

string (Timestamp format)

Solo output. L'ora futura stimata in cui i passeggeri verranno lasciati alla destinazione finale oppure l'ora effettiva in cui è stata consegnata.

Un timestamp in formato "Zulu" UTC RFC3339, 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 uscita, inclusi. Questo percorso potrebbe includere tappe di altri viaggi.

vehicleWaypoints[]

object (TripWaypoint)

Questo campo supporta l'ordinamento manuale delle tappe della corsa. Contiene tutti i punti restanti per il veicolo assegnato, nonché i punti di prelievo e di discesa della 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 nelle chiamate trips.update e trips.create, NON nelle chiamate trips.get.

route[]

object (LatLng)

Solo output. Percorso previsto per questo viaggio per la prima entrata nei Waypoint rimanenti. Tieni presente che il primo tappa potrebbe appartenere a una corsa diversa.

currentRouteSegment

string

Solo output. Percorso codificato per il punto di tappa 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.

Un timestamp in formato "Zulu" UTC RFC3339, 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 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.

Un timestamp in formato "Zulu" UTC RFC3339, 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 tappa in cui termina currentRouteSegment.

remainingDistanceMeters

integer

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

etaToFirstWaypoint

string (Timestamp format)

Solo output. L'orario di arrivo stimato al 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 in formato "Zulu" UTC RFC3339, 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 dal momento in cui i dati della corsa vengono restituiti al momento 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).

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 in cui remainingWaypoints è stato modificato (un tappa è stata aggiunta, rimossa o modificata).

Un timestamp in formato "Zulu" UTC RFC3339, 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 sono stati modificati remainingWaypoints.path_to_waypoint e remainingWaypoints.traffic_to_waypoint. L'app client deve memorizzare nella cache questo valore e trasmetterlo in GetTripRequest per garantire che i percorsi e il traffico per remainingWaypoints vengano restituiti solo se aggiornati.

Un timestamp in formato "Zulu" UTC RFC3339, 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 poter 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'oggetto lastLocation del veicolo può essere agganciato al segmento currentRouteSegment. Falso se lastLocation o currentRouteSegment non esiste. Il calcolo viene eseguito da Fleet Engine. Eventuali aggiornamenti dei client verranno ignorati.

view

enum (TripView)

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

TripStatus

Lo stato di una corsa che indica il suo avanzamento.

Enum
UNKNOWN_TRIP_STATUS Predefinita, utilizzata 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 passeggero.
ENROUTE_TO_INTERMEDIATE_DESTINATION Il conducente si sta dirigendo verso una destinazione intermedia (non il punto di discesa).
ENROUTE_TO_DROPOFF L'autista ha preso il passeggero e si sta dirigendo verso la prossima destinazione.
COMPLETE Il passeggero è stato consegnato e la corsa è terminata.
CANCELED La corsa è stata annullata prima del ritiro da parte del conducente, del passeggero o del fornitore di servizi di ridesharing.

StopLocation

La posizione effettiva 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 è avvenuta l'interruzione.

Un timestamp in formato "Zulu" UTC RFC3339, 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 del timestamp.

Un timestamp in formato "Zulu" UTC RFC3339, 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 insiemi di campi Viaggio in una risposta trips.get. Consulta AIP-157 per il contesto. È probabile che vengano aggiunte altre visualizzazioni.

Enum
TRIP_VIEW_UNSPECIFIED Il valore predefinito. Per la compatibilità con le versioni precedenti, l'API utilizza per impostazione predefinita una vista SDK. Per garantire stabilità e supporto, consigliamo ai clienti di selezionare un TripView diverso da SDK.
SDK Include i campi che potrebbero non essere interpretabili o supportati quando utilizzano le librerie disponibili pubblicamente.
JOURNEY_SHARING_V1S I campi Trip vengono compilati per il caso d'uso della condivisione del percorso. Questa visualizzazione è destinata alle comunicazioni server-to-server.

Metodi

create

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

get

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

update

Aggiorna i dati del viaggio.