Method: providers.vehicles.list

İstek seçenekleriyle eşleşen bir sağlayıcıyla ilişkili araçların sayfalara ayrı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öndürülecek maksimum araç sayısı. Varsayılan değer: 100.
pageToken

string

Araç gruplarını sayfalara ayırabilmeniz için önceki vehicles.list çağrısında sağlanan nextPageToken değeri. İsteğin filtre ölçütü, önceki vehicles.list çağrısı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çlarda maximumCapacity, bu değere eşit veya bu değerden büyük olacaktır. Ayarlanırsa 0'dan büyük veya 0'a eşit olmalıdır.
tripTypes[]

enum (TripType)

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

string (Duration format)

Yanıtı belirtilen süre içinde Fleet Engine'e konum güncellemesi gönderen araçlarla kısıtlar. Konumlarını ileten sabit araçlar eski olarak kabul edilmez. Varsa geçerli ve pozitif bir süre olmalıdır.

En fazla dokuz kesir basamağı içeren ve "s" ile biten saniye cinsinden bir 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 listedir; requiredOneOfAttributes liste listesine izin veren bir mesaj kullanır. İki alan birlikte bu 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 requiredAttribute'e izin verilir. Bir araçta izin verilen maksimum özellik sayısıyla eşleşir. Tekrarlanan her dize, "key:value" biçiminde olmalıdır.
requiredOneOfAttributes[]

string

Yanıtı her VehicleAttributeList öğesinde belirtilen özelliklerden en az birine sahip araçlarla kısıtlar. Her listede, aracın özelliklerden en az biriyle eşleşmesi gerekir. Bu alan, her VehicleAttributeList için kapsayıcı bir ayırma/VEYA işlemidir ve VehicleAttributeList koleksiyonundaki bir bağlaç/VE işlemidir. Tekrarlanan her dize, "key1:value1|key2:value2|key3:value3" biçiminde olmalıdır.
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets ek işlevler sağlar.

requiredOneOfAttributes operatörüne benzer şekilde, requiredOneOfAttributeSets aşağıdaki gibi ifadelere izin veren bir liste listesine olanak tanıyan bir mesaj kullanır:

(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, VehicleAttributeList koleksiyonundaki her bir VehicleAttributeList ve kapsayıcı ayırma/VEYA işlemi için bir bağlaç/VE 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 kısıtlar.
onTripOnly

boolean

Yalnızca geçerli yolculuklara sahip araçları iade edin.
filter

string

İsteğe bağlı. Araçları listelerken 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 başka kısıtlamalarla birlikte bir VE ifadesi olarak işlev görür.

Yalnızca araç özellikleri (örneğin, attributes.<key> = <value> veya attributes.<key1> = <value1> AND attributes.<key2> = <value2>) sorguları desteklenir. Bir filtre sorgusunda izin verilen maksimum kısıtlama sayısı 50'dir.

Ayrıca, tüm özellikler dize olarak depolanır. Bu nedenle, özelliklere karşılık yalnızca dize karşılaştırmaları desteklenir. Sayı veya boole değerleriyle karşılaştırmak için değerlerin dize olarak ele alınmak üzere açık bir şekilde tırnak içine alınması gerekir (örneğin, attributes.<key> = "10" veya attributes.<key> = "true").
viewport

object (Viewport)

İsteğe bağlı. Bilinen son konumu görüntü alanı tarafından tanımlanan dikdörtgen alanda bulunan araçların döndürüldüğü araçları 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)

İstekteki ölçütlere uyan araçlar. Döndürülen maksimum araç sayısı, istekteki pageSize alanı tarafından belirlenir.
nextPageToken

string

Araç listesinin sonraki sayfasını almak için kullanılan jeton veya istek ölçütlerini karşılayan başka araç yoksa boş bırakılmalıdır.
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 punto karşısında çapraz olarak iki dikey olarak gösterilen enlem-boylam görüntü alanı. Bir görüntü alanı, kapalı bir bölge olarak kabul edilir, yani sınırlarını içerir. Enlem sınırları -90 ile 90 derece dahil, boylam sınırları ise -180 ila 180 derece (bu değerler dahil) aralığında olmalıdır. Bazı durumlar şunlardır:

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

  • low.longitude > high.longitude ise boylam aralığı ters çevrilir (görüntü alanı 180 derecelik 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ş olur.

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

Hem low hem de high doldurulmalıdır ve gösterilen kutu boş olamaz (yukarıdaki tanımlarda belirtildiği gibi). Boş 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ı.