- 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 pencarian kendaraan di sekitar titik penjemputan. Hanya kendaraan dalam radius penelusuran yang akan ditampilkan. Nilai harus antara 400 dan 10.000 meter (inklusif). |
count |
Wajib. Menentukan jumlah maksimum kendaraan yang akan ditampilkan. Nilai harus antara 1 dan 50 (inklusif). |
minimumCapacity |
Wajib. Menentukan jumlah penumpang yang dipertimbangkan untuk perjalanan. Nilai harus lebih besar atau sama dengan satu. Driver tidak dipertimbangkan dalam nilai kapasitas. |
tripTypes[] |
Wajib. Mewakili jenis perjalanan yang diusulkan. Harus menyertakan tepat satu jenis. |
maximumStaleness |
Membatasi penelusuran hanya pada kendaraan yang telah mengirimkan pembaruan lokasi ke Fleet Engine dalam durasi yang ditentukan. Kendaraan tidak bergerak 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, diakhiri dengan ' |
vehicleTypes[] |
Wajib. Membatasi penelusuran pada kendaraan dengan salah satu jenis yang ditentukan. Minimal satu jenis kendaraan harus ditentukan. VehicleType dengan kategori |
requiredAttributes[] |
Pemanggil dapat membentuk operasi logis yang kompleks menggunakan kombinasi kolom
Membatasi penelusuran hanya pada kendaraan dengan atribut yang ditentukan. Kolom ini merupakan operasi gabungan/DAN. Maksimum 50 requiredAttributes diizinkan. Jumlah ini cocok dengan jumlah atribut maksimum yang diizinkan di kendaraan. |
requiredOneOfAttributes[] |
Membatasi penelusuran hanya untuk kendaraan tersebut yang memiliki setidaknya salah satu atribut yang ditentukan di setiap |
requiredOneOfAttributeSets[] |
Serupa dengan
Membatasi penelusuran hanya untuk kendaraan tersebut dengan semua atribut di |
orderBy |
Wajib. Menentukan kriteria pengurutan yang diinginkan untuk hasil. |
includeBackToBack |
Hal 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 |
Nilai ini menunjukkan apakah kendaraan dengan perjalanan aktif memenuhi syarat untuk penelusuran ini. Nilai ini harus ditetapkan ke selain |
filter |
Opsional. Kueri filter yang akan diterapkan saat menelusuri kendaraan. Buka http://aip.dev/160 untuk mengetahui contoh sintaksis filter. Kolom ini dirancang untuk menggantikan kolom Filter ini berfungsi sebagai klausa AND dengan batasan lainnya, seperti Perhatikan bahwa satu-satunya kueri yang didukung adalah pada 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
vehicles.search
pesan respons.
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 kendaraan yang cocok dalam respons.
Enum | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Default, digunakan untuk pesanan kendaraan yang tidak ditentukan atau tidak dikenal. |
PICKUP_POINT_ETA |
Urutan naik menurut waktu mengemudi kendaraan ke titik penjemputan. |
PICKUP_POINT_DISTANCE |
Urutan naik menurut jarak mengemudi kendaraan ke titik penjemputan. |
DROPOFF_POINT_ETA |
Urutan menaik menurut waktu mengemudi kendaraan ke titik pengantaran. Pesanan ini hanya dapat digunakan jika titik pengantaran ditentukan dalam permintaan. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Urutan menaik menurut jarak garis lurus dari lokasi terakhir kendaraan yang dilaporkan ke titik penjemputan. |
COST |
Urutan menaik menurut biaya pencocokan yang dikonfigurasi. Biaya pencocokan didefinisikan sebagai penghitungan berbobot antara jarak garis lurus dan PWT. Bobot ditetapkan dengan nilai default dan dapat diubah per pelanggan. Hubungi dukungan Google jika bobot ini perlu diubah untuk project Anda. |
CurrentTripsPresent
Menentukan jenis batasan pada perjalanan kendaraan saat ini.
Enum | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
Ketersediaan kendaraan dengan perjalanan diatur oleh kolom includeBackToBack . |
NONE |
Kendaraan tanpa 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 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 |
Kendaraan mengemudi PWT ke lokasi penjemputan yang ditentukan dalam permintaan. Nilai kosong menunjukkan kegagalan dalam menghitung PWT untuk kendaraan. Jika Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. 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 meliputi 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 penjemputan yang diminta biasanya kecil.) Nilai kosong menunjukkan error dalam menghitung jarak. |
vehiclePickupStraightLineDistanceMeters |
Wajib. Jarak garis lurus antara kendaraan dan titik penjemputan yang ditentukan dalam permintaan. |
vehicleDropoffEta |
Kendaraan yang lengkap mengarahkan PWT ke titik pengantaran yang ditentukan dalam permintaan. PWT mencakup berhenti di setiap titik jalan sebelum Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
vehiclePickupToDropoffDistanceMeters |
Jarak mengemudi kendaraan (dalam meter) dari titik penjemputan ke titik pengantaran yang ditentukan dalam permintaan. Jarak hanya antara dua titik dan tidak mencakup lokasi kendaraan atau titik lain yang harus dikunjungi sebelum kendaraan mengunjungi titik penjemputan atau titik pengantaran. Nilai hanya akan diisi jika |
tripType |
Wajib. Jenis perjalanan dari permintaan yang digunakan untuk menghitung PWT ke titik penjemputan. |
vehicleTripsWaypoints[] |
Daftar titik jalan yang diurutkan yang digunakan untuk menghitung PWT. Daftar ini 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 |
Jenis kendaraan yang cocok. |
requestedOrderedBy |
Pesanan yang diminta untuk menyortir kecocokan kendaraan. |
orderedBy |
Pesanan sebenarnya yang digunakan untuk kendaraan ini. Biasanya ini akan cocok dengan kolom 'orderBy' 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 kedatangan kendaraan di titik jalan ini. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
VehicleMatchType
Jenis pencocokan kendaraan.
Enum | |
---|---|
UNKNOWN |
Jenis pencocokan kendaraan tidak diketahui |
EXCLUSIVE |
Kendaraan saat ini tidak memiliki perjalanan yang ditetapkan untuknya 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 memadai 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. |