Créer des tâches d'expédition

Ce document suppose que vous avez lu le guide d'introduction sur les tâches planifiées dans la section Présentation de Fleet Engine, ainsi que la section Qu'est-ce qu'une tâche planifiée ? de cette section.

Fleet Engine pour les tâches planifiées propose différentes grandes catégories de tâches:

  • Tâches de livraison : utilisez-les pour les tâches de conduite, y compris le retrait et la livraison de colis.
  • Tâches d'indisponibilité : utilisez-les lorsque les conducteurs ne sont pas disponibles, par exemple lors des pauses obligatoires.
  • Tâches d'arrêt planifiées : utilisez-les pour les tâches non liées à la conduite à des points de dépôt ou à des emplacements de clients, comme le temps nécessaire pour entrer dans un bâtiment ou trouver un point de livraison.

Ce document explique comment créer des tâches d'expédition sur votre serveur. Pour en savoir plus sur les autres types de tâches, consultez Créer d'autres types de tâches.

Champs de la tâche de livraison

Cette section décrit les champs de tâche requis pour les tâches de ramassage et de livraison.

Champs de tâche obligatoires

Pour chaque tâche que vous créez dans Fleet Engine, vous devez lui fournir les champs obligatoires et, éventuellement, tous les champs facultatifs. Le moteur de parc ignore tous les autres champs et génère une exception si une requête de création de tâche fournit un deliveryVehicleId attribué. Pour attribuer des tâches à un véhicule, utilisez UpdateDeliveryVehicleRequest. Pour en savoir plus, consultez la section Mettre à jour des tâches.

ChampValeur
type

Définissez le type correspondant au type de tâche, parmi les suivants:

  • PICKUP
  • DELIVERY
  • SCHEDULED_STOP
  • UNAVAILABLE
state State.OPEN
task_id ID de tâche unique. Il ne doit pas s'agir du numéro de suivi de l'envoi. Si vous ne disposez pas d'ID de tâche dans votre système, vous pouvez générer un identifiant unique universel (UUID). Pour en savoir plus, consultez la section ID de tâche.
tracking_id Tâches PICKUP ou DELIVERY uniquement : numéro ou identifiant que vous utilisez pour suivre un envoi. N'indiquez pas ce champ pour les tâches ne concernant pas l'expédition.
plannedLocation Tâches PICKUP, DELIVERY ou SCHEDULED_STOP uniquement : emplacement où la tâche doit être effectuée. Non obligatoire pour les tâches UNAVAILABLE.
taskDuration Temps estimé à ajouter pour effectuer la tâche. Par exemple, pour chercher une place de parking ou se rendre à l'endroit de la remise.

Champs facultatifs pour les tâches d'expédition

ChampValeur
targetTimeWindow La période pendant laquelle la tâche doit être terminée. Ce champ n'affecte pas le comportement de routage.
task_tracking_view_config Tâches PICKUP ou DELIVERY uniquement : configuration du suivi des tâches qui spécifie les éléments de données visibles par les utilisateurs finaux et dans quelles circonstances.
attributes Liste des attributs de tâche personnalisés. Chaque attribut doit avoir une clé unique.

Créer une tâche de récupération d'envoi

Pour utiliser Fleet Engine afin de suivre l'activité d'un livreur qui récupère une commande, créez une tâche de retrait. Pour ce faire, vous devez définir l'attribut de type de tâche sur PICKUP. L'exemple suivant illustre un retrait à une livraison depuis le Grand Indonesia East Mall.

Les exemples suivants montrent comment créer une tâche de retrait en magasin à l'aide de la bibliothèque gRPC Java ou comment envoyer une requête HTTP REST à CreateTask.

gRPC

  static final String PROJECT_ID = "my-delivery-co-gcp-project";

  DeliveryServiceBlockingStub deliveryService =
    DeliveryServiceGrpc.newBlockingStub(channel);

  // Task settings
  String parent = "providers/" + PROJECT_ID;
  Task task = Task.newBuilder()
    .setType(Task.Type.PICKUP)
    .setState(Task.State.OPEN)
    .setTrackingId("my-tracking-id")
    .setPlannedLocation(               // Grand Indonesia East Mall
      LocationInfo.newBuilder().setPoint(
        LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    .setTaskDuration(
      Duration.newBuilder().setSeconds(2 * 60))
    .setTargetTimeWindow(
      TimeWindow.newBuilder()
        .setStartTime(Timestamp.newBuilder().setSeconds(1680123600))
        .setEndTime(Timestamp.newBuilder().setSeconds(1680130800)))
    .addAttributes(TaskAttribute.newBuilder().setKey("foo").setStringValue("value"))
    .addAttributes(TaskAttribute.newBuilder().setKey("bar").setNumberValue(10))
    .addAttributes(TaskAttribute.newBuilder().setKey("baz").setBoolValue(false))
    .build();

  // Task request
  CreateTaskRequest createTaskRequest =
    CreateTaskRequest.newBuilder()  // No need for the header
        .setParent(parent)          // Avoid using auto-incrementing IDs for the taskId
        .setTaskId("task-8241890")  // Task ID assigned by the Provider
        .setTask(task)              // Initial state
        .build();

  // Error handling
  // If Fleet Engine does not have a task with that ID and the credentials of the
  // requestor pass, the service creates the task successfully.

  try {
    Task createdTask = deliveryService.createTask(createTaskRequest);
  } catch (StatusRuntimeException e) {
    Status s = e.getStatus();
    switch (s.getCode()) {
       case ALREADY_EXISTS:
         break;
       case PERMISSION_DENIED:
         break;
    }
    return;
  }

REST

Pour créer une tâche de retrait en magasin à partir d'un environnement de serveur, effectuez un appel REST HTTP à CreateTask:

POST https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks?taskId=<id>

<id> est un identifiant unique de la tâche.

L'en-tête de la requête doit contenir un champ Authorization avec la valeur Bearer <token>, où <token> est émis par votre serveur conformément aux consignes décrites dans Rôles de compte de service et Jetons Web JSON.

Le corps de la requête doit contenir une entité Task avec les champs appropriés décrits dans la section Champs de la tâche d'expédition.

Exemple de commande curl :

 # Set $JWT, $PROJECT_ID, $TRACKING_ID, and $TASK_ID in the local
 # environment
 curl -X POST "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?taskId=${TASK_ID}" \
   -H "Content-type: application/json" \
   -H "Authorization: Bearer ${JWT}" \
   --data-binary @- << EOM
 {
   "type": "PICKUP",
   "state": "OPEN",
   "trackingId": "${TRACKING_ID}",
   "plannedLocation": {
      "point": {
         "latitude": -6.195139,
         "longitude": 106.820826
      }
   },
   "taskDuration": "90s",
   "targetTimeWindow": {
     "startTime": "2023-03-29T21:00:00Z",
     "endTime": "2023-03-29T23:00:00Z"
   }
 }
 EOM

Créer une tâche de livraison

Pour utiliser Fleet Engine afin de suivre l'activité d'un livreur livrant une livraison, créez une tâche de livraison. Pour ce faire, définissez l'attribut de type de tâche sur DELIVERY. L'exemple suivant illustre une livraison à destination du Grand Indonesia East Mall.

Les exemples suivants montrent comment créer une tâche de retrait de colis à l'aide de la bibliothèque gRPC Java ou comment effectuer une requête REST HTTP à CreateTask.

gRPC

  static final String PROJECT_ID = "my-delivery-co-gcp-project";

  DeliveryServiceBlockingStub deliveryService =
    DeliveryServiceGrpc.newBlockingStub(channel);

  // Task settings
  String parent = "providers/" + PROJECT_ID;
  Task task = Task.newBuilder()
    .setType(Task.Type.DELIVERY)
    .setState(Task.State.OPEN)
    .setTrackingId("my-tracking-id")
    .setPlannedLocation(               // Grand Indonesia East Mall
      LocationInfo.newBuilder().setPoint(
        LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    .setTaskDuration(
      Duration.newBuilder().setSeconds(2 * 60))
    .setTargetTimeWindow(
      TimeWindow.newBuilder()
        .setStartTime(Timestamp.newBuilder().setSeconds(1680123600))
        .setEndTime(Timestamp.newBuilder().setSeconds(1680130800)))
    .addAttributes(TaskAttribute.newBuilder().setKey("foo").setStringValue("value"))
    .addAttributes(TaskAttribute.newBuilder().setKey("bar").setNumberValue(10))
    .addAttributes(TaskAttribute.newBuilder().setKey("baz").setBoolValue(false))
    .build();

  // Task request
  CreateTaskRequest createTaskRequest =
    CreateTaskRequest.newBuilder()  // No need for the header
        .setParent(parent)          // Avoid using auto-incrementing IDs for the taskId
        .setTaskId("task-8241890")  // Task ID assigned by the Provider
        .setTask(task)              // Initial state
        .build();

  // Error handling
  // If Fleet Engine does not have task with that ID and the credentials of the
  // requestor pass, the service creates the task successfully.

  try {
    Task createdTask = deliveryService.createTask(createTaskRequest);
  } catch (StatusRuntimeException e) {
    Status s = e.getStatus();
    switch (s.getCode()) {
       case ALREADY_EXISTS:
         break;
       case PERMISSION_DENIED:
         break;
    }
    return;
  }

REST

Pour créer une tâche de retrait en magasin à partir d'un environnement de serveur, effectuez un appel REST HTTP à CreateTask:

POST https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks?taskId=<id>

&lt;id&gt; est un identifiant unique pour la tâche.

L'en-tête de requête doit contenir un champ Authorization avec la valeur Bearer <token>, où <token> est émis par votre serveur conformément aux instructions décrites dans les sections Rôles de compte de service et Jetons Web JSON.

Le corps de la requête doit contenir une entité Task:

Exemple de commande curl :

 # Set $JWT, $PROJECT_ID, $TRACKING_ID, and $TASK_ID in the local
 # environment
 curl -X POST "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?taskId=${TASK_ID}" \
   -H "Content-type: application/json" \
   -H "Authorization: Bearer ${JWT}" \
   --data-binary @- << EOM
 {
   "type": "DELIVERY",
   "state": "OPEN",
   "trackingId": "${TRACKING_ID}",
   "plannedLocation": {
      "point": {
         "latitude": -6.195139,
         "longitude": 106.820826
      }
   },
   "taskDuration": "90s",
   "targetTimeWindow": {
     "startTime": "2023-03-29T21:00:00Z",
     "endTime": "2023-03-29T23:00:00Z"
   }
 }
 EOM
 ```

Étape suivante