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)

Header permintaan Fleet Engine standar.

object (TerminalLocation)

Wajib. Lokasi pengambilan yang akan ditelusuri di dekatnya.

object (TerminalLocation)

Lokasi pengantaran yang diinginkan pelanggan. Kolom ini wajib diisi jika tripTypes berisi TripType.SHARED.

integer

Wajib. Menentukan radius penelusuran kendaraan di sekitar titik penjemputan. Hanya kendaraan dalam radius penelusuran yang akan ditampilkan. Nilai harus antara 400 dan 10.000 meter (inklusif).

integer

Wajib. Menentukan jumlah maksimum kendaraan yang akan ditampilkan. Nilainya harus antara 1 dan 50 (inklusif).

integer

Wajib. Menentukan jumlah penumpang yang dipertimbangkan untuk perjalanan. Nilai harus lebih besar dari atau sama dengan satu. Driver tidak dipertimbangkan dalam nilai kapasitas.

enum (TripType)

Wajib. Merepresentasikan jenis perjalanan yang diusulkan. Harus menyertakan tepat satu jenis. UNKNOWN_TRIP_TYPE tidak diizinkan. Membatasi penelusuran hanya ke kendaraan yang dapat mendukung jenis perjalanan tersebut.

string (Duration format)

Membatasi penelusuran hanya untuk kendaraan yang telah mengirim pembaruan lokasi ke Fleet Engine dalam durasi yang ditentukan. Kendaraan statis yang masih mengirimkan lokasinya tidak dianggap usang. Jika kolom ini tidak disetel, server akan menggunakan lima menit sebagai nilai default.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

object (VehicleType)

Wajib. Membatasi penelusuran ke kendaraan dengan salah satu jenis yang ditentukan. Setidaknya satu jenis kendaraan harus ditentukan. VehicleTypes dengan kategori UNKNOWN tidak diizinkan.

object (VehicleAttribute)

Pemanggil dapat membentuk operasi logis yang kompleks menggunakan kombinasi kolom requiredAttributes, requiredOneOfAttributes, dan requiredOneOfAttributeSets.

requiredAttributes adalah daftar; requiredOneOfAttributes menggunakan pesan yang mengizinkan daftar daftar. Dalam kombinasi, kedua kolom tersebut memungkinkan komposisi ekspresi ini:

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

Membatasi penelusuran hanya untuk kendaraan dengan atribut yang ditentukan. Kolom ini adalah operasi konjungsi/AND. Jumlah atribut wajib yang diizinkan adalah maksimum 50. Jumlah ini sesuai dengan jumlah atribut maksimum yang diizinkan di kendaraan.

object (VehicleAttributeList)

Membatasi penelusuran hanya untuk kendaraan yang memiliki setidaknya satu atribut yang ditentukan di setiap VehicleAttributeList. Dalam setiap daftar, kendaraan harus cocok dengan setidaknya salah satu atribut. Kolom ini adalah operasi disjungsi/OR inklusif di setiap VehicleAttributeList dan operasi konjungsi/AND di seluruh kumpulan VehicleAttributeList.

object (VehicleAttributeList)

requiredOneOfAttributeSets menyediakan fungsi tambahan.

Serupa dengan requiredOneOfAttributes, requiredOneOfAttributeSets menggunakan pesan yang memungkinkan daftar daftar, sehingga memungkinkan ekspresi seperti ini:

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

Membatasi penelusuran hanya untuk kendaraan yang memiliki semua atribut di VehicleAttributeList. Dalam setiap daftar, kendaraan harus cocok dengan semua atribut. Kolom ini adalah operasi konjungsi/AND di setiap VehicleAttributeList dan operasi disjungsi/OR inklusif di seluruh kumpulan VehicleAttributeList.

enum (VehicleMatchOrder)

Wajib. Menentukan kriteria pengurutan yang diinginkan untuk hasil.

boolean

Detail ini menunjukkan apakah kendaraan dengan satu perjalanan aktif memenuhi syarat untuk penelusuran ini. Kolom ini hanya digunakan jika currentTripsPresent tidak ditentukan. Jika currentTripsPresent tidak ditentukan dan kolom ini adalah false, kendaraan dengan perjalanan yang ditetapkan akan dikecualikan dari hasil penelusuran. Jika currentTripsPresent tidak ditentukan dan kolom ini berupa true, hasil penelusuran dapat menyertakan kendaraan dengan satu perjalanan aktif yang memiliki status ENROUTE_TO_DROPOFF. Jika currentTripsPresent ditentukan, kolom ini tidak dapat ditetapkan ke benar (true).

Nilai default-nya adalah false.

string

Menunjukkan perjalanan yang terkait dengan SearchVehicleRequest ini.

enum (CurrentTripsPresent)

Detail ini menunjukkan apakah kendaraan dengan perjalanan aktif memenuhi syarat untuk penelusuran ini. Nilai ini harus disetel ke sesuatu selain CURRENT_TRIPS_PRESENT_UNSPECIFIED jika tripType menyertakan SHARED.

string

Opsional. Kueri filter yang akan diterapkan saat menelusuri kendaraan. Lihat http://aip.dev/160 untuk mengetahui contoh sintaksis filter.

Kolom ini dirancang untuk menggantikan kolom requiredAttributes, requiredOneOfAttributes, dan required_one_of_attributes_sets. Jika nilai yang tidak kosong ditentukan di sini, kolom berikut harus kosong: requiredAttributes, requiredOneOfAttributes, dan required_one_of_attributes_sets.

Filter ini berfungsi sebagai klausa AND dengan batasan lain, seperti minimumCapacity atau vehicleTypes.

Perhatikan bahwa satu-satunya kueri yang didukung adalah pada atribut kendaraan (misalnya, attributes.<key> = <value> atau attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Jumlah maksimum batasan yang diizinkan dalam kueri filter adalah 50.

Selain itu, semua atribut disimpan sebagai string, sehingga satu-satunya perbandingan yang didukung terhadap atribut adalah perbandingan string. Untuk dibandingkan dengan nilai angka atau boolean, nilai harus diapit tanda kutip secara eksplisit agar diperlakukan sebagai string (misalnya, attributes.<key> = "10" atau attributes.<key> = "true").