Method: providers.vehicles.search

Trả về danh sách xe phù hợp với các lựa chọn yêu cầu.

Yêu cầu HTTP

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

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

Tham số đường dẫn

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.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}
Trường
header

object (RequestHeader)

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

object (TerminalLocation)

Bắt buộc. Điểm đón khách để tìm kiếm gần.
dropoffPoint

object (TerminalLocation)

Vị trí trả xe dự kiến của khách hàng. Trường này là bắt buộc nếu tripTypes chứa TripType.SHARED.
pickupRadiusMeters

integer

Bắt buộc. Xác định bán kính tìm kiếm xe xung quanh điểm đón khách. Hệ thống chỉ trả về những xe nằm trong bán kính tìm kiếm. Giá trị phải nằm trong khoảng từ 400 đến 10.000 mét (bao gồm).
count

integer

Bắt buộc. Chỉ định số lượng xe tối đa cần trả lại. Giá trị phải nằm trong khoảng từ 1 đến 50 (bao gồm).
minimumCapacity

integer

Bắt buộc. Xác định số lượng hành khách được xem xét cho một chuyến đi. Giá trị phải lớn hơn hoặc bằng 1. Trình điều khiển không được xem xét trong giá trị hạn mức.
tripTypes[]

enum (TripType)

Bắt buộc. Đại diện cho loại chuyến đi được đề xuất. Phải bao gồm chính xác một loại. UNKNOWN_TRIP_TYPE là không được phép. Chỉ những xe có thể hỗ trợ loại chuyến đi đó mới có thể tìm kiếm.
maximumStaleness

string (Duration format)

Giới hạn tìm kiếm ở 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 bạn không đặt trường này, máy chủ sẽ sử dụng giá trị mặc định là 5 phút.

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".
vehicleTypes[]

object (VehicleType)

Bắt buộc. Giới hạn việc tìm kiếm trong những xe thuộc một trong các loại được chỉ định. Bạn phải chỉ định ít nhất một loại phương tiện. Không được phép sử dụng các loại xe thuộc danh mục UNKNOWN.
requiredAttributes[]

object (VehicleAttribute)

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
...)

Chỉ những xe có các thuộc tính đã chỉ định mới được tìm kiếm. 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.
requiredOneOfAttributes[]

object (VehicleAttributeList)

Chỉ tìm những xe có ít nhất một thuộc tính đã 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.
requiredOneOfAttributeSets[]

object (VehicleAttributeList)

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
  ...)
)

Chỉ những chiếc xe có tất cả các thuộc tính trong VehicleAttributeList mới được tìm kiếm. 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.
orderBy

enum (VehicleMatchOrder)

Bắt buộc. Xác định tiêu chí sắp xếp mong muốn cho kết quả.
includeBackToBack

boolean

Thuộc tính này cho biết những phương tiện có một chuyến đi đang hoạt động có đủ điều kiện cho nội dung tìm kiếm này hay không. Trường này chỉ được dùng khi chưa chỉ định currentTripsPresent. Nếu bạn không chỉ định currentTripsPresent và trường này là false, thì những xe có chuyến đi được chỉ định sẽ bị loại trừ khỏi kết quả tìm kiếm. Nếu bạn không chỉ định currentTripsPresent và trường này là true, kết quả tìm kiếm có thể bao gồm những phương tiện có một chuyến đi đang hoạt động có trạng thái ENROUTE_TO_DROPOFF. Khi currentTripsPresent đã được chỉ định, bạn không thể đặt trường này thành true (đúng).

Giá trị mặc định là false.
tripId

string

Cho biết chuyến đi liên quan đến SearchVehicleRequest này.
currentTripsPresent

enum (CurrentTripsPresent)

Cột này cho biết những phương tiện có chuyến đi đang hoạt động có đủ điều kiện xuất hiện trong nội dung tìm kiếm này hay không. Bạn phải đặt giá trị này không phải là CURRENT_TRIPS_PRESENT_UNSPECIFIED nếu tripType bao gồm SHARED.
filter

string

Không bắt buộc. Một cụm từ tìm kiếm bộ lọc để áp dụng khi tìm 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ư minimumCapacity hoặc vehicleTypes.

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").

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của SearchVehiclesResponse.