本文假設您已閱讀「Fleet Engine 簡介」一節中的 [排定工作][1] 入門指南,以及本節中的「[什麼是排定工作?][2]」。
Fleet Engine for scheduled tasks 提供不同的大類別工作:
- 出貨工作:用於駕駛工作,包括取貨和送貨。
- 無法提供服務的任務:用於駕駛人無法提供服務的時間,例如必須休息時。
- 預定停靠點工作:適用於在投遞箱或顧客地點執行的非駕駛工作,例如進入建築物或尋找投遞點的時間。
本文說明如何在伺服器上建立出貨工作。如要瞭解其他工作類型,請參閱「建立其他工作類型」。
出貨工作欄位
本節說明取貨和送貨工作所需的任務欄位。
必要工作欄位
在 Fleet Engine 中建立每項工作時,您都必須提供必要欄位,也可以提供任何選填欄位。Fleet Engine 會忽略所有其他欄位,如果工作建立要求提供指派的 deliveryVehicleId,則會擲回例外狀況。如要將工作指派給車輛,請使用 UpdateDeliveryVehicleRequest。詳情請參閱更新工作。
| 欄位 | 值 |
|---|---|
type |
設為與工作類型相符的類型,可以是下列其中一種:
|
state |
State.OPEN |
task_id |
不重複的工作 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 |
自訂工作屬性清單。每個屬性都必須有專屬鍵。 |
建立貨件取貨工作
如要使用 Fleet Engine 追蹤司機取貨活動,請建立取貨工作。這包括將工作類型屬性設為 PICKUP。以下範例說明從 Grand Indonesia East Mall 取貨的流程。
下列範例說明如何使用 [Java gRPC 程式庫][4] 建立貨物取貨工作,或如何對 [CreateTask][5]發出 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> 是工作項目的專屬 ID。
要求標頭必須包含「Authorization」欄位,值為「Bearer <token>」,其中「<token>」是由伺服器根據 [服務帳戶角色][6] 和 [JSON Web 權杖][7]中所述的準則核發。
要求主體必須包含 Task 實體,以及 [貨運工作欄位][8]中說明的適當欄位。
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建立貨件運送工作
如要使用 Fleet Engine 追蹤運送貨物的司機活動,請建立貨物運送工作。這包括將工作類型屬性設為 DELIVERY。以下範例說明如何將貨件運送至 Grand Indonesia East Mall。
下列範例說明如何使用 [Java gRPC 程式庫][4] 建立貨物取貨工作,或如何對 [CreateTask][5]發出 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> 是工作項目的專屬 ID。
要求標頭必須包含「Authorization」欄位,值為「Bearer <token>」,其中「<token>」是由伺服器根據 [服務帳戶角色][6] 和 [JSON Web 權杖][7]中所述的準則核發。
要求主體必須包含 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
```placeidtrips1:/maps/documentation/mobility/fleet-engine/reference/tasks/rpc/maps.fleetengine.delivery.v1.html#locationinfo placeidtrips2:/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/LocationInfo.html placeidtrips3:/maps/documentation/mobility/fleet-engine/reference/tasks/rpc/maps.fleetengine.delivery.v1.html#maps.fleetengine.delivery.v1.LocationInfo.FIELDS.string.maps.fleetengine.delivery.v1.LocationInfo.place placeidtrips4:/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/LocationInfo.html#FIELDS.place
後續步驟
- [建立其他工作類型][13]
- [更新工作][3]
[1]:/maps/documentation/mobility/fleet-engine/essentials/tasks-intro [2]:/maps/documentation/mobility/fleet-engine/journeys/tasks [3]:update-tasks [4]:/maps/documentation/mobility/fleet-engine/essentials/client-libraries-tasks#java [5]:/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks/create [6]:/maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/service-accounts [7]:/maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/jwt [8]:/maps/documentation/mobility/fleet-engine/journeys/tasks/create-shipment-tasks#shipment_task_fields [13]:/maps/documentation/mobility/fleet-engine/journeys/tasks/create-other-tasks