REST Resource: providers.deliveryVehicles

Ressource: Lieferfahrzeug

Die DeliveryVehicle-Nachricht. Ein Lieferfahrzeug befördert Lieferungen von einem Depot zu einem Lieferort und von einem Abholort zum Depot. In einigen Fällen transportieren Lieferfahrzeuge auch Lieferungen direkt vom Abholort zum Lieferort.

Hinweis: gRPC und REST APIs verwenden unterschiedliche Namenskonventionen für Felder. Das Feld DeliveryVehicle.current_route_segment in der gRPC API und das Feld DeliveryVehicle.currentRouteSegment in der REST API verweisen beispielsweise auf dasselbe Feld.

JSON-Darstellung 
{
  "name": string,
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "navigationStatus": enum (DeliveryVehicleNavigationStatus),
  "currentRouteSegment": string,
  "currentRouteSegmentEndPoint": {
    object (LatLng)
  },
  "remainingDistanceMeters": integer,
  "remainingDuration": string,
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "attributes": [
    {
      object (DeliveryVehicleAttribute)
    }
  ],
  "type": enum (DeliveryVehicleType)
}
Felder
name

string

Der eindeutige Name dieses Lieferfahrzeugs. Das Format dafür ist providers/{provider}/deliveryVehicles/{vehicle}.
lastLocation

object (DeliveryVehicleLocation)

Der letzte gemeldete Standort des Lieferfahrzeugs.
navigationStatus

enum (DeliveryVehicleNavigationStatus)

Der Navigationsstatus des Lieferfahrzeugs.
currentRouteSegment

string (bytes format)

Die codierte Polylinie, die die von der Navigation empfohlene Route zum nächsten Wegpunkt angibt. Ihre Fahrer-App aktualisiert dies, wenn eine Haltestelle erreicht oder vorbeigeleitet wird und wenn die Route neu berechnet wird. Diese LatLngs werden in Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) für alle aktiven Aufgaben zurückgegeben, die dem Fahrzeug zugewiesen sind.

In einigen Fällen wird dieses Feld möglicherweise nicht zum Ausfüllen von Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) verwendet:

  • Der Endpunkt von currentRouteSegment stimmt nicht mit DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) oder DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST) überein.

  • Die Treiber-App hat ihren Standort in letzter Zeit nicht aktualisiert, sodass der letzte aktualisierte Wert für dieses Feld möglicherweise veraltet ist.

  • Die Fahrer-App hat vor Kurzem ihren Standort aktualisiert, aber die currentRouteSegment ist veraltet und verweist auf eine vorherige Fahrzeughaltestelle.

In diesen Fällen füllt Fleet Engine dieses Feld mit einer Route von der zuletzt übergebenen VehicleStop zur nächsten VehicleStop, um sicherzustellen, dass dem Nutzer dieses Felds die besten verfügbaren Informationen zum aktuellen Pfad des Lieferfahrzeugs zur Verfügung stehen.

Ein base64-codierter String.
currentRouteSegmentEndPoint

object (LatLng)

Der Ort, an dem die currentRouteSegment endet. Diese wird derzeit nicht von der Treiber-App ausgefüllt, du kannst sie jedoch bei deliveryVehicles.patch-Aufrufen bereitstellen. Das ist entweder die LatLng der nächsten Haltestelle oder die letzte LatLng der currentRouteSegment. Fleet Engine versucht dann, mit einer tatsächlichen VehicleStop zu interpolieren.

Dieses Feld wird in deliveryVehicles.patch-Aufrufen ignoriert, wenn das Feld currentRouteSegment leer ist.
remainingDistanceMeters

integer

Die verbleibende Fahrstrecke für die currentRouteSegment. Dieses Feld wird in der Regel in der Treiber-App bereitgestellt. Unter bestimmten Umständen überschreibt Fleet Engine den von der Anwendung gesendeten Wert jedoch. Weitere Informationen findest du unter DeliveryVehicle.current_route_segment. Dieses Feld wird in Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) oder Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) für alle aktiven Tasks zurückgegeben, die dem Lieferfahrzeug zugewiesen sind.

Fleet Engine ignoriert dieses Feld in UpdateDeliveryVehicleRequest, wenn das Feld currentRouteSegment leer ist.
remainingDuration

string (Duration format)

Die verbleibende Fahrzeit für currentRouteSegment. Dieses Feld wird in der Regel in der Treiber-App bereitgestellt. Unter bestimmten Umständen überschreibt Fleet Engine den von der Anwendung gesendeten Wert jedoch. Weitere Informationen findest du unter DeliveryVehicle.current_route_segment. Dieses Feld wird in Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) oder Task.remainingVehicleJourneySegments[0].drivingDuration (REST) für alle aktiven Aufgaben zurückgegeben, die dem Lieferfahrzeug zugewiesen sind.

Fleet Engine ignoriert dieses Feld in UpdateDeliveryVehicleRequest, wenn das Feld currentRouteSegment leer ist.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Die Fahrtabschnitte, die diesem Lieferfahrzeug zugewiesen sind, beginnend mit dem zuletzt gemeldeten Standort des Fahrzeugs. Dieses Feld wird in der Antwort von deliveryVehicles.list nicht ausgefüllt.
attributes[]

object (DeliveryVehicleAttribute)

Eine Liste benutzerdefinierter Lieferfahrzeugattribute. Ein Lieferfahrzeug kann maximal 100 Attribute haben, wobei jedes Attribut einen eindeutigen Schlüssel haben muss.
type

enum (DeliveryVehicleType)

Der Typ dieses Lieferfahrzeugs. Wenn kein Wert festgelegt ist, wird standardmäßig AUTO verwendet.

DeliveryVehicleNavigationStatus

Der Navigationsstatus des Fahrzeugs.

Enums
UNKNOWN_NAVIGATION_STATUS Unbekannter Navigationsstatus.
NO_GUIDANCE Die Navigation in der Fahrer-App ist im FREE_NAV-Modus.
ENROUTE_TO_DESTINATION Die Schritt-für-Schritt-Navigation ist verfügbar und die Navigation in der Fahrer-App hat den GUIDED_NAV-Modus erreicht.
OFF_ROUTE Das Fahrzeug ist nicht mehr auf der vorgeschlagenen Route gefahren.
ARRIVED_AT_DESTINATION Das Fahrzeug ist maximal 50 m vom Ziel entfernt.

DeliveryVehicleAttribute

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 delivery_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
  // delivery_vehicle_attribute_value.
}
Felder
key

string

Der Schlüssel des Attributs.
value

string

Der Wert des Attributs.
Union-Feld delivery_vehicle_attribute_value. Der Wert des Attributs kann als String, boolescher oder Double-Wert angegeben werden. Für delivery_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.

DeliveryVehicleType

Der Typ des Lieferfahrzeugs.

Enums
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Der Wert wird nicht verwendet.
AUTO Ein Auto.
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.

Methoden

create

 Erstellt einen neuen DeliveryVehicle und gibt ihn zurück.

get

 Gibt die angegebene DeliveryVehicle-Instanz zurück.

list

 Ruft alle DeliveryVehicles ab, die den angegebenen Filterkriterien entsprechen.

patch

 Schreibt aktualisierte DeliveryVehicle-Daten in Fleet Engine und weist dem DeliveryVehicle Tasks zu.