Method: providers.deliveryVehicles.list

Mendapatkan semua DeliveryVehicle yang memenuhi kriteria pemfilteran yang ditentukan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Harus dalam format providers/{provider}. provider harus berupa ID Project Google Cloud. Misalnya, sample-cloud-project.

Parameter kueri

Parameter
header

object (DeliveryRequestHeader)

Opsional. Header permintaan Delivery API standar.
pageSize

integer

Opsional. Jumlah maksimum kendaraan yang akan dikembalikan. Layanan mungkin menampilkan lebih sedikit dari jumlah ini. Jika Anda tidak menentukan angka ini, server akan menentukan jumlah hasil yang akan ditampilkan.
pageToken

string

Opsional. Token halaman, yang diterima dari panggilan deliveryVehicles.list sebelumnya. Anda harus menyediakannya untuk mengambil halaman selanjutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan ke deliveryVehicles.list harus cocok dengan panggilan yang menyediakan token halaman.
filter

string

Opsional. Kueri filter yang akan diterapkan saat mencantumkan kendaraan pengiriman. Lihat http://aip.dev/160 untuk mengetahui contoh sintaksis filter. Jika Anda tidak menentukan nilai, atau jika Anda menentukan string kosong untuk filter, semua kendaraan pengiriman akan ditampilkan.

Perhatikan bahwa satu-satunya kueri yang didukung untuk deliveryVehicles.list adalah di atribut kendaraan (misalnya, attributes.<key> = <value> atau attributes.<key1> = <value1> AND attributes.<key2> = <value2>). 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").

Jumlah batasan maksimum yang diizinkan dalam kueri filter adalah 50. Pembatasan adalah bagian dari kueri bentuk attribute.<KEY> <COMPARATOR> <VALUE>, misalnya attributes.foo = bar adalah 1 pembatasan.
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 deliveryVehicles.list.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (DeliveryVehicle)

Kumpulan kendaraan pengiriman yang memenuhi kriteria pemfilteran yang diminta. Jika tidak ada filter yang ditentukan, permintaan akan menampilkan semua kendaraan pengiriman. Respons berhasil juga boleh kosong. Respons kosong menunjukkan bahwa tidak ditemukan kendaraan pengiriman yang memenuhi kriteria filter yang diminta.
nextPageToken

string

Anda dapat meneruskan token ini di ListDeliveryVehiclesRequest untuk terus mencantumkan hasil. Jika semua hasil ditampilkan, kolom ini tidak akan ada dalam respons, atau akan berupa string kosong.
totalSize

string (int64 format)

Total jumlah kendaraan pengiriman 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.