本文說明從伺服器或瀏覽器尋找工作資訊的方法。Fleet Engine 支援兩種尋找工作的方式:
查詢工作:您可以使用下列 ID 查詢工作:
- 工作 ID:使用者 (例如機群運算子) 可存取工作資料的完整檢視畫面。
- 追蹤 ID:用戶端軟體會使用這組 ID,向使用者提供有限資訊,例如包裹預計在家裡的時機。
列出工作:廣泛存取工作,僅適用於信任的使用者。
查詢工作
本節說明如何依工作 ID 或追蹤 ID 查詢工作。它的規定如下:
按追蹤 ID 查詢時,必須遵守「已追蹤物件的瀏覽權限規則」中所述的瀏覽權限規則。
盡可能使用最小的符記來降低安全性風險。舉例來說,如果您使用「傳送消費者憑證」,則任何呼叫都只會傳回與該使用者相關的資訊,例如貨運的寄件者或收件者。Fleet Engine 會在回應中遮蓋所有其他資訊。如要進一步瞭解符記,請參閱 JSON 網頁符記。
依工作 ID 查詢工作
您可以使用 gRPC 或 REST,從伺服器環境中按工作 ID 來查詢工作。下列範例說明如何使用 Java gRPC 程式庫或對 GetTask 的 REST 要求。
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TASK_ID = "task-8597549";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task request
String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
GetTaskRequest getTaskRequest = GetTaskRequest.newBuilder() // No need for the header
.setName(taskName)
.build();
try {
Task task = deliveryService.getTask(getTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<taskId>
- <id> 是工作的專屬 ID。
- <taskId> 是要查詢的工作 ID。
- 要求標頭必須包含「Authorization」欄位,其值為「Bearer <token>」,其中 <token> 是由伺服器根據「服務帳戶角色」和「JSON Web 權杖」中的指南所發出。
- 要求主體必須為空白。
- 如果查詢成功,回應主體會包含工作項目實體。
curl
指令範例:
# Set JWT, PROJECT_ID, and TASK_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}"
透過追蹤 ID 查詢工作
以下範例說明如何使用對 GetTaskTrackingInfo
的 gRPC 或 HTTP REST 呼叫,依運送追蹤 ID 查詢工作。
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
GetTaskTrackingInfoRequest getTaskTrackingInfoRequest = GetTaskTrackingInfoRequest.newBuilder() // No need for the header
.setParent(parent)
.setTrackingId(TRACKING_ID)
.build();
try {
TaskTrackingInfo taskTrackingInfo = deliveryService.getTaskTrackingInfo(getTaskTrackingInfoRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/taskTrackingInfo/<tracking_id>
<tracking_id> 是與工作相關聯的追蹤 ID。
要求標頭必須包含「Authorization」欄位,其值為「Bearer <token>」,其中 <token> 包含正確的服務帳戶角色。請參閱「服務帳戶角色」。
如果查詢成功,回應主體會包含 taskTrackingInfo 實體。
curl
指令範例:
# Set JWT, PROJECT_ID, and TRACKING_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/taskTrackingInfo/${TRACKING_ID}"
列出工作
列出工作會廣泛存取工作。只有可信任的使用者才能列出工作。請在提出清單工作要求時,使用 Delivery Fleet Reader 或 Delivery Admin 驗證權杖。詳情請參閱「服務帳戶角色」。
分頁清單
工作清單會分頁。您可以在清單工作要求中指定頁面大小。如果指定了頁面大小,則傳回的工作數量不得超過指定的頁面大小。如果沒有指定頁面大小,系統會使用合理的預設值。如果要求的頁面大小超過內部最大值,則會使用內部最大值。
工作清單可包含用於讀取下一頁結果的符記。如要擷取下一頁,請重新發出相同要求,並附上頁面符記。如果傳回的網頁權杖為空白,表示沒有其他可擷取的工作。
列出工作時的欄位
Fleet Engine 會在列出工作時遮蓋下列欄位:
VehicleStop.planned_location
VehicleStop.state
VehicleStop.TaskInfo.taskId
根據 Google API 改善提案,使用下列欄位格式:
欄位類型 | 格式 | 範例 |
---|---|---|
時間戳記 | RFC-3339 | task_outcome_time = 2022-03-01T11:30:00-08:00 |
時間長度 | 後面加上 s 的秒數 |
task_duration = 120s |
列舉 | 字串 | state = CLOSED AND type = PICKUP |
位置 | point.latitude 和point.longitude |
planned_location.point.latitude > 36.1 AND planned_location.point.longitude < -122.0 |
篩選已列出的工作
您可以從大部分的工作屬性中篩選列出的工作。如要進一步瞭解篩選器查詢語法,請參閱 AIP-160。如未指定篩選器查詢,則會列出所有工作。
下表列出可用於篩選的有效工作屬性:
篩選清單的工作屬性 | |
---|---|
|
|
如需篩選器查詢運算子的完整清單,請參閱 AIP-160。
列出工作範例
以下範例說明如何列出 deliveryVehicleId
的工作與工作屬性,兩者以及如何使用 Java gRPC 程式庫,以及對 ListTasks
的 HTTP REST 呼叫。
成功的回應仍可能為空白。如果回應空白,代表沒有與提供的 deliveryVehicleId
相關聯的工作。
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
ListTasksRequest listTasksRequest = ListTasksRequest.newBuilder() // No need for the header
.setParent(parent)
.setFilter("delivery_vehicle_id = 123 AND attributes.foo = true")
.build();
try {
ListTasksResponse listTasksResponse = deliveryService.listTasks(listTasksRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks
如要將篩選器套用到所列工作,請納入「filter」網址參數,並使用網址逸出的篩選器查詢做為值。
要求標頭必須包含 Authorization 欄位,其值為 Bearer <token>,其中 <token> 具有正確的服務帳戶角色。請參閱「服務帳戶角色」。
成功的查詢會提供具有以下結構的回應主體:
// JSON representation
{
"tasks": [
{
object (Task)
}
],
"nextPageToken": string,
"totalSize": integer
}
curl
指令範例:
# Set JWT, PROJECT_ID, and VEHICLE_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?filter=state%20%3D%20OPEN%20AND%20delivery_vehicle_id%20%3D%20${VEHICLE_ID}"