本文档假定您已阅读车队引擎简介部分中有关计划任务的入门指南,以及本部分中的什么是计划任务?。
适用于定期任务的车队引擎提供了不同类别的任务:
- 运输任务:用于驾车任务,包括取件和送货。
- 非可用时间任务:适用于司机无法提供服务的时间,例如休息时间。
- 安排的停止任务:用于在取件箱或客户地点执行非驾驶任务,例如进入建筑物或查找送货点所需的时间。
本文档介绍了如何在服务器上创建发货任务。如需了解其他任务类型,请参阅创建其他任务类型。
配送任务字段
本部分介绍了取件和送货任务所需的任务字段。
必填的任务字段
对于您在车队引擎中创建的每个任务,您都必须为其提供必填字段,还可以提供任何可选字段。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 |
自定义任务属性列表。每个属性都必须具有唯一键。 |
创建运输接货任务
如需使用车队引擎跟踪司机上门取件的情况,请创建上门取件任务。这涉及将任务类型属性设置为 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> 是任务的唯一标识符。
请求标头必须包含一个值为 Bearer <token> 的 Authorization 字段,其中 <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
创建运输提交任务
如需使用车队引擎跟踪配送运输的司机活动,请创建运输配送任务。这涉及将任务类型属性设置为 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> 是任务的唯一标识符。
请求标头必须包含一个值为 Bearer <token> 的 Authorization 字段,其中 <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
```