REST Resource: providers.deliveryVehicles

Ressource: DeliveryVehicle

Die DeliveryVehicle-Nachricht. Ein Lieferfahrzeug transportiert Sendungen von einem Depot zu einem Lieferort und von einem Abholort zum Depot. In einigen Fällen werden Sendungen auch direkt vom Abholort zum Lieferort transportiert.

Hinweis: gRPC- und REST-APIs verwenden unterschiedliche Feldbenennungskonventionen. 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 zuletzt 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. Diese wird von der Fahrer-App aktualisiert, wenn eine Haltestelle erreicht oder vorbeigeleitet wird oder 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 der currentRouteSegment stimmt nicht mit DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) oder DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST) überein.

  • Die Standortinformationen der Fahrer App wurden vor Kurzem nicht aktualisiert. Daher ist der zuletzt aktualisierte Wert für dieses Feld möglicherweise veraltet.

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

In diesen Fällen füllt die Fleet Engine dieses Feld mit einem Routenabschnitt vom zuletzt passierten zu dem nächsten Fahrzeugstopp aus, damit der Nutzer dieses Felds die bestmöglichen Informationen zum aktuellen Pfad des Lieferfahrzeugs hat.

Ein base64-codierter String.
currentRouteSegmentEndPoint

object (LatLng)

Der Ort, an dem die currentRouteSegment endet. Dieser Wert wird derzeit nicht von der Fahrer App erfasst. Sie können ihn aber bei deliveryVehicles.patch-Anrufen angeben. Das ist entweder die LatLng der nächsten Haltestelle oder die letzte LatLng der currentRouteSegment. Die Fleet Engine versucht dann, eine tatsächliche VehicleStop zu interpolieren.

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

integer

Die verbleibende Fahrstrecke für den currentRouteSegment. Dieses Feld wird in der Regel in der Treiber-App bereitgestellt. Unter bestimmten Umständen überschreibt Fleet Engine den von der App gesendeten Wert jedoch. Weitere Informationen finden Sie 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 Fahrtdauer für die currentRouteSegment. Dieses Feld wird normalerweise von der Fahrer App bereitgestellt. Es gibt jedoch einige Fälle, in denen Fleet Engine den von der App gesendeten Wert überschreibt. Weitere Informationen finden Sie 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 diesem Lieferfahrzeug zugewiesenen Fahrtabschnitte, 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 Attribute für Lieferfahrzeuge. Ein Übermittlungsmedium kann maximal 100 Attribute haben und jedes Attribut muss einen eindeutigen Schlüssel haben.
type

enum (DeliveryVehicleType)

Der Typ dieses Lieferfahrzeugs. Wenn nicht festgelegt, wird standardmäßig AUTO verwendet.

DeliveryVehicleNavigationStatus

Der Navigationsstatus des Fahrzeugs.

Enums
UNKNOWN_NAVIGATION_STATUS Nicht angegebener Navigationsstatus.
NO_GUIDANCE Die Navigation der Fahr-App befindet sich im Modus FREE_NAV.
ENROUTE_TO_DESTINATION Die detaillierte Routenführung ist verfügbar und die Navigation in der Fahrer App befindet sich im Modus GUIDED_NAV.
OFF_ROUTE Das Fahrzeug ist von der vorgeschlagenen Route abgekommen.
ARRIVED_AT_DESTINATION Das Fahrzeug befindet sich in etwa 50 m Entfernung vom Ziel.

DeliveryVehicleAttribute

Beschreibt ein Fahrzeugattribut als Schlüssel/Wert-Paar. Die Länge des Strings „Schlüssel:Wert“ darf 256 Zeichen nicht überschreiten.

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 vom Typ „String“, „Boole“ oder „Doppelt“ sein. Für delivery_vehicle_attribute_value ist nur einer der folgenden Werte zulässig:
stringValue

string

Attributwert vom Typ „String“.

Hinweis: Dies ist identisch mit dem Feld value, das irgendwann eingestellt wird. Für Methoden zum Erstellen oder Aktualisieren kann jedes der beiden Felder verwendet werden. Wir empfehlen jedoch dringend, stringValue zu verwenden. Wenn sowohl stringValue als auch value festgelegt sind, müssen sie identisch sein, da sonst ein Fehler auftritt. Beide Felder werden in Antworten ausgefüllt.
boolValue

boolean

Boolescher Attributwert.
numberValue

number

Attributwert mit doppeltem Typ.

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 Fortbewegungsmittel.
PEDESTRIAN Personen, die in der Regel gehen oder laufen und Fußgängerwege entlangfahren.

Methoden

create

 Erstellt eine neue DeliveryVehicle und gibt sie 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 die Fleet Engine und weist der DeliveryVehicle Tasks zu.