- Permintaan HTTP
- Parameter lokasi
- Isi permintaan
- Isi respons
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Titik jalan
- VehicleMatchType
Menampilkan daftar kendaraan yang cocok dengan opsi permintaan.
Permintaan HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
parent |
Wajib. Harus dalam format |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "header": { object ( |
Kolom | |
---|---|
header |
Header permintaan Fleet Engine standar. |
pickupPoint |
Wajib. Titik penjemputan untuk menelusuri di dekat. |
dropoffPoint |
Lokasi pengantaran yang diinginkan pelanggan. Kolom ini wajib diisi jika |
pickupRadiusMeters |
Wajib. Menentukan radius penelusuran kendaraan di sekitar titik penjemputan. Hanya kendaraan dalam radius pencarian yang akan ditampilkan. Nilai harus antara 400 dan 10.000 meter (inklusif). |
count |
Wajib. Menentukan jumlah maksimum kendaraan yang akan ditampilkan. Nilainya harus antara 1 dan 50 (inklusif). |
minimumCapacity |
Wajib. Menentukan jumlah penumpang yang dipertimbangkan untuk sebuah perjalanan. Nilai harus lebih besar dari atau sama dengan satu. Driver tidak dipertimbangkan dalam nilai kapasitas. |
tripTypes[] |
Wajib. Menampilkan jenis perjalanan yang diusulkan. Harus menyertakan tepat satu jenis. |
maximumStaleness |
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 ' |
vehicleTypes[] |
Wajib. Membatasi penelusuran ke kendaraan dengan salah satu jenis yang ditentukan. Setidaknya satu jenis kendaraan harus ditentukan. VehicleType dengan kategori |
requiredAttributes[] |
Pemanggil dapat membentuk operasi logika yang kompleks menggunakan kombinasi kolom
Membatasi penelusuran hanya untuk kendaraan dengan atribut yang ditentukan. Kolom ini adalah operasi konjungsi/AND. Maksimal 50 atribut wajib yang diizinkan. Jumlah ini sesuai dengan jumlah atribut maksimum yang diizinkan di kendaraan. |
requiredOneOfAttributes[] |
Membatasi penelusuran hanya untuk kendaraan yang memiliki setidaknya satu atribut yang ditentukan di setiap |
requiredOneOfAttributeSets[] |
Serupa dengan
Membatasi penelusuran hanya untuk kendaraan yang memiliki semua atribut di |
orderBy |
Wajib. Menentukan kriteria pengurutan yang diinginkan untuk hasil. |
includeBackToBack |
Detail ini menunjukkan apakah kendaraan dengan satu perjalanan aktif memenuhi syarat untuk penelusuran ini. Kolom ini hanya digunakan jika Nilai default-nya adalah |
tripId |
Menunjukkan perjalanan yang terkait dengan |
currentTripsPresent |
Detail ini menunjukkan apakah kendaraan dengan perjalanan aktif memenuhi syarat untuk penelusuran ini. Nilai ini harus disetel ke sesuatu selain |
filter |
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 Filter ini berfungsi sebagai klausa AND dengan batasan lain, seperti Perhatikan bahwa satu-satunya kueri yang didukung adalah di atribut kendaraan (misalnya, Selain itu, semua atribut disimpan sebagai string, sehingga satu-satunya perbandingan yang didukung terhadap atribut adalah perbandingan string. Untuk membandingkan dengan nilai angka atau boolean, nilai harus dikutip secara eksplisit agar diperlakukan sebagai string (misalnya, |
Isi respons
Pesan respons vehicles.search
.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"matches": [
{
object ( |
Kolom | |
---|---|
matches[] |
Daftar kendaraan yang cocok dengan kriteria |
VehicleAttributeList
Jenis data daftar-daftar untuk atribut kendaraan.
Representasi JSON |
---|
{
"attributes": [
{
object ( |
Kolom | |
---|---|
attributes[] |
Daftar atribut dalam koleksi ini. |
VehicleMatchOrder
Menentukan urutan kecocokan kendaraan dalam respons.
Enum | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Default, digunakan untuk pesanan kecocokan kendaraan yang tidak ditentukan atau tidak dikenal. |
PICKUP_POINT_ETA |
Urutan menaik berdasarkan waktu mengemudi kendaraan ke lokasi penjemputan. |
PICKUP_POINT_DISTANCE |
Urutan menaik berdasarkan jarak mengemudi kendaraan ke titik penjemputan. |
DROPOFF_POINT_ETA |
Urutan menaik berdasarkan waktu mengemudi kendaraan ke titik penurunan. Urutan ini hanya dapat digunakan jika titik penurunan ditentukan dalam permintaan. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Urutan menaik dengan jarak garis lurus dari lokasi terakhir kendaraan ke titik penjemputan. |
COST |
Urutan menaik menurut biaya pencocokan yang dikonfigurasi. Biaya kecocokan didefinisikan sebagai penghitungan tertimbang antara jarak garis lurus dan PWT. Bobot ditetapkan dengan nilai default dan dapat diubah per pelanggan. Hubungi dukungan Google jika bobot ini perlu dimodifikasi untuk project Anda. |
CurrentTripsPresent
Menentukan jenis pembatasan pada perjalanan kendaraan saat ini.
Enum | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
Ketersediaan kendaraan dengan perjalanan yang ada diatur oleh kolom includeBackToBack . |
NONE |
Kendaraan yang tidak memiliki perjalanan dapat muncul di hasil penelusuran. Jika nilai ini digunakan, includeBackToBack tidak boleh true . |
ANY |
Kendaraan dengan maksimal 5 perjalanan saat ini dan 10 titik jalan akan disertakan dalam hasil penelusuran. Jika nilai ini digunakan, includeBackToBack tidak boleh true . |
VehicleMatch
Berisi kendaraan dan estimasi terkait untuk kendaraan yang cocok dengan titik perjalanan aktif untuk kendaraan SearchVehiclesRequest
.
Representasi JSON |
---|
{ "vehicle": { object ( |
Kolom | |
---|---|
vehicle |
Wajib. Kendaraan yang sesuai dengan permintaan. |
vehiclePickupEta |
PWT mengemudi kendaraan ke lokasi penjemputan yang ditentukan dalam permintaan. Nilai kosong menunjukkan kegagalan dalam menghitung PWT untuk kendaraan. Jika Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
vehiclePickupDistanceMeters |
Jarak dari lokasi Kendaraan saat ini ke titik penjemputan yang ditentukan dalam permintaan, termasuk titik penjemputan atau pengantaran perantara untuk perjalanan yang ada. Jarak ini mencakup jarak mengemudi (rute) yang dihitung, ditambah jarak garis lurus antara titik akhir navigasi dan titik penjemputan yang diminta. (Jarak antara titik akhir navigasi dan titik pengambilan yang diminta biasanya kecil.) Nilai kosong menunjukkan error saat menghitung jarak. |
vehiclePickupStraightLineDistanceMeters |
Wajib. Jarak garis lurus antara kendaraan dan titik penjemputan yang ditentukan dalam permintaan. |
vehicleDropoffEta |
PWT mengemudi kendaraan lengkap ke titik penurunan yang ditentukan dalam permintaan. PWT mencakup perhentian di setiap titik jalan sebelum Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
vehiclePickupToDropoffDistanceMeters |
Jarak mengemudi kendaraan (dalam meter) dari titik penjemputan ke titik penurunan yang ditentukan dalam permintaan. Jarak tersebut hanya antara dua titik dan tidak termasuk lokasi kendaraan atau titik lain yang harus dikunjungi sebelum kendaraan mengunjungi titik penjemputan atau titik penurunan. Nilai hanya akan diisi saat |
tripType |
Wajib. Jenis perjalanan permintaan yang digunakan untuk menghitung PWT ke lokasi penjemputan. |
vehicleTripsWaypoints[] |
Daftar titik jalan yang diurutkan yang digunakan untuk menghitung PWT. Daftar tersebut mencakup lokasi kendaraan, titik penjemputan dari perjalanan aktif untuk kendaraan, dan titik penjemputan yang diberikan dalam permintaan. Daftar kosong menunjukkan kegagalan dalam menghitung PWT untuk kendaraan. |
vehicleMatchType |
Kecocokan jenis kendaraan. |
requestedOrderedBy |
Pesanan yang diminta untuk mengurutkan kecocokan kendaraan. |
orderedBy |
Pesanan sebenarnya yang digunakan untuk kendaraan ini. Biasanya ini akan cocok dengan 'orderBy' bidang dari permintaan; Namun, dalam keadaan tertentu seperti error server internal, metode yang berbeda dapat digunakan (seperti |
Waypoint
Menjelaskan titik perantara di sepanjang rute untuk VehicleMatch
dalam SearchVehiclesResponse
. Konsep ini direpresentasikan sebagai TripWaypoint
di semua endpoint lainnya.
Representasi JSON |
---|
{
"latLng": {
object ( |
Kolom | |
---|---|
latLng |
Lokasi titik jalan ini. |
eta |
Perkiraan waktu kendaraan akan tiba di titik jalan ini. Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
VehicleMatchType
Kecocokan jenis kendaraan.
Enum | |
---|---|
UNKNOWN |
Jenis pencocokan kendaraan tidak diketahui |
EXCLUSIVE |
Kendaraan saat ini belum ditetapkan untuk perjalanan dan dapat melanjutkan ke titik penjemputan. |
BACK_TO_BACK |
Kendaraan saat ini ditetapkan untuk perjalanan, tetapi dapat melanjutkan ke titik penjemputan setelah menyelesaikan perjalanan yang sedang berlangsung. Penghitungan PWT dan jarak memperhitungkan perjalanan yang ada. |
CARPOOL |
Kendaraan memiliki kapasitas yang cukup untuk perjalanan bersama. |
CARPOOL_BACK_TO_BACK |
Kendaraan akan menyelesaikan perjalanan aktif saat ini sebelum melanjutkan ke titik penjemputan. Penghitungan PWT dan jarak memperhitungkan perjalanan yang ada. |