ค้นหางาน

เอกสารนี้อธิบายวิธีค้นหาข้อมูลงานจากเซิร์ฟเวอร์หรือเบราว์เซอร์ Fleet Engine รองรับ 2 วิธีในการค้นหางาน ดังนี้

  • ค้นหางาน: คุณค้นหางานได้โดยใช้รหัสต่อไปนี้

    • รหัสงาน: ใช้โดยผู้ใช้ เช่น ผู้ให้บริการยานพาหนะ ซึ่งมีสิทธิ์เข้าถึงมุมมองแบบเต็มของข้อมูลงาน
    • รหัสติดตาม: ใช้โดยซอฟต์แวร์ไคลเอ็นต์ของคุณเพื่อแสดงข้อมูลแบบจำกัด แก่ผู้ใช้ปลายทาง เช่น เมื่อคาดการณ์ว่าพัสดุจะนำส่งถึงบ้าน

    โปรดทำความเข้าใจความแตกต่างระหว่างรหัสงานและรหัสการติดตามงาน สองรายการนี้ไม่เหมือนกัน ดูฟิลด์งานพื้นฐานได้ใน คู่มืองานที่กำหนดเวลาไว้

  • แสดงรายการงาน: สิทธิ์เข้าถึงงานในวงกว้าง ซึ่งมีไว้สำหรับผู้ใช้ที่เชื่อถือได้เท่านั้น

ค้นหางาน

ส่วนนี้อธิบายวิธีค้นหางานตามรหัสงานหรือรหัสการติดตาม โดยมีข้อกำหนดต่อไปนี้

  • การค้นหาตามรหัสติดตามต้องเป็นไปตามกฎการมองเห็น ที่ระบุไว้ในกฎการมองเห็นสำหรับออบเจ็กต์ที่ติดตาม

  • ใช้โทเค็นที่แคบที่สุดเท่าที่จะเป็นไปได้เพื่อจำกัดความเสี่ยงด้านความปลอดภัย ตัวอย่างเช่น หากคุณใช้โทเค็นผู้บริโภคการนำส่ง การเรียกใดๆ จะแสดงเฉพาะข้อมูลที่เกี่ยวข้องกับผู้ใช้ปลายทางนั้น เช่น ผู้จัดส่งหรือผู้รับสินค้า Fleet Engine จะปกปิดข้อมูลอื่นๆ ทั้งหมดใน การตอบกลับ ดูข้อมูลเพิ่มเติมเกี่ยวกับโทเค็นได้ที่โทเค็นเว็บ JSON

ค้นหางานตามรหัสงาน

คุณค้นหางานตามรหัสงานจากสภาพแวดล้อมของเซิร์ฟเวอร์ได้โดยใช้ gRPC หรือ REST ตัวอย่างต่อไปนี้แสดงวิธีใช้ไลบรารี gRPC ของ Java หรือคำขอ 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> คือตัวระบุที่ไม่ซ้ำกันสำหรับงาน
  • <taskId> คือรหัสของงานที่จะค้นหา
  • ส่วนหัวของคำขอต้องมีฟิลด์ Authorization ที่มีค่าเป็น Bearer <token> โดยที่ <token> ออกโดยเซิร์ฟเวอร์ของคุณ ตามหลักเกณฑ์ที่อธิบายไว้ในบทบาทของบัญชีบริการและ โทเค็นเว็บ JSON
  • เนื้อหาของคำขอต้องว่างเปล่า
  • หากการค้นหาสำเร็จ เนื้อหาการตอบกลับจะมีเอนทิตีของงาน

ตัวอย่างคำสั่ง 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}"

ค้นหางานตามรหัสติดตาม

ตัวอย่างต่อไปนี้แสดงวิธีค้นหางานตามรหัสติดตามการจัดส่ง โดยใช้ gRPC หรือการเรียก HTTP REST ไปยัง GetTaskTrackingInfo

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> คือรหัสติดตามที่เชื่อมโยงกับงาน

  • ส่วนหัวของคำขอต้องมีฟิลด์ 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 เมื่อส่งคำขอ list tasks ดูข้อมูลเพิ่มเติมได้ที่บทบาทของบัญชีบริการ

แบ่งหน้าในรายการ

ระบบจะแบ่งหน้าสำหรับรายการงาน คุณระบุขนาดหน้าได้ในคำขอของงานรายการ หากระบุขนาดหน้า จำนวนงานที่แสดงจะไม่เกิน ขนาดหน้าที่ระบุ หากไม่มีขนาดหน้า ระบบจะใช้ค่าเริ่มต้นที่เหมาะสม หากขนาดหน้าที่ขอเกินค่าสูงสุดภายใน ระบบจะใช้ค่าสูงสุดภายใน

รายการงานอาจมีโทเค็นสำหรับการอ่านผลการค้นหาหน้าถัดไป หากต้องการ ดึงข้อมูลหน้าถัดไป ให้ส่งคำขอเดิมอีกครั้งพร้อมกับโทเค็นหน้าเว็บ เมื่อโทเค็นหน้าที่ส่งคืนว่างเปล่า แสดงว่าไม่มีงานให้ดึงข้อมูลอีก

ฟิลด์เมื่อแสดงรายการงาน

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 และแอตทริบิวต์งาน ทั้งด้วยไลบรารี gRPC ของ Java และด้วยการเรียก HTTP REST ไปยัง ListTasks

การตอบกลับที่สำเร็จอาจยังคงว่างเปล่าได้ การตอบกลับที่ว่างเปล่าแสดงว่าไม่มีงานที่เชื่อมโยงกับ 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

หากต้องการใช้ตัวกรองกับงานที่แสดง ให้ใส่พารามิเตอร์ URL "filter" โดยมีคำค้นหาตัวกรองที่หลีก URL เป็นค่า

ส่วนหัวของคำขอต้องมีฟิลด์ 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}"

ขั้นตอนถัดไป