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

enum (VehicleState)

Der Fahrzeugstatus.

enum (TripType)

Fahrttypen, die von diesem Fahrzeug unterstützt werden.

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 Fahrer wird bei 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)

Informationen zum Kfz-Kennzeichen des Fahrzeugs.

object (TerminalLocation)

Verworfen. Verwenden Sie stattdessen Vehicle.waypoints.

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.

object (TrafficPolylineData)

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

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

object (TripWaypoint)

Der 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. Die Fleet Engine versucht dann, einen 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 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 wird nicht angegeben, wenn das Feld currentRouteSegment leer ist.

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.

Bei der Aktualisierung 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 ist 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. Zeitpunkt der letzten Aktualisierung des Felds waypoints. Clients sollten diesen Wert im Cache speichern und in GetVehicleRequest übergeben, um sicherzustellen, dass 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 Fahrten nacheinander annimmt. Wenn true, vehicles.search das Fahrzeug auch dann enthalten kann, 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: Dieses Feld entspricht dem Feld value, das demnächst 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

Attributwert mit doppeltem Typ.

{
  "category": enum (Category)
}

enum (Category)

Kategorie des Fahrzeugtyps

{
  "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 Kfz-Kennzeichens oder „-1“, wenn das Kfz-Kennzeichen keinen numerischen Wert enthält.

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

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

object (VisualTrafficReportPolylineRendering)

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

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

Wenn keine Straßenstrecke zu gestalten ist, sollte der Kunde den Standard 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 den 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 sich das Gerät in einem interaktiven Zustand befindet.

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]