本文假設您已閱讀「Fleet Engine 簡介」一節中的「排定工作」簡介指南,以及本節中的「什麼是排定工作?」。
Fleet Engine 預定工作提供不同類別的工作:
- 出貨工作:用於駕駛工作,包括取貨和送貨。
- 無法提供服務的任務:用於司機無法提供服務的時間,例如必須休息時。
- 預定停靠點工作:用於在投遞箱或顧客地點進行非駕駛工作,例如進入建築物或尋找投遞點的時間。
本文說明如何在伺服器上建立非出貨工作。如要瞭解運送工作類型,請參閱「建立運送工作」。
非駕駛工作的工作欄位
本節記錄停機和排定停止工作所需的任務欄位。
必要工作欄位
在 Fleet Engine 中建立每項工作時,您都必須提供必要欄位,也可以提供任何選填欄位。Fleet Engine 會忽略所有其他欄位,如果工作建立要求提供指派的 deliveryVehicleId
,則會擲回例外狀況。如要將工作指派給車輛,請使用 UpdateDeliveryVehicleRequest
。詳情請參閱「更新工作」。
欄位 | 值 |
---|---|
type |
設為與工作類型相符的類型,也就是下列其中一種:
|
state |
State.OPEN |
task_id |
不重複的工作 ID。這不得為貨件的追蹤號碼。如果系統中沒有工作 ID,可以產生通用唯一識別碼 (UUID)。詳情請參閱「工作 ID」。 |
tracking_id |
僅限 PICKUP 或 DELIVERY 工作:
用於追蹤貨件的號碼或 ID。如果不是出貨作業,請勿提供這個欄位。 |
planned_location |
PICKUP 、DELIVERY 或 SCHEDULED_STOP 工作 (僅限):工作完成地點。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> 是工作專屬 ID。
要求標頭必須包含「Authorization」欄位,值為「Bearer <token>」,其中「<token>」是由伺服器根據「服務帳戶角色」和「JSON Web Token」中說明的準則發出。
要求主體必須包含 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> 是工作專屬 ID。
要求標頭必須包含「Authorization」欄位,值為「Bearer <token>」,其中「<token>」是由伺服器根據「服務帳戶角色」和「JSON Web Token」中說明的準則發出。
要求主體必須包含 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