创建运单任务

本文档假定您已阅读舰队引擎简介部分中有关预定任务的入门指南,以及本部分中的什么是预定任务?

适用于预定任务的 Fleet Engine 提供以下不同的大类任务:

  • 送货任务:用于驾驶任务,包括取货和送货。
  • 不可用任务:用于司机不可用的时间,例如强制休息时间。
  • 预定停靠点任务:用于在投递箱或客户地点执行非驾驶任务,例如进入建筑物或找到送货点所需的时间。

本文档介绍了如何在服务器上创建装运任务。如需了解其他任务类型,请参阅创建其他任务类型

配送任务字段

本部分记录了取货和送货任务所需的任务字段。

必需的任务字段

对于您在 Fleet Engine 中创建的每个任务,您都必须为其提供必需字段,也可以提供任何可选字段。Fleet Engine 会忽略所有其他字段,如果任务创建请求提供已分配的 deliveryVehicleId,则会抛出异常。如需将任务分配给车辆,请使用 UpdateDeliveryVehicleRequest。如需了解详情,请参阅更新任务

字段
type

设置为与任务类型匹配的类型,即以下类型之一:

  • PICKUP
  • DELIVERY
  • SCHEDULED_STOP
  • UNAVAILABLE
state State.OPEN
task_id 唯一任务 ID。不得是相应货件的跟踪编号。如果您的系统中没有任务 ID,您可以生成一个通用唯一标识符 (UUID)。如需了解详情,请参阅任务 ID
tracking_id 仅限 PICKUPDELIVERY 任务:您用于跟踪货件的编号或标识符。请勿为非货件任务提供此字段。
planned_location 仅限 PICKUPDELIVERYSCHEDULED_STOP 任务:要完成任务的位置。对于 UNAVAILABLE 任务,此权限不是必需的。
task_duration 完成任务所需的预计额外时间。例如,寻找停车位或步行前往交接地点。

可选的货件任务字段

字段
target_time_window 任务应完成的时间窗口。此字段不会影响路由行为。
task_tracking_view_config 仅限 PICKUPDELIVERY 任务:任务跟踪的配置,用于指定在哪些情况下最终用户可以查看哪些数据元素。
attributes 自定义任务属性的列表。每个属性都必须具有唯一的键。

创建货件揽收任务

如需使用 Fleet Engine 跟踪司机取货的活动,请创建取货任务。这需要将任务类型属性设置为 PICKUP。以下示例展示了从 Grand Indonesia East Mall 提取的货件。

以下示例展示了如何使用 Java gRPC 库创建货件揽收任务,以及如何向 CreateTask 发出 HTTP REST 请求。

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

如需从服务器环境中创建货件揽收任务,请向 CreateTask 发出 HTTP REST 调用:

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

<id> 是任务的唯一标识符。

请求标头必须包含一个 Authorization 字段,其值为 Bearer <token>,其中 <token> 是由您的服务器根据服务账号角色JSON Web 令牌中所述的准则颁发的。

请求正文必须包含一个 Task 实体,其中包含货件任务字段中所述的相应字段。

示例 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

创建货件配送任务

如需使用 Fleet Engine 跟踪送货司机的活动,请创建送货任务。这需要将任务类型属性设置为 DELIVERY。以下示例展示了向 Grand Indonesia East Mall 运送货件的流程。

以下示例展示了如何使用 Java gRPC 库创建货件揽收任务,以及如何向 CreateTask 发出 HTTP REST 请求。

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

如需从服务器环境中创建货件揽收任务,请向 CreateTask 发出 HTTP REST 调用:

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

<id> 是任务的唯一标识符。

请求标头必须包含一个 Authorization 字段,其值为 Bearer <token>,其中 <token> 是由您的服务器根据服务账号角色JSON Web 令牌中所述的准则颁发的。

请求正文必须包含 Task 实体:

示例 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
 ```

后续步骤