REST Resource: providers.vehicles

{
  "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)
  }
}

string

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

enum (VehicleState)

Der Fahrzeugstatus.

enum (TripType)

Von diesem Fahrzeug unterstützte Fahrttypen.

string

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

object (VehicleLocation)

Letzter gemeldeter Standort des Fahrzeugs.

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.

object (VehicleAttribute)

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

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.

object (LicensePlate)

Kfz-Kennzeichen des Fahrzeugs.

object (TerminalLocation)

Eingestellt: Verwende stattdessen Vehicle.waypoints.

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.

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.

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

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.

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.

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

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.

object (TripWaypoint)

Die verbleibenden Wegpunkte, die diesem Fahrzeug zugewiesen sind.

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

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.

enum (NavigationStatus)

Der Navigationsstatus des Fahrzeugs.

object (DeviceSettings)

Nur Eingabe. Informationen zu den Einstellungen des Mobilgeräts, das der Fahrer verwendet.

{
  "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.
}

string

Der Schlüssel des Attributs. Schlüssel dürfen keinen Doppelpunkt (:) enthalten.

string

Der Wert des Attributs.

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.

boolean

Boolescher Attributwert

number

Doppelter Attributwert.

{
  "category": enum (Category)
}

enum (Category)

Fahrzeugtypkategorie

{
  "countryCode": string,
  "lastCharacter": string
}

string

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

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“

{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}

object (VisualTrafficReportPolylineRendering)

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

{
  "roadStretch": [
    {
      object (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.

{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}

enum (Style)

Erforderlich. Der Stil, der angewendet werden soll.

integer

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

integer

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

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

enum (LocationPowerSaveMode)

Gibt an, wie sich die Standortfunktionen auf dem Gerät verhalten, wenn der Energiesparmodus aktiviert ist.

boolean

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

boolean

Gibt an, ob das Gerät interaktiv ist.

object (BatteryInfo)

Informationen zum Akkustatus.

{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}

enum (BatteryStatus)

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

enum (PowerSource)

Status der Akkustromquelle.

number

Aktueller Akkustand in Prozent [0–100].