Method: providers.deliveryVehicles.list

Lấy tất cả DeliveryVehicle đáp ứng tiêu chí lọc đã chỉ định.

Yêu cầu HTTP

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
parent

string

Bắt buộc. Phải ở định dạng providers/{provider}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.

Tham số truy vấn

Thông số
header

object (DeliveryRequestHeader)

Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn.
pageSize

integer

Không bắt buộc. Số lượng phương tiện tối đa cần trả lại. Dịch vụ có thể trả về ít hơn số lượng này. Nếu bạn không chỉ định số lượng này, thì máy chủ sẽ xác định số lượng kết quả cần trả về.
pageToken

string

Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi deliveryVehicles.list trước đó. Bạn phải cung cấp giá trị này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho deliveryVehicles.list phải khớp với lệnh gọi đã cung cấp mã thông báo trang.
filter

string

Không bắt buộc. Cụm từ tìm kiếm để áp dụng khi đăng thông tin về xe giao hàng. Hãy xem http://aip.dev/160 để biết ví dụ về cú pháp bộ lọc. Nếu bạn không chỉ định giá trị hoặc nếu bạn chỉ định một chuỗi trống cho bộ lọc, thì tất cả các phương tiện phân phối sẽ được trả về.

Xin lưu ý rằng các truy vấn duy nhất được hỗ trợ cho deliveryVehicles.list là các thuộc tính xe (ví dụ: attributes.<key> = <value> hoặc attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Ngoài ra, mọi thuộc tính đều được lưu trữ dưới dạng chuỗi nên các phép so sánh duy nhất được hỗ trợ so với các thuộc tính là phép so sánh chuỗi. Để so sánh với giá trị số hoặc boolean, các giá trị đó phải được đặt trong dấu ngoặc kép rõ ràng để được coi là chuỗi (ví dụ: attributes.<key> = "10" hoặc attributes.<key> = "true").

Số lượng quy tắc hạn chế tối đa được phép trong một truy vấn bộ lọc là 50. Hạn chế là một phần của truy vấn có dạng attribute.<KEY> <COMPARATOR> <VALUE>, ví dụ: attributes.foo = bar là 1 hạn chế.
viewport

object (Viewport)

Không bắt buộc. Bộ lọc giới hạn các xe được trả về ở những vị trí đã biết gần đây nhất nằm trong khu vực hình chữ nhật do khung nhìn xác định.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Thông báo phản hồi deliveryVehicles.list.

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

Biểu diễn dưới dạng JSON 
{
  "deliveryVehicles": [
    {
      object (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Trường
deliveryVehicles[]

object (DeliveryVehicle)

Tập hợp các phương tiện phân phối đáp ứng tiêu chí lọc đã yêu cầu. Khi không chỉ định bộ lọc nào, yêu cầu sẽ trả về tất cả các phương tiện phân phối. Bạn cũng có thể để trống một phản hồi thành công. Nội dung phản hồi trống cho biết không tìm thấy xe giao hàng nào đáp ứng tiêu chí lọc đã yêu cầu.
nextPageToken

string

Bạn có thể truyền mã thông báo này trong ListDeliveryVehiclesRequest để tiếp tục liệt kê kết quả. Khi tất cả kết quả được trả về, trường này sẽ không có trong phản hồi hoặc sẽ là một chuỗi trống.
totalSize

string (int64 format)

Tổng số phương tiện phân phối phù hợp với tiêu chí yêu cầu trên tất cả các trang.

Khung nhìn

Khung nhìn vĩ độ – kinh độ, được biểu thị bằng hai đường chéo đối diện điểm low và high. Khung nhìn được coi là một vùng kín, tức là bao gồm cả ranh giới. Giới hạn vĩ độ phải nằm trong khoảng từ -90 đến 90 độ và giới hạn kinh độ phải nằm trong khoảng từ -180 đến 180 độ. Có nhiều trường hợp như sau:

  • Nếu low = high, khung nhìn sẽ bao gồm một điểm duy nhất đó.

  • Nếu low.longitude > high.longitude, thì dải kinh độ sẽ bị đảo ngược (khung nhìn sẽ cắt ngang đường kinh độ 180 độ).

  • Nếu low.longitude = -180 độ và high.longitude = 180 độ, thì khung nhìn sẽ bao gồm tất cả kinh độ.

  • Nếu low.longitude = 180 độ và high.longitude = -180 độ, thì dải kinh độ sẽ trống.

  • Nếu low.latitude > high.latitude, phạm vi vĩ độ sẽ trống.

Bạn phải điền cả low và high và hộp được biểu thị không được để trống (như được chỉ định theo định nghĩa ở trên). Chế độ xem trống sẽ dẫn đến lỗi.

Ví dụ: khung nhìn này bao gồm toàn bộ Thành phố New York:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Biểu diễn dưới dạng JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Trường
low

object (LatLng)

Bắt buộc. Điểm thấp của khung nhìn.
high

object (LatLng)

Bắt buộc. Điểm cao của khung nhìn.