Liệt kê xe giao hàng

Tài liệu này mô tả cách đăng xe giao hàng.

Môi trường và giới hạn

Bạn có thể liệt kê các phương tiện phân phối từ môi trường máy chủ hoặc trình duyệt. SDK của trình điều khiển không hỗ trợ việc đăng xe giao hàng.

Việc đăng xe tải hàng yêu cầu quyền truy cập rộng rãi vào xe tải hàng và chỉ dành cho những người dùng đáng tin cậy. Sử dụng mã thông báo của Trình đọc nhóm phân phối hoặc Quản trị viên phân phối của Fleet Engine khi đưa ra yêu cầu về xe giao hàng theo danh sách.

Các trường sau đây bị loại bỏ do ảnh hưởng của các trường trong danh sách xe giao hàng đến kích thước phản hồi:

  • CurrentRouteSegment
  • RemainingVehicleJourneySegments

Cách sử dụng

Bạn có thể liệt kê xe theo bộ lọc thuộc tính và giới hạn khung nhìn. Nếu bạn chỉ định không có bộ lọc hoặc khung nhìn, thì phản hồi sẽ bao gồm tất cả các phương tiện giao hàng.

Danh sách có bộ lọc thuộc tính

Bạn có thể liệt kê xe giao hàng theo bộ lọc bằng cách sử dụng thuộc tính attributes của xe. Ví dụ: để truy vấn một thuộc tính có khoá my_key và giá trị my_value, hãy sử dụng attributes.my_key = my_value. Để truy vấn nhiều thuộc tính, hãy kết hợp các truy vấn bằng cách sử dụng toán tử logic ANDOR như trong attributes.key1 = value1 AND attributes.key2 = value2. Hãy xem AIP-160 để biết nội dung mô tả đầy đủ về cú pháp truy vấn bộ lọc. Nếu bạn kết hợp bộ lọc với giới hạn khung nhìn, bộ lọc sẽ đóng vai trò là toán tử AND cho giới hạn khung nhìn. Hãy xem phần Truy vấn bộ lọc thuộc tính xe để biết thông tin chi tiết.

Danh sách có giới hạn khung nhìn

Bạn có thể lọc các xe giao hàng trong danh sách theo vị trí bằng cách sử dụng tham số yêu cầu viewport. Tham số yêu cầu viewport xác định khung nhìn bằng hai toạ độ giới hạn: cặp toạ độ vĩ độ và kinh độ high (đông bắc) và low (Tây Nam). Yêu cầu sẽ bị từ chối nếu vĩ độ cao thấp hơn vĩ độ địa lý thấp.

Liệt kê câu trả lời

Theo mặc định, danh sách xe giao hàng được phân trang bằng kích thước trang hợp lý. Nếu bạn chỉ định kích thước trang, yêu cầu sẽ chỉ trả về số lượng xe theo giới hạn hoặc ít hơn. 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. Kích thước trang mặc định và tối đa đều là 100 xe.

Danh sách xe giao hàng có thể bao gồm một mã thông báo để đọc trang kết quả tiếp theo. Mã thông báo trang chỉ xuất hiện trong phản hồi khi có thêm trang phương tiện giao hàng để truy xuất. Để truy xuất trang tác vụ tiếp theo, hãy sử dụng mã thông báo trang với yêu cầu giống hệt với yêu cầu trước đó.

Danh sách ví dụ về xe

Bạn có thể sử dụng thư viện gRPC Java hoặc REST để liệt kê xe tải giao hàng ở một khu vực cụ thể có một thuộc tính nhất định. Một phản hồi thành công vẫn có thể trống. Khi điều đó xảy ra, có nghĩa là không xe nào có thuộc tính đã chỉ định tồn tại trong khung nhìn đã chỉ định.

Java


  static final String PROJECT_ID = "my-delivery-co-gcp-project";

  DeliveryServiceBlockingStub deliveryService =
    DeliveryServiceGrpc.newBlockingStub(channel);

  // Tasks request
  String parent = "providers/" + PROJECT_ID;
  ListDeliveryVehiclesRequest listDeliveryVehiclesRequest =
    ListDeliveryVehiclesRequest.newBuilder()  // No need for the header
        .setParent(parent)
        .setViewport(
              Viewport.newBuilder()
                .setHigh(LatLng.newBuilder()
                    .setLatitude(37.45)
                    .setLongitude(-122.06)
                    .build())
                .setLow(LatLng.newBuilder()
                    .setLatitude(37.41)
                    .setLongitude(-122.11)
                    .build())
        .setFilter("attributes.my_key = my_value")
        .build();

  try {
    ListDeliveryVehiclesResponse listDeliveryVehiclesResponse =
        deliveryService.listDeliveryVehicles(listDeliveryVehiclesRequest);
  } catch (StatusRuntimeException e) {
    Status s = e.getStatus();
    switch (s.getCode()) {
        case NOT_FOUND:
            break;

        case PERMISSION_DENIED:
            break;
    }
    return;
  }

REST

  # HTTP request
  html GET https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles

  # Request with a filter
  # Request sets JWT, PROJECT_ID, and VEHICLE_ID in the local environment
  curl -H "Authorization: Bearer ${JWT}" \
    "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles?filter=attributes.my_key%20%3D%20my_value%20&viewport.high.latitude=37.45&viewport.high.longitude=-122.06&viewport.low.latitude=37.41&viewport.low.longitude=-122.11"

Nếu tra cứu thành công thì nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

  // JSON representation
  {
    "deliveryVehicles": [
      {
        object (DeliveryVehicle)
      }
    ],
    "nextPageToken": string,
    "totalSize": integer
  }

Bước tiếp theo