Method: providers.vehicles.list

Menampilkan daftar kendaraan bernomor halaman yang terkait dengan penyedia yang cocok dengan opsi permintaan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Harus dalam format providers/{provider}. Penyedia harus berupa Project ID (misalnya, sample-cloud-project) Project Google Cloud tempat akun layanan yang melakukan panggilan ini menjadi anggota.

Parameter kueri

Parameter
header

object (RequestHeader)

Header permintaan Fleet Engine standar.
pageSize

integer

Jumlah maksimum kendaraan yang akan dikembalikan. Nilai default: 100.
pageToken

string

Nilai nextPageToken yang diberikan oleh panggilan sebelumnya ke vehicles.list sehingga Anda dapat memberi nomor halaman pada grup kendaraan. Nilai tidak ditentukan jika kriteria filter permintaan tidak sama dengan kriteria filter untuk panggilan sebelumnya ke vehicles.list.
minimumCapacity

integer

Menentukan kapasitas minimum kendaraan yang diperlukan. Semua kendaraan yang dikembalikan akan memiliki maximumCapacity lebih besar dari atau sama dengan nilai ini. Jika ditetapkan, harus lebih besar atau sama dengan 0.
tripTypes[]

enum (TripType)

Membatasi respons untuk kendaraan yang mendukung setidaknya salah satu jenis perjalanan yang ditentukan.
maximumStaleness

string (Duration format)

Membatasi respons terhadap kendaraan yang telah mengirim pembaruan lokasi ke Fleet Engine dalam durasi yang ditentukan. Kendaraan statis yang masih mengirimkan lokasinya tidak dianggap usang. Jika ada, harus berupa durasi positif yang valid.

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

enum (Category)

Wajib. Membatasi respons untuk kendaraan dengan salah satu kategori jenis yang ditentukan. UNKNOWN tidak diizinkan.
requiredAttributes[]

string

Pemanggil dapat membentuk operasi logika 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 respons ke 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. Setiap string berulang harus memiliki format "key:value".
requiredOneOfAttributes[]

string

Membatasi respons untuk kendaraan dengan 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. Setiap string berulang harus dalam format "key1:value1|key2:value2|key3:value3".
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets menyediakan fungsi tambahan.

Serupa dengan requiredOneOfAttributes, requiredOneOfAttributeSets menggunakan pesan yang mengizinkan daftar daftar, yang 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 respons ke kendaraan yang cocok dengan 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. Setiap string berulang harus dalam format "key1:value1|key2:value2|key3:value3".
vehicleState

enum (VehicleState)

Membatasi respons terhadap kendaraan yang memiliki status kendaraan ini.
onTripOnly

boolean

Hanya kembalikan kendaraan dengan perjalanan saat ini.
filter

string

Opsional. Kueri filter yang akan diterapkan saat mencantumkan 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 vehicleState atau onTripOnly.

Perhatikan bahwa satu-satunya kueri yang didukung adalah di atribut kendaraan (misalnya, attributes.<key> = <value> atau attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Jumlah batasan maksimum 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 membandingkan dengan nilai angka atau boolean, nilai harus dikutip secara eksplisit agar diperlakukan sebagai string (misalnya, attributes.<key> = "10" atau attributes.<key> = "true").
viewport

object (Viewport)

Opsional. Filter yang membatasi pengembalian kendaraan ke mobil yang lokasi terakhirnya diketahui berada di area persegi panjang yang ditentukan oleh area pandang.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons vehicles.list.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Kolom
vehicles[]

object (Vehicle)

Kendaraan yang cocok dengan kriteria dalam permintaan. Jumlah maksimum kendaraan yang ditampilkan ditentukan oleh kolom pageSize dalam permintaan.
nextPageToken

string

Token untuk mengambil halaman kendaraan berikutnya, atau kosongkan jika tidak ada lagi kendaraan yang memenuhi kriteria permintaan.
totalSize

string (int64 format)

Wajib. Total jumlah kendaraan yang cocok dengan kriteria permintaan di semua halaman.

Area Pandang

Area tampilan lintang-bujur, direpresentasikan sebagai dua titik yang berlawanan secara diagonal dengan low dan high. Area pandang dianggap sebagai wilayah tertutup, yaitu menyertakan batasnya. Batas lintang harus berkisar antara -90 hingga 90 derajat inklusif, dan batas bujur harus berkisar antara -180 hingga 180 derajat inklusif. Berbagai kasus meliputi:

  • Jika low = high, area pandang terdiri dari titik tunggal tersebut.

  • Jika low.longitude > high.longitude, rentang bujur dibalik (area pandang melintasi garis bujur 180 derajat).

  • Jika low.longitude = -180 derajat dan high.longitude = 180 derajat, area pandang mencakup semua bujur.

  • Jika low.longitude = 180 derajat dan high.longitude = -180 derajat, rentang bujur kosong.

  • Jika low.latitude > high.latitude, rentang lintang kosong.

low dan high harus diisi, dan kotak yang direpresentasikan tidak boleh kosong (seperti yang ditentukan oleh definisi di atas). Area pandang kosong akan menyebabkan error.

Misalnya, area pandang ini sepenuhnya mencakup New York City:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "lintang": 40.91618, "bujur": -73.70018 } }

Representasi JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Kolom
low

object (LatLng)

Wajib. Titik rendah area pandang.
high

object (LatLng)

Wajib. Titik tinggi area pandang.