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 für dieses Fahrzeug. Das Format dafür ist providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

Der Fahrzeugstatus.
supportedTripTypes[]

enum (TripType)

Von diesem Fahrzeug unterstützte Fahrttypen.
currentTrips[]

string

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

object (VehicleLocation)

Letzter gemeldeter Standort des Fahrzeugs.
maximumCapacity

integer

Die Gesamtzahl der Fahrgäste, die dieses Fahrzeug befördern kann. Der Treiber wird in diesem Wert nicht berücksichtigt. Dieser Wert muss größer oder gleich eins 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 zum Filtern von Fahrzeugen in vehicles.search-Ergebnissen verwendet werden. Beeinflusst außerdem die voraussichtliche Ankunftszeit und die Routenberechnung.
licensePlate

object (LicensePlate)

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

object (TerminalLocation)

Eingestellt: Verwende stattdessen Vehicle.waypoints.
currentRouteSegment

string

Die Polylinie, die die Route angibt, die die Fahrer-App zum nächsten Wegpunkt nehmen möchte. 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 die Verwendung vom Treiber-SDK vorgesehen. Die Decodierung wird noch nicht unterstützt.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Nur Eingabe. Fleet Engine verwendet diese Informationen, um die Weitergabe von Fahrten zu verbessern. Hinweis: Dieses Feld ist nur für die Verwendung vom Treiber-SDK vorgesehen.
currentRouteSegmentVersion

string (Timestamp format)

Nur Ausgabe. Uhrzeit, zu der currentRouteSegment festgelegt wurde. Sie kann vom Client gespeichert und in zukünftigen vehicles.get-Anfragen übergeben werden, um zu verhindern, dass Routen zurückgegeben werden, die sich nicht geändert haben.

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)

Wegpunkt, an dem currentRouteSegment endet. Sie kann von Fahrern bei vehicles.update-Aufrufen entweder als vollständiger Wegpunkt, als Wegpunkt LatLng oder als letztes LatLng der currentRouteSegment angegeben werden. Fleet Engine versucht dann, mit einem tatsächlichen Wegpunkt zu interpolieren, wenn dieser nicht vollständig angegeben ist. Dieses Feld wird in vehicles.update-Aufrufen ignoriert, sofern nicht auch currentRouteSegment angegeben ist.
remainingDistanceMeters

integer

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

string (Timestamp format)

Die voraussichtliche Ankunftszeit für den ersten Eintrag im Feld waypoints. Der Wert wird 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.

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

integer

Nur Eingabe. Die verbleibende Fahrzeit für currentRouteSegment. Der Wert wird nicht angegeben, wenn das Feld waypoints oder das Feld Vehicle.current_route_segment leer ist. Dieser Wert sollte etaToFirstWaypoint–current_time entsprechen, 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. Letzte Aktualisierung des Felds waypoints. Clients sollten diesen Wert im Cache speichern und in GetVehicleRequest übergeben, damit das Feld waypoints nur zurückgegeben wird, wenn es aktualisiert 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".
backToBackEnabled

boolean

Gibt an, ob der Fahrer aufeinanderfolgende Fahrten akzeptiert. Wenn true, enthält vehicles.search das Fahrzeug möglicherweise auch dann, 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 des Mobilgeräts, das der Fahrer verwendet.

VehicleState

Der Status eines Vehicle.

Enums
UNKNOWN_VEHICLE_STATE Standardeinstellung, die für nicht angegebene oder nicht erkannte Fahrzeugstatus verwendet wird.
OFFLINE Das Fahrzeug akzeptiert keine neuen Fahrten. Hinweis: Das Fahrzeug kann in diesem Status weiterhin betrieben werden, während eine ihm zugewiesene Fahrt abgeschlossen wird.
ONLINE Das Fahrzeug nimmt neue Fahrten an.

VehicleAttribute

Beschreibt ein Fahrzeugattribut als Schlüssel/Wert-Paar. Das Schlüssel/Wert-Paar String darf nicht länger als 256 Zeichen sein.

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 keinen Doppelpunkt (:) enthalten.
value

string

Der Wert des Attributs.
Union-Feld vehicle_attribute_value. Der Wert des Attributs kann als String, boolescher oder Double-Wert angegeben werden. Für vehicle_attribute_value ist nur einer der folgenden Werte zulässig:
stringValue

string

Als String eingegebener Attributwert.

Hinweis: Dies ist identisch mit dem Feld value, das irgendwann eingestellt wird. Für die Erstellungs- oder Aktualisierungsmethode können beide Felder verwendet werden, die Verwendung von stringValue wird jedoch dringend empfohlen. Wenn sowohl stringValue als auch value festgelegt sind, müssen sie identisch sein. Andernfalls wird ein Fehler ausgegeben. Beide Felder werden in den Antworten ausgefüllt.
boolValue

boolean

Boolescher Attributwert
numberValue

number

Doppelter Attributwert.

VehicleType

Der Fahrzeugtyp.

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

enum (Category)

Fahrzeugtypkategorie

Kategorie

Fahrzeugtypkategorien

Enums
UNKNOWN Standardeinstellung; wird für nicht angegebene oder nicht erkannte Fahrzeugkategorien verwendet.
AUTO Ein Auto.
TAXI Alle Fahrzeuge, die als Taxi fungieren (in der Regel lizenziert oder gesetzlich reguliert).
TRUCK In der Regel ein Fahrzeug mit einer großen Speicherkapazität.
TWO_WHEELER Ein Motorrad, Moped oder ein anderes Fahrzeug mit zwei Rädern
BICYCLE Von Menschen betriebene Transportmittel
PEDESTRIAN Personen, die in der Regel gehen oder laufen und Fußgängerwege entlangfahren.

LicensePlate

Die Nummernschildinformationen des Fahrzeugs. Damit keine personenidentifizierbaren Informationen gespeichert werden, werden nur die Mindestinformationen zum Kfz-Kennzeichen als Teil des Rechtssubjekts gespeichert.

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

string

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

string

Die letzte Ziffer des Nummernschilds oder „-1“ an, dass kein numerischer Wert im Kfz-Kennzeichen vorhanden ist.

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

TrafficPolylineData

Die Verkehrslage auf der voraussichtlichen Route wird genannt.

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

object (VisualTrafficReportPolylineRendering)

Polylinien-Rendering, der die Geschwindigkeit des Traffics für alle Regionen entlang eines Abschnitts einer Fahrt durch einen Kunden angibt.

VisualTrafficReportPolylineRendering

Beschreibt, wie Clients einen Teil der Polylinie entlang der Route färben sollten.

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

object (RoadStretch)

Optional. Straßenabschnitte, die entlang der Polylinie gerendert werden sollen. Streckenabschnitte überschneiden sich garantiert nicht und decken nicht unbedingt die gesamte Route ab.

Falls keine Straßenabschnitte vorhanden sind, die angepasst werden sollen, sollte der Client die Standardeinstellung für die Route anwenden.

RoadStretch

Ein Straßenabschnitt, der 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 die der Stil angewendet werden soll.

Stil

Der Verkehrsstil, der die Verkehrsgeschwindigkeit angibt.

Enums
STYLE_UNSPECIFIED Kein Stil ausgewählt.
SLOWER_TRAFFIC Der Verkehr wird langsamer.
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)

Gibt an, 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 das Gerät interaktiv ist.
batteryInfo

object (BatteryInfo)

Informationen zum Akkustatus.

LocationPowerSaveMode

Wie Standortfunktionen so konfiguriert sind, dass sie sich auf dem Mobilgerät verhalten, wenn das Gerät im Energiesparmodus ist ist aktiviert. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE Nicht definierter StandortEnergiesparmodus
LOCATION_MODE_NO_CHANGE Entweder sollten Standortanbieter vom Energiesparmodus nicht betroffen sein oder er 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, Standortkorrekturen sollten jedoch 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)

Status des Akkus, z. B. ob er voll oder aufgeladen wird
powerSource

enum (PowerSource)

Status der Akkustromquelle.
batteryPercentage

number

Aktueller Akkustand in Prozent [0–100].

BatteryStatus

Status des Akkus, z. B. ob er voll oder aufgeladen wird

Enums
UNKNOWN_BATTERY_STATUS Akkustand unbekannt.
BATTERY_STATUS_CHARGING Der Akku wird geladen.
BATTERY_STATUS_DISCHARGING Akku wird entladen.
BATTERY_STATUS_FULL Akku ist vollständig geladen.
BATTERY_STATUS_NOT_CHARGING Akku wird nicht geladen.
BATTERY_STATUS_POWER_LOW Der Akkustand ist niedrig.

PowerSource

Typ des Ladegeräts, das zum Laden des Akkus verwendet wird.

Enums
UNKNOWN_POWER_SOURCE Die Stromquelle ist unbekannt.
POWER_SOURCE_AC Die Stromquelle ist ein Wechselstromladegerät.
POWER_SOURCE_USB Die Stromquelle ist ein USB-Anschluss.
POWER_SOURCE_WIRELESS Die Stromquelle ist kabellos.
POWER_SOURCE_UNPLUGGED Akku ist ausgesteckt.

Methoden

create

 Instanziiert ein neues Fahrzeug, das mit einem On-Demand-Mitfahrdienst oder Lieferdienst verknüpft ist.

get

 Gibt ein Fahrzeug von der Fleet Engine zurück.

list

 Gibt eine paginierte Liste von Fahrzeugen zurück, die einem Anbieter zugeordnet sind und den Anfrageoptionen entsprechen.
Gibt eine Liste von Fahrzeugen zurück, die den Anfrageoptionen entsprechen.

update

 Schreibt aktualisierte Fahrzeugdaten in die Fleet Engine.

updateAttributes

 Aktualisiert teilweise Attribute des Fahrzeugs.