REST Resource: providers.deliveryVehicles

Ressource: DeliveryVehicle

Message DeliveryVehicle. Un véhicule de livraison transporte les colis d'un dépôt à un lieu de livraison et d'un lieu de collecte à un dépôt. Dans certains cas, les véhicules de livraison transportent également les colis directement du lieu de collecte au lieu de livraison.

Remarque : Les API gRPC et REST utilisent différentes conventions de dénomination des champs. Par exemple, le champ DeliveryVehicle.current_route_segment de l'API gRPC et le champ DeliveryVehicle.currentRouteSegment de l'API REST font référence au même champ.

Représentation 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)
}
Champs
name

string

Nom unique de ce véhicule de livraison. Il a le format suivant : providers/{provider}/deliveryVehicles/{vehicle}.
lastLocation

object (DeliveryVehicleLocation)

Dernière position signalée du véhicule de livraison.
navigationStatus

enum (DeliveryVehicleNavigationStatus)

État de navigation du véhicule de livraison.
currentRouteSegment

string (bytes format)

Polyligne encodée spécifiant l'itinéraire que la navigation recommande d'emprunter pour atteindre le point de cheminement suivant. Votre application conducteur met à jour cette valeur lorsqu'un arrêt est atteint ou dépassé, et lorsque la navigation est redirigée. Ces LatLng sont renvoyés dans Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) pour toutes les tâches actives attribuées au véhicule.

Dans certains cas, ce champ ne peut pas être utilisé pour renseigner Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) :

  • Le point de terminaison de currentRouteSegment ne correspond pas à DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) ou DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • L'application du conducteur n'a pas mis à jour sa position récemment. La valeur de ce champ peut donc être obsolète.

  • L'application du conducteur a récemment mis à jour sa position, mais currentRouteSegment est obsolète et pointe vers un arrêt précédent du véhicule.

Dans ce cas, Fleet Engine renseigne ce champ avec un itinéraire entre le VehicleStop le plus récent et le prochain VehicleStop pour s'assurer que le consommateur de ce champ dispose des meilleures informations disponibles sur le trajet actuel du véhicule de livraison.

Chaîne encodée en base64.
currentRouteSegmentEndPoint

object (LatLng)

Emplacement où se termine l'currentRouteSegment. Ce champ n'est pas renseigné par l'application du conducteur pour le moment, mais vous pouvez le fournir lors des appels deliveryVehicles.patch. Il s'agit soit du LatLng de l'arrêt à venir du véhicule, soit du dernier LatLng de currentRouteSegment. Fleet Engine fera ensuite tout son possible pour interpoler une VehicleStop réelle.

Ce champ est ignoré dans les appels deliveryVehicles.patch si le champ currentRouteSegment est vide.
remainingDistanceMeters

integer

Distance restante à parcourir en voiture pour l'currentRouteSegment. L'application Driver fournit généralement ce champ, mais dans certains cas, Fleet Engine peut remplacer la valeur envoyée par l'application. Pour en savoir plus, consultez DeliveryVehicle.current_route_segment. Ce champ est renvoyé dans Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) ou Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) pour tous les Task actifs attribués au véhicule de livraison.

Fleet Engine ignore ce champ dans UpdateDeliveryVehicleRequest si le champ currentRouteSegment est vide.
remainingDuration

string (Duration format)

Temps de trajet restant pour l'currentRouteSegment. L'application Driver fournit généralement ce champ, mais dans certains cas, Fleet Engine remplace la valeur envoyée par l'application. Pour en savoir plus, consultez DeliveryVehicle.current_route_segment. Ce champ est renvoyé dans Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) ou Task.remainingVehicleJourneySegments[0].drivingDuration (REST) pour toutes les tâches actives attribuées au véhicule de livraison.

Fleet Engine ignore ce champ dans UpdateDeliveryVehicleRequest si le champ currentRouteSegment est vide.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Segments de parcours attribués à ce véhicule de livraison, à partir de la dernière position signalée du véhicule. Ce champ ne sera pas renseigné dans la réponse de deliveryVehicles.list.
attributes[]

object (DeliveryVehicleAttribute)

Liste des attributs personnalisés pour le véhicule de livraison. Un véhicule de livraison peut comporter au maximum 100 attributs, et chaque attribut doit avoir une clé unique.
type

enum (DeliveryVehicleType)

Type de véhicule de livraison. Si cette valeur n'est pas définie, la valeur par défaut est AUTO.

DeliveryVehicleNavigationStatus

État de navigation du véhicule.

Enums
UNKNOWN_NAVIGATION_STATUS État de navigation non spécifié.
NO_GUIDANCE La navigation de l'application Driver est en mode FREE_NAV.
ENROUTE_TO_DESTINATION La navigation détaillée est disponible et l'application de navigation de l'application Conducteur est passée en mode GUIDED_NAV.
OFF_ROUTE Le véhicule a quitté l'itinéraire suggéré.
ARRIVED_AT_DESTINATION Le véhicule se trouve à environ 50 m de la destination.

DeliveryVehicleAttribute

Décrit un attribut de véhicule sous la forme d'une paire clé-valeur. La longueur de la chaîne "clé:valeur" ne doit pas dépasser 256 caractères.

Représentation 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.
}
Champs
key

string

Clé de l'attribut.
value

string

Valeur de l'attribut.
Champ d'union delivery_vehicle_attribute_value. La valeur de l'attribut peut être de type chaîne, booléen ou double. delivery_vehicle_attribute_value ne peut être qu'un des éléments suivants :
stringValue

string

Valeur d'attribut de type chaîne.

Remarque : Ce champ est identique au champ value, qui sera à terme abandonné. Pour les méthodes de création ou de mise à jour, vous pouvez utiliser l'un ou l'autre des champs, mais nous vous recommandons vivement d'utiliser stringValue. Si stringValue et value sont définis, ils doivent être identiques, sinon une erreur sera générée. Les deux champs sont renseignés dans les réponses.
boolValue

boolean

Valeur d'attribut de type booléen.
numberValue

number

Valeur d'attribut à double type.

DeliveryVehicleType

Type de véhicule de livraison.

Enums
DELIVERY_VEHICLE_TYPE_UNSPECIFIED La valeur n'est pas utilisée.
AUTO Une automobile.
TWO_WHEELER Une moto, une cyclomoteur ou un autre véhicule à deux roues
BICYCLE Transport à propulsion humaine
PEDESTRIAN Transporteur humain, généralement à pied ou en courant, se déplaçant le long de voies piétonnes.

Méthodes

create

 Crée et affiche un DeliveryVehicle.

get

 Renvoie l'instance DeliveryVehicle spécifiée.

list

 Récupère tous les DeliveryVehicle qui répondent aux critères de filtrage spécifiés.

patch

 Écrit les données DeliveryVehicle mises à jour dans Fleet Engine et attribue Tasks à DeliveryVehicle.