Method: providers.vehicles.list

Trả về danh sách xe được phân trang liên kết với một nhà cung cấp khớp với các tuỳ chọn 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 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 đó đến vehicles.list cung cấp để bạn có thể phân trang qua các nhóm xe. Giá trị này không 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 đó đến 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ả cá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 được đặt, phải lớn hơn hoặc bằng 0.
tripTypes[]

enum (TripType)

Hạn chế phản hồi ở 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 xe đã gửi thông tin cập nhật vị trí đến Động cơ của đội xe trong khoảng thời gian được chỉ định. 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 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ố thập phân, 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 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 danh sách danh sách. Khi kết hợp, hai 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à toán tử kết hợp/AND. Bạn chỉ được chỉ định tối đa 50 requiredAttributes. Số lượng này khớp với số lượng thuộc tính tối đa được phép trên một xe. Mỗi chuỗi lặp lại phải có định dạng "khoá:giá trị".
requiredOneOfAttributes[]

string

Hạn chế phản hồi đối với những xe 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 xe phải khớp với ít nhất một thuộc tính. Trường này là toán tử tách/OR bao gồm trong mỗi VehicleAttributeList và phép toán 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 "khoá1:giá trị1|khoá2:giá trị2|khoá3:giá trị3".
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 danh sách 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
  ...)
)

Hạn chế phản hồi đối với những chiếc xe khớp với tất cả cá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 "khoá1:giá trị1|khoá2:giá trị2|khoá3:giá trị3".
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ả về những xe có (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 như một mệnh đề AND với các quy tắc 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 của 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 truy vấn bộ lọc là 50.

Ngoài ra, tất cả các thuộc tính đều được lưu trữ dưới dạng chuỗi, vì vậy, việc so sánh duy nhất được hỗ trợ đối với các thuộc tính là 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").
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

Thông báo phản hồi vehicles.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 
{
  "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ởi trường pageSize trong yêu cầu.
nextPageToken

string

Mã thông báo để truy xuất trang tiếp theo về 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 phù hợp với tiêu chí yêu cầu trên tất cả các trang.

Khung nhìn

Chế độ xem vĩ độ-kinh độ, được biểu thị dưới dạng hai điểm low và high đối diện nhau theo đường chéo. 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 chỉ 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ì phạm vi kinh độ trống.

  • Nếu low.latitude > high.latitude, thì 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 quanh hoàn toàn Thành phố New York:

{ &quot;low&quot;: { &quot;latitude&quot;: 40.477398, &quot;longitude&quot;: -74.259087 }, &quot;high&quot;: { &quot;latitude&quot;: 40.91618, &quot;longitude&quot;: -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.