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 到 10,000 公尺之間 (含)。

integer

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

integer

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

enum (TripType)

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

string (Duration format)

將搜尋範圍限制在指定時間內，已將位置更新傳送至 Fleet Engine 的車輛。固定式車輛仍會傳輸地點，不視為已過時。如未設定這個欄位，伺服器會使用五分鐘做為預設值。

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

object (VehicleType)

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

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 個 requiredAttributes。這與車輛可用的屬性數量上限相符。

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")。