REST Resource: providers.deliveryVehicles

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

string

The unique name of this Delivery Vehicle. The format is providers/{provider}/deliveryVehicles/{vehicle}.

object (DeliveryVehicleLocation)

The last reported location of the Delivery Vehicle.

enum (DeliveryVehicleNavigationStatus)

The Delivery Vehicle's navigation status.

string (bytes format)

The encoded polyline specifying the route that the navigation recommends taking to the next waypoint. Your driver app updates this when a stop is reached or passed, and when the navigation reroutes. These LatLngs are returned in Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) or Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) for all active Tasks assigned to the Vehicle.

There are a few cases where this field might not be used to populate Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) or Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

• The endpoint of the currentRouteSegment does not match DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) or DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

• The driver app has not updated its location recently, so the last updated value for this field might be stale.

• The driver app has recently updated its location, but the currentRouteSegment is stale, and points to a previous vehicle stop.

In these cases, Fleet Engine populates this field with a route from the most recently passed VehicleStop to the upcoming VehicleStop to ensure that the consumer of this field has the best available information on the current path of the Delivery Vehicle.

A base64-encoded string.

object (LatLng)

The location where the currentRouteSegment ends. This is not currently populated by the driver app, but you can supply it on deliveryVehicles.patch calls. It is either the LatLng from the upcoming vehicle stop, or the last LatLng of the currentRouteSegment. Fleet Engine will then do its best to interpolate to an actual VehicleStop.

This field is ignored in deliveryVehicles.patch calls if the currentRouteSegment field is empty.

integer

The remaining driving distance for the currentRouteSegment. The Driver app typically provides this field, but there are some circumstances in which Fleet Engine will override the value sent by the app. For more information, see DeliveryVehicle.current_route_segment. This field is returned in Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) or Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) for all active Tasks assigned to the Delivery Vehicle.

Fleet Engine ignores this field in UpdateDeliveryVehicleRequest if the currentRouteSegment field is empty.

string (Duration format)

The remaining driving time for the currentRouteSegment. The Driver app typically provides this field, but there are some circumstances in which Fleet Engine will override the value sent by the app. For more information, see DeliveryVehicle.current_route_segment. This field is returned in Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) or Task.remainingVehicleJourneySegments[0].drivingDuration (REST) for all active tasks assigned to the Delivery Vehicle.

Fleet Engine ignores this field in UpdateDeliveryVehicleRequest if the currentRouteSegment field is empty.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object (VehicleJourneySegment)

The journey segments assigned to this Delivery Vehicle, starting from the Vehicle's most recently reported location. This field won't be populated in the response of deliveryVehicles.list.

object (DeliveryVehicleAttribute)

A list of custom Delivery Vehicle attributes. A Delivery Vehicle can have at most 100 attributes, and each attribute must have a unique key.

enum (DeliveryVehicleType)

The type of this delivery vehicle. If unset, this will default to AUTO.

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

string

The attribute's key.

string

The attribute's value.

string

String typed attribute value.

Note: This is identical to the value field which will eventually be deprecated. For create or update methods, either field can be used, but it's strongly recommended to use stringValue. If both stringValue and value are set, they must be identical or an error will be thrown. Both fields are populated in responses.

boolean

Boolean typed attribute value.

number

Double typed attribute value.