尋找工作

本文說明如何從伺服器或瀏覽器尋找工作資訊。Fleet Engine 支援兩種尋找工作的方式：

  • 查詢工作：您可以透過下列 ID 查詢工作：

    • 工作 ID：供車隊營運商等使用者查看完整的工作資料。
    • 追蹤 ID：用戶端軟體會使用這個 ID 向使用者提供有限的資訊，例如包裹預計送達住家的時間。

    請務必瞭解工作 ID 和工作追蹤 ID 的差異。兩者並不相同。請參閱排定工作時間指南中的「基本工作欄位」。

  • 列出工作：可廣泛存取工作，僅適用於信任的使用者。

查詢工作

本節說明如何依工作 ID 或追蹤 ID 查詢工作。必須符合下列規定：

  • 依追蹤 ID 進行的查詢必須遵守「追蹤物件的顯示規則」一文所述的顯示規則。

  • 請盡可能使用範圍最窄的權杖，以降低安全性風險。舉例來說，如果您使用 Delivery Consumer Token，任何呼叫只會傳回與該使用者相關的資訊，例如貨件的寄件者或收件者。Fleet Engine 會在回應中遮蓋所有其他資訊。如要進一步瞭解權杖，請參閱「JSON Web Token」。

依工作 ID 查詢工作

您可以使用 gRPC 或 REST，從伺服器環境依工作 ID 查詢工作。下列範例說明如何使用 Java gRPC 程式庫或 REST 要求來 GetTask。

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 Token」中說明的準則發出。
  • 要求主體必須為空白。
  • 如果查詢成功，回應主體會包含工作實體。

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 查詢工作

下列範例說明如何使用 gRPC 或 HTTP REST 呼叫 GetTaskTrackingInfo，依出貨追蹤 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。如果未指定篩選查詢，系統會列出所有工作。

下表列出可用於篩選的有效工作屬性：

用於篩選清單的工作屬性
  • type
  • attributes
  • tracking_id
  • delivery_vehicle_id
  • state
  • planned_location
  • task_duration
  • task_duration_outcome
  • task_outcome
  • task_outcome_location
  • task_outcome_time

如需篩選器查詢運算子的完整清單，請參閱 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}"

後續步驟