REST Resource: providers.deliveryVehicles

Recurso: DeliveryVehicle

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

Nota: gRPC y las APIs de REST usan convenciones de nomenclatura de campo 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

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

object (DeliveryVehicleLocation)

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

enum (DeliveryVehicleNavigationStatus)

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 para conductores la actualiza cuando se alcanza o pasa una parada, y cuando se redirige la navegación. 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 este campo podría no usarse 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) o DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • La app del controlador no actualizó su ubicación recientemente, por lo que el valor de la última actualización de este campo podría estar 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 completa este campo con una ruta desde la VehicleStop que pasó más recientemente hasta la VehicleStop que pasó 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 objeto currentRouteSegment. Actualmente, la app del controlador no propaga esta información, pero puedes proporcionarla en las llamadas de deliveryVehicles.patch. Es el LatLng de la próxima parada del vehículo o el último LatLng del currentRouteSegment. Fleet Engine hará todo lo posible para interpolar a 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. La aplicación del controlador generalmente proporciona este campo, pero hay algunas circunstancias en las que Fleet Engine anulará el valor que envía la aplicación. 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 ignora este campo en UpdateDeliveryVehicleRequest si el campo currentRouteSegment está vacío.
remainingDuration

string (Duration format)

Tiempo de conducción restante: currentRouteSegment. La aplicación del controlador generalmente proporciona este campo, pero hay algunas circunstancias en las que Fleet Engine anulará el valor que envía la aplicación. Para obtener más información, consulta DeliveryVehicle.current_route_segment. Este campo se muestra 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 ignora este campo en UpdateDeliveryVehicleRequest si el campo currentRouteSegment está vacío.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Los segmentos de recorrido asignados a este vehículo de entrega, a partir de la ubicación informada 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 atributo debe tener una clave única.
type

enum (DeliveryVehicleType)

El tipo de este vehículo de entrega. Si no la estableces, la configuración predeterminada será AUTO.

DeliveryVehicleNavigationStatus

El estado de navegación del vehículo.

Enumeraciones
UNKNOWN_NAVIGATION_STATUS Estado de navegación no especificado.
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 de Driver 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.

DeliveryVehicleAttribute

Describe un atributo de vehículo como un par clave-valor. La función “key:value” la longitud de la cadena 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

Es el valor del atributo.
Campo de unión delivery_vehicle_attribute_value. El valor del atributo puede estar en cadena, en booleano o en tipo doble. Las direcciones (delivery_vehicle_attribute_value) solo pueden ser una de las siguientes opciones:
stringValue

string

Valor del atributo de tipo de cadena.

Nota: Es idéntico al campo value, que eventualmente dejará de estar disponible. Para los métodos de creación o actualización, se puede usar cualquier campo, pero es muy recomendable usar stringValue. Si se configuran stringValue y value, deben ser idénticos; de lo contrario, se mostrará 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

El tipo de vehículo de entrega.

Enumeraciones
DELIVERY_VEHICLE_TYPE_UNSPECIFIED El valor no está en uso.
AUTO Un automóvil
TWO_WHEELER Una motocicleta, ciclomotor y otro vehículo de dos ruedas
BICYCLE Transporte impulsado por personas.
PEDESTRIAN Un transportador humano, generalmente caminando o corriendo, que viaja por senderos 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 de DeliveryVehicle actualizados en Fleet Engine y asigna Tasks al DeliveryVehicle.