REST Resource: providers.trips

Ressource: Trip

Reisemetadaten.

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

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 an dem der Kunde abgeholt wurde. In diesem Feld können Anbieter Feedback zu tatsächlichen Abholinformationen geben.

actualPickupArrivalPoint

object (StopLocation)

Nur Eingabe. Die tatsächliche Zeit und der tatsächliche Standort des Fahrers, der am Abholpunkt ankommt. In diesem Feld kann der Dienstleister Feedback zur tatsächlichen Ankunft am Abholort geben.

pickupTime

string (Timestamp format)

Nur Ausgabe Entweder die voraussichtliche zukünftige Zeit, zu der der Fahrgast/die Fahrgäste abgeholt werden, oder die tatsächliche Zeit, zu der der Fahrgast abgeholt wird.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 angefragt wird (zusätzlich zu Abhol- und Absetzort). Dies wird anfangs nicht für geteilte Reisen unterstützt.

intermediateDestinationsVersion

string (Timestamp format)

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

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

intermediateDestinationIndex

integer

Wenn TripStatus den Wert ENROUTE_TO_INTERMEDIATE_DESTINATION hat, ist dies eine Zahl zwischen [0...N-1], die angibt, welches Zwischenziel das Fahrzeug als Nächstes durchquert. Wenn TripStatus den Wert ARRIVED_AT_INTERMEDIATE_DESTINATION hat, ist dies eine Zahl zwischen [0...N-1], die angibt, an welchem Zwischenziel sich das Fahrzeug befindet. Der Anbieter legt diesen Wert fest. Wenn keine intermediateDestinations vorhanden sind, wird dieses Feld ignoriert.

actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Nur Eingabe. Die tatsächliche Zeit und der tatsächliche Standort der Ankunft des Fahrers an einem Zwischenziel. In diesem Feld kann der Dienstleister 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 an der der Kunde von einem Zwischenziel abgeholt wurde. In diesem Feld können 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 zu der der Kunde ausgestiegen ist. In diesem Feld kann der Dienstleister Feedback zu den tatsächlichen Ausstiegsinformationen geben.

dropoffTime

string (Timestamp format)

Nur Ausgabe Entweder die voraussichtliche Ankunftszeit, zu der die Fahrgäste am Zielort aussteigen, oder die tatsächliche Zeit, zu der sie ausgestiegen sind.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 bis zur Abgabestelle (einschließlich). Dieser Pfad kann Wegpunkte von 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 Start- und Zielpunkte für diese Fahrt. Wenn die Fahrt keinem Fahrzeug zugewiesen wurde, ignoriert Fleet Engine dieses Feld. 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 verbleibenden Waypoints. 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 die Verwendung mit dem Driver SDK und dem 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 mit dem Driver SDK und dem Consumer SDK vorgesehen.

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

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

Nur Ausgabe Zeigt die Verkehrslage entlang der Straße currentRouteSegment an, sobald diese verfügbar ist.

Hinweis: Dieses Feld ist nur für die Verwendung mit dem Driver SDK und dem 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 mit dem Driver SDK und dem Consumer SDK vorgesehen.

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

currentRouteSegmentEndPoint

object (TripWaypoint)

Nur Ausgabe 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 storniert wurde.

etaToFirstWaypoint

string (Timestamp format)

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

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 ab der Rückgabe der Fahrtdaten bis zur Zeit in Trip.eta_to_first_waypoint. Der Wert ist nicht angegeben, wenn die Fahrt keinem Fahrzeug zugewiesen oder inaktiv ist (abgeschlossen oder abgebrochen).

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".

remainingWaypointsVersion

string (Timestamp format)

Nur Ausgabe Gibt an, wann der Ort remainingWaypoints zuletzt geändert wurde, d. h., ein Wegpunkt hinzugefügt, entfernt oder geändert wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 Client-App sollte diesen Wert im Cache speichern und in GetTripRequest übergeben, damit die Pfade und der Traffic für remainingWaypoints nur bei einer Aktualisierung zurückgegeben werden.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 verfügbare Kapazität haben, um in einer vehicles.search-Antwort zurückgegeben zu werden.

lastLocation

object (VehicleLocation)

Nur Ausgabe Zeigt den letzten gemeldeten Standort des Fahrzeugs entlang der Route an.

lastLocationSnappable

boolean

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

view

enum (TripView)

Die ausgefüllte Teilmenge der Trip-Felder und wie sie interpretiert werden sollen.

TripStatus

Der Status einer Fahrt, der ihren Verlauf anzeigt.

Enums
UNKNOWN_TRIP_STATUS Standardeinstellung, wird für einen nicht angegebenen oder unbekannten Fahrtstatus verwendet.
NEW Neu erstellte Reise.
ENROUTE_TO_PICKUP Der Fahrer ist auf dem Weg zum Abholpunkt.
ARRIVED_AT_PICKUP Der Fahrer ist am Abholpunkt 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 zur Abgabestelle).
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 Mitfahrdienstanbieter storniert.

StopLocation

Der tatsächliche Ort, an dem eine Haltestelle (Start-/Abbruch) angehalten wurde.

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 Haltestelle stattgefunden hat.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 Veraltet. Verwenden Sie das Feld „Zeitstempel“.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 findest du unter AIP-157. Weitere Aufrufe werden wahrscheinlich hinzugefügt.

Enums
TRIP_VIEW_UNSPECIFIED Der Standardwert. Aus Gründen der Abwärtskompatibilität wird für die API standardmäßig eine SDK-Ansicht verwendet. Wir empfehlen Kunden, einen anderen TripView als SDK auszuwählen, um Stabilität und Support zu gewährleisten.
SDK Umfasst Felder, die bei öffentlich verfügbaren Bibliotheken möglicherweise nicht interpretierbar oder unterstützt werden können.
JOURNEY_SHARING_V1S Fahrtfelder werden für den Anwendungsfall „Wegbeschreibung teilen“ ausgefüllt. Diese Ansicht ist für die Server-zu-Server-Kommunikation vorgesehen.

Methoden

create

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

get

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

update

Aktualisiert Fahrtdaten.