Method: providers.vehicles.list

傳回與要求選項相符之供應商相關聯的分頁清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。格式須為 providers/{provider}。提供者必須是發出此呼叫的服務帳戶所屬 Google Cloud 專案的專案 ID (例如 sample-cloud-project)。

查詢參數

參數
header

object (RequestHeader)

標準 Fleet Engine 要求標頭。
pageSize

integer

要傳回的車輛數量上限。預設值為 100。
pageToken

string

先前呼叫 vehicles.list 提供的 nextPageToken 值，讓您可以對多組車輛進行分頁。如果要求的篩選條件與先前呼叫 vehicles.list 的篩選條件不同，該值就不會定義。
minimumCapacity

integer

指定車輛所需的最低容量。所有傳回的車輛都會有大於或等於這個值的 maximumCapacity。設定時，必須大於或等於 0。
tripTypes[]

enum (TripType)

限制回應範圍必須支援至少一種指定行程類型的車輛。
maximumStaleness

string (Duration format)

限制系統在指定時間內對 Fleet Engine 傳送位置更新資訊的車輛做出回應。即使一般車輛仍在傳輸位置資訊，也不算過時。如有提供，必須是有效的正值。

持續時間以秒為單位，最多 9 個小數位數，結尾為「s」。範例："3.5s"。
vehicleTypeCategories[]

enum (Category)

必要欄位。限制回應具有其中一個指定類型類別的車輛。不允許UNKNOWN。
requiredAttributes[]

string

呼叫端可以使用 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 個必要屬性。這與車輛允許的屬性數量上限相符。每個重複字串的格式應為「key:value」。
requiredOneOfAttributes[]

string

限制對每個 VehicleAttributeList 中至少具有一個指定屬性的車輛回應。每份清單上的車輛至少須有一項屬性相符。這個欄位是每個 VehicleAttributeList 中的否定/OR 運算，以及 VehicleAttributeList 集合中的連接/AND 運算。每個重複字串的格式應為「key1:value1|key2:value2|key3:value3」。
requiredOneOfAttributeSets[]

string

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 運算。每個重複字串的格式應為「key1:value1|key2:value2|key3:value3」。
vehicleState

enum (VehicleState)

限制回應具有此車輛狀態的車輛。
onTripOnly

boolean

只傳回有當前行程的車輛。
filter

string

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

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

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

請注意，只有車輛屬性 (例如 attributes.<key> = <value> 或 attributes.<key1> = <value1> AND attributes.<key2> = <value2>) 才支援查詢。篩選查詢最多可包含 50 個限制。

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

object (Viewport)

選用設定。這個篩選器可限制車輛只返回可視位置位於可視區域定義的矩形區域。

要求主體

要求主體必須為空白。

回應主體

vehicles.list 回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
欄位
vehicles[]

object (Vehicle)

符合要求條件的車輛。傳回的車輛數量上限取決於要求中的 pageSize 欄位。
nextPageToken

string

用來擷取下一頁車輛的權杖；如果沒有其他符合要求條件的車輛，則留空。
totalSize

string (int64 format)

必要欄位。在所有頁面中，符合要求的車輛總數。

可視區域

經緯度可視區域，以對角線的兩點對角線表示 low 和 high 點。系統會將可視區域視為封閉區域，也就是包含界線的邊界。緯度邊界必須介於 -90 到 90 度（含），且經度範圍必須介於 -180 到 180 度（含）。各種情況包括：

  • 如果 low = high，可視區域是由該單點組成。

  • 如果 low.longitude >high.longitude，經度範圍會反轉 (可視區域會跨越 180 度經度線)。

  • 如果 low.longitude = -180 度，high.longitude = 180 度，可視區域會包含所有經度。

  • 如果 low.longitude = 180 度，high.longitude = -180 度，則經度範圍會留空。

  • 如果 low.latitude >high.latitude，緯度範圍是空的。

low 和 high 都必須填入，而代表方塊不得留空 (如上文定義所述)。空白的可視區域會導致錯誤。

舉例來說，這個可視區域會完整涵蓋紐約市：

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

JSON 表示法 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
欄位
low

object (LatLng)

必要欄位。可視區域的低點。
high

object (LatLng)

必要欄位。可視區域的高點。