REST Resource: providers.vehicles

Ressource: Fahrzeug

Fahrzeugmetadaten

JSON-Darstellung 
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}
Felder
name

string

Nur Ausgabe. Der eindeutige Name dieses Fahrzeugs. Das Format dafür ist providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

Der Fahrzeugstatus.
supportedTripTypes[]

enum (TripType)

Fahrttypen, die von diesem Fahrzeug unterstützt werden.
currentTrips[]

string

Nur Ausgabe. Liste der tripId für Fahrten, die diesem Fahrzeug derzeit zugewiesen sind.
lastLocation

object (VehicleLocation)

Letzter gemeldeter Standort des Fahrzeugs.
maximumCapacity

integer

Die Gesamtzahl der Fahrgäste, die dieses Fahrzeug aufnehmen kann. Der Fahrer wird bei diesem Wert nicht berücksichtigt. Dieser Wert muss größer oder gleich 1 sein.
attributes[]

object (VehicleAttribute)

Liste der Fahrzeugattribute. Ein Fahrzeug kann maximal 100 Attribute haben und jedes Attribut muss einen eindeutigen Schlüssel haben.
vehicleType

object (VehicleType)

Erforderlich. Der Typ dieses Fahrzeugs. Kann verwendet werden, um Fahrzeuge in vehicles.search-Ergebnissen zu filtern. Wirkt sich auch auf die geschätzte Ankunftszeit und die Routenberechnung aus.
licensePlate

object (LicensePlate)

Informationen zum Kfz-Kennzeichen des Fahrzeugs.
route[]
(deprecated)

object (TerminalLocation)

Verworfen. Verwenden Sie stattdessen Vehicle.waypoints.
currentRouteSegment

string

Die Polylinie, die die Route angibt, die die Fahrer App zum nächsten Wegpunkt nehmen soll. Diese Liste wird auch in Trip.current_route_segment für alle aktiven Fahrten zurückgegeben, die dem Fahrzeug zugewiesen sind.

Hinweis: Dieses Feld ist nur für das Driver SDK vorgesehen. Das Dekodieren wird noch nicht unterstützt.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Nur Eingabe. Fleet Engine verwendet diese Informationen, um die Freigabe von Fahrten zu verbessern. Hinweis: Dieses Feld ist nur für das Driver SDK vorgesehen.
currentRouteSegmentVersion

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem currentRouteSegment festgelegt wurde. Sie kann vom Client gespeichert und in zukünftigen vehicles.get-Anfragen übergeben werden, um zu verhindern, dass sich nicht geänderte Routen zurückgeben.

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)

Der Wegpunkt, an dem currentRouteSegment endet. Dieser kann von Fahrern bei vehicles.update-Aufrufen entweder als vollständiger Wegpunkt für die Fahrt, als Wegpunkt LatLng oder als letzter LatLng der currentRouteSegment angegeben werden. Die Fleet Engine versucht dann, einen tatsächlichen Wegpunkt zu interpolieren, wenn dieser nicht vollständig angegeben ist. Dieses Feld wird bei vehicles.update-Aufrufen ignoriert, es sei denn, currentRouteSegment ist ebenfalls angegeben.
remainingDistanceMeters

integer

Die verbleibende Fahrstrecke für den currentRouteSegment. Dieser Wert wird auch in Trip.remaining_distance_meters für alle aktiven Fahrten zurückgegeben, die dem Fahrzeug zugewiesen sind. Wenn das Feld currentRouteSegment leer ist, ist der Wert nicht angegeben.
etaToFirstWaypoint

string (Timestamp format)

Die geschätzte Zeit bis zum ersten Eintrag im Feld waypoints. Der Wert ist nicht angegeben, wenn das Feld waypoints oder das Feld Vehicle.current_route_segment leer ist.

Beim Aktualisieren eines Fahrzeugs hat remainingTimeSeconds in derselben Anfrage Vorrang vor etaToFirstWaypoint.

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".
remainingTimeSeconds

integer

Nur Eingabe. Die verbleibende Fahrtdauer für die currentRouteSegment. Der Wert ist nicht angegeben, wenn das Feld waypoints oder das Feld Vehicle.current_route_segment leer ist. Dieser Wert sollte mit etaToFirstWaypoint–current_time übereinstimmen, wenn alle Parteien dieselbe Uhr verwenden.

Beim Aktualisieren eines Fahrzeugs hat remainingTimeSeconds in derselben Anfrage Vorrang vor etaToFirstWaypoint.
waypoints[]

object (TripWaypoint)

Die verbleibenden Wegpunkte, die diesem Fahrzeug zugewiesen sind.
waypointsVersion

string (Timestamp format)

Nur Ausgabe. Das letzte Mal, als das Feld waypoints aktualisiert wurde. Clients sollten diesen Wert im Cache speichern und in GetVehicleRequest übergeben, damit das Feld waypoints nur zurückgegeben wird, wenn es aktualisiert wurde.

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".
backToBackEnabled

boolean

Gibt an, ob der Fahrer Fahrten nacheinander annimmt. Bei true kann vehicles.search das Fahrzeug auch dann enthalten, wenn es derzeit einer Fahrt zugewiesen ist. Der Standardwert ist false.
navigationStatus

enum (NavigationStatus)

Der Navigationsstatus des Fahrzeugs.
deviceSettings

object (DeviceSettings)

Nur Eingabe. Informationen zu den Einstellungen auf dem Mobilgerät, das vom Fahrer verwendet wird.

VehicleState

Der Status einer Vehicle.

Enums
UNKNOWN_VEHICLE_STATE Standardwert, wird für nicht angegebene oder nicht erkannte Fahrzeugstatus verwendet.
OFFLINE Es können keine neuen Fahrten mit dem Fahrzeug gebucht werden. Hinweis: Das Fahrzeug kann in diesem Status weiter betrieben werden, während es eine ihm zugewiesene Fahrt durchführt.
ONLINE Das Fahrzeug nimmt neue Fahrten an.

VehicleAttribute

Beschreibt ein Fahrzeugattribut als Schlüssel/Wert-Paar. Die Länge des Strings „Schlüssel:Wert“ darf 256 Zeichen nicht überschreiten.

JSON-Darstellung 
{
  "key": string,
  "value": string,

  // Union field vehicle_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field vehicle_attribute_value.
}
Felder
key

string

Der Schlüssel des Attributs. Schlüssel dürfen das Doppelpunktzeichen (:) nicht enthalten.
value

string

Der Wert des Attributs.
Union-Feld vehicle_attribute_value. Der Wert des Attributs kann vom Typ „String“, „Boolescher Wert“ oder „Doppelt“ sein. Für vehicle_attribute_value ist nur einer der folgenden Werte zulässig:
stringValue

string

Attributwert vom Typ „String“.

Hinweis: Dieses Feld entspricht dem Feld value, das demnächst eingestellt wird. Für Methoden zum Erstellen oder Aktualisieren kann jedes der beiden Felder verwendet werden. Wir empfehlen jedoch dringend, stringValue zu verwenden. Wenn sowohl stringValue als auch value festgelegt sind, müssen sie identisch sein, da sonst ein Fehler auftritt. Beide Felder werden in Antworten ausgefüllt.
boolValue

boolean

Boolescher Attributwert.
numberValue

number

Attributwert mit doppeltem Typ.

VehicleType

Der Fahrzeugtyp.

JSON-Darstellung 
{
  "category": enum (Category)
}
Felder
category

enum (Category)

Kategorie des Fahrzeugtyps

Kategorie

Kategorien für Fahrzeugtypen

Enums
UNKNOWN Standardwert, der für nicht angegebene oder nicht erkannte Fahrzeugkategorien verwendet wird.
AUTO Ein Auto.
TAXI Alle Fahrzeuge, die als Taxi dienen (in der Regel lizenziert oder reguliert).
TRUCK In der Regel ein Fahrzeug mit großer Ladekapazität.
TWO_WHEELER Motorrad, Moped oder anderes Zweirad
BICYCLE Von Menschen betriebene Fortbewegungsmittel.
PEDESTRIAN Ein Personentransportmittel, das in der Regel zu Fuß oder beim Laufen auf Fußwegen unterwegs ist.

LicensePlate

Das Kfz-Kennzeichen des Fahrzeugs. Um das Speichern personenidentifizierbarer Informationen zu vermeiden, werden nur die minimalen Informationen zum Kfz-Kennzeichen als Teil des Elements gespeichert.

JSON-Darstellung 
{
  "countryCode": string,
  "lastCharacter": string
}
Felder
countryCode

string

Erforderlich. CLDR-Länder-/Regionscode. Zum Beispiel US für die USA oder IN für Indien.
lastCharacter

string

Die letzte Ziffer des Kfz-Kennzeichens oder „-1“, wenn das Kfz-Kennzeichen keinen numerischen Wert enthält.

  • „ABC 1234“ -> „4“
  • „AB 123 CD“ -> „3“
  • „ABCDEF“ -> „-1“

TrafficPolylineData

Verkehrslage entlang der voraussichtlichen Fahrzeugroute

JSON-Darstellung 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Felder
trafficRendering

object (VisualTrafficReportPolylineRendering)

Ein Polylinien-Rendering der Verkehrsgeschwindigkeit für alle Regionen entlang eines Streckenabschnitts einer Fahrt.

VisualTrafficReportPolylineRendering

Beschreibt, wie Kunden einen Teil der Polylinie entlang der Route färben sollen.

JSON-Darstellung 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Felder
roadStretch[]

object (RoadStretch)

Optional. Straßenabschnitte, die entlang der Polylinie gerendert werden sollen. Abschnitte überschneiden sich nicht und umfassen nicht unbedingt die gesamte Route.

Wenn keine Straßenstrecke zu gestalten ist, sollte der Kunde den Standard für die Route anwenden.

RoadStretch

Eine Straßenstrecke, die gerendert werden soll.

JSON-Darstellung 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Felder
style

enum (Style)

Erforderlich. Der Stil, der angewendet werden soll.
offsetMeters

integer

Erforderlich. Der Stil sollte zwischen [offsetMeters, offsetMeters + lengthMeters) angewendet werden.
lengthMeters

integer

Erforderlich. Die Länge des Pfads, auf den der Stil angewendet werden soll.

Stil

Der Verkehrsstil, der die Verkehrsgeschwindigkeit angibt.

Enums
STYLE_UNSPECIFIED Es wurde kein Stil ausgewählt.
SLOWER_TRAFFIC Der Traffic verlangsamt sich.
TRAFFIC_JAM Es gibt einen Stau.

DeviceSettings

Informationen zu verschiedenen Einstellungen auf dem Mobilgerät.

JSON-Darstellung 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
Felder
locationPowerSaveMode

enum (LocationPowerSaveMode)

Wie sich die Standortfunktionen auf dem Gerät verhalten, wenn der Energiesparmodus aktiviert ist.
isPowerSaveMode

boolean

Gibt an, ob sich das Gerät derzeit im Energiesparmodus befindet.
isInteractive

boolean

Gibt an, ob sich das Gerät in einem interaktiven Zustand befindet.
batteryInfo

object (BatteryInfo)

Informationen zum Akkustatus.

LocationPowerSaveMode

Wie sich die Standortfunktionen auf dem Mobilgerät verhalten, wenn die Energiesparfunktion des Geräts aktiviert ist. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE Undefined LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE Entweder sollten die Standortanbieter nicht vom Energiesparmodus betroffen sein oder der Energiesparmodus ist deaktiviert.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Der GPS-basierte Standortanbieter sollte deaktiviert werden, wenn der Energiesparmodus aktiviert ist und das Gerät nicht interaktiv ist.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Alle Standortanbieter sollten deaktiviert werden, wenn der Energiesparmodus aktiviert ist und das Gerät nicht interaktiv ist.
LOCATION_MODE_FOREGROUND_ONLY Alle Standortanbieter bleiben verfügbar, aber Standortkorrekturen sollten nur für Apps im Vordergrund bereitgestellt werden.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF Die Standortermittlung wird nicht deaktiviert, aber LocationManager drosselt alle Anfragen an Anbieter, wenn das Gerät nicht interaktiv ist.

BatteryInfo

Informationen zum Akku des Geräts.

JSON-Darstellung 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Felder
batteryStatus

enum (BatteryStatus)

Akkustatus, z. B. ob er voll oder in der Ladung ist
powerSource

enum (PowerSource)

Status der Akkustromquelle.
batteryPercentage

number

Aktueller Akkustand in Prozent [0–100].

BatteryStatus

Akkustatus, z. B. ob er voll oder in der Ladung ist

Enums
UNKNOWN_BATTERY_STATUS Akkustand unbekannt.
BATTERY_STATUS_CHARGING Der Akku wird geladen.
BATTERY_STATUS_DISCHARGING Der Akku wird entladen.
BATTERY_STATUS_FULL Der Akku ist voll.
BATTERY_STATUS_NOT_CHARGING Der Akku wird nicht aufgeladen.
BATTERY_STATUS_POWER_LOW Der Akkustand ist niedrig.

PowerSource

Der Typ des Ladegeräts, mit dem der Akku geladen wird.

Enums
UNKNOWN_POWER_SOURCE Stromquelle unbekannt.
POWER_SOURCE_AC Die Stromquelle ist ein Wechselstrom-Ladegerät.
POWER_SOURCE_USB Stromversorgung über einen USB-Anschluss
POWER_SOURCE_WIRELESS Die Stromversorgung ist kabellos.
POWER_SOURCE_UNPLUGGED Der Akku ist nicht angeschlossen.

Methoden

create

 Erzeugt ein neues Fahrzeug, das mit einem On-Demand-Fahrdienst oder einem Lieferservice verknüpft ist.

get

 Gibt ein Fahrzeug aus der Fleet Engine zurück.

list

 Eine paginaierte Liste der Fahrzeuge, die mit einem Anbieter verknüpft sind und den Anfrageoptionen entsprechen.
Gibt eine Liste der Fahrzeuge zurück, die den Anfrageoptionen entsprechen.

update

 Schreibt aktualisierte Fahrzeugdaten in die Fleet Engine.

updateAttributes

 Die Attribute eines Fahrzeugs werden teilweise aktualisiert.