本文档假定您已阅读有关 以及 Fleet Engine 简介部分中的计划任务 如本部分的什么是计划任务?部分。
用于计划任务的 Fleet Engine 提供不同广泛类别的任务:
- 装运任务:用于驾驶任务,包括自提和配送 运单。
- 不可用任务:用于司机无法提供服务的情况,例如 以及所需的休息时间。
- 计划中停止任务:用于保管箱或客户中的非驾驶任务 位置,例如进入建筑物或定位投递点的时间。
本文档介绍了如何在服务器上创建非配送任务。对于 运单任务类型,请参阅创建配送任务。
非驱动任务的任务字段
本部分介绍了两个不可用状态所需的任务字段 和计划停止任务
必填任务字段
对于您在 Fleet Engine 中创建的每个任务,您必须为其提供必需的
字段,还可以提供任何可选字段。舰队引擎
并忽略其他所有字段,如果创建任务,则会抛出异常
请求会提供分配的 deliveryVehicleId
。如需向车辆分配任务,请执行以下操作:
请使用 UpdateDeliveryVehicleRequest
。如需了解详情,请参阅
更新任务。
字段 | 值 |
---|---|
type |
设置为与任务类型匹配的类型,类型包括:
|
state |
State.OPEN |
task_id |
唯一任务 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。
- 尽管不必为不可用任务提供位置信息, 这样可以在一天中更精确地计算预计到达时间。
特殊可见性规则适用于车辆位于
用于分享旅程的 UNAVAILABLE
任务。
- 与配送跟踪库集成的消费者应用: 车辆正在执行不可用任务,消费者应用的用户看不到 但他们仍然可以查看车辆的状态信息 发货
- 与舰队跟踪库集成的舰队跟踪应用:当 车辆正在执行不可用任务,使用车队的车队管理员 跟踪应用将能够查看车辆位置,以执行不可用任务。
以下示例展示了如何使用
Java gRPC 库或了解如何向
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.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
如需从服务器环境创建不可用任务,请创建 HTTP REST
对 CreateTask
的调用:
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
。
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
如需从服务器环境创建计划停止任务,请创建 HTTP REST
对 CreateTask
的调用:
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