REST Resource: providers.deliveryVehicles

Recurso: DeliveryVehicle

El mensaje DeliveryVehicle Un vehículo de reparto transporta envíos desde un depósito a una ubicación de entrega y desde un punto de partida hasta el depósito. En algunos casos, los vehículos de reparto también transportan los envíos directamente desde el lugar de recogida hasta el lugar de entrega.

Nota: Las APIs de gRPC y REST usan convenciones de nombres de campos diferentes. Por ejemplo, el campo DeliveryVehicle.current_route_segment en la API de gRPC y el campo DeliveryVehicle.currentRouteSegment en la API de REST hacen referencia al mismo campo.

Representación JSON 
{
  "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)
}
Campos
name

string

Es el nombre único de este vehículo de entrega. El formato es providers/{provider}/deliveryVehicles/{vehicle}.
lastLocation

object (DeliveryVehicleLocation)

Es la última ubicación informada del vehículo de entrega.
navigationStatus

enum (DeliveryVehicleNavigationStatus)

Es el estado de navegación del vehículo de entrega.
currentRouteSegment

string (bytes format)

La polilínea codificada que especifica la ruta que la navegación recomienda tomar al siguiente punto de referencia. Tu app de conductor actualiza este estado cuando se llega a una parada o se pasa por ella, y cuando la navegación se desvía. Estos LatLng se muestran en Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) para todas las tareas activas asignadas al vehículo.

Hay algunos casos en los que es posible que este campo no se use para propagar Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • El extremo de currentRouteSegment no coincide con DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) ni DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • La app del controlador no actualizó su ubicación recientemente, por lo que es posible que el último valor actualizado de este campo esté inactivo.

  • La app del conductor actualizó su ubicación recientemente, pero la currentRouteSegment está inactiva y apunta a una parada anterior del vehículo.

En estos casos, Fleet Engine propaga este campo con una ruta desde la última versión de VehicleStop que se pasó a la próxima VehicleStop para garantizar que el consumidor de este campo tenga la mejor información disponible sobre la ruta actual del vehículo de entrega.

String codificada en base64.
currentRouteSegmentEndPoint

object (LatLng)

La ubicación donde termina el currentRouteSegment. Actualmente, la app del controlador no propaga esto, pero puedes proporcionarlo en las llamadas de deliveryVehicles.patch. Es el LatLng de la próxima parada del vehículo o el último LatLng de la currentRouteSegment. Luego, Fleet Engine hará lo posible para interpolar un VehicleStop real.

Este campo se ignora en las llamadas a deliveryVehicles.patch si el campo currentRouteSegment está vacío.
remainingDistanceMeters

integer

La distancia en automóvil restante para el currentRouteSegment. Por lo general, la app de Driver proporciona este campo, pero hay algunas circunstancias en las que Fleet Engine anulará el valor que envía la app. Para obtener más información, consulta DeliveryVehicle.current_route_segment. Este campo se muestra en Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) para todos los Task activos asignados al vehículo de entrega.

Fleet Engine ignorará este campo en UpdateDeliveryVehicleRequest si el campo currentRouteSegment está vacío.
remainingDuration

string (Duration format)

El tiempo de viaje restante del currentRouteSegment. Por lo general, la app de Driver proporciona este campo, pero hay algunas circunstancias en las que Fleet Engine anulará el valor que envía la app. Para obtener más información, consulta DeliveryVehicle.current_route_segment. Este campo se devuelve en Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDuration (REST) para todas las tareas activas asignadas al vehículo de entrega.

Fleet Engine ignorará este campo en UpdateDeliveryVehicleRequest si el campo currentRouteSegment está vacío.

Es una duración en segundos con hasta nueve dígitos decimales que termina en "s". Ejemplo: "3.5s".
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Son los segmentos del recorrido asignados a este vehículo de entrega, comenzando por la ubicación más reciente del vehículo. Este campo no se propagará en la respuesta de deliveryVehicles.list.
attributes[]

object (DeliveryVehicleAttribute)

Una lista de atributos personalizados de vehículos de entrega. Un vehículo de entrega puede tener 100 atributos como máximo, y cada uno debe tener una clave única.
type

enum (DeliveryVehicleType)

Es el tipo de este vehículo de entregas. Si no la estableces, el valor predeterminado será AUTO.

DeliveryVehicleNavigationStatus

El estado de navegación del vehículo.

Enumeradores
UNKNOWN_NAVIGATION_STATUS No se especificó el estado de la navegación.
NO_GUIDANCE La navegación de la app de Driver está en modo FREE_NAV.
ENROUTE_TO_DESTINATION La navegación paso a paso está disponible y la navegación de la app para conductores ingresó al modo GUIDED_NAV.
OFF_ROUTE El vehículo se desvió de la ruta sugerida.
ARRIVED_AT_DESTINATION El vehículo se encuentra a unos 50 m del destino aproximadamente.

DeliveryVehicleAttribute

Describe un atributo de vehículo como un par clave-valor. La longitud de la string "key:value" no puede superar los 256 caracteres.

Representación JSON 
{
  "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.
}
Campos
key

string

La clave del atributo.
value

string

El valor del atributo.
Campo de unión delivery_vehicle_attribute_value. El valor del atributo puede ser de tipo string, bool o doble. Las direcciones (delivery_vehicle_attribute_value) solo pueden ser una de las siguientes opciones:
stringValue

string

Valor del atributo escrito en cadena.

Nota: Este valor es idéntico al campo value, que con el tiempo dejará de estar disponible. Para los métodos de creación o actualización, se puede usar cualquiera de los campos, pero se recomienda usar stringValue. Si se configuran stringValue y value, deben ser idénticos; de lo contrario, se generará un error. Ambos campos se propagan en las respuestas.
boolValue

boolean

Valor de atributo de tipo booleano.
numberValue

number

Valor de atributo de doble tipo.

DeliveryVehicleType

Indica el tipo de vehículo de entrega.

Enumeradores
DELIVERY_VEHICLE_TYPE_UNSPECIFIED El valor no está en uso.
AUTO Un automóvil.
TWO_WHEELER Una motocicleta, un ciclomotor o cualquier otro vehículo de dos ruedas
BICYCLE Transporte impulsado por seres humanos.
PEDESTRIAN Un transportador de personas que, por lo general, camina o corre a lo largo de caminos peatonales.

Métodos

create

 Crea y muestra un DeliveryVehicle nuevo.

get

 Muestra la instancia DeliveryVehicle especificada.

list

 Obtiene todos los DeliveryVehicle que cumplen con los criterios de filtrado especificados.

patch

 Escribe datos actualizados de DeliveryVehicle en Fleet Engine y asigna Tasks a DeliveryVehicle.