Package maps.fleetengine.delivery.v1

Index

DeliveryService

Le service Last Mile Delivery.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Crée et renvoie un lot de nouveaux objets Task.
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

Crée et affiche un objet DeliveryVehicle.
CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Crée et affiche un objet Task.
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Renvoie l'instance DeliveryVehicle spécifiée.
GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Récupère des informations sur un Task.
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Renvoie l'instance TaskTrackingInfo spécifiée.
ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

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

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Récupère tous les Task qui correspondent aux critères de filtrage spécifiés.
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Écrit les données DeliveryVehicle mises à jour dans Fleet Engine et attribue Tasks au DeliveryVehicle. Vous ne pouvez pas mettre à jour le nom de DeliveryVehicle. Vous pouvez mettre à jour remaining_vehicle_journey_segments, mais il doit contenir tous les VehicleJourneySegment pour être conservés sur DeliveryVehicle. Les task_id sont récupérés à partir de remaining_vehicle_journey_segments, et leurs Tasks correspondants sont attribués au DeliveryVehicle s'ils n'ont pas encore été attribués.
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Met à jour les données Task.

BatchCreateTasksRequest

Le message de requête BatchCreateTask.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery. Remarque: Si vous définissez ce champ, le champ d'en-tête des messages CreateTaskRequest doit être vide ou correspondre à ce champ.
parent

string

Obligatoire. Ressource parente partagée par toutes les tâches. Cette valeur doit être au format providers/{provider}. provider doit correspondre à l'ID du projet Google Cloud. Exemple : sample-cloud-project. Le champ parent dans les messages CreateTaskRequest doit être vide ou correspondre à ce champ.
requests[]

CreateTaskRequest

Obligatoire. Message de requête spécifiant les ressources à créer. Remarque: Vous pouvez créer un maximum de 500 tâches par lot.

BatchCreateTasksResponse

Le message de réponse BatchCreateTask

Champs
tasks[]

Task

Tâches créées.

CreateDeliveryVehicleRequest

Le message de requête CreateDeliveryVehicle.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. Le fournisseur doit être l'ID du projet Google Cloud. Exemple :sample-cloud-project
delivery_vehicle_id

string

Obligatoire. L'ID du véhicule de livraison doit être unique et soumis aux restrictions suivantes:

  • Veuillez saisir une chaîne Unicode valide.
  • Ne doit pas dépasser 64 caractères.
  • Normalisée selon le formulaire C de normalisation Unicode.
  • Ne doit pas contenir les caractères ASCII suivants : "/", ":", "?", "," ou "#".
delivery_vehicle

DeliveryVehicle

Obligatoire. L'entité DeliveryVehicle à créer. Lorsque vous créez un véhicule de livraison, vous pouvez définir les champs facultatifs suivants:

  • type
  • last_location
  • attributs

Remarque: Le champ name du véhicule de livraison est ignoré. Aucun autre champ de véhicule de livraison ne doit être défini. sinon une erreur est renvoyée.

CreateTaskRequest

Le message de requête CreateTask.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. provider doit correspondre à l'ID du projet Google Cloud. Exemple : sample-cloud-project.
task_id

string

Obligatoire. L'ID de la tâche doit être unique, mais il ne doit pas s'agir d'un ID de suivi du colis. Pour stocker un ID de suivi de livraison, utilisez le champ tracking_id. Notez que plusieurs tâches peuvent avoir le même tracking_id. Les ID de tâche sont soumis aux restrictions suivantes:

  • Veuillez saisir une chaîne Unicode valide.
  • Ne doit pas dépasser 64 caractères.
  • Normalisée selon le formulaire C de normalisation Unicode.
  • Ne doit pas contenir les caractères ASCII suivants : "/", ":", "?", "," ou "#".
task

Task

Obligatoire. Entité Task à créer. Lors de la création d'une tâche, les champs suivants sont obligatoires:

  • type
  • state (doit être défini sur OPEN)
  • tracking_id (ne doit pas être défini pour les tâches UNAVAILABLE ou SCHEDULED_STOP, mais est obligatoire pour tous les autres types de tâches)
  • planned_location (facultatif pour UNAVAILABLE tâches)
  • task_duration

Remarque: Le champ name de la tâche est ignoré. Aucun autre champ de tâche ne doit être défini. sinon une erreur est renvoyée.

DeliveryRequestHeader

Un RequestHeader contient des champs communs à toutes les requêtes RPC de distribution.

Champs
language_code

string

Code de langue BCP-47, tel que en-US ou sr-Latn. Pour en savoir plus, consultez la page http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Si aucun nom n'est spécifié, la réponse peut être rédigée dans n'importe quelle langue, la langue de préférence étant l'anglais, le cas échéant. Exemple de valeur de champ: en-US.
region_code

string

Obligatoire. Code CLDR de la région d'origine de la requête. Exemple de valeur de champ: US.
sdk_version

string

Version du SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: 1.1.2.
os_version

string

Version du système d'exploitation sur lequel le SDK à l'origine de l'appel s'exécute. Exemples de valeurs de champ: 4.4.1, 12.1.
device_model

string

Modèle de l'appareil sur lequel le SDK appelant est exécuté. Exemples de valeurs de champ: iPhone12,1, SM-G920F.
sdk_type

SdkType

Type de SDK envoyant la requête.
maps_sdk_version

string

Version du MapSDK dont dépend le SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: 5.2.1.
nav_sdk_version

string

Version du NavSDK dont dépend le SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: 2.1.0.
platform

Platform

Plate-forme du SDK appelant.
manufacturer

string

Fabricant de l'appareil Android issu du SDK appelant (applicable uniquement aux SDK Android) Exemple de valeur de champ: Samsung.
android_api_level

int32

Niveau d'API Android du SDK appelant, applicable uniquement aux SDK Android. Exemple de valeur de champ: 23.
trace_id

string

ID facultatif qui peut être fourni à des fins de journalisation afin d'identifier la requête.

Plate-forme

Plate-forme du SDK appelant.

Enums
PLATFORM_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si la plate-forme est omise.
ANDROID La requête provient d'Android.
IOS La demande provient d'iOS.
WEB La requête provient du Web.

SdkType

Types de SDK possibles.

Enums
SDK_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si sdk_type est omis.
CONSUMER Le SDK appelant est Consumer.
DRIVER Le SDK qui est à l'origine de l'appel est Driver.
JAVASCRIPT Le SDK appelant est JavaScript.

DeliveryVehicle

Le message DeliveryVehicle Un véhicule de livraison transporte les envois d'un dépôt à un lieu de livraison, et d'un point de retrait au dépôt. Dans certains cas, les véhicules de livraison transportent également les colis directement du lieu d'enlèvement au lieu de livraison.

Remarque: Les API gRPC et REST utilisent des conventions d'attribution de noms de champs différentes. 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.

Champs
name

string

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

DeliveryVehicleLocation

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

DeliveryVehicleNavigationStatus

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

bytes

Polyligne encodée spécifiant l'itinéraire que la navigation recommande d'emprunter pour atteindre le point de cheminement suivant. L'application du conducteur met à jour cette information lorsqu'un arrêt est atteint ou franchi, et lorsque la navigation change d'itinéraire. Ces LatLngs 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 peut ne 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 current_route_segment ne correspond pas à DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) ni à DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

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

  • L'application du conducteur a récemment mis à jour sa position, mais le current_route_segment 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 allant du VehicleStop le plus récemment transmis au prochain VehicleStop afin de s'assurer que le consommateur de ce champ dispose des meilleures informations disponibles sur le trajet actuel du véhicule de livraison.
current_route_segment_end_point

LatLng

Emplacement où se termine le current_route_segment. Actuellement, ce champ n'est pas renseigné par l'application pilote, mais vous pouvez le fournir lors des appels UpdateDeliveryVehicle. Il s'agit soit du LatLng de l'arrêt à venir du véhicule, soit du dernier LatLng de current_route_segment. Fleet Engine fera alors de son mieux pour interpoler un VehicleStop réel.

Ce champ est ignoré dans les appels UpdateDeliveryVehicle si le champ current_route_segment est vide.
remaining_distance_meters

Int32Value

Distance en voiture restante pour le current_route_segment. L'application Conducteur 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 current_route_segment est vide.
remaining_duration

Duration

Temps de trajet restant pour le current_route_segment. L'application Conducteur 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_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 current_route_segment est vide.
remaining_vehicle_journey_segments[]

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 ListDeliveryVehicles.
attributes[]

DeliveryVehicleAttribute

Liste d'attributs personnalisés de véhicule de livraison. Un véhicule de livraison ne peut pas comporter plus de 100 attributs, chacun d'entre eux doit avoir une clé unique.
type

DeliveryVehicleType

Type de ce véhicule de livraison. Si cette règle n'est pas configurée, la valeur par défaut est AUTO.

DeliveryVehicleType

Type de véhicule de livraison.

Enums
DELIVERY_VEHICLE_TYPE_UNSPECIFIED La valeur n'est pas utilisée.
AUTO Une voiture.
TWO_WHEELER Une moto, une cyclomoteur ou un autre véhicule à deux roues
BICYCLE Transport à énergie humaine
PEDESTRIAN Transporteur humain, généralement marchant ou courant, empruntant des voies piétonnes.

DeliveryVehicleAttribute

Décrit un attribut de véhicule en tant que paire clé-valeur. La valeur "key:value" La chaîne ne doit pas dépasser 256 caractères.

Champs
key

string

Clé de l'attribut.
value

string

Valeur de l'attribut.
Champ d'union delivery_vehicle_attribute_value. Valeur de l'attribut. Elle peut être de type "string", "bool" ou "double". delivery_vehicle_attribute_value ne peut être qu'un des éléments suivants :
string_value

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 string_value. Si string_value et value sont tous deux définis, ils doivent être identiques, sinon une erreur sera générée. Les deux champs sont renseignés dans les réponses.
bool_value

bool

Valeur d'attribut de type booléen.
number_value

double

Valeur d'attribut saisie en double.

DeliveryVehicleLocation

L'emplacement, la vitesse et la direction d'un véhicule à un moment précis.

Champs
location

LatLng

Emplacement du véhicule. Lorsqu'il est envoyé à Fleet Engine, la position du véhicule correspond à une position GPS. Lorsque vous le recevez en réponse, la position du véhicule peut être une position GPS, une position supplémentaire ou toute autre position estimée. La source est spécifiée dans location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

Obsolète: utilisez plutôt latlng_accuracy.
latlng_accuracy

DoubleValue

Précision de location en mètres sous la forme d'un rayon.
heading

Int32Value

Direction du véhicule en degrés. 0 représente le nord. La plage valide est [0,360).
bearing_accuracy
(deprecated)

DoubleValue

Obsolète: utilisez plutôt heading_accuracy.
heading_accuracy

DoubleValue

Précision de heading en degrés.
altitude

DoubleValue

Altitude en mètres au-dessus de WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Obsolète: utilisez plutôt altitude_accuracy.
altitude_accuracy

DoubleValue

Précision de altitude en mètres.
speed_kmph
(deprecated)

Int32Value

Vitesse du véhicule en kilomètres par heure. Obsolète: utilisez plutôt speed.
speed

DoubleValue

Vitesse du véhicule en mètres/seconde
speed_accuracy

DoubleValue

Précision de speed en mètres/seconde.
update_time

Timestamp

Heure à laquelle location a été signalé par le capteur selon l'horloge du capteur.
server_time

Timestamp

Uniquement en sortie. Heure à laquelle le serveur a reçu les informations de localisation.
location_sensor

DeliveryVehicleLocationSensor

Fournisseur des données de localisation (par exemple, GPS).
is_road_snapped

BoolValue

Indique si location est aligné sur une route.
is_gps_sensor_enabled

BoolValue

Uniquement en entrée. Indique si le capteur GPS est activé sur l'appareil mobile.
time_since_update

Int32Value

Uniquement en entrée. Temps écoulé (en secondes) depuis l'envoi de la première position au serveur. Ce sera zéro pour la première mise à jour. Si l'heure n'est pas connue (lorsque l'application redémarre, par exemple), cette valeur est réinitialisée.
num_stale_updates
(deprecated)

Int32Value

Uniquement en entrée. Obsolète: d'autres signaux sont désormais utilisés pour déterminer si un établissement est obsolète.
raw_location

LatLng

Localisation brute du véhicule (non traitée par la capture de route).
raw_location_time

Timestamp

Horodatage associé à l'emplacement brut.
raw_location_sensor

DeliveryVehicleLocationSensor

Source de l'emplacement brut. La valeur par défaut est GPS.
raw_location_accuracy

DoubleValue

Précision de raw_location en tant que rayon, en mètres.
supplemental_location

LatLng

Emplacement supplémentaire fourni par l'application d'intégration.
supplemental_location_time

Timestamp

Code temporel associé à l'emplacement supplémentaire.
supplemental_location_sensor

DeliveryVehicleLocationSensor

Source de l'emplacement supplémentaire. La valeur par défaut est CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

Précision de supplemental_location en tant que rayon, en mètres.
road_snapped
(deprecated)

bool

Obsolète: utilisez plutôt is_road_snapped.

DeliveryVehicleLocationSensor

Capteur ou méthodologie permettant de déterminer la position.

Enums
UNKNOWN_SENSOR Le capteur n'est pas spécifié ou est inconnu.
GPS GPS ou GPS assisté.
NETWORK GPS assisté, identifiant d'antenne-relais ou point d'accès Wi-Fi.
PASSIVE ID de l'antenne-relais ou point d'accès Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Position déterminée par l'appareil mobile comme étant la position la plus probable sur la route.
CUSTOMER_SUPPLIED_LOCATION Emplacement fourni par le client à partir d'une source indépendante. En règle générale, cette valeur est utilisée pour un emplacement fourni à partir de sources autres que l'appareil mobile exécutant le SDK Driver. Si la source d'origine est décrite par l'une des autres valeurs d'énumération, utilisez cette valeur. Les emplacements marqués CUSTOMER_SUPPLIED_LOCATION sont généralement fournis via le last_location.supplemental_location_sensor d'un véhicule de livraison.
FLEET_ENGINE_LOCATION Emplacement calculé par Fleet Engine en fonction des signaux à sa disposition. Uniquement en sortie. Cette valeur sera refusée si elle est reçue dans une requête.
FUSED_LOCATION_PROVIDER Fused Location Provider d'Android.
CORE_LOCATION Fournisseur de services de localisation sur les systèmes d'exploitation Apple.

DeliveryVehicleNavigationStatus

État de navigation du véhicule.

Enums
UNKNOWN_NAVIGATION_STATUS État de navigation non spécifié.
NO_GUIDANCE La navigation de l'application Conducteur 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 à moins de 50 m de la destination.

GetDeliveryVehicleRequest

Le message de requête GetDeliveryVehicle.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/deliveryVehicles/{delivery_vehicle}. provider doit correspondre à l'ID du projet Google Cloud. Exemple : sample-cloud-project.

GetTaskRequest

Le message de requête GetTask.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/tasks/{task}. provider doit correspondre à l'ID du projet Google Cloud. Exemple : sample-cloud-project.

GetTaskTrackingInfoRequest

Le message de requête GetTaskTrackingInfoRequest.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/taskTrackingInfo/{tracking_id}. provider doit correspondre à l'ID du projet Google Cloud et tracking_id à l'ID de suivi associé à la tâche. Exemple de nom possible : providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

Le message de requête ListDeliveryVehicles.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. provider doit correspondre à l'ID du projet Google Cloud. Exemple : sample-cloud-project.
page_size

int32

Facultatif. Nombre maximal de véhicules à renvoyer. Le service peut renvoyer moins que ce nombre. Si vous ne spécifiez pas ce nombre, le serveur détermine le nombre de résultats à renvoyer.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListDeliveryVehicles précédent. Vous devez fournir cette information pour pouvoir récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListDeliveryVehicles doivent correspondre à l'appel ayant fourni le jeton de page.
filter

string

Facultatif. Requête de filtre à appliquer lorsque vous listez les véhicules de livraison. Consultez la page http://aip.dev/160 pour obtenir des exemples de syntaxe de filtre. Si vous ne spécifiez pas de valeur ou si vous spécifiez une chaîne vide pour le filtre, tous les véhicules de livraison sont renvoyés.

Notez que les seules requêtes acceptées pour ListDeliveryVehicles concernent les attributs du véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). De plus, tous les attributs sont stockés sous forme de chaînes. Par conséquent, les seules comparaisons acceptées par rapport aux attributs sont les comparaisons de chaînes. Pour effectuer une comparaison avec des valeurs numériques ou booléennes, les valeurs doivent être explicitement placées entre guillemets pour être traitées comme des chaînes (par exemple, attributes.<key> = "10" ou attributes.<key> = "true").

Le nombre maximal de restrictions autorisé dans une requête de filtre est de 50. Une restriction fait partie de la requête sous la forme attribute.<KEY> <COMPARATOR> <VALUE>. Par exemple, attributes.foo = bar correspond à 1 restriction.
viewport

Viewport

Facultatif. Filtre qui limite les véhicules renvoyés à ceux dont la dernière position connue se trouvait dans la zone rectangulaire définie par la fenêtre d'affichage.

ListDeliveryVehiclesResponse

Le message de réponse ListDeliveryVehicles

Champs
delivery_vehicles[]

DeliveryVehicle

Ensemble des véhicules de livraison qui répondent aux critères de filtrage demandés. Si aucun filtre n'est spécifié, la requête renvoie tous les véhicules de livraison. Une réponse positive peut également être vide. Une réponse vide indique qu'aucun véhicule de livraison ne répond aux critères de filtrage demandés.
next_page_token

string

Vous pouvez transmettre ce jeton dans ListDeliveryVehiclesRequest pour continuer à répertorier les résultats. Lorsque tous les résultats sont renvoyés, ce champ ne figure pas dans la réponse ou il s'agit d'une chaîne vide.
total_size

int64

Nombre total de véhicules de livraison correspondant aux critères de la demande, sur l'ensemble des pages.

ListTasksRequest

Le message de requête ListTasks.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. provider doit correspondre à l'ID du projet Google Cloud. Exemple : sample-cloud-project.
page_size

int32

Facultatif. Nombre maximal de tâches à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si vous ne spécifiez pas cette valeur, le serveur détermine le nombre de résultats à renvoyer.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListTasks précédent. Vous pouvez l'indiquer pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListTasks doivent correspondre à l'appel ayant fourni le jeton de page.
filter

string

Facultatif. Requête de filtre à appliquer lors de la liste des tâches. Consultez la page http://aip.dev/160 pour obtenir des exemples de syntaxe de filtre. Si vous ne spécifiez pas de valeur ou si vous filtrez sur une chaîne vide, toutes les tâches sont renvoyées. Pour en savoir plus sur les propriétés des tâches pouvant être filtrées, consultez Répertorier les tâches.

ListTasksResponse

Réponse ListTasks contenant l'ensemble des tâches qui répondent aux critères de filtre de ListTasksRequest.

Champs
tasks[]

Task

Ensemble des tâches qui répondent aux critères de filtrage demandés. Si aucun filtre n'est spécifié, la requête renvoie toutes les tâches. Une réponse positive peut également être vide. Une réponse vide indique qu'aucune tâche ne correspond aux critères de filtrage demandés.
next_page_token

string

Transmettez ce jeton dans ListTasksRequest pour continuer à répertorier les résultats. Si tous les résultats ont été renvoyés, ce champ est une chaîne vide ou n'apparaît pas dans la réponse.
total_size

int64

Nombre total de tâches correspondant aux critères de la demande, sur l'ensemble des pages.

LocationInfo

Un établissement avec des identifiants supplémentaires.

Champs
point

LatLng

Coordonnées du lieu

Tâche

Une tâche dans l'API Delivery représente une action unique à suivre. En général, il existe une distinction entre les tâches liées à l'expédition et les tâches de rupture. Un envoi peut être associé à plusieurs tâches. Par exemple, il peut y avoir une tâche pour la prise en charge et une pour le dépôt ou la correspondance. De plus, différentes tâches pour une livraison donnée peuvent être gérées par différents véhicules. Par exemple, un véhicule peut prendre en charge le retrait, conduisant la livraison au centre, tandis qu'un autre véhicule la même livraison du hub au point de dépôt.

Remarque: Les API gRPC et REST utilisent des conventions d'attribution de noms de champs différentes. Par exemple, le champ Task.journey_sharing_info de l'API gRPC et le champ Task.journeySharingInfo de l'API REST font référence au même champ.

Champs
name

string

Doit se présenter sous la forme providers/{provider}/tasks/{task}.
type

Type

Obligatoire. Immuable. Définit le type de la tâche. Par exemple, une rupture ou une livraison.
state

State

Obligatoire. État actuel de l'exécution de la tâche.
task_outcome

TaskOutcome

Le résultat de la tâche
task_outcome_time

Timestamp

Code temporel qui indique quand le résultat de l'Task a été défini par le fournisseur.
task_outcome_location

LocationInfo

Emplacement où le résultat de Task a été défini. Cette valeur est mise à jour dans UpdateTask. Si cette valeur n'est pas explicitement mise à jour par le fournisseur, Fleet Engine la renseigne par défaut avec la dernière position connue du véhicule (la position brute).
task_outcome_location_source

TaskOutcomeLocationSource

Indique d'où provient la valeur de task_outcome_location.
tracking_id

string

Immuable. Ce champ facilite le stockage d'un identifiant afin d'éviter d'utiliser un mappage compliqué. Vous ne pouvez pas définir tracking_id pour les tâches de type UNAVAILABLE et SCHEDULED_STOP. Ces identifiants sont soumis aux restrictions suivantes:

  • Veuillez saisir une chaîne Unicode valide.
  • Ne doit pas dépasser 64 caractères.
  • Normalisée selon le formulaire C de normalisation Unicode.
  • Ne doit pas contenir les caractères ASCII suivants : "/", ":", "?", "," ou "#".
delivery_vehicle_id

string

Uniquement en sortie. ID du véhicule qui exécute la tâche. Les identifiants des véhicules de livraison sont soumis aux restrictions suivantes:

  • Veuillez saisir une chaîne Unicode valide.
  • Ne doit pas dépasser 64 caractères.
  • Normalisée selon le formulaire C de normalisation Unicode.
  • Ne doit pas contenir les caractères ASCII suivants : "/", ":", "?", "," ou "#".
planned_location

LocationInfo

Immuable. Le lieu où la tâche sera effectuée. Facultatif pour UNAVAILABLE Tasks, mais obligatoire pour toutes les autres tâches.
task_duration

Duration

Obligatoire. Immuable. Temps nécessaire pour exécuter une tâche à cet emplacement.
target_time_window

TimeWindow

La période pendant laquelle la tâche doit être terminée.
journey_sharing_info

JourneySharingInfo

Uniquement en sortie. Champs spécifiques au partage de parcours. Non renseigné lorsque l'état est CLOSED.
task_tracking_view_config

TaskTrackingViewConfig

Configuration du suivi des tâches qui spécifie quels éléments de données sont visibles par les utilisateurs finaux et dans quelles circonstances.
attributes[]

TaskAttribute

Liste d'attributs de tâche personnalisés. Chaque attribut doit avoir une clé unique.

JourneySharingInfo

Champs spécifiques pour le partage du parcours.

Champs
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Informations de suivi des arrêts effectués par le véhicule attribué avant d'effectuer cette tâche. Notez que cette liste peut contenir des arrêts associés à d'autres tâches.

Le premier segment, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), contient des informations sur l'itinéraire depuis la dernière position connue du conducteur jusqu'au prochain VehicleStop. Les informations sur l'itinéraire actuel proviennent généralement de l'application du pilote, sauf dans certains cas mentionnés dans la documentation concernant DeliveryVehicle.current_route_segment. Les autres segments dans Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments (REST) sont renseignés par Fleet Engine. Elles fournissent des informations sur l'itinéraire entre les VehicleStops restants.
last_location

DeliveryVehicleLocation

Indique la dernière position signalée du véhicule attribué.
last_location_snappable

bool

Indique si le lastLocation du véhicule peut être ancré au current_route_segment. Cette valeur est "False" si last_location ou current_route_segment n'existent pas. Cette valeur est calculée par Fleet Engine. Les mises à jour des clients sont ignorées.

État

État d'une tâche. Cela indique la progression de la tâche.

Enums
STATE_UNSPECIFIED Par défaut. Utilisé pour un état de tâche non spécifié ou non reconnu.
OPEN Soit la tâche n'a pas encore été attribuée à un véhicule de livraison, soit celui-ci n'a pas encore dépassé l'arrêt associé à l'élément Task.
CLOSED Lorsque le véhicule passe à l'arrêt pour cette tâche.

TaskOutcome

Le résultat d'une tentative d'exécution d'une tâche. Lorsque TaskState est fermé, TaskOutcome indique s'il a bien été effectué.

Enums
TASK_OUTCOME_UNSPECIFIED Le résultat de la tâche avant sa valeur.
SUCCEEDED La tâche a bien été exécutée.
FAILED Soit la tâche n'a pas pu être terminée, soit elle a été annulée.

TaskOutcomeLocationSource

Identité de la source qui a renseigné le task_outcome_location.

Enums
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Le résultat de la tâche avant qu'il ne soit défini.
PROVIDER task_outcome_location spécifié par le fournisseur.
LAST_VEHICLE_LOCATION Le fournisseur n'a pas spécifié le task_outcome_location. Fleet Engine a donc utilisé la dernière position connue du véhicule.

Type

Type de tâche.

Enums
TYPE_UNSPECIFIED Le type de tâche est inconnu par défaut.
PICKUP Une tâche de retrait est l'action effectuée pour récupérer un colis chez un client. Les ramassage des véhicules en dépôt ou en borne doivent utiliser le type SCHEDULED_STOP.
DELIVERY Une tâche de livraison est l'action entreprise pour livrer un envoi à un client final. Les dépôts de véhicules dans un dépôt ou une ligne de dépôt doivent utiliser le type SCHEDULED_STOP.
SCHEDULED_STOP Une tâche d'arrêt programmé est utilisée à des fins de planification. Par exemple, il peut s'agir de la collecte ou du dépose de colis depuis des véhicules de recharge ou des dépôts. Vous ne devez pas l'utiliser pour les envois récupérés ou déposés chez un client final.
UNAVAILABLE Tâche indiquant que le véhicule n'est pas disponible pour réparation. Cela peut se produire lorsque le conducteur fait une pause ou lorsque le véhicule est en cours de ravitaillement.

TaskAttribute

Décrit un attribut de tâche en tant que paire clé-valeur. La valeur "key:value" La chaîne ne doit pas dépasser 256 caractères.

Champs
key

string

Clé de l'attribut. Les clés ne doivent pas contenir le caractère deux-points (:).
Champ d'union task_attribute_value. Valeur de l'attribut. Elle peut être de type "string", "bool" ou "double". Si aucune valeur n'est définie, la chaîne "string_value" de l'attribut TaskAttribute sera stockée en tant que chaîne vide "". task_attribute_value ne peut être que l'un des éléments suivants:
string_value

string

Valeur d'attribut de type chaîne.
bool_value

bool

Valeur d'attribut de type booléen.
number_value

double

Valeur d'attribut saisie en double.

TaskTrackingInfo

Le message TaskTrackingInfo Le message contient des informations de suivi des tâches qui seront utilisées pour l'affichage. Si un ID de suivi est associé à plusieurs tâches, Fleet Engine utilise une heuristique pour décider quelle tâche TaskTrackingInfo sélectionner.

Champs
name

string

Doit être au format providers/{provider}/taskTrackingInfo/{tracking}, où tracking représente l'ID de suivi.
tracking_id

string

Immuable. ID de suivi d'une tâche. * La chaîne doit être une chaîne Unicode valide. * Il ne doit pas dépasser 64 caractères. * Normalisée selon le format Unicode Normalization Form C. * Ne doit pas contenir les caractères ASCII suivants : "/", ":", "?", "," ou "#".
vehicle_location

DeliveryVehicleLocation

Dernière position du véhicule.
route_polyline_points[]

LatLng

Liste de points qui, une fois connectés, forment une polyligne de l'itinéraire attendu du véhicule jusqu'au lieu de la tâche.
remaining_stop_count

Int32Value

Indique le nombre d'arrêts restants du véhicule jusqu'à l'arrêt de la tâche, y compris l'arrêt de la tâche. Par exemple, si le prochain arrêt du véhicule est l'arrêt de la tâche, la valeur est 1.
remaining_driving_distance_meters

Int32Value

Distance totale restante en mètres jusqu'au VehicleStop d'intérêt.
estimated_arrival_time

Timestamp

Horodatage indiquant l'heure d'arrivée estimée à l'emplacement de l'arrêt.
estimated_task_completion_time

Timestamp

Le code temporel qui indique l'heure d'achèvement estimée d'une tâche.
state

State

État actuel de l'exécution de la tâche.
task_outcome

TaskOutcome

Le résultat d'une tentative d'exécution d'une tâche.
task_outcome_time

Timestamp

Le code temporel qui indique quand le résultat de la tâche a été défini par le fournisseur.
planned_location

LocationInfo

Immuable. Le lieu où la tâche sera effectuée.
target_time_window

TimeWindow

La période pendant laquelle la tâche doit être terminée.
attributes[]

TaskAttribute

Attributs personnalisés définis sur la tâche.

TaskTrackingViewConfig

Message de configuration qui définit le moment où un élément de données d'une tâche doit être visible par les utilisateurs finaux.

Champs
route_polyline_points_visibility

VisibilityOption

Champ qui spécifie quand les points de la polyligne de l'itinéraire peuvent être visibles. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.
estimated_arrival_time_visibility

VisibilityOption

Champ qui indique quand l'heure d'arrivée estimée peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.
estimated_task_completion_time_visibility

VisibilityOption

Champ qui spécifie quand le temps d'exécution estimé de la tâche peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.
remaining_driving_distance_visibility

VisibilityOption

Champ qui spécifie à quel moment la distance de conduite restante peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.
remaining_stop_count_visibility

VisibilityOption

Champ qui indique quand le nombre d'arrêts restants peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.
vehicle_location_visibility

VisibilityOption

Champ qui spécifie quand la position du véhicule peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.

VisibilityOption

Message d'option qui définit le moment où un élément de données doit être visible par les utilisateurs finaux.

Champs
Champ d'union visibility_option. Option de visibilité spécifique choisie. visibility_option ne peut être qu'un des éléments suivants :
remaining_stop_count_threshold

int32

Les utilisateurs finaux peuvent voir cet élément de données si le nombre d'arrêts restants est inférieur ou égal au seuil restant (stop_stop_count_threshold).
duration_until_estimated_arrival_time_threshold

Duration

Cet élément de données est visible par les utilisateurs finaux si l'heure d'arrivée prévue à l'arrêt est inférieure ou égale à la durée définie.
remaining_driving_distance_meters_threshold

int32

Cet élément de données est visible par les utilisateurs finaux si la distance de conduite restante en mètres <= minimum_driving_distance_meters_threshold.
always

bool

S'il est défini sur "true", cet élément de données est toujours visible par les utilisateurs finaux sans seuil. Ce champ ne peut pas être défini sur "false".
never

bool

S'il est défini sur "true", cet élément de données est toujours masqué pour les utilisateurs finaux sans seuil. Ce champ ne peut pas être défini sur "false".

TimeWindow

Une période.

Champs
start_time

Timestamp

Obligatoire. Heure de début de la période (incluse).
end_time

Timestamp

Obligatoire. Heure de fin de la période (incluse).

UpdateDeliveryVehicleRequest

Le message de requête UpdateDeliveryVehicle.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
delivery_vehicle

DeliveryVehicle

Obligatoire. Mise à jour de l'entité DeliveryVehicle à appliquer. Remarque: Vous ne pouvez pas modifier le nom de DeliveryVehicle.
update_mask

FieldMask

Obligatoire. Masque de champ qui indique les champs DeliveryVehicle à mettre à jour. Notez que le masque "update_mask" doit contenir au moins un champ.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "remaining_vehicle_journey_segments"

UpdateTaskRequest

Le message de requête UpdateTask.

Champs
header

DeliveryRequestHeader

Facultatif. En-tête de requête standard de l'API Delivery.
task

Task

Obligatoire. Tâche associée à la mise à jour. Les champs suivants sont gérés par Fleet Engine. Ne les mettez pas à jour avec Task.update.

  • last_location.
  • last_location_snappable
  • name
  • remaining_vehicle_journey_segments
  • task_outcome_location_source.

Remarque: Une fois la valeur de task_outcome définie, vous ne pouvez plus la modifier.

Si la tâche a été attribuée à un véhicule de livraison, ne définissez pas l'état de la tâche sur CLOSED (FERMÉE) à l'aide de Task.update. À la place, supprimez le VehicleStop qui contient la tâche du véhicule de livraison, ce qui définit automatiquement l'état de la tâche sur CLOSED (FERMÉE).
update_mask

FieldMask

Obligatoire. Masque de champ qui indique les champs de tâche à mettre à jour. Remarque: update_mask doit contenir au moins un champ.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "task_outcome,task_outcome_time,task_outcome_location"

VehicleJourneySegment

Représente le segment de trajet d'un véhicule, entre son arrêt précédent et l'arrêt actuel. S'il s'agit du premier arrêt actif, il va de la position actuelle du véhicule à cet arrêt.

Champs
stop

VehicleStop

Spécifie l'emplacement de l'arrêt, ainsi que les Task associés à l'arrêt. Il est possible que certains champs du champ VehicleStop ne soient pas présents si ce segment de trajet fait partie de JourneySharingInfo.
driving_distance_meters

Int32Value

Uniquement en sortie. Distance de trajet entre l'arrêt précédent et cet arrêt. Si l'arrêt actuel est le premier arrêt de la liste des segments du trajet, le point de départ correspond à la position du véhicule enregistrée au moment où cet arrêt a été ajouté à la liste. Ce champ peut ne pas être présent si ce segment de parcours fait partie de JourneySharingInfo.
driving_duration

Duration

Uniquement en sortie. Temps de trajet entre l'arrêt précédent et cet arrêt. Si l'arrêt actuel est le premier arrêt de la liste des segments du trajet, le point de départ correspond à la position du véhicule enregistrée au moment où cet arrêt a été ajouté à la liste.

Si ce champ est défini dans le chemin Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) ou Task.remainingVehicleJourneySegments[0].drivingDuration (REST), il peut être renseigné avec la valeur de DeliveryVehicle.remaining_duration (gRPC) ou DeliveryVehicle.remainingDuration (REST). Cela indique la durée restante du trajet à partir de la dernière position connue de l'application de conduite plutôt que la durée de trajet de l'arrêt précédent.
path[]

LatLng

Uniquement en sortie. Trajet entre l'arrêt précédent et cet arrêt. Si l'arrêt actuel est le premier arrêt de la liste des segments du trajet, il s'agit du chemin entre la position actuelle du véhicule et cet arrêt au moment où l'arrêt a été ajouté à la liste. Ce champ peut ne pas être présent si ce segment de parcours fait partie de JourneySharingInfo.

Si ce champ est défini dans le chemin Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), il peut être renseigné avec les LatLng décodées à partir de DeliveryVehicle.current_route_segment (gRPC) ou de DeliveryVehicle.currentRouteSegment (REST). Vous obtenez ainsi le trajet en voiture à partir de la dernière position connue de l'application du conducteur, plutôt qu'à partir de l'arrêt précédent.

VehicleStop

Décrit un point où un véhicule s'arrête pour effectuer un ou plusieurs Task.

Champs
planned_location

LocationInfo

Obligatoire. Emplacement de l'arrêt. Notez que les lieux indiqués dans les Task ne correspondent peut-être pas exactement à ce lieu, mais ils se trouvent à une courte distance de celui-ci. Ce champ ne sera pas renseigné dans la réponse à un appel GetTask.
tasks[]

TaskInfo

Liste des Task à effectuer à cet arrêt. Ce champ ne sera pas renseigné dans la réponse à un appel GetTask.
state

State

État de VehicleStop. Ce champ ne sera pas renseigné dans la réponse à un appel GetTask.

État

État actuel d'un VehicleStop.

Enums
STATE_UNSPECIFIED Inconnu.
NEW Créé, mais pas le routage actif.
ENROUTE Attribué et routage actif.
ARRIVED Arrivé à l'arrêt. Part du principe que lorsque le véhicule emprunte les itinéraires vers le prochain arrêt, tous les arrêts précédents sont terminés.

TaskInfo

Informations supplémentaires sur la tâche effectuée à cet arrêt.

Champs
task_id

string

ID de la tâche. Ce champ ne sera pas renseigné dans la réponse à un appel GetTask. Les ID de tâche sont soumis aux restrictions suivantes:

  • Veuillez saisir une chaîne Unicode valide.
  • Ne doit pas dépasser 64 caractères.
  • Normalisée selon le formulaire C de normalisation Unicode.
  • Ne doit pas contenir les caractères ASCII suivants : "/", ":", "?", "," ou "#".
task_duration

Duration

Uniquement en sortie. Temps nécessaire à l'exécution de la tâche.
target_time_window

TimeWindow

Uniquement en sortie. La période pendant laquelle la tâche doit être terminée. Il n'est défini que dans la réponse à GetDeliveryVehicle.