取得符合指定篩選條件的所有 DeliveryVehicle
。
HTTP 要求
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
必要欄位。格式須為 |
查詢參數
參數 | |
---|---|
header |
選用設定。Standard Delivery API 要求標頭。 |
pageSize |
選用設定。要傳回的車輛數量上限。服務傳回的產品數量可能會少於這個數字。如果您未指定這個數字,伺服器就會決定要傳回的結果數量。 |
pageToken |
選用設定。屬於接收自前一個 進行分頁時,提供至 |
filter |
選用設定。列出運輸車輛時要套用的篩選器查詢。如需篩選器語法的範例,請參閱 http://aip.dev/160。如果未指定任何值,或是為篩選器指定空字串,系統就會傳回所有運送車輛。 請注意, 篩選器查詢最多可加入 50 個限制。限制是 |
viewport |
選用設定。這個篩選器會限制傳回的車輛,傳回最後已知位置位於可視區域定義的矩形區域的車輛。 |
要求主體
要求主體必須為空白。
回應主體
deliveryVehicles.list
回應訊息。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"deliveryVehicles": [
{
object ( |
欄位 | |
---|---|
deliveryVehicles[] |
符合要求篩選條件的貨運車輛組合。如未指定篩選條件,要求會傳回所有貨運公司。成功的回應也可以留空。如果回應空白,表示找不到符合要求的篩選條件。 |
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 |
必要欄位。可視區域的高點。 |