Tài liệu này mô tả những cách bạn có thể tìm thông tin về nhiệm vụ từ một máy chủ hoặc trình duyệt. Fleet Engine hỗ trợ 2 cách tìm nhiệm vụ:
Tra cứu nhiệm vụ: Bạn có thể tra cứu nhiệm vụ theo các mã sau:
- Mã nhiệm vụ: được sử dụng bởi những người dùng như nhà điều hành đội xe, những người có quyền truy cập vào chế độ xem đầy đủ dữ liệu nhiệm vụ.
- Mã theo dõi: do phần mềm ứng dụng của bạn sử dụng để cung cấp thông tin hạn chế cho người dùng cuối, chẳng hạn như thời điểm dự kiến gói hàng sẽ đến nhà họ.
Hãy nhớ nắm rõ sự khác biệt giữa mã nhiệm vụ và mã theo dõi nhiệm vụ. Hai trường hợp này không phải là một. Xem phần Các trường cơ bản của nhiệm vụ trong hướng dẫn Nhiệm vụ đã lên lịch.
Liệt kê nhiệm vụ: quyền truy cập rộng rãi vào các nhiệm vụ, chỉ dành cho những người dùng đáng tin cậy.
Tra cứu nhiệm vụ
Phần này mô tả cách tra cứu nhiệm vụ theo mã nhiệm vụ hoặc mã theo dõi. Phần này có các yêu cầu sau:
Việc tra cứu theo mã theo dõi phải tuân thủ các quy tắc về khả năng hiển thị được nêu trong phần Quy tắc về khả năng hiển thị đối với các đối tượng được theo dõi.
Sử dụng mã thông báo hẹp nhất có thể để hạn chế rủi ro bảo mật. Ví dụ: nếu bạn sử dụng Mã thông báo người tiêu dùng dịch vụ giao hàng, thì mọi lệnh gọi chỉ trả về thông tin liên quan đến người dùng cuối đó, chẳng hạn như người gửi hoặc người nhận lô hàng. Fleet Engine sẽ biên tập tất cả thông tin khác trong các phản hồi. Để biết thêm thông tin về mã thông báo, hãy xem bài viết Mã thông báo web JSON.
Tra cứu nhiệm vụ theo mã nhiệm vụ
Bạn có thể tra cứu một nhiệm vụ theo mã nhiệm vụ của nhiệm vụ đó từ môi trường máy chủ bằng gRPC hoặc REST. Các ví dụ sau đây cho thấy cách sử dụng thư viện gRPC Java hoặc yêu cầu REST đến 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> là giá trị nhận dạng duy nhất của nhiệm vụ.
- <taskId> là mã của nhiệm vụ cần tra cứu.
- Tiêu đề của yêu cầu phải chứa một trường Authorization có giá trị Bearer <token>, trong đó <token> do máy chủ của bạn cấp theo các nguyên tắc được mô tả trong phần Vai trò tài khoản dịch vụ và mã thông báo web JSON.
- Nội dung yêu cầu phải trống.
- Nếu tra cứu thành công, nội dung phản hồi sẽ chứa một thực thể nhiệm vụ.
Lệnh curl mẫu:
# 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}"
Tra cứu nhiệm vụ theo mã theo dõi
Các ví dụ sau đây cho thấy cách tra cứu việc cần làm theo mã theo dõi lô hàng bằng gRPC hoặc lệnh gọi REST HTTP đến 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> là mã theo dõi được liên kết với nhiệm vụ.
Tiêu đề của yêu cầu phải chứa một trường Authorization có giá trị Bearer <token>, trong đó <token> mang vai trò tài khoản dịch vụ chính xác. Xem phần Vai trò tài khoản dịch vụ.
Nếu tra cứu thành công, nội dung phản hồi sẽ chứa một taskTrackingInfo.
Lệnh curl mẫu:
# 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}"Liệt kê nhiệm vụ
Yêu cầu liệt kê nhiệm vụ cho phép truy cập rộng rãi vào các nhiệm vụ. Tính năng liệt kê nhiệm vụ chỉ dành cho những người dùng đáng tin cậy. Sử dụng mã thông báo xác thực Delivery Fleet Reader hoặc Delivery Admin khi đưa ra yêu cầu liệt kê nhiệm vụ. Xem phần Vai trò tài khoản dịch vụ để biết thêm thông tin.
Phân trang danh sách
Danh sách nhiệm vụ được phân trang. Bạn có thể chỉ định kích thước trang trong yêu cầu liệt kê nhiệm vụ. Nếu bạn chỉ định kích thước trang, thì số lượng nhiệm vụ được trả về sẽ không lớn hơn kích thước trang đã chỉ định. Nếu không có kích thước trang, hệ thống sẽ sử dụng giá trị mặc định hợp lý. Nếu kích thước trang được yêu cầu vượt quá giá trị tối đa nội bộ, thì hệ thống sẽ sử dụng giá trị tối đa nội bộ.
Danh sách việc cần làm có thể bao gồm một mã thông báo để đọc trang kết quả tiếp theo. Để truy xuất trang tiếp theo đó, hãy phát hành lại cùng một yêu cầu cùng với mã thông báo trang. Khi mã thông báo trang được trả về là trống, sẽ không có thêm nhiệm vụ nào để truy xuất.
Các trường khi liệt kê nhiệm vụ
Fleet Engine sẽ biên tập các trường sau đây khi liệt kê nhiệm vụ:
VehicleStop.planned_locationVehicleStop.stateVehicleStop.TaskInfo.taskId
Sử dụng các định dạng trường sau đây dựa trên Đề xuất cải tiến API của Google:
| Loại trường | Định dạng | Ví dụ: |
|---|---|---|
| Dấu thời gian | RFC-3339 | task_outcome_time = 2022-03-01T11:30:00-08:00 |
| Thời lượng | Số giây, tiếp theo là s |
task_duration = 120s |
| Enum | Chuỗi | state = CLOSED AND type = PICKUP |
| Thông tin vị trí | point.latitude và point.longitude |
planned_location.point.latitude > 36.1 AND planned_location.point.longitude < -122.0 |
Lọc các nhiệm vụ được liệt kê
Bạn có thể lọc các nhiệm vụ được liệt kê theo hầu hết các thuộc tính của nhiệm vụ. Để biết cú pháp truy vấn bộ lọc, hãy xem AIP-160. Nếu không có truy vấn bộ lọc nào được chỉ định, thì tất cả các nhiệm vụ sẽ được liệt kê.
Bảng sau đây cho thấy các thuộc tính hợp lệ của nhiệm vụ mà bạn có thể sử dụng để lọc:
| Thuộc tính của nhiệm vụ để lọc danh sách | |
|---|---|
|
|
Xem AIP-160 để biết danh sách đầy đủ các toán tử truy vấn bộ lọc.
Ví dụ về danh sách việc cần làm
Ví dụ sau đây cho thấy cách liệt kê nhiệm vụ cho một deliveryVehicleId và một thuộc tính của nhiệm vụ, cả bằng thư viện gRPC Java và bằng lệnh gọi REST HTTP đến ListTasks.
Phản hồi thành công vẫn có thể trống. Phản hồi trống cho biết không có nhiệm vụ nào được liên kết với deliveryVehicleId được cung cấp.
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
Để áp dụng bộ lọc cho các nhiệm vụ được liệt kê, hãy thêm tham số URL "filter" có truy vấn bộ lọc đã thoát URL làm giá trị.
Tiêu đề của yêu cầu phải chứa một trường Authorization có giá trị Bearer <token>, trong đó <token> mang vai trò tài khoản dịch vụ chính xác. Xem phần Vai trò tài khoản dịch vụ.
Tra cứu thành công sẽ cung cấp nội dung phản hồi có cấu trúc sau:
// JSON representation
{
"tasks": [
{
object (Task)
}
],
"nextPageToken": string,
"totalSize": integer
}
Lệnh curl mẫu:
# 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}"