Method: providers.vehicles.search

{
  "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
}

object (RequestHeader)

標準 Fleet Engine 要求標頭。

object (TerminalLocation)

必要欄位。要搜尋附近的取貨地點。

object (TerminalLocation)

客戶的下車地點。如果 tripTypes 包含 TripType.SHARED，則此為必要欄位。

integer

必要欄位。定義取貨點周圍的車輛搜尋半徑。系統只會傳回搜尋半徑範圍內的車輛。值必須介於 400 至 10000 公尺 (含) 之間。

integer

必要欄位。指定傳回的車輛數量上限。這個值必須介於 1 至 50 (含) 之間。

integer

必要欄位。指定行程的乘客人數。這個值必須大於或等於 1。容量值不會計入驅動程式。

enum (TripType)

必要欄位。代表建議行程的類型。必須包含一個類型。不允許 UNKNOWN_TRIP_TYPE。將搜尋範圍限制在可支援該行程類型的車輛。

string (Duration format)

將搜尋範圍限制在指定時間範圍內，只搜尋已向 Fleet Engine 傳送位置更新的車輛。靜止車輛仍會傳送位置，因此不會被視為過時。如果未設定此欄位，伺服器會使用五分鐘做為預設值。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。

object (VehicleType)

必要欄位。將搜尋範圍限制在某個指定類型的車輛。至少須指定一種交通工具類型。不允許類別為 UNKNOWN 的 VehicleTypes。

object (VehicleAttribute)

呼叫端可以使用 requiredAttributes、requiredOneOfAttributes 和 requiredOneOfAttributeSets 欄位的任意組合，建立複雜的邏輯運算式。

requiredAttributes 是清單；requiredOneOfAttributes 使用訊息允許清單清單。兩個欄位結合後，可組合成下列運算式：

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

只搜尋具有指定屬性的車輛。這個欄位是結合/AND 作業。最多只能有 50 個必要屬性。這與車輛允許的屬性數量上限相符。

object (VehicleAttributeList)

將搜尋範圍限制為每個 VehicleAttributeList 中至少包含一個指定屬性的車輛。每份清單上的車輛至少須有一項屬性相符。這個欄位是每個 VehicleAttributeList 中的否定/OR 運算，以及 VehicleAttributeList 集合中的連接/AND 運算。

object (VehicleAttributeList)

requiredOneOfAttributeSets 提供額外功能。

與 requiredOneOfAttributes 類似，requiredOneOfAttributeSets 會使用可接受清單清單的訊息，允許以下這類運算式：

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

僅搜尋具有 VehicleAttributeList 所有屬性的車輛。在每份清單中，車輛必須符合所有屬性。這個欄位是每個 VehicleAttributeList 中的合集/AND 運算，且 VehicleAttributeList 集合內包覆式/OR 運算。

enum (VehicleMatchOrder)

必要欄位。指定結果的排序條件。

boolean

這項屬性可指出是否有單一行程的車輛符合此搜尋條件。只有在未指定 currentTripsPresent 時，才會使用這個欄位。如果未指定 currentTripsPresent 且這個欄位為 false，就會從搜尋結果中排除已指定行程的車輛。如未指定 currentTripsPresent 且這個欄位為 true，搜尋結果可能會包含只有一個進行中行程的車輛，且狀態為 ENROUTE_TO_DROPOFF。指定 currentTripsPresent 時，這個欄位無法設為 true。

預設值為 false。

string

表示與此 SearchVehicleRequest 相關的行程。

enum (CurrentTripsPresent)

這項屬性可指出是否有符合搜尋條件的有效行程。如果 tripType 包含 SHARED，則必須將此屬性設為 CURRENT_TRIPS_PRESENT_UNSPECIFIED 以外的值。

string

選用設定。搜尋車輛時要套用的篩選查詢。如需篩選器語法的範例，請參閱 http://aip.dev/160。

這個欄位是用來取代 requiredAttributes、requiredOneOfAttributes 和 required_one_of_attributes_sets 欄位。如果在這裡指定非空白值，下列欄位必須留空：requiredAttributes、requiredOneOfAttributes 和 required_one_of_attributes_sets。

這個篩選函式可做為 AND 子句，但具有其他限制條件，例如 minimumCapacity 或 vehicleTypes。

請注意，系統僅支援車輛屬性查詢 (例如 attributes.<key> = <value> 或 attributes.<key1> = <value1> AND attributes.<key2> = <value2>)。篩選器查詢允許的限制數量上限為 50。

此外，所有屬性都會儲存為字串，因此唯一支援與屬性的比較是字串比較。如要比較數字或布林值，必須明確加上引號，才能將值視為字串 (例如 attributes.<key> = "10" 或 attributes.<key> = "true")。