Method: providers.vehicles.list

Trả về danh sách các xe đã phân trang liên kết với một nhà cung cấp khớp với các lựa chọn cho yêu cầu.

Yêu cầu HTTP

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

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}. Nhà cung cấp phải là Mã dự án (ví dụ: sample-cloud-project) của Dự án Google Cloud có tài khoản dịch vụ thực hiện lệnh gọi này.

Tham số truy vấn

Các tham số
header

object (RequestHeader)

Tiêu đề của yêu cầu Fleet Engine tiêu chuẩn.
pageSize

integer

Số lượng xe tối đa có thể trả lại. Giá trị mặc định: 100.
pageToken

string

Giá trị của nextPageToken được lệnh gọi trước đến vehicles.list cung cấp để bạn có thể phân trang thông qua các nhóm phương tiện. Giá trị này không xác định được nếu tiêu chí lọc của yêu cầu không giống với tiêu chí lọc của lệnh gọi trước đó đến vehicles.list.
minimumCapacity

integer

Xác định dung tích tối thiểu bắt buộc của xe. Tất cả xe được trả lại sẽ có maximumCapacity lớn hơn hoặc bằng giá trị này. Nếu được đặt, giá trị này phải lớn hơn hoặc bằng 0.
tripTypes[]

enum (TripType)

Hạn chế phản hồi cho những xe hỗ trợ ít nhất một trong các loại chuyến đi đã chỉ định.
maximumStaleness

string (Duration format)

Giới hạn phản hồi đối với những xe đã gửi thông tin cập nhật vị trí cho Fleet Engine trong khoảng thời gian đã chỉ định. Những xe đứng yên vẫn đang truyền thông tin vị trí không bị coi là lỗi thời. Nếu có, phải là một khoảng thời gian dương hợp lệ.

Thời lượng tính bằng giây có tối đa 9 chữ số phân số, kết thúc bằng 's'. Ví dụ: "3.5s".
vehicleTypeCategories[]

enum (Category)

Bắt buộc. Hạn chế phản hồi cho các phương tiện thuộc một trong các danh mục loại được chỉ định. UNKNOWN là không được phép.
requiredAttributes[]

string

Phương thức gọi có thể tạo các phép toán logic phức tạp bằng cách sử dụng bất kỳ tổ hợp nào của các trường requiredAttributes, requiredOneOfAttributes và requiredOneOfAttributeSets.

requiredAttributes là một danh sách; requiredOneOfAttributes sử dụng một thông báo cho phép tạo một danh sách các danh sách. Kết hợp với hai trường này, bạn sẽ cho phép tạo biểu thức này:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

Hạn chế phản hồi cho các xe có các thuộc tính đã chỉ định. Trường này là một phép toán cộng/AND. Chỉ cho phép tối đa 50 thuộc tính requiredAttributes. Số lượng thuộc tính này khớp với số lượng thuộc tính tối đa được phép trên xe. Mỗi chuỗi lặp lại phải có định dạng "key:value".
requiredOneOfAttributes[]

string

Hạn chế phản hồi cho các phương tiện có ít nhất một trong các thuộc tính được chỉ định trong mỗi VehicleAttributeList. Trong mỗi danh sách, một chiếc xe phải khớp với ít nhất một trong các thuộc tính. Trường này là một phép phân tách/OR bao hàm trong mỗi VehicleAttributeList và là một phép toán tử kết hợp/AND trên tập hợp VehicleAttributeList. Mỗi chuỗi lặp lại phải có định dạng "key1:value1|key2:value2|key3:value3".
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets cung cấp chức năng bổ sung.

Tương tự như requiredOneOfAttributes, requiredOneOfAttributeSets dùng một thông điệp cho phép tạo danh sách các danh sách, cho phép các biểu thức như sau:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

Giới hạn phản hồi cho những phương tiện khớp với mọi thuộc tính trong VehicleAttributeList. Trong mỗi danh sách, một chiếc xe phải phù hợp với tất cả các thuộc tính. Trường này là một phép toán tử kết hợp/AND trong mỗi VehicleAttributeList và phép phân ly/OR bao gồm cả hai thao tác này trên tập hợp VehicleAttributeList. Mỗi chuỗi lặp lại phải có định dạng "key1:value1|key2:value2|key3:value3".
vehicleState

enum (VehicleState)

Hạn chế phản hồi những phương tiện có trạng thái xe này.
onTripOnly

boolean

Chỉ trả lại những phương tiện có(các) chuyến đi hiện tại.
filter

string

Không bắt buộc. Một cụm từ tìm kiếm bộ lọc để áp dụng khi đăng thông tin xe. Hãy xem http://aip.dev/160 để xem ví dụ về cú pháp bộ lọc.

Trường này được thiết kế để thay thế các trường requiredAttributes, requiredOneOfAttributes và required_one_of_attributes_sets. Nếu chỉ định giá trị không trống ở đây, thì các trường sau phải trống: requiredAttributes, requiredOneOfAttributes và required_one_of_attributes_sets.

Bộ lọc này hoạt động dưới dạng mệnh đề AND với các điều kiện ràng buộc khác, chẳng hạn như vehicleState hoặc onTripOnly.

Xin lưu ý rằng chỉ những cụm từ tìm kiếm được hỗ trợ về thuộc tính xe (ví dụ: attributes.<key> = <value> hoặc attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Số lượng hạn chế tối đa được phép trong một cụm từ tìm kiếm bộ lọc là 50.

Ngoài ra, tất cả thuộc tính đều được lưu trữ dưới dạng chuỗi, do đó, 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").
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

vehicles.list tin nhắn phản hồi.

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 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Các trường
vehicles[]

object (Vehicle)

Những xe đáp ứng các tiêu chí trong yêu cầu. Số lượng xe tối đa được trả lại được xác định theo trường pageSize trong yêu cầu.
nextPageToken

string

Mã thông báo để truy xuất trang xe tiếp theo, hoặc để trống nếu không còn xe nào đáp ứng tiêu chí yêu cầu.
totalSize

string (int64 format)

Bắt buộc. Tổng số xe đáp ứng 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.