Method: providers.vehicles.search

{
  "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
}

object (RequestHeader)

Tiêu đề yêu cầu thông thường của Công cụ của đội xe.

object (TerminalLocation)

Bắt buộc. Điểm đón để tìm kiếm ở gần.

object (TerminalLocation)

Địa điểm giao hàng mà khách hàng dự định. Trường này là bắt buộc nếu tripTypes chứa TripType.SHARED.

integer

Bắt buộc. Xác định bán kính tìm kiếm xe xung quanh điểm nhận hàng. Hệ thống sẽ chỉ trả về những chiếc 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).

integer

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

integer

Bắt buộc. Chỉ đị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. Người lái xe không được xem xét trong giá trị hạn mức.

enum (TripType)

Bắt buộc. Biểu thị loại chuyến đi được đề xuất. Phải có đúng một loại. UNKNOWN_TRIP_TYPE là không được phép. Giới hạn tìm kiếm chỉ những xe có thể hỗ trợ loại chuyến đi đó.

string (Duration format)

Chỉ cho phép tìm kiếm những xe đã gửi thông tin cập nhật vị trí đến Công cụ quản lý đội xe trong khoảng thời gian đã chỉ định. Xe đang đỗ vẫn truyền vị trí của chúng không được coi là cũ. Nếu bạn không đặt trường này, máy chủ sẽ sử dụng 5 phút làm giá trị mặc định.

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

object (VehicleType)

Bắt buộc. Hạn chế kết quả tìm kiếm ở những loại xe thuộc một trong các loại đã chỉ định. Bạn phải chỉ định ít nhất một loại xe. Không được phép sử dụng các loại xe có danh mục UNKNOWN.

object (VehicleAttribute)

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

Chỉ cho phép tìm kiếm những chiếc xe có các thuộc tính được chỉ định. Trường này là toán tử kết hợp/AND. 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.

object (VehicleAttributeList)

Giới hạn tìm kiếm chỉ cho 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à một toán tử loại trừ/OR bao gồm trong mỗi VehicleAttributeList và một toán tử kết hợp/AND trên tập hợp VehicleAttributeList.

object (VehicleAttributeList)

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

Giới hạn tìm kiếm chỉ cho những xe có 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à một toán tử kết hợp/AND trong mỗi VehicleAttributeList và toán tử loại trừ bao hàm/OR trên tập hợp VehicleAttributeList.

enum (VehicleMatchOrder)

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

boolean

Thuộc tính này cho biết liệu những phương tiện có một chuyến đi đang hoạt động có đủ điều kiện cho lượt tìm kiếm này hay không. Trường này chỉ được dùng khi currentTripsPresent không được chỉ định. Khi currentTripsPresent không được chỉ định và trường này là false, các phương tiện có chuyến đi được chỉ định sẽ bị loại trừ khỏi kết quả tìm kiếm. Khi 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 các xe có một chuyến đi đang hoạt động và có trạng thái là ENROUTE_TO_DROPOFF. Khi chỉ định currentTripsPresent, bạn không thể đặt trường này thành true.

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

string

Cho biết chuyến đi được liên kết với SearchVehicleRequest này.

enum (CurrentTripsPresent)

Giá trị này cho biết liệu những xe có chuyến đi đang hoạt động có đủ điều kiện cho lượt tìm kiếm này hay không. Giá trị này phải được đặt thành giá trị khác với CURRENT_TRIPS_PRESENT_UNSPECIFIED nếu tripType bao gồm SHARED.

string

Không bắt buộc. Cụm từ tìm kiếm để áp dụng khi tìm kiếm 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 một giá trị không trống tại đâ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 như một mệnh đề AND với các quy tắc ràng buộc khác, chẳng hạn như minimumCapacity hoặc vehicleTypes.

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