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)

Fahrzeugstatus
supportedTripTypes[]

enum (TripType)

Von diesem Fahrzeug unterstützte Fahrttypen.
currentTrips[]

string

Nur Ausgabe. Liste der Fahrten mit 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 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, wobei jedes Attribut einen eindeutigen Schlüssel haben muss.
vehicleType

object (VehicleType)

Erforderlich. Der Typ dieses Fahrzeugs. Kann zum Filtern von Fahrzeugen in vehicles.search-Ergebnissen verwendet werden. Beeinflusst auch die voraussichtliche Ankunftszeit und die Routenberechnung.
licensePlate

object (LicensePlate)

Das Nummernschild des Fahrzeugs.
route[]
(deprecated)

object (TerminalLocation)

Eingestellt: Verwenden Sie stattdessen Vehicle.waypoints.
currentRouteSegment

string

Die Polylinie, die die Route angibt, die die Fahrer-App zum nächsten Wegpunkt zurücklegen 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 durch das Driver SDK vorgesehen. Die Decodierung wird noch nicht unterstützt.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Nur Eingabe. Fleet Engine verwendet diese Informationen, um das Teilen von Journeys zu verbessern. Hinweis: Dieses Feld ist nur für die Verwendung durch 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 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 Diese kann von Fahrern bei vehicles.update-Aufrufen entweder als Wegpunkt für die gesamte Fahrt, als Wegpunkt LatLng oder als letzter LatLng der currentRouteSegment angegeben werden. Fleet Engine versucht dann, einen tatsächlichen Wegpunkt zu interpolieren, falls dieser nicht vollständig angegeben ist. Dieses Feld wird in 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. Der Wert ist 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 ist nicht angegeben, wenn das Feld waypoints oder Vehicle.current_route_segment leer ist.

Wenn ein Fahrzeug aktualisiert wird, hat remainingTimeSeconds Vorrang vor etaToFirstWaypoint in derselben Anfrage.

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 den currentRouteSegment. Der Wert ist nicht angegeben, wenn das Feld waypoints oder Vehicle.current_route_segment leer ist. Dieser Wert sollte etaToFirstWaypoint–current_time entsprechen, wenn alle Parteien dieselbe Uhr verwenden.

Wenn ein Fahrzeug aktualisiert wird, hat remainingTimeSeconds Vorrang vor etaToFirstWaypoint in derselben Anfrage.
waypoints[]

object (TripWaypoint)

Die verbleibenden Wegpunkte, die diesem Fahrzeug zugewiesen sind.
waypointsVersion

string (Timestamp format)

Nur Ausgabe. Zeitpunkt der letzten 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 Rückfahrten akzeptiert. Wenn true festgelegt ist, kann das Fahrzeug in vehicles.search eingeschlossen werden, auch 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 eines Vehicle-Objekts.

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

VehicleAttribute

Beschreibt ein Fahrzeugattribut als Schlüssel/Wert-Paar. Der String „key:value“ 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 doppelter Typ angegeben werden. Für vehicle_attribute_value ist nur einer der folgenden Werte zulässig:
stringValue

string

Attributwert vom Typ „String“.

Hinweis: Dies ist mit dem Feld value identisch, das letztendlich verworfen wird. Bei Erstellungs- oder Aktualisierungsmethoden kann jedes Feld verwendet werden. Es wird jedoch dringend empfohlen, stringValue zu verwenden. 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

Doppelt eingegebener Attributwert.

VehicleType

Der Fahrzeugtyp.

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

enum (Category)

Fahrzeugtypkategorie

Kategorie

Fahrzeugtypen

Enums
UNKNOWN Standardeinstellung, wird für nicht spezifizierte oder nicht erkannte Fahrzeugkategorien verwendet.
AUTO Ein Auto.
TAXI Jedes Fahrzeug, das als Taxi fungiert (in der Regel lizenziert oder reguliert).
TRUCK In der Regel ein Fahrzeug mit einer großen Speicherkapazität.
TWO_WHEELER Motorrad, Moped oder anderes zweirädriges Fahrzeug
BICYCLE Von Menschen angetriebene Fahrzeuge.
PEDESTRIAN Ein Personentransporter, der in der Regel zu Fuß oder joggt und Fußgängerwege entlangfährt.

LicensePlate

Das Kfz-Kennzeichen des Fahrzeugs. Damit keine personenidentifizierbaren Informationen gespeichert werden, werden nur die Informationen zum Nummernschild als Teil der Entität 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 Kfz-Kennzeichens oder „-1“, wenn kein numerischer Wert vorhanden ist.

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

TrafficPolylineData

Die Verkehrslage auf der erwarteten Route des Fahrzeugs wird angezeigt.

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

object (VisualTrafficReportPolylineRendering)

Polyliniendarstellung, die zeigt, wie schnell der Verkehr für alle Regionen entlang eines Abschnitts einer Fahrt ist.

VisualTrafficReportPolylineRendering

Beschreibt, wie Clients 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. Streckenabschnitte werden garantiert nicht überlappen und reichen nicht unbedingt die gesamte Route.

Falls keine Straßenabschnitte für den Stil festgelegt werden, sollte der Client die Standardeinstellung für die Route anwenden.

RoadStretch

Ein Straßenabschnitt, der gerendert werden sollte.

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

Festlegen, wie Standortfunktionen sich 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 im interaktiven Zustand befindet.
batteryInfo

object (BatteryInfo)

Informationen zum Akkustatus.

LocationPowerSaveMode

Festlegen, wie Standortfunktionen auf Mobilgeräten konfiguriert werden, wenn der Energiesparmodus aktiviert ist (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE Nicht definierter Energiesparmodus für Standort
LOCATION_MODE_NO_CHANGE Der Energiesparmodus sollte entweder keine Auswirkungen auf die Standortanbieter haben 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 der Standortmanager 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, u. a. vollständig aufgeladen oder aufgeladen
powerSource

enum (PowerSource)

Status der Stromquelle für den Akku.
batteryPercentage

number

Aktueller Akkustand in % [0–100].

BatteryStatus

Status des Akkus, u. a. vollständig aufgeladen oder aufgeladen

Enums
UNKNOWN_BATTERY_STATUS Akkustatus unbekannt.
BATTERY_STATUS_CHARGING Der Akku wird geladen.
BATTERY_STATUS_DISCHARGING Akku wird entladen.
BATTERY_STATUS_FULL Der Akku ist vollständig geladen.
BATTERY_STATUS_NOT_CHARGING Der 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 Stromquelle unbekannt.
POWER_SOURCE_AC Als Stromquelle wird ein Netzteil verwendet.
POWER_SOURCE_USB Die Stromquelle ist ein USB-Anschluss.
POWER_SOURCE_WIRELESS Die Stromquelle ist kabellos.
POWER_SOURCE_UNPLUGGED Der Akku ist nicht angeschlossen.

Methoden

create

 Instanziiert ein neues Fahrzeug, das mit einem On-Demand-Anbieter von Mitfahrdiensten oder -lieferungen verknüpft ist

get

 Gibt ein Fahrzeug von Fleet Engine zurück.

list

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

update

 Aktualisierte Fahrzeugdaten werden in Fleet Engine geschrieben.

updateAttributes

 Aktualisiert die Attribute eines Fahrzeugs teilweise.