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)

Der Ort, an dem der Kunde angibt, dass er abgeholt werden möchte.
actualPickupPoint

object (StopLocation)

Nur Eingabe. Der tatsächliche Ort, an dem 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.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
intermediateDestinations[]

object (TerminalLocation)

Zwischenhaltestellen, die zusätzlich zu Abhol- und Absetzvorgang für die Fahrtanfragen erforderlich sind. Diese Funktion wird anfangs nicht für Fahrten mit mehreren Personen unterstützt.
intermediateDestinationsVersion

string (Timestamp format)

Gibt an, wann die intermediateDestinations zuletzt geändert wurde. Dein Server sollte diesen Wert im Cache speichern und bei der Aktualisierung von intermediateDestinationIndex in UpdateTripRequest übergeben, damit intermediateDestinations nicht geändert wird.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
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. Die tatsächliche Ankunftszeit und der tatsächliche Ort des Fahrers an einem Zwischenziel. In diesem Feld können Anbieter Feedback zu den tatsächlichen Ankunftsinformationen an Zwischenzielen geben.
actualIntermediateDestinations[]

object (StopLocation)

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

object (TerminalLocation)

Der Ort, an dem der Kunde angibt, dass er abgesetzt werden soll.
actualDropoffPoint

object (StopLocation)

Nur Eingabe. Die tatsächliche Uhrzeit und der tatsächliche Ort, an dem der Kunde abgesetzt wurde. In diesem Feld kann der Anbieter Feedback zu den tatsächlichen Abholinformationen 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.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
remainingWaypoints[]

object (TripWaypoint)

Nur Ausgabe. Der vollständige Pfad vom aktuellen Standort zum Zielort. Dieser Pfad kann Wegpunkte aus anderen Fahrten enthalten.
vehicleWaypoints[]

object (TripWaypoint)

In diesem Feld können die Wegpunkte für die Fahrt manuell sortiert werden. Sie enthält alle verbleibenden Wegpunkte für das zugewiesene Fahrzeug sowie die Abhol- und Rückgabeorte für diese Fahrt. Wenn der Fahrt kein Fahrzeug zugewiesen wurde, wird dieses Feld von Fleet Engine ignoriert. Aus Datenschutzgründen wird dieses Feld vom Server nur bei trips.update- und trips.create-Aufrufen, NICHT bei trips.get-Aufrufen ausgefüllt.
route[]

object (LatLng)

Nur Ausgabe. Voraussichtliche Route für diese Fahrt zum ersten Eintrag in „remainingWaypoints“. Der erste Wegpunkt kann zu einer anderen Fahrt gehören.
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. Das Dekodieren 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 das Driver SDK und das Consumer SDK vorgesehen.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

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

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

string (Timestamp format)

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

Hinweis: Dieses Feld ist nur für das Driver SDK und das Consumer SDK vorgesehen.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
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 geschätzte Ankunftszeit zum nächsten Wegpunkt (erster Eintrag im Feld remainingWaypoints). Der Wert ist nicht angegeben, wenn die Fahrt keinem Fahrzeug zugewiesen ist oder inaktiv ist (abgeschlossen oder abgebrochen).

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
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 inaktiv ist (abgeschlossen oder abgebrochen).

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

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
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, damit die Pfade und Zugriffe für remainingWaypoints nur zurückgegeben werden, wenn sie aktualisiert wurden.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
numberOfPassengers

integer

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

object (VehicleLocation)

Nur Ausgabe. Der letzte gemeldete Standort des Fahrzeugs entlang der Route.
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 ausgefüllten Trip-Felder und ihre Interpretation.

TripStatus

Der Status einer Fahrt, der den Fortschritt 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 Zielort).
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 beendet.
CANCELED Die Fahrt wurde vor der Abholung vom Fahrer, Fahrgast oder Mitfahrdienstanbieter storniert.

StopLocation

Der tatsächliche Ort, an dem eine Haltestelle (Aufnahme/Abgabe) erfolgt ist.

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.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
stopTime
(deprecated)

string (Timestamp format)

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

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

TripView

Auswahl für verschiedene Trip-Felder 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 wird in der API standardmäßig eine SDK-Ansicht verwendet. Für Stabilität und Support empfehlen wir Kunden, eine andere TripView als SDK auszuwählen.
SDK Enthält Felder, die mithilfe öffentlich verfügbarer Bibliotheken möglicherweise nicht interpretiert oder unterstützt werden können.
JOURNEY_SHARING_V1S Die Fahrtfelder werden für den Anwendungsfall „Fahrt teilen“ 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.

delete

 Löscht eine einzelne Fahrt.

get

 Informationen zu einer einzelnen Fahrt abrufen
Alle Fahrten für ein bestimmtes Fahrzeug abrufen

update

 Aktualisiert Fahrtdaten.