傳回與要求選項相符的供應商相關聯的分頁清單。
HTTP 要求
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
必要欄位。格式須為 |
查詢參數
參數 | |
---|---|
header |
標準的 Fleet Engine 要求標頭。 |
pageSize |
要傳回的車輛數量上限。預設值為 100。 |
pageToken |
先前呼叫 |
minimumCapacity |
指定車輛的最小容量。所有傳回的車輛都會有大於或等於這個值的 |
tripTypes[] |
限制只傳回支援至少一種指定行程類型的車輛。 |
maximumStaleness |
限制僅針對在指定時間範圍內傳送位置更新至 Fleet Engine 的車輛的回應。靜態車輛傳輸其所在位置不算是過時。如有顯示,必須是有效的正值時間長度。 持續時間以秒為單位,最多 9 個小數位數,結尾為「 |
vehicleTypeCategories[] |
必要欄位。限制只傳回屬於其中一個指定類型類別的車輛回應。不允許 |
requiredAttributes[] |
呼叫端可以使用
限制只傳回具有指定屬性的車輛。這個欄位是結合/AND 運算。最多允許 50 個 requiredAttributes。這與車輛允許的屬性數量上限相符。每個重複字串都應採用「key:value」格式。 |
requiredOneOfAttributes[] |
限制只對每個 |
requiredOneOfAttributeSets[] |
與
限制只對符合 |
vehicleState |
限制只對具備此交通工具狀態的車輛做出回應。 |
onTripOnly |
只退還有目前行程的車輛。 |
filter |
選用設定。列出車輛時要套用的篩選器查詢。如需篩選器語法的範例,請參閱 http://aip.dev/160。 這個欄位的用途是取代 這個篩選器可當做 AND 子句與其他限制 (例如 請注意,只有車輛屬性 (例如 此外,所有屬性都會儲存為字串,因此唯一支援的比較項目是字串比較。為了與數字或布林值比較,您必須將值明確加上引號,才會視為字串 (例如 |
viewport |
選用設定。這個篩選器會限制傳回的車輛,傳回最後已知位置位於可視區域定義的矩形區域的車輛。 |
要求主體
要求主體必須為空白。
回應主體
vehicles.list
則回應訊息。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"vehicles": [
{
object ( |
欄位 | |
---|---|
vehicles[] |
符合要求中的條件的車輛。傳回的車輛數量上限取決於要求中的 |
nextPageToken |
用來擷取下一頁車輛的符記;如果沒有任何車輛符合要求條件,則會留空。 |
totalSize |
必要欄位。所有頁面中符合要求條件的車輛總數。 |
可視區域
經緯度可視區域,以對角線的兩點在 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 ( |
欄位 | |
---|---|
low |
必要欄位。可視區域的低點。 |
high |
必要欄位。可視區域的高點。 |