Tài liệu này mô tả các cách để bạn có thể tìm thông tin tác vụ từ máy chủ hoặc trình duyệt. Công cụ của Fleet hỗ trợ hai cách tìm tác vụ:
Tra cứu việc cần làm: Bạn có thể tra cứu việc cần làm theo các mã sau:
- Mã việc cần làm: được những người dùng, chẳng hạn như nhà vận hành hệ thống thiết bị có quyền truy cập vào chế độ xem toàn bộ dữ liệu công việc, sử dụng.
- Mã theo dõi: được 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ư khi dự kiến nhận gói hàng tại nhà của họ.
Hãy nhớ hiểu rõ sự khác biệt giữa mã tác vụ và mã theo dõi tác vụ. Hai trường hợp này không phải là một. Hãy xem phần Các trường của nhiệm vụ cơ bản trong hướng dẫn về nhiệm vụ theo lịch.
Danh sách việc cần làm: quyền truy cập rộng rãi vào các việc cần làm, chỉ dành cho người dùng đáng tin cậy.
Tra cứu việc cần làm
Phần này mô tả cách tra cứu công việc theo mã công việc hoặc mã theo dõi. Ứng dụng này có các yêu cầu sau:
Các hoạt động tra cứu bằng mã theo dõi phải tuân thủ các quy tắc hiển thị nêu trong Quy tắc về chế độ hiển thị cho đố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 dùng phân phối, mọi lệnh gọi sẽ 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ẽ loại bỏ mọi thông tin khác trong phản hồi. Để biết thêm thông tin về mã thông báo, hãy xem mã thông báo Web JSON.
Tra cứu việc cần làm theo mã việc cần làm
Bạn có thể dùng gRPC hoặc REST để tra cứu một công việc theo mã công việc của công việc đó trong môi trường máy chủ. Các ví dụ sau đây minh hoạ cách sử dụng thư viện Java gRPC hoặc một yêu cầu 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> là giá trị nhận dạng duy nhất của tác vụ.
- <taskId> là mã nhận dạng của việc cần làm cần tra cứu.
- Tiêu đề yêu cầu phải chứa một trường Uỷ quyền với giá trị Bearer <token>, trong đó <token> do máy chủ của bạn cấp theo nguyên tắ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ể công việc.
Ví dụ về lệnh 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}"
Tra cứu công việc theo mã theo dõi
Các ví dụ sau đây cho thấy cách tra cứu công việc theo mã vận đơn bằng cách sử dụng gRPC hoặc lệnh gọi HTTP REST đế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 tác vụ.
Tiêu đề yêu cầu phải chứa trường Authorization (Uỷ quyền) có giá trị Bearer <token>, trong đó <token> mang vai trò tài khoản dịch vụ chính xác. Xem Vai trò của 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 thực thể taskTrackingInfo.
Ví dụ về lệnh 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}"
Liệt kê việc cần làm
Công việc trong trang thông tin yêu cầu quyền truy cập rộng rãi vào công việc. Tính năng liệt kê công việc chỉ dành cho người dùng đáng tin cậy. Sử dụng mã xác thực của Trình đọc nhóm phân phối hoặc Quản trị viên phân phối khi gửi yêu cầu tác vụ liên quan đến danh sách. Hãy xem bài viết Vai trò trong tài khoản dịch vụ để biết thêm thông tin.
Phân trang danh sách
Danh sách việc cần làm được phân trang. Bạn có thể chỉ định kích thước trang trong yêu cầu tác vụ danh sách. Nếu bạn chỉ định kích thước trang, thì số lượng tác 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, thì 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ì kích thước tối đa nội bộ sẽ được sử dụng.
Danh sách công việc 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 đưa ra lại yêu cầu tương tự cùng với mã thông báo trang. Khi mã thông báo trang được trả về trống, sẽ không có thêm tác vụ nào để truy xuất.
Các trường khi liệt kê việc cần làm
Công cụ quản lý đội xe sẽ loại bỏ các trường sau đây khi liệt kê công việc:
VehicleStop.planned_location
VehicleStop.state
VehicleStop.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, theo sau là s |
task_duration = 120s |
Enum | Chuỗi | state = CLOSED AND type = PICKUP |
Vị trí | point.latitude và point.longitude |
planned_location.point.latitude > 36.1 AND planned_location.point.longitude < -122.0 |
Lọc việc cần làm đã liệt kê
Bạn có thể lọc các công việc được liệt kê theo hầu hết thuộc tính của công việc. Để biết cú pháp truy vấn bộ lọc, hãy xem AIP-160. Nếu bạn không chỉ định truy vấn bộ lọc, tất cả công việc sẽ được liệt kê.
Bảng sau đây trình bày các thuộc tính công việc hợp lệ mà bạn có thể dùng để lọc:
Thuộc tính tác vụ để lọc danh sách | |
---|---|
|
|
Hãy xem AIP-160 để biết danh sách đầy đủ các toán tử truy vấn bộ lọc.
Liệt kê ví dụ về tác vụ
Ví dụ sau đây cho thấy cách liệt kê các tác vụ cho deliveryVehicleId
và thuộc tính tác vụ, cả bằng thư viện gRPC Java và bằng lệnh gọi HTTP REST đến ListTasks
.
Một phản hồi thành công vẫn có thể trống. Nội dung phản hồi trống cho biết không có tác vụ nào liên kết với deliveryVehicleId
đã 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 công việc trong danh sách, hãy thêm tham số URL "bộ lọc" với truy vấn bộ lọc được thoát URL làm giá trị.
Tiêu đề yêu cầu phải chứa một trường Uỷ quyền có giá trị Bearer <token>, trong đó <token> mang đúng vai trò tài khoản dịch vụ. Xem Vai trò của tài khoản dịch vụ.
Một lượt 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
}
Ví dụ về lệnh 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}"