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 個 requiredAttributes。這與車輛允許的屬性數量上限相符。每個重複字串都應採用「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)

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