Package maps.fleetengine.delivery.v1

Index

DeliveryService

Le service de livraison Last Mile.

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 renvoie un DeliveryVehicle.

CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Crée et renvoie 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.

SearchTasks

rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse)

Obsolète: utilisez plutôt GetTaskTrackingInfo.

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Écrit les données DeliveryVehicle mises à jour dans Fleet Engine et attribue Tasks à DeliveryVehicle. Vous ne pouvez pas modifier le nom de DeliveryVehicle. Vous pouvez mettre à jour remaining_vehicle_journey_segments, mais il doit contenir tous les VehicleJourneySegment actuellement sur DeliveryVehicle. Les task_id sont récupérés à partir de remaining_vehicle_journey_segments, et les Tasks correspondantes sont attribuées à 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 de l'API de livraison standard. 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 être l'ID du projet Google Cloud. Exemple :sample-cloud-project Le champ parent des messages CreateTaskRequest doit être vide ou correspondre à ce champ.

requests[]

CreateTaskRequest

Obligatoire. Message de requête qui spécifie les ressources à créer. Remarque: Vous pouvez créer jusqu'à 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 de l'API de livraison standard.

parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. Le fournisseur doit correspondre à 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:

  • Vous devez saisir une chaîne Unicode valide.
  • La longueur ne doit pas dépasser 64 caractères.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".
delivery_vehicle

DeliveryVehicle

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

  • last_location
  • attributs

Remarque: Le champ name du véhicule de livraison est ignoré. Tous les autres champs DeliveryVehicle ne doivent pas être définis. Sinon, une erreur est renvoyée.

CreateTaskRequest

Le message de requête CreateTask.

Champs
header

DeliveryRequestHeader

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

parent

string

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

task_id

string

Obligatoire. L'ID de tâche doit être unique, mais il ne doit pas s'agir d'un ID de suivi de livraison. 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:

  • Vous devez saisir une chaîne Unicode valide.
  • La longueur ne doit pas dépasser 64 caractères.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".
task

Task

Obligatoire. Entité "Tâche" à 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 obligatoire pour tous les autres types de tâches)
  • planned_location (facultatif pour les tâches UNAVAILABLE)
  • task_duration

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

DeliveryRequestHeader

"RequestHeader" contient des champs communs à toutes les requêtes RPC de diffusion.

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 des deux n'est spécifié, la réponse peut être rédigée dans n'importe quelle langue, avec une préférence pour l'anglais si un tel nom existe. 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 appelant est exécuté. Exemples de valeurs de champs: 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 champs: iPhone12,1, SM-G920F.

sdk_type

SdkType

Type de SDK qui envoie 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 à partir 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 pouvant ê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 requête 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 appelant est Driver.
JAVASCRIPT Le SDK appelant est JavaScript.

DeliveryVehicle

Le message DeliveryVehicle. Un véhicule de livraison transporte des envois d'un dépôt à un lieu de livraison, puis d'un lieu de retrait au dépôt. Dans certains cas, les véhicules de livraison transportent également les envois directement du lieu de retrait 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 la navigation du véhicule de livraison.

current_route_segment

bytes

Polyligne encodée spécifiant l'itinéraire que la navigation recommande de suivre pour accéder au point de cheminement suivant. L'application du conducteur se met à jour lorsqu'un arrêt est atteint ou dépassé, et lorsque la navigation change d'itinéraire. 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 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 pilote n'a pas mis à jour sa position récemment. La dernière valeur mise à jour pour ce champ peut donc ê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 du dernier VehicleStop passé à VehicleStop pour s'assurer que le consommateur de ce champ dispose des meilleures informations disponibles sur le parcours actuel du véhicule de livraison.

current_route_segment_end_point

LatLng

Emplacement où se termine current_route_segment. Ce champ n'est actuellement pas renseigné par l'application de pilote, mais vous pouvez l'indiquer pour les appels UpdateDeliveryVehicle. Il s'agit soit du LatLng de l'arrêt prochain du véhicule, soit du dernier LatLng du current_route_segment. Fleet Engine s'efforcera alors d'interpoler au mieux une valeur VehicleStop réelle.

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 Pilote 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_distance_meters (gRPC) ou Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) pour tous les éléments 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 Pilote 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 current_route_segment est vide.

remaining_vehicle_journey_segments[]

VehicleJourneySegment

Segments de trajet attribués à ce véhicule de livraison, à partir de sa dernière position enregistrée. Ce champ ne sera pas renseigné dans la réponse de ListDeliveryVehicles.

attributes[]

DeliveryVehicleAttribute

Liste d'attributs personnalisés pour le véhicule de livraison. Un véhicule de livraison ne peut pas comporter plus de 100 attributs, chacun d'entre eux devant être associé à 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 Moto, cyclomoteur ou autre véhicule à deux roues
BICYCLE Transport manuel.
PEDESTRIAN Transporteur humain, généralement en train de marcher ou de courir sur des chemins piétonniers.

DeliveryVehicleAttribute

Décrit un attribut de véhicule en tant que paire clé-valeur. La chaîne "key:value" ne peut 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. La valeur de l'attribut peut être de type chaîne, valeur booléenne ou double. delivery_vehicle_attribute_value ne peut être qu'un des éléments suivants :
string_value

string

Valeur d'attribut de 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 les deux définis, ils doivent être identiques, sans quoi une erreur est 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 de type double.

DeliveryVehicleLocation

Localisation, vitesse et direction d'un véhicule à un moment donné.

Champs
location

LatLng

L'emplacement du véhicule Lorsqu'il est envoyé à Fleet Engine, la position du véhicule est une position GPS. Lorsque vous le recevez dans une réponse, la position du véhicule peut être soit une position GPS, un lieu supplémentaire, soit une 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 forme de rayon

heading

Int32Value

Sens de circulation 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, sur la base de son horloge.

server_time

Timestamp

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

location_sensor

DeliveryVehicleLocationSensor

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

is_road_snapped

BoolValue

Indique si location est ancré à 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 (en secondes) écoulé depuis la première envoi de la position au serveur. Cette valeur est égale à zéro lors de 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

Emplacement brut du véhicule (non traité par l'outil de détection de la route).

raw_location_time

Timestamp

Code temporel 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 comme 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 comme rayon, en mètres.

road_snapped
(deprecated)

bool

Obsolète: utilisez plutôt is_road_snapped.

DeliveryVehicleLocationSensor

Capteur ou méthodologie utilisé pour 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é, identification d’antenne-relais ou point d’accès Wi-Fi.
PASSIVE ID d'antenne-relais ou point d'accès Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Emplacement déterminé par l'appareil mobile comme étant la position la plus probable sur la route.
CUSTOMER_SUPPLIED_LOCATION Site fourni par le client par une source indépendante. Généralement, cette valeur est utilisée pour un emplacement fourni à partir de sources autres que l'appareil mobile exécutant Driver SDK. Si la source originale est décrite par l'une des autres valeurs d'énumération, utilisez-la. Les lieux marqués CUSTOMER_SUPPLIED_LOCATION sont généralement indiqués 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 disponibles. 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 localisation sur les systèmes d'exploitation Apple.

DeliveryVehicleNavigationStatus

État de la 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 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 dans un rayon d'environ 50 mètres autour de la destination.

GetDeliveryVehicleRequest

Le message de requête GetDeliveryVehicle.

Champs
header

DeliveryRequestHeader

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

name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/deliveryVehicles/{delivery_vehicle}. provider doit être 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 de l'API de livraison standard.

name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/tasks/{task}. provider doit être 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 de l'API de livraison standard.

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 doit correspondre à l'ID de suivi associé à la tâche. Voici un exemple de nom : 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 de l'API de livraison standard.

parent

string

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

page_size

int32

Facultatif. Nombre maximal de véhicules à retourner. Le service peut renvoyer un nombre inférieur à cette valeur. 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 le fournir pour 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 de véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). De plus, comme tous les attributs sont stockés sous forme de chaînes, les seules comparaisons possibles avec les 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 en tant que chaînes (par exemple, attributes.<key> = "10" ou attributes.<key> = "true").

Le nombre maximal de restrictions autorisées 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.

viewport

Viewport

Facultatif. Un 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 correspond 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 est une chaîne vide.

total_size

int64

Nombre total de véhicules de livraison correspondant aux critères de la demande, sur toutes les pages.

ListTasksRequest

Le message de requête ListTasks.

Champs
header

DeliveryRequestHeader

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

parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. provider doit être 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 lors 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 création de listes de 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 "Task" (Tâche) que vous pouvez filtrer, consultez la section Liste de tâches.

ListTasksResponse

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

Champs
tasks[]

Task

Ensemble de 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 filtre 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 requête, sur toutes les pages.

LocationInfo

Un établissement avec tout autre identifiant

Champs
point

LatLng

Coordonnées du lieu

SearchTasksRequest

Obsolète: envoyez des GetTaskTrackingInfoRequest à GetTaskTrackingInfo à la place.

Champs
header

DeliveryRequestHeader

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

parent

string

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

tracking_id

string

Obligatoire. Identifiant de l'ensemble des tâches associées demandées. Les ID de suivi sont soumis aux restrictions suivantes:

  • Vous devez saisir une chaîne Unicode valide.
  • La longueur ne doit pas dépasser 64 caractères.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".
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 SearchTasks précédent. Vous devez indiquer cette valeur pour récupérer la page suivante.

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

SearchTasksResponse

Réponse SearchTasks. Il contient l'ensemble des tâches qui correspondent aux critères de recherche du SearchTasksRequest.

Champs
tasks[]

Task

Ensemble de tâches pour le tracking_id demandé. Une réponse positive peut également être vide. Une réponse vide indique qu'aucune tâche n'est associée au tracking_id fourni.

next_page_token

string

Transmettez ce jeton dans SearchTasksRequest 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.

Tâche

Dans l'API Delivery, une tâche représente une seule action à suivre. En général, il existe une distinction entre les tâches liées à l'expédition et les tâches de coupure. Un envoi peut être associé à plusieurs tâches. Par exemple, il peut y avoir une tâche pour la prise en charge et une autre pour le dépôt ou le transfert. De plus, différentes tâches pour un envoi donné peuvent être traitées par différents véhicules. Par exemple, un véhicule peut s'occuper du retrait et conduire le colis jusqu'au hub, tandis qu'un autre véhicule effectue la même expédition du hub jusqu'au lieu de dépose.

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 pause ou une livraison).

state

State

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

task_outcome

TaskOutcome

Le résultat de la tâche.

task_outcome_time

Timestamp

Code temporel indiquant à quel moment le résultat de la Task a été défini par le fournisseur.

task_outcome_location

LocationInfo

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

task_outcome_location_source

TaskOutcomeLocationSource

Indique la provenance de la valeur de task_outcome_location.

tracking_id

string

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

  • Vous devez saisir une chaîne Unicode valide.
  • La longueur ne doit pas dépasser 64 caractères.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".
delivery_vehicle_id

string

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

  • Vous devez saisir une chaîne Unicode valide.
  • La longueur ne doit pas dépasser 64 caractères.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".
planned_location

LocationInfo

Immuable. Emplacement où la tâche sera terminée. Facultatif pour les tâches UNAVAILABLE, 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

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 les éléments de données visibles par les utilisateurs finaux dans quelles circonstances.

attributes[]

TaskAttribute

Liste d'attributs Task personnalisés. Chaque attribut doit avoir une clé unique.

JourneySharingInfo

Partagez des champs spécifiques de parcours.

Champs
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Informations de suivi concernant les arrêts que le véhicule assigné passera 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 conducteur, sauf dans certains cas indiqués dans la documentation de 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. Ils 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é à current_route_segment. Cette valeur est "False" si last_location ou current_route_segment n'existe 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 ce dernier n'a pas encore dépassé l'arrêt attribué au véhicule par Task.
CLOSED Lorsque le véhicule passe à l'arrêt pour cette tâche.

TaskOutcome

Résultat de la tentative d'exécution d'une tâche. Lorsque TaskState est fermé, TaskOutcome indique s'il s'est terminé correctement.

Enums
TASK_OUTCOME_UNSPECIFIED Résultat de la tâche avant que sa valeur ne soit définie.
SUCCEEDED La tâche a bien été exécutée.
FAILED La tâche n'a pas pu être terminée ou elle a été annulée.

TaskOutcomeLocationSource

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

Enums
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Résultat de la tâche avant qu'elle ne soit définie.
PROVIDER Le fournisseur a spécifié la task_outcome_location.
LAST_VEHICLE_LOCATION Comme le fournisseur n'a pas spécifié le champ task_outcome_location, Fleet Engine a utilisé la dernière position connue du véhicule.

Type

Type de tâche.

Enums
TYPE_UNSPECIFIED Par défaut, le type de tâche est inconnu.
PICKUP Une tâche de retrait est l'action entreprise pour récupérer un colis auprès d'un client. Les retraits de véhicules au niveau des dépôts ou des distributeurs doivent utiliser le type SCHEDULED_STOP.
DELIVERY Une tâche de livraison est l'action entreprise pour livrer un envoi à un client final. Le type SCHEDULED_STOP doit être utilisé pour les dépôts ou les décharges de véhicules d'occasion.
SCHEDULED_STOP Une tâche d'arrêt planifiée est utilisée à des fins de planification. Par exemple, il peut représenter la collecte ou le dépôt des envois dans des véhicules d'alimentation ou des dépôts. Il ne doit pas être utilisé pour les colis récupérés ou déposés par un client final.
UNAVAILABLE Tâche qui signifie que le véhicule n'est pas disponible en réparation. Cela peut se produire lorsque le conducteur fait une pause ou lorsqu'il est en train de faire le plein.

TaskAttribute

Décrit un attribut de tâche en tant que paire clé-valeur. La chaîne "key:value" ne peut 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. La valeur de l'attribut peut être de type chaîne, valeur booléenne ou double. Si aucune valeur n'est définie, la valeur string_value de l'attribut TaskAttribute sera stockée sous la forme d'une chaîne vide "". task_attribute_value ne peut être que l'un des éléments suivants:
string_value

string

Valeur d'attribut de chaîne.

bool_value

bool

Valeur d'attribut de type booléen.

number_value

double

Valeur d'attribut de type double.

TaskTrackingInfo

Le message TaskTrackingInfo. Ce message contient des informations sur le suivi des tâches qui seront affichées. Si un ID de suivi est associé à plusieurs tâches, Fleet Engine utilise une méthode heuristique pour déterminer quelles informations de la tâche sélectionner (TaskTrackingInfo).

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 valeur doit être une chaîne Unicode valide. * N'utilisez pas plus de 64 caractères. * Normalisée conformément au formulaire de normalisation Unicode C. * Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".

vehicle_location

DeliveryVehicleLocation

Dernière position du véhicule

route_polyline_points[]

LatLng

Liste de points qui, lorsqu'ils sont reliés entre eux, forment une polyligne représentant l'itinéraire attendu du véhicule vers l'emplacement de la tâche.

remaining_stop_count

Int32Value

Indique le nombre d'arrêts restants par le véhicule jusqu'à ce que l'arrêt de la tâche soit atteint, y compris celui 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 qui vous intéresse.

estimated_arrival_time

Timestamp

Code temporel indiquant l'heure d'arrivée estimée à l'arrêt.

estimated_task_completion_time

Timestamp

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

state

State

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

task_outcome

TaskOutcome

Résultat de la tentative d'exécution d'une tâche.

task_outcome_time

Timestamp

Code temporel indiquant le moment où le résultat de la tâche a été défini par le fournisseur.

planned_location

LocationInfo

Immuable. Emplacement où la tâche sera terminée.

target_time_window

TimeWindow

Période pendant laquelle la tâche doit être terminée.

attributes[]

TaskAttribute

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

TaskTrackingViewConfig

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

Champs
route_polyline_points_visibility

VisibilityOption

Champ indiquant dans quel cas 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 spécifiant le moment auquel 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 le moment auquel le temps estimé d'achèvement 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

Le champ indiquant quand la distance restante en voiture 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 spécifiant 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 indiquant dans quels cas 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. L'option de visibilité spécifique choisie. visibility_option ne peut être qu'un des éléments suivants :
remaining_stop_count_threshold

int32

Cet élément de données est visible par les utilisateurs finaux si le nombre d'arrêts restants est inférieur ou égal à restant_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 à duration_until_estimated_arrival_time_threshold.

remaining_driving_distance_meters_threshold

int32

Cet élément de données est visible par les utilisateurs finaux si la distance restante en voiture est inférieure ou égale à rester_driving_distance_meters_threshold.

always

bool

Si cette règle est définie 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

Si cette règle est définie 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 de l'API de livraison standard.

delivery_vehicle

DeliveryVehicle

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

update_mask

FieldMask

Obligatoire. Masque de champ qui indique les champs DeliveryVehicle à mettre à jour. Notez que 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 de l'API de livraison standard.

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 à l'aide de Task.update.

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

Remarque: une fois la valeur 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 son état sur CLOSED à l'aide de Task.update. Au lieu de cela, supprimez le VehicleStop contenant la tâche du véhicule de livraison, ce qui définit automatiquement son état sur CLOSED.

update_mask

FieldMask

Obligatoire. Masque de champ indiquant les champs "Task" (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 la section du trajet d'un véhicule, de son arrêt précédent à l'arrêt actuel. S'il s'agit du premier arrêt actif, cela signifie qu'il s'agit du trajet entre la position actuelle du véhicule et cet arrêt.

Champs
stop

VehicleStop

Spécifie l'emplacement de l'arrêt, ainsi que les Task associés à l'arrêt. Certains champs de VehicleStop peuvent ne pas être présents si cette section 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 de la liste des segments de 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 cette section 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 de la liste des segments de 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). Vous obtenez ainsi la durée restante du trajet à partir de la dernière position connue de l'application du conducteur, plutôt que celle 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 de la liste des segments de 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 cette section de parcours fait partie de JourneySharingInfo.

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

VehicleStop

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

Champs
planned_location

LocationInfo

Obligatoire. Emplacement de l'arrêt. Notez que les emplacements indiqués dans les Task ne correspondent peut-être pas exactement à ce lieu, mais seront situés à une courte distance de celui-ci. Ce champ ne sera pas renseigné dans la réponse à un appel GetTask ou SearchTasks.

tasks[]

TaskInfo

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

state

State

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

État

État actuel d'une VehicleStop.

Enums
STATE_UNSPECIFIED Inconnu.
NEW Créé, mais pas de routage actif.
ENROUTE Attribué et routage actif.
ARRIVED Arrivé à l'arrêt. Suppose que, lorsque le véhicule s'oriente vers l'arrêt suivant, tous les arrêts précédents ont été effectué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 ou SearchTasks. Les ID de tâche sont soumis aux restrictions suivantes:

  • Vous devez saisir une chaîne Unicode valide.
  • La longueur ne doit pas dépasser 64 caractères.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".
task_duration

Duration

Uniquement en sortie. Temps nécessaire pour effectuer la tâche.

target_time_window

TimeWindow

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