本文档假定您已阅读 计划任务简介指南(位于Fleet Engine 简介部分)以及本部分中的什么是计划任务?。
计划任务的 Fleet Engine 提供不同的大类任务:
- 货件任务:用于驾驶任务,包括货件的取货和送货。
- 不可用任务:用于驾驶员不可用的时间,例如 需要休息的时间。
- 计划停靠任务:用于投递箱或客户 所在地点的非驾驶任务,例如进入建筑物或找到送货点的时间。
本文档介绍了如何在服务器上创建非货件任务。 如需了解 货件任务类型,请参阅创建货件任务。
非驾驶任务的任务字段
本部分介绍了不可用任务和计划停靠任务所需的任务字段。
必需的任务字段
对于您在 Fleet Engine 中创建的每个任务,您都必须为其提供必需的字段,并且还可以提供任何可选字段。Fleet Engine 会忽略所有其他字段,并且如果任务创建请求提供了分配的 deliveryVehicleId,则会抛出异常。如需将任务分配给车辆,请使用 UpdateDeliveryVehicleRequest。如需了解详情,请参阅
更新任务。
| 字段 | 值 |
|---|---|
type |
设置为与任务类型匹配的类型,即以下其中一种:
|
state |
State.OPEN |
task_id |
唯一任务 ID。此 ID 不得是货件的跟踪编号。如果您的系统中没有任务 ID,您可以生成通用唯一标识符 (UUID)。如需了解具体信息,请参阅 任务 ID。 |
tracking_id |
PICKUP 或 DELIVERY 任务仅限:
您用于跟踪货件的编号或标识符。请勿为非货件任务提供此字段。 |
planned_location |
PICKUP, DELIVERY 或
SCHEDULED_STOP 任务仅限:要完成任务的地点。`UNAVAILABLE` 任务不需要此字段。UNAVAILABLE |
task_duration |
完成任务所需的预计时间。例如,寻找停车位 或步行前往交接地点。 |
可选货件任务字段
| 字段 | 值 |
|---|---|
target_time_window |
应完成任务的时间窗口。此字段 不会影响路线规划行为。 |
task_tracking_view_config |
PICKUP 或 DELIVERY 任务仅限:
任务跟踪的配置,用于指定在何种情况下向最终用户显示哪些数据元素。 |
attributes |
自定义任务属性的列表。每个属性都必须具有唯一的键。 |
创建不可用任务
您可以创建指示不可用的任务;例如,用于驾驶员休息。如需创建不可用任务,请遵循以下准则:
- 将任务类型设置为
UNAVAILABLE。 - 请勿添加跟踪 ID。
- 虽然您不必为不可用任务提供地点,但这样做可以提高全天的预计到达时间计算准确性。
当车辆执行 UNAVAILABLE 任务以进行行程共享时,车辆位置信息适用特殊的可见性规则。
- 与货件跟踪库集成的消费者应用:当 车辆执行不可用任务时,消费者应用的用户无法看到 车辆位置,但他们仍然可以查看货件的 状态信息。
- 与 Fleet Tracking 库集成的车队跟踪应用:当 车辆执行不可用任务时,使用车队 跟踪应用的车队管理员将能够看到不可用任务的车辆位置。
以下示例展示了如何使用
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.UNAVAILABLE)
.setState(Task.State.OPEN)
.setTaskDuration(
Duration.newBuilder().setSeconds(60 * 60)) // 1hr break
.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, 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": "UNAVAILABLE",
"state": "OPEN",
"plannedLocation": {
"point": {
"latitude": -6.195139,
"longitude": 106.820826
}
},
"taskDuration": "300s"
}
EOM创建计划停靠任务
您可以为计划停靠创建任务;例如,用于客户所在地的非驾驶任务、加油停靠,或驾驶员从支线车辆接收货件时。创建计划停靠任务时,请遵循以下准则:
- 将任务类型设置为
- 请勿添加跟踪 ID。
- 您可以选择性地提供地点。
以下示例展示了如何使用
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.SCHEDULED_STOP)
.setState(Task.State.OPEN)
.setPlannedLocation( // Grand Indonesia East Mall
LocationInfo.newBuilder().setPoint(
LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
.setTaskDuration(
Duration.newBuilder().setSeconds(2 * 60))
.build();
// Task request
CreateTaskRequest createTaskRequest =
CreateTaskRequest.newBuilder() // No need for the header
.setParent(parent)
.setTaskId("task-8241890") // Task ID assigned by the Provider
.setTrip(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, 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": "SCHEDULED_STOP",
"state": "OPEN",
"plannedLocation": {
"point": {
"latitude": -6.195139,
"longitude": 106.820826
}
},
"taskDuration": "600s"
}
EOM