Method: providers.vehicles.list

Trả về danh sách xe được phân trang có liên kết với một nhà cung cấp phù hợp với các lựa chọn trong 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

Thông 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 trên Google Cloud mà tài khoản dịch vụ thực hiện lệnh gọi này là thành viên.

Tham số truy vấn

Thông số
header

object (RequestHeader)

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

integer

Số lượng phương tiện tối đa cần trả lại. Giá trị mặc định: 100.
pageToken

string

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

integer

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

enum (TripType)

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

string (Duration format)

Hạn chế phản hồi đối với những phương tiện đã gửi thông tin cập nhật vị trí cho Fleet Engine trong khoảng thời gian cụ thể. Các phương tiện tại chỗ vẫn truyền dữ liệu vị trí của chúng không bị coi là lỗi thời. Nếu có, phải là một thời lượng dương hợp lệ.

Thời lượng tính bằng giây với 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 đối với những phương tiện có một trong các danh mục loại đã chỉ định. UNKNOWN là không được phép.
requiredAttributes[]

string

Phương thức gọi có thể tạo thành 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 dùng một thông báo cho phép tạo một danh sách gồm các danh sách. Khi được kết hợp, 2 trường này cho phép thành phần của 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 đối với những xe có các thuộc tính được chỉ định. Trường này là phép toán kết hợp/VÀ. Cho phép tối đa 50 requiredAttributes. Giá trị này khớp với số lượng thuộc tính tối đa được phép trên một chiếc 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 những 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à phép toán tách/HOẶC toàn diện trong mỗi VehicleAttributeList và phép kết hợp/VÀ 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 sử dụng một thông báo cho phép tạo một danh sách gồm nhiều danh sách, cho phép các biểu thức như danh sách này:

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

Hạn chế phản hồi cho các phương tiện khớp với tất cả thuộc tính trong VehicleAttributeList. Trong mỗi danh sách, một chiếc xe phải khớp với tất cả các thuộc tính. Trường này là phép toán kết hợp/VÀ trong mỗi VehicleAttributeList và phép tách/HOẶC bao gồm 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 đối với những xe có trạng thái xe này.
onTripOnly

boolean

Chỉ trả xe cùng(các) chuyến đi hiện tại.
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. Hãy xem http://aip.dev/160 để biết 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 bạn chỉ định giá trị không trống ở đây, thì các trường sau đây 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 cùng 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 các truy vấn duy nhất được hỗ trợ là về các thuộc tính xe (ví dụ: attributes.<key> = <value> hoặc attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Số lượng giới hạn tối đa được phép trong một truy vấn bộ lọc là 50.

Ngoài ra, mọi thuộc tính đều được lưu trữ dưới dạng chuỗi, do đó, phép so sánh duy nhất được hỗ trợ so với các thuộc tính là so sánh chuỗi. Để so sánh với giá trị số hoặc giá trị boolean, các giá trị phải được trích dẫn rõ ràng để được xử lý dưới dạng 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 những xe được đưa về là những xe có vị trí xác định gần đây nhất nằm trong khu vực hình chữ nhật mà 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

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
}
Trường
vehicles[]

object (Vehicle)

Xe phù hợp với các tiêu chí trong yêu cầu. Số lượng xe tối đa được trả về được xác định bằng trường pageSize trong yêu cầu.
nextPageToken

string

Mã thông báo để truy xuất trang tiếp theo của xe 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 các tiêu chí của 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. Một khung nhìn được xem là một khu vực đóng, tức là khu vực đó bao gồm cả 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ó nhiều trường hợp như sau:

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

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

  • Nếu low.longitude = -180 độ và high.longitude = 180 độ, 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 độ trống.

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

Cả low và high đều phải được điền và không được để trống ô được thể hiện (như được chỉ định trong các định nghĩa ở trên). Chế độ xem trống sẽ dẫn đến lỗi.

Ví dụ: khung nhìn này bao quanh hoàn toàn Thành phố New York:

{ "thấp": { "vĩ độ": 40.477398, "kinh độ": -74.259087 }, "cao": { "vĩ độ": 40.91618, "kinh độ": -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.