REST Resource: providers.trips

Ressource: Fahrt

Metadaten zu Fahrten.

JSON-Darstellung 
{
  "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)
}
Felder
name

string

Nur Ausgabe. Im Format „providers/{provider}/trips/{trip}“
vehicleId

string

ID des Fahrzeugs, das diese Fahrt durchführt.
tripStatus

enum (TripStatus)

Aktueller Status der Fahrt.
tripType

enum (TripType)

Die Art der Fahrt.
pickupPoint

object (TerminalLocation)

Ort, an dem der Kunde angibt, dass er abgeholt wird.
actualPickupPoint

object (StopLocation)

Nur Eingabe. Der tatsächliche Ort, an dem und wo der Kunde abgeholt wurde. In diesem Feld kann der Anbieter Feedback zu den tatsächlichen Abholinformationen geben.
actualPickupArrivalPoint

object (StopLocation)

Nur Eingabe. Die tatsächliche Ankunftszeit und der tatsächliche Ort des Fahrers am Abholort. In diesem Feld kann der Anbieter Feedback zu den tatsächlichen Ankunftsinformationen an der Abholstelle geben.
pickupTime

string (Timestamp format)

Nur Ausgabe. Entweder die geschätzte zukünftige Zeit, zu der die Fahrgäste abgeholt werden, oder die tatsächliche Zeit, zu der sie abgeholt wurden.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
intermediateDestinations[]

object (TerminalLocation)

Zwischenstopps, damit die Fahrt angefordert wird (zusätzlich zu Start- und Zielhaltestellen). Diese Funktion wird anfangs nicht für Fahrten mit mehreren Personen unterstützt.
intermediateDestinationsVersion

string (Timestamp format)

Gibt an, wann das intermediateDestinations zuletzt geändert wurde. Dein Server sollte diesen Wert im Cache speichern und beim Aktualisieren von intermediateDestinationIndex in UpdateTripRequest übergeben, um sicherzustellen, dass intermediateDestinations nicht geändert wird.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
intermediateDestinationIndex

integer

Wenn TripStatus = ENROUTE_TO_INTERMEDIATE_DESTINATION ist, eine Zahl zwischen [0..N-1], die angibt, welches Zwischenziel das Fahrzeug als Nächstes passiert. Wenn TripStatus ARRIVED_AT_INTERMEDIATE_DESTINATION ist, eine Zahl zwischen [0–N–1], die angibt, an welchem Zwischenziel sich das Fahrzeug befindet. Dieser Wert wird vom Anbieter festgelegt. Wenn keine intermediateDestinations vorhanden sind, wird dieses Feld ignoriert.
actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Nur Eingabe. Tatsächliche Uhrzeit und Ort der Ankunft des Fahrers an einem Zwischenziel. In diesem Feld können Anbieter Feedback zu tatsächlichen Ankunftsinformationen an Zwischenzielen geben.
actualIntermediateDestinations[]

object (StopLocation)

Nur Eingabe. Die tatsächliche Zeit und der tatsächliche Ort, an dem und wo der Kunde von einem Zwischenziel abgeholt wurde. In diesem Feld kann der Anbieter Feedback zu tatsächlichen Abholinformationen an Zwischenzielen geben.
dropoffPoint

object (TerminalLocation)

Ort, an dem der Kunde angibt, dass er aussteigt.
actualDropoffPoint

object (StopLocation)

Nur Eingabe. Die tatsächliche Zeit und der tatsächliche Ort, an dem und wo der Kunde ausstieg. In diesem Feld können Dienstleister Feedback zu tatsächlichen Abbruchinformationen geben.
dropoffTime

string (Timestamp format)

Nur Ausgabe. Entweder die geschätzte zukünftige Zeit, zu der die Fahrgäste am Zielort abgesetzt werden, oder die tatsächliche Zeit, zu der sie abgesetzt wurden.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
remainingWaypoints[]

object (TripWaypoint)

Nur Ausgabe. Der vollständige Pfad vom aktuellen Standort zum Zielort. Dieser Pfad könnte Wegpunkte von anderen Fahrten enthalten.
vehicleWaypoints[]

object (TripWaypoint)

Dieses Feld unterstützt die manuelle Sortierung der Wegpunkte für die Fahrt. Sie enthält alle verbleibenden Wegpunkte für das zugewiesene Fahrzeug sowie die Start- und Zielorte für diese Fahrt. Wenn der Fahrt kein Fahrzeug zugewiesen wurde, wird dieses Feld von Fleet Engine ignoriert. Aus Datenschutzgründen wird dieses Feld nur bei trips.update- und trips.create-Aufrufen vom Server ausgefüllt, NICHT bei trips.get-Aufrufen.
route[]

object (LatLng)

Nur Ausgabe. Voraussichtliche Route für diese Fahrt zum ersten Eintrag in „remainingWaypoints“. Beachten Sie, dass der erste Wegpunkt möglicherweise zu einer anderen Fahrt gehört.
currentRouteSegment

string

Nur Ausgabe. Ein codierter Pfad zum nächsten Wegpunkt.

Hinweis: Dieses Feld ist nur für das Driver SDK und das Consumer SDK vorgesehen. Die Decodierung wird noch nicht unterstützt.
currentRouteSegmentVersion

string (Timestamp format)

Nur Ausgabe. Gibt an, wann die Route zuletzt geändert wurde.

Hinweis: Dieses Feld ist nur für die Verwendung vom Driver SDK und Consumer SDK vorgesehen.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

Nur Ausgabe. Gibt die Verkehrslage entlang der currentRouteSegment an, sofern verfügbar.

Hinweis: Dieses Feld ist nur für die Verwendung vom Driver SDK und Consumer SDK vorgesehen.
currentRouteSegmentTrafficVersion

string (Timestamp format)

Nur Ausgabe. Gibt an, wann das currentRouteSegmentTraffic zuletzt geändert wurde.

Hinweis: Dieses Feld ist nur für die Verwendung vom Driver SDK und Consumer SDK vorgesehen.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

Nur Ausgabe. Der Wegpunkt, an dem currentRouteSegment endet.
remainingDistanceMeters

integer

Nur Ausgabe. Die verbleibende Fahrstrecke im Feld currentRouteSegment. Der Wert ist nicht angegeben, wenn die Fahrt keinem Fahrzeug zugewiesen ist oder die Fahrt abgeschlossen oder abgebrochen wurde.
etaToFirstWaypoint

string (Timestamp format)

Nur Ausgabe. Die voraussichtliche Ankunftszeit zum nächsten Wegpunkt (erster Eintrag im Feld remainingWaypoints). Der Wert ist nicht angegeben, wenn die Fahrt keinem Fahrzeug zugewiesen ist oder die Fahrt inaktiv ist (abgeschlossen oder gestrichen).

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
remainingTimeToFirstWaypoint

string (Duration format)

Nur Ausgabe. Die Dauer zwischen dem Zeitpunkt, zu dem die Fahrtdaten zurückgegeben werden, und dem Zeitpunkt in Trip.eta_to_first_waypoint. Der Wert ist nicht angegeben, wenn die Fahrt keinem Fahrzeug zugewiesen ist oder die Fahrt inaktiv ist (abgeschlossen oder gestrichen).

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
remainingWaypointsVersion

string (Timestamp format)

Nur Ausgabe. Gibt an, wann remainingWaypoints zuletzt geändert wurde (ein Wegpunkt wurde hinzugefügt, entfernt oder geändert).

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
remainingWaypointsRouteVersion

string (Timestamp format)

Nur Ausgabe. Gibt an, wann remainingWaypoints.path_to_waypoint und remainingWaypoints.traffic_to_waypoint zuletzt geändert wurden. Ihre Clientanwendung sollte diesen Wert im Cache speichern und in GetTripRequest übergeben, um sicherzustellen, dass die Pfade und der Traffic für remainingWaypoints nur bei einer Aktualisierung zurückgegeben werden.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
numberOfPassengers

integer

Nicht veränderbar. Gibt die Anzahl der Fahrgäste bei dieser Fahrt an, ohne den Fahrer. Ein Fahrzeug muss genügend Kapazität haben, damit es in einer vehicles.search-Antwort zurückgegeben werden kann.
lastLocation

object (VehicleLocation)

Nur Ausgabe. Gibt den zuletzt gemeldeten Standort des Fahrzeugs entlang der Route an.
lastLocationSnappable

boolean

Nur Ausgabe. Gibt an, ob die lastLocation des Fahrzeugs an das aktuelle Routensegment angedockt werden kann. „False“, wenn lastLocation oder currentRouteSegment nicht vorhanden ist. Sie wird von der Fleet Engine berechnet. Alle Aktualisierungen von Kunden werden ignoriert.
view

enum (TripView)

Die Teilmenge der Trip-Felder, die ausgefüllt werden, und deren Interpretation.

TripStatus

Der Status einer Fahrt, der den Verlauf angibt.

Enums
UNKNOWN_TRIP_STATUS Standardwert, wird für nicht angegebene oder nicht erkannte Fahrtstatus verwendet.
NEW Neu erstellte Fahrt.
ENROUTE_TO_PICKUP Der Fahrer ist auf dem Weg zum Abholort.
ARRIVED_AT_PICKUP Der Fahrer ist am Abholort angekommen.
ARRIVED_AT_INTERMEDIATE_DESTINATION Der Fahrer ist an einem Zwischenziel angekommen und wartet auf den Fahrgast.
ENROUTE_TO_INTERMEDIATE_DESTINATION Der Fahrer ist auf dem Weg zu einem Zwischenziel (nicht zum Absetzpunkt).
ENROUTE_TO_DROPOFF Der Fahrer hat den Fahrgast abgeholt und ist auf dem Weg zum nächsten Ziel.
COMPLETE Der Fahrgast ist ausgestiegen und die Fahrt ist abgeschlossen.
CANCELED Die Fahrt wurde vor der Abholung durch den Fahrer, Fahrgast oder Mitfahrdienst gestrichen.

StopLocation

Der tatsächliche Ort, an dem eine Haltestelle (Ab-/Absetz) stattfand.

JSON-Darstellung 
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
Felder
point

object (LatLng)

Erforderlich. Gibt den tatsächlichen Standort an.
timestamp

string (Timestamp format)

Gibt an, wann die Unterbrechung aufgetreten ist.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
stopTime
(deprecated)

string (Timestamp format)

Nur Eingabe Verworfen. Verwenden Sie das Feld „Zeitstempel“.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

TripView

Auswahl für verschiedene Gruppen von Trip-Feldern in einer trips.get-Antwort. Weitere Informationen finden Sie unter AIP-157. Es werden wahrscheinlich weitere Ansichten hinzugefügt.

Enums
TRIP_VIEW_UNSPECIFIED Der Standardwert. Aus Gründen der Abwärtskompatibilität verwendet die API standardmäßig eine SDK-Ansicht. Um Stabilität und Support zu gewährleisten, wird Kunden empfohlen, eine andere TripView als SDK auszuwählen.
SDK Umfasst Felder, die in öffentlich verfügbaren Bibliotheken möglicherweise nicht interpretiert oder nicht unterstützt werden können.
JOURNEY_SHARING_V1S Für den Anwendungsfall „Teilen von Reisen“ werden die Reisefelder ausgefüllt. Diese Ansicht ist für die Server-zu-Server-Kommunikation gedacht.

Methoden

create

 Erstellt eine Fahrt in der Fleet Engine und gibt die neue Fahrt zurück.

get

 Informationen zu einer einzelnen Fahrt abrufen.
Sie können alle Fahrten für ein bestimmtes Fahrzeug abrufen.

update

 Aktualisiert Fahrtdaten.