Method: providers.vehicles.search

İstek seçenekleriyle eşleşen araçların listesini döndürür.

HTTP isteği

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

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.

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:

JSON gösterimi 
{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}
Alanlar
header

object (RequestHeader)

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

object (TerminalLocation)

Zorunlu. Yakınında aranacak teslim noktası.
dropoffPoint

object (TerminalLocation)

Müşterinin istediği teslim yeri. tripTypes, TripType.SHARED içeriyorsa bu alan gereklidir.
pickupRadiusMeters

integer

Zorunlu. Başlangıç noktasının çevresindeki araç arama yarıçapını tanımlar. Yalnızca arama yarıçapı dahilindeki araçlar döndürülür. Değer 400 ile 10.000 metre (dahil) arasında olmalıdır.
count

integer

Zorunlu. Döndürülecek maksimum araç sayısını belirtir. Değer 1 ile 50 (dahil) arasında olmalıdır.
minimumCapacity

integer

Zorunlu. Bir seyahat için dikkate alınan yolcu sayısını belirtir. Değer 1'den büyük veya 1'e eşit olmalıdır. Sürücü, kapasite değerine dahil edilmez.
tripTypes[]

enum (TripType)

Zorunlu. Önerilen seyahat türünü gösterir. Tam olarak bir tür içermelidir. UNKNOWN_TRIP_TYPE politikasına izin verilmiyor. Aramayı yalnızca bu seyahat türünü destekleyen araçlarla kısıtlar.
maximumStaleness

string (Duration format)

Aramayı yalnızca 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. Bu alan ayarlanmazsa sunucu varsayılan değer olarak beş dakika kullanır.

En fazla dokuz kesir basamağı içeren ve "s" ile biten saniye cinsinden bir süre. Örnek: "3.5s".
vehicleTypes[]

object (VehicleType)

Zorunlu. Aramayı, belirtilen türlerden birine sahip araçlarla kısıtlar. En az bir araç türü belirtilmelidir. Kategorisi UNKNOWN olan VehicleType'lara izin verilmez.
requiredAttributes[]

object (VehicleAttribute)

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
...)

Aramayı yalnızca 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.
requiredOneOfAttributes[]

object (VehicleAttributeList)

Aramayı yalnızca 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.
requiredOneOfAttributeSets[]

object (VehicleAttributeList)

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
  ...)
)

Aramayı yalnızca VehicleAttributeList içindeki tüm özelliklere sahip 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.
orderBy

enum (VehicleMatchOrder)

Zorunlu. Sonuçlar için istenen sıralama kriterini belirtir.
includeBackToBack

boolean

Tek bir aktif seyahati olan araçların bu arama için uygun olup olmadığını gösterir. Bu alan yalnızca currentTripsPresent belirtilmediğinde kullanılır. currentTripsPresent belirtilmediğinde ve bu alan false olduğunda, rota atanmış araçlar arama sonuçlarından hariç tutulur. currentTripsPresent belirtilmemişse ve bu alan true ise arama sonuçları, ENROUTE_TO_DROPOFF durumunda olan etkin bir geziye sahip araçları içerebilir. currentTripsPresent belirtildiğinde, bu alan doğru olarak ayarlanamaz.

false, varsayılan değerdir.
tripId

string

Bu SearchVehicleRequest ile ilişkili geziyi gösterir.
currentTripsPresent

enum (CurrentTripsPresent)

Aktif gezilere sahip araçların bu arama için uygun olup olmadığını gösterir. tripType, SHARED içeriyorsa bu, CURRENT_TRIPS_PRESENT_UNSPECIFIED dışında bir değere ayarlanmalıdır.
filter

string

İsteğe bağlı. Araç ararken 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, minimumCapacity veya vehicleTypes 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").

Yanıt gövdesi

Başarılıysa yanıt metni, SearchVehiclesResponse öğesinin bir örneğini içerir.