本文档假定您已阅读车队引擎简介部分中有关计划任务的入门指南,以及本部分中的什么是计划任务?。
用于计划任务的 Fleet Engine 提供不同广泛类别的任务:
- 运输任务:用于驾车任务,包括取件和送货。
- 不可用任务:用于司机无法工作的情况,例如需要的休息时间。
- 安排的停止任务:用于在取件箱或客户地点执行非驾驶任务,例如进入建筑物或查找送货点所需的时间。
本文档介绍了如何在服务器上创建非发货任务。如需了解发货任务类型,请参阅创建发货任务。
非驾车任务的任务字段
本部分介绍了非可用性任务和安排的停止任务所需的任务字段。
必填的任务字段
对于您在车队引擎中创建的每个任务,您都必须为其提供必填字段,还可以提供任何可选字段。Fleet Engine 会忽略所有其他字段,如果任务创建请求提供了分配的 deliveryVehicleId
,则会抛出异常。如需向车辆分配任务,请使用 UpdateDeliveryVehicleRequest
。如需了解详情,请参阅更新任务。
字段 | 值 |
---|---|
type |
设置为与任务类型匹配的类型,类型包括:
|
state |
State.OPEN |
task_id |
唯一的任务 ID。此编号不得为运单的跟踪编号。如果您的系统中没有任务 ID,您可以生成通用唯一标识符 (UUID)。如需了解详情,请参阅任务 ID。 |
tracking_id |
仅限 PICKUP 或 DELIVERY 任务:您用于跟踪运输的编号或标识符。对于非配送任务,请勿提供此字段。 |
plannedLocation |
仅限 PICKUP 、DELIVERY 或 SCHEDULED_STOP 任务:完成任务的位置。UNAVAILABLE 任务无需此属性。 |
taskDuration |
为完成任务而预计需要添加的时间。例如,查找停车位或步行到接人点。 |
可选的配送任务字段
字段 | 值 |
---|---|
targetTimeWindow |
应完成任务的时间范围。此字段不会影响路由行为。 |
task_tracking_view_config |
仅限 PICKUP 或 DELIVERY 任务:任务跟踪的配置,用于指定在哪些情况下向最终用户显示哪些数据元素。 |
attributes |
自定义任务属性的列表。每个属性都必须具有唯一键。 |
创建非空闲时间任务
您可以创建一项用于指明服务不可用的任务,例如驾驶员休息时间。如需创建非空闲时间任务,请遵循以下准则:
- 将任务类型设置为
UNAVAILABLE
。 - 请勿添加跟踪 ID。
- 虽然您无需为不可用任务提供位置,但这样做可以全天进行增强型 ETA 计算。
当车辆处于用于分享行程的 UNAVAILABLE
任务时,系统会对车辆位置信息应用特殊的公开范围规则。
- 与配送跟踪库集成的消费者应用:当车辆执行不可用任务时,消费者应用的用户无法看到车辆位置,但仍可以看到其运输的状态信息。
- 与车队跟踪库集成的车队跟踪应用:当车辆执行非可用性任务时,使用车队跟踪应用的车队管理员将能够查看非可用性任务的车辆位置。
以下示例展示了如何使用 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> 是任务的唯一标识符。
请求标头必须包含一个值为 Bearer <token> 的 Authorization 字段,其中 <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> 是任务的唯一标识符。
请求标头必须包含值为 Bearer <token> 的 Authorization 字段,其中 <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