Index
DeliveryService
(interface)BatchCreateTasksRequest
(message)BatchCreateTasksResponse
(message)CreateDeliveryVehicleRequest
(message)CreateTaskRequest
(message)DeliveryRequestHeader
(message)DeliveryRequestHeader.Platform
(enum)DeliveryRequestHeader.SdkType
(enum)DeliveryVehicle
(message)DeliveryVehicle.DeliveryVehicleType
(enum)DeliveryVehicleAttribute
(message)DeliveryVehicleLocation
(message)DeliveryVehicleLocationSensor
(enum)DeliveryVehicleNavigationStatus
(enum)GetDeliveryVehicleRequest
(message)GetTaskRequest
(message)GetTaskTrackingInfoRequest
(message)ListDeliveryVehiclesRequest
(message)ListDeliveryVehiclesResponse
(message)ListTasksRequest
(message)ListTasksResponse
(message)LocationInfo
(message)SearchTasksRequest
(message) (obsolète)SearchTasksResponse
(message) (obsolète)Task
(message)Task.JourneySharingInfo
(message)Task.State
(enum)Task.TaskOutcome
(enum)Task.TaskOutcomeLocationSource
(enum)Task.Type
(enum)TaskAttribute
(message)TaskTrackingInfo
(message)TaskTrackingViewConfig
(message)TaskTrackingViewConfig.VisibilityOption
(message)TimeWindow
(message)UpdateDeliveryVehicleRequest
(message)UpdateTaskRequest
(message)VehicleJourneySegment
(message)VehicleStop
(message)VehicleStop.State
(enum)VehicleStop.TaskInfo
(message)
DeliveryService
Le service de livraison Last Mile.
BatchCreateTasks |
---|
Crée et renvoie un lot de nouveaux objets |
CreateDeliveryVehicle |
---|
Crée et renvoie un |
CreateTask |
---|
Crée et renvoie un objet |
GetDeliveryVehicle |
---|
Renvoie l'instance |
GetTask |
---|
Récupère des informations sur un |
GetTaskTrackingInfo |
---|
Renvoie l'instance |
ListDeliveryVehicles |
---|
Récupère tous les |
ListTasks |
---|
Récupère tous les |
SearchTasks |
---|
Obsolète: utilisez plutôt |
UpdateDeliveryVehicle |
---|
Écrit les données |
UpdateTask |
---|
Met à jour les données |
BatchCreateTasksRequest
Le message de requête BatchCreateTask
.
Champs | |
---|---|
header |
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 |
parent |
Obligatoire. Ressource parente partagée par toutes les tâches. Cette valeur doit être au format |
requests[] |
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[] |
Tâches créées. |
CreateDeliveryVehicleRequest
Le message de requête CreateDeliveryVehicle
.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
parent |
Obligatoire. Doit se présenter sous la forme |
delivery_vehicle_id |
Obligatoire. L'ID du véhicule de livraison doit être unique et soumis aux restrictions suivantes:
|
delivery_vehicle |
Obligatoire. Entité
Remarque: Le champ |
CreateTaskRequest
Le message de requête CreateTask
.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
parent |
Obligatoire. Doit se présenter sous la forme |
task_id |
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
|
task |
Obligatoire. Entité "Tâche" à créer. Lors de la création d'une tâche, les champs suivants sont obligatoires:
Remarque: Le champ |
DeliveryRequestHeader
"RequestHeader" contient des champs communs à toutes les requêtes RPC de diffusion.
Champs | |
---|---|
language_code |
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: |
region_code |
Obligatoire. Code CLDR de la région d'origine de la requête. Exemple de valeur de champ: |
sdk_version |
Version du SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: |
os_version |
Version du système d'exploitation sur lequel le SDK appelant est exécuté. Exemples de valeurs de champs: |
device_model |
Modèle de l'appareil sur lequel le SDK appelant est exécuté. Exemples de valeurs de champs: |
sdk_type |
Type de SDK qui envoie la requête. |
maps_sdk_version |
Version du MapSDK dont dépend le SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: |
nav_sdk_version |
Version du NavSDK dont dépend le SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: |
platform |
Plate-forme du SDK appelant. |
manufacturer |
Fabricant de l'appareil Android à partir du SDK appelant (applicable uniquement aux SDK Android). Exemple de valeur de champ: |
android_api_level |
Niveau d'API Android du SDK appelant, applicable uniquement aux SDK Android. Exemple de valeur de champ: |
trace_id |
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 |
Nom unique du véhicule de livraison. Il a le format suivant : |
last_location |
Dernière position signalée du véhicule de livraison |
navigation_status |
État de la navigation du véhicule de livraison. |
current_route_segment |
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 Dans certains cas, ce champ peut ne pas être utilisé pour renseigner
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 |
Emplacement où se termine Ce champ est ignoré dans les appels |
remaining_distance_meters |
Distance en voiture restante pour le Fleet Engine ignore ce champ dans |
remaining_duration |
Temps de trajet restant pour le Fleet Engine ignore ce champ dans |
remaining_vehicle_journey_segments[] |
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 |
attributes[] |
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 |
Type de ce véhicule de livraison. Si cette règle n'est pas configurée, la valeur par défaut est |
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 |
Clé de l'attribut. |
value |
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 |
Valeur d'attribut de chaîne. Remarque: Ce champ est identique au champ |
bool_value |
Valeur d'attribut de type booléen. |
number_value |
Valeur d'attribut de type double. |
DeliveryVehicleLocation
Localisation, vitesse et direction d'un véhicule à un moment donné.
Champs | |
---|---|
location |
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 |
horizontal_accuracy |
Obsolète: utilisez plutôt |
latlng_accuracy |
Précision de |
heading |
Sens de circulation du véhicule en degrés. 0 représente le nord. La plage valide est [0 360). |
bearing_accuracy |
Obsolète: utilisez plutôt |
heading_accuracy |
Précision de |
altitude |
Altitude en mètres au-dessus de WGS84. |
vertical_accuracy |
Obsolète: utilisez plutôt |
altitude_accuracy |
Précision de |
speed_kmph |
Vitesse du véhicule en kilomètres par heure. Obsolète: utilisez plutôt |
speed |
Vitesse du véhicule en mètres/seconde |
speed_accuracy |
Précision de |
update_time |
Heure à laquelle |
server_time |
Uniquement en sortie. Heure à laquelle le serveur a reçu les informations de localisation. |
location_sensor |
Fournisseur de données de localisation (par exemple, |
is_road_snapped |
Indique si |
is_gps_sensor_enabled |
Uniquement en entrée. Indique si le capteur GPS est activé sur l'appareil mobile. |
time_since_update |
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 |
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 |
Emplacement brut du véhicule (non traité par l'outil de détection de la route). |
raw_location_time |
Code temporel associé à l'emplacement brut. |
raw_location_sensor |
Source de l'emplacement brut. La valeur par défaut est |
raw_location_accuracy |
Précision de |
supplemental_location |
Emplacement supplémentaire fourni par l'application d'intégration. |
supplemental_location_time |
Code temporel associé à l'emplacement supplémentaire. |
supplemental_location_sensor |
Source de l'emplacement supplémentaire. La valeur par défaut est |
supplemental_location_accuracy |
Précision de |
road_snapped |
Obsolète: utilisez plutôt |
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. |
GetDeliveryVehicleRequest
Le message de requête GetDeliveryVehicle
.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
name |
Obligatoire. Doit se présenter sous la forme |
GetTaskRequest
Le message de requête GetTask
.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
name |
Obligatoire. Doit se présenter sous la forme |
GetTaskTrackingInfoRequest
Le message de requête GetTaskTrackingInfoRequest
.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
name |
Obligatoire. Doit se présenter sous la forme |
ListDeliveryVehiclesRequest
Le message de requête ListDeliveryVehicles
.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
parent |
Obligatoire. Doit se présenter sous la forme |
page_size |
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 |
Facultatif. Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
filter |
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 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 |
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[] |
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 |
Vous pouvez transmettre ce jeton dans |
total_size |
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 |
Facultatif. En-tête de requête de l'API de livraison standard. |
parent |
Obligatoire. Doit se présenter sous la forme |
page_size |
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 |
Facultatif. Jeton de page reçu lors d'un appel Lors de la pagination, tous les autres paramètres fournis à |
filter |
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[] |
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 |
Transmettez ce jeton dans |
total_size |
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 |
Coordonnées du lieu |
SearchTasksRequest
Obsolète: envoyez des GetTaskTrackingInfoRequest
à GetTaskTrackingInfo
à la place.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
parent |
Obligatoire. Doit se présenter sous la forme |
tracking_id |
Obligatoire. Identifiant de l'ensemble des tâches associées demandées. Les ID de suivi sont soumis aux restrictions suivantes:
|
page_size |
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 |
Facultatif. Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
SearchTasksResponse
Réponse SearchTasks
. Il contient l'ensemble des tâches qui correspondent aux critères de recherche du SearchTasksRequest
.
Champs | |
---|---|
tasks[] |
Ensemble de tâches pour le |
next_page_token |
Transmettez ce jeton dans |
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 |
Doit se présenter sous la forme |
type |
Obligatoire. Immuable. Définit le type de la tâche. (par exemple, une pause ou une livraison). |
state |
Obligatoire. État d'exécution actuel de la tâche. |
task_outcome |
Le résultat de la tâche. |
task_outcome_time |
Code temporel indiquant à quel moment le résultat de la |
task_outcome_location |
Lieu où le résultat de |
task_outcome_location_source |
Indique la provenance de la valeur de |
tracking_id |
Immuable. Ce champ facilite le stockage d'un identifiant, ce qui vous évite d'utiliser un mappage compliqué. Vous ne pouvez pas définir
|
delivery_vehicle_id |
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:
|
planned_location |
Immuable. Emplacement où la tâche sera terminée. Facultatif pour les tâches |
task_duration |
Obligatoire. Immuable. Temps nécessaire pour exécuter une tâche à cet emplacement. |
target_time_window |
Période pendant laquelle la tâche doit être terminée. |
journey_sharing_info |
Uniquement en sortie. Champs spécifiques au partage de parcours. Non renseigné lorsque l'état est |
task_tracking_view_config |
Configuration du suivi des tâches qui spécifie les éléments de données visibles par les utilisateurs finaux dans quelles circonstances. |
attributes[] |
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[] |
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, |
last_location |
Indique la dernière position signalée du véhicule attribué. |
last_location_snappable |
Indique si le lastLocation du véhicule peut être ancré à |
É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 |
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 |
Valeur d'attribut de chaîne. |
bool_value |
Valeur d'attribut de type booléen. |
number_value |
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 |
Doit être au format |
tracking_id |
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 |
Dernière position du véhicule |
route_polyline_points[] |
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 |
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 |
Distance totale restante en mètres jusqu'au |
estimated_arrival_time |
Code temporel indiquant l'heure d'arrivée estimée à l'arrêt. |
estimated_task_completion_time |
Code temporel qui indique l'heure d'achèvement estimée d'une tâche. |
state |
État d'exécution actuel de la tâche. |
task_outcome |
Résultat de la tentative d'exécution d'une tâche. |
task_outcome_time |
Code temporel indiquant le moment où le résultat de la tâche a été défini par le fournisseur. |
planned_location |
Immuable. Emplacement où la tâche sera terminée. |
target_time_window |
Période pendant laquelle la tâche doit être terminée. |
attributes[] |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Obligatoire. Heure de début de la période (incluse). |
end_time |
Obligatoire. Heure de fin de la période (incluse). |
UpdateDeliveryVehicleRequest
Le message de requête UpdateDeliveryVehicle
.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
delivery_vehicle |
Obligatoire. Mise à jour de l'entité |
update_mask |
Obligatoire. Masque de champ qui indique les champs Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : |
UpdateTaskRequest
Le message de requête UpdateTask
.
Champs | |
---|---|
header |
Facultatif. En-tête de requête de l'API de livraison standard. |
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
Remarque: une fois la valeur Si la tâche a été attribuée à un véhicule de livraison, ne définissez pas son état sur CLOSED à l'aide de |
update_mask |
Obligatoire. Masque de champ indiquant les champs "Task" (Tâche) à mettre à jour. Remarque: Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : |
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 |
Spécifie l'emplacement de l'arrêt, ainsi que les |
driving_distance_meters |
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 |
driving_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 |
path[] |
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 Si ce champ est défini dans le chemin d'accès |
VehicleStop
Décrit un point où un véhicule s'arrête pour effectuer une ou plusieurs valeurs Task
.
Champs | |
---|---|
planned_location |
Obligatoire. Emplacement de l'arrêt. Notez que les emplacements indiqués dans les |
tasks[] |
Liste des |
state |
État de |
É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 |
ID de la tâche. Ce champ ne sera pas renseigné dans la réponse à un appel
|
task_duration |
Uniquement en sortie. Temps nécessaire pour effectuer la tâche. |
target_time_window |
Uniquement en sortie. Période pendant laquelle la tâche doit être terminée. Il n'est défini que dans la réponse à |