本文假設您已閱讀「Fleet Engine 簡介」一節中排程工作的入門指南,以及本節的「什麼是排程工作?」。
針對排程工作,Fleet Engine 提供不同類別的工作:
- Shipment tasks:用於駕駛工作,包括取貨和運送貨物。
- 不提供服務任務:用於司機無法提供服務的時間,例如休息時間。
- 預定停靠點任務:用於提貨箱或客戶地點的非行車任務,例如進入建築物或尋找提貨點的時間。
本文件將說明如何在伺服器上建立非出貨工作。如需瞭解運送工作類型,請參閱「建立運送工作」。
非駕駛任務的工作欄位
本節說明不提供服務和排定停止工作時所需的工作欄位。
必填工作欄位
您在 Fleet Engine 中建立的每項工作都必須提供必要欄位,也可以提供任何選用欄位。Fleet Engine 會忽略所有其他欄位,如果工作建立要求提供已指派的 deliveryVehicleId
,就會擲回例外狀況。如要將工作指派給車輛,請使用 UpdateDeliveryVehicleRequest
。詳情請參閱「更新工作」。
欄位 | 值 |
---|---|
type |
設為與工作類型相符的類型,如下所示:
|
state |
State.OPEN |
task_id |
不重複的任務 ID。這必須不是貨件的追蹤號碼。如果系統中沒有工作 ID,您可以產生通用唯一識別碼 (UUID)。詳情請參閱「工作 ID」。 |
tracking_id |
僅限 PICKUP 或 DELIVERY 任務:您用於追蹤出貨的號碼或 ID。請勿為非運送工作提供這個欄位。 |
plannedLocation |
PICKUP 、DELIVERY 或 SCHEDULED_STOP 工作 (僅限工作):工作完成的位置。UNAVAILABLE 工作不需要此值。 |
taskDuration |
預計完成這項工作所需的時間。例如尋找停車位,或步行前往交車地點。 |
選用運送工作欄位
欄位 | 值 |
---|---|
targetTimeWindow |
應完成工作時段。這個欄位不會影響轉送行為。 |
task_tracking_view_config |
PICKUP 或 DELIVERY 工作任務 (僅限):工作追蹤的設定,可指定在何種情況下向使用者顯示哪些資料元素。 |
attributes |
自訂工作屬性清單。每個屬性都必須有專屬金鑰。 |
建立無法使用的工作
您可以建立工作,指出無法提供服務的時間,例如司機休息時間。如要建立無法使用的工作,請遵循下列規範:
- 將工作類型設為
UNAVAILABLE
。 - 請勿加入追蹤 ID。
- 雖然您不必為無法提供服務的任務提供地點,但這樣做可在整天提供更精確的預估到達時間。
當車輛位置處於用於行程分享的 UNAVAILABLE
工作時,系統會套用特殊瀏覽權限規則。
- 與「Shipment 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 權杖」中的指南所發出。
要求主體必須包含 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 權杖」中的指南所發出。
要求主體必須包含 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