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

Các tham 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

Các tham số
header

object (DeliveryRequestHeader)

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

integer

Không bắt buộc. Số lượng xe tối đa có thể trả lại. Dịch vụ có thể trả về ít hơn con số này. Nếu bạn không chỉ định số 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 thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông 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. Một cụm từ tìm kiếm bộ lọc sẽ áp dụng khi đăng thông tin về xe có dịch vụ giao hàng. Hãy xem http://aip.dev/160 để xem 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 chuỗi trống cho bộ lọc, thì tất cả xe giao hàng đều được trả về.

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

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

object (Viewport)

Không bắt buộc. Bộ lọc giới hạn số xe được trả về cho những người có vị trí xác định gần đây nhất là trong khu vực hình chữ nhật được xác định trong khung nhìn.

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

Tin nhắn 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
}
Các trường
deliveryVehicles[]

object (DeliveryVehicle)

Nhóm xe giao hàng đáp ứng các tiêu chí lọc theo yêu cầu. Nếu bạn không chỉ định bộ lọc nào, yêu cầu sẽ trả về tất cả xe giao hàng. Phản hồi thành công cũng có thể bị trống. 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 theo yêu cầu.
nextPageToken

string

Bạn có thể truyền mã thông báo này vào 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ố xe giao hàng phù hợp với tiêu chí yêu cầu, trên tất cả các trang.

Khung nhìn

Một khung nhìn kinh độ – vĩ độ, được biểu thị bằng hai điểm chéo đối diện low và high. Một khung nhìn được coi là một khu vực đóng, tức là khung nhìn bao gồm ranh giới của nó. 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ó một số trường hợp như sau:

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

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

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

  • Nếu low.longitude = 180 độ và high.longitude = -180 độ, thì phạm vi kinh độ sẽ trống.

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

Cả low và high đều phải được điền và không được để trống hộp được đại diện (như được chỉ định trong các định nghĩa ở trên). Nếu một khung nhìn trống sẽ gây ra lỗi.

Ví dụ: khung nhìn này bao quanh đầy đủ 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)
  }
}
Các 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.