REST Resource: providers.deliveryVehicles

Ressource: DeliveryVehicle

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

Hinweis: gRPC und REST APIs verwenden unterschiedliche Namenskonventionen für Felder. Beispielsweise beziehen sich das Feld DeliveryVehicle.current_route_segment in der gRPC API und das Feld DeliveryVehicle.currentRouteSegment in der REST API 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 Route zum nächsten Wegpunkt angibt, die von der Navigation empfohlen wird. Diese wird von der Fahrer-App aktualisiert, wenn eine Haltestelle erreicht oder vorbeigeleitet wird oder wenn die Navigation umkehrt. 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.

Es gibt einige Fälle, in denen dieses Feld nicht zum Ausfüllen von Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) verwendet wird:

  • 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. Daher ist der Wert der letzten Aktualisierung für dieses Feld möglicherweise veraltet.

  • Der Standort der Fahrer-App wurde vor Kurzem aktualisiert, aber der currentRouteSegment ist veraltet und verweist auf eine frühere Haltestelle des Fahrzeugs.

In diesen Fällen füllt Fleet Engine dieses Feld mit einer Route von der zuletzt übergebenen VehicleStop zur nächsten VehicleStop-Position auf, damit der Nutzer dieses Felds die besten verfügbaren Informationen zum aktuellen Pfad des Lieferfahrzeugs hat.

Ein base64-codierter String.
currentRouteSegmentEndPoint

object (LatLng)

Der Standort, an dem currentRouteSegment endet. Sie wird derzeit nicht von der Fahrer-App ausgefüllt, aber Sie können sie bei deliveryVehicles.patch-Aufrufen bereitstellen. Dies ist entweder der LatLng der nächsten Haltestelle des Fahrzeugs oder der letzte LatLng des currentRouteSegment. Fleet Engine versucht dann, in eine tatsächliche VehicleStop zu interpolieren.

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

integer

Die verbleibende Strecke mit dem Auto für den currentRouteSegment. Die Treiber-App stellt dieses Feld normalerweise zur Verfügung. Unter bestimmten Umständen überschreibt Fleet Engine jedoch den von der Anwendung gesendeten Wert. 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 Fahrzeit für currentRouteSegment. Die Treiber-App stellt dieses Feld normalerweise zur Verfügung. Unter bestimmten Umständen überschreibt Fleet Engine jedoch den von der Anwendung gesendeten Wert. 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.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Die diesem Lieferfahrzeug zugewiesenen Fahrtsegmente, 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 mit benutzerdefinierten Attributen für Lieferfahrzeuge. Ein Lieferfahrzeug kann maximal 100 Attribute haben, wobei jedes Attribut einen eindeutigen Schlüssel haben muss.
type

enum (DeliveryVehicleType)

Der Typ dieses Lieferfahrzeugs. Wenn die Richtlinie nicht konfiguriert ist, wird standardmäßig AUTO verwendet.

DeliveryVehicleNavigationStatus

Der Navigationsstatus des Fahrzeugs.

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

DeliveryVehicleAttribute

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 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, Bool oder Double sein. Für delivery_vehicle_attribute_value ist nur einer der folgenden Werte zulässig:
stringValue

string

Als String typisierter Attributwert.

Hinweis: Dies ist mit dem Feld value identisch, das letztendlich eingestellt wird. Bei Methoden zum Erstellen oder Aktualisieren können beide Felder verwendet werden. Es wird jedoch dringend empfohlen, stringValue zu verwenden. Wenn sowohl stringValue als auch value festgelegt sind, müssen die Werte identisch sein. Andernfalls wird ein Fehler ausgegeben. Beide Felder werden in den Antworten ausgefüllt.
boolValue

boolean

Boolescher Attributwert.
numberValue

number

Doppelt eingegebener Attributwert.

DeliveryVehicleType

Der Typ des Lieferfahrzeugs.

Enums
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Der Wert wird nicht verwendet.
AUTO Ein Auto.
TWO_WHEELER Ein Motorrad, ein Moped oder ein anderes zweirädriges Fahrzeug
BICYCLE Von Menschen angetriebene Transporte.
PEDESTRIAN Personentransporter, die in der Regel zu Fuß oder laufen und einen Fußgängerweg entlangfahren.

Methoden

create

 Erstellt ein neues DeliveryVehicle-Objekt und gibt es zurück.

get

 Gibt die angegebene DeliveryVehicle-Instanz zurück.

list

 Ruft alle DeliveryVehicles ab, die die angegebenen Filterkriterien erfüllen.

patch

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