Method: providers.vehicles.list

İstek seçenekleriyle eşleşen bir sağlayıcıyla ilişkili araçların sayfalandırılmış bir listesini döndürür.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. providers/{provider} biçiminde olmalıdır. Sağlayıcı, bu çağrıyı yapan hizmet hesabının üyesi olduğu Google Cloud projesinin proje kimliği (örneğin, sample-cloud-project) olmalıdır.

Sorgu parametreleri

Parametreler
header

object (RequestHeader)

Standart Fleet Engine istek başlığı.
pageSize

integer

Dönecek maksimum araç sayısı. Varsayılan değer: 100.
pageToken

string

Araç grupları arasında sayfalandırma yapabilmeniz için vehicles.list işlevine yapılan önceki bir çağrı tarafından sağlanan nextPageToken değerini belirtir. İsteğin filtre ölçütleri, vehicles.list için yapılan önceki çağrının filtre ölçütleriyle aynı değilse değer tanımsız olur.
minimumCapacity

integer

Aracın gerekli minimum kapasitesini belirtir. Döndürülen tüm araçların maximumCapacity değeri bu değerden büyük veya bu değere eşit olacaktır. Ayarlanmışsa 0'dan büyük veya 0'a eşit olmalıdır.
tripTypes[]

enum (TripType)

Yanıtı, belirtilen gezi türlerinden en az birini destekleyen araçlarla kısıtlar.
maximumStaleness

string (Duration format)

Belirtilen süre içinde Fleet Engine'e konum güncellemeleri gönderen araçlarla yanıtı kısıtlar. Hareketsiz olan ancak konumlarını hâlâ gönderen araçlar eski kabul edilmez. Varsa geçerli bir pozitif süre olmalıdır.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".
vehicleTypeCategories[]

enum (Category)

Zorunlu. Yanıtı, belirtilen tür kategorilerinden birine sahip araçlarla kısıtlar. UNKNOWN politikasına izin verilmiyor.
requiredAttributes[]

string

Arayanlar requiredAttributes, requiredOneOfAttributes ve requiredOneOfAttributeSets alanlarının herhangi bir kombinasyonunu kullanarak karmaşık mantıksal işlemler oluşturabilir.

requiredAttributes bir listetir; requiredOneOfAttributes, liste listesine izin veren bir mesaj kullanır. Bu iki alan birlikte kullanıldığında aşağıdaki ifadenin oluşturulmasına olanak tanır:

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

Yanıtı, belirtilen özelliklere sahip araçlarla kısıtlar. Bu alan bir bağlaç/VE işlemidir. En fazla 50 requiredAttributes değerine izin verilir. Bu sayı, bir araçta izin verilen maksimum özellik sayısıyla eşleşir. Tekrarlanan her dize "anahtar:değer" biçiminde olmalıdır.
requiredOneOfAttributes[]

string

Yanıtı, her VehicleAttributeList özelliğinde belirtilen özelliklerden en az birine sahip araçlarla kısıtlar. Her listede bir araç, özelliklerden en az biriyle eşleşmelidir. Bu alan, her VehicleAttributeList içindeki kapsayıcı bir ayırma/VEYA işlemi ve VehicleAttributeList koleksiyonundaki bir bağlantı/VE işlemidir. Tekrarlanan her dize "anahtar1:değer1|anahtar2:değer2|anahtar3:değer3" biçiminde olmalıdır.
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets ek işlevler sunar.

requiredOneOfAttributes'e benzer şekilde requiredOneOfAttributeSets, liste listesine izin veren bir mesaj kullanır ve aşağıdaki gibi ifadelere izin verir:

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

Yanıtı, VehicleAttributeList içindeki tüm özelliklerle eşleşen araçlarla kısıtlar. Her listede bir araç, tüm özelliklerle eşleşmelidir. Bu alan, her VehicleAttributeList içindeki bir bağlaç/VE işlemidir ve VehicleAttributeList koleksiyonundaki kapsayıcı ayırma/VEYA işlemidir. Tekrarlanan her dize "key1:value1|key2:value2|key3:value3" biçiminde olmalıdır.
vehicleState

enum (VehicleState)

Yanıtı, bu araç durumuna sahip araçlarla sınırlandırır.
onTripOnly

boolean

Yalnızca mevcut seyahatleri olan araçları döndürün.
filter

string

İsteğe bağlı. Araçlar listelenirken uygulanacak bir filtre sorgusu. Filtre söz dizimi örnekleri için http://aip.dev/160 adresine bakın.

Bu alan requiredAttributes, requiredOneOfAttributes ve required_one_of_attributes_sets alanlarının yerini alacak şekilde tasarlanmıştır. Burada boş olmayan bir değer belirtilirse şu alanlar boş olmalıdır: requiredAttributes, requiredOneOfAttributes ve required_one_of_attributes_sets.

Bu filtre, vehicleState veya onTripOnly gibi diğer kısıtlamalarla birlikte bir VE ifadesi olarak işlev görür.

Desteklenen sorguların sadece araç özellikleri (ör. attributes.<key> = <value> veya attributes.<key1> = <value1> AND attributes.<key2> = <value2>) üzerinde desteklendiğini unutmayın. Bir filtre sorgusunda izin verilen maksimum kısıtlama sayısı 50'dir.

Ayrıca tüm özellikler dize olarak depolandığından, özelliklerle ilgili olarak desteklenen tek karşılaştırma dize karşılaştırmasıdır. Sayı veya Boole değerleriyle karşılaştırmak için değerlerin dize olarak değerlendirilmesi amacıyla açıkça tırnak içine alınması gerekir (örneğin, attributes.<key> = "10" veya attributes.<key> = "true").
viewport

object (Viewport)

İsteğe bağlı. Geri gelen araçları, bilinen son konumu görüntü alanının tanımladığı dikdörtgen alanda olan araçlarla sınırlayan bir filtre.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

vehicles.list yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Alanlar
vehicles[]

object (Vehicle)

Talepteki ölçütlerle eşleşen araçlar. Döndürülen maksimum araç sayısı, istekteki pageSize alanı tarafından belirlenir.
nextPageToken

string

Araçların bir sonraki sayfasını almak için kullanılan jeton veya istek ölçütlerini karşılayan başka araç yoksa boş bırakın.
totalSize

string (int64 format)

Zorunlu. Tüm sayfalarda istek ölçütleriyle eşleşen toplam araç sayısı.

Görüntü alanı

low ve high noktasının karşısında çapraz olarak iki şekilde gösterilen enlem-boylam görüntü alanı. Görüntü alanı, kapalı bir bölge olarak kabul edilir. Yani kendi sınırlarını içerir. Enlem sınırları -90 ile 90 derece (dahil) arasında, boylam sınırları ise -180 ile 180 derece (dahil) arasında olmalıdır. Çeşitli durumlar şunlardır:

  • low = high ise görüntü alanı tek bir noktadan oluşur.

  • low.longitude > high.longitude ise boylam aralığı tersine çevrilir (görüntü alanı 180 derece boylam çizgisini geçer).

  • low.longitude = -180 derece ve high.longitude = 180 derece ise görüntü alanı tüm boylamları içerir.

  • low.longitude = 180 derece ve high.longitude = -180 derece ise boylam aralığı boştur.

  • low.latitude > high.latitude ise enlem aralığı boştur.

Hem low hem de high doldurulmalıdır ve temsil edilen kutu boş olamaz (yukarıdaki tanımlarda belirtildiği gibi). Boş bir görüntü alanı hataya neden olur.

Örneğin, bu görüntü alanı New York City'yi tamamen kapsar:

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

JSON gösterimi 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Alanlar
low

object (LatLng)

Zorunlu. Görüntü alanının düşük noktası.
high

object (LatLng)

Zorunlu. Görüntü alanının yüksek noktası.