Method: providers.deliveryVehicles.list

取得符合指定篩選條件的所有 DeliveryVehicle。

HTTP 要求

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

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

路徑參數

參數
parent

string

必要欄位。格式須為 providers/{provider}。provider 必須是 Google Cloud 專案 ID。例如：sample-cloud-project。

查詢參數

參數
header

object (DeliveryRequestHeader)

選用設定。標準 Delivery API 要求標頭。
pageSize

integer

選用設定。要傳回的車輛數量上限。服務傳回的次數可能會少於這個數字。如果未指定這個數字，伺服器會決定要傳回的結果數量。
pageToken

string

選用設定。屬於接收自前一個 deliveryVehicles.list 呼叫的網頁權杖。必須提供此項目才能擷取後續網頁。

進行分頁時，提供至 deliveryVehicles.list 的所有其他參數須與提供網頁權杖的呼叫相符。
filter

string

選用設定。列出運輸車輛時要套用的篩選查詢。如需篩選器語法範例，請參閱 http://aip.dev/160。如果未指定值，或是為篩選器指定空白字串，則會傳回所有運輸車輛。

請注意，只有車輛屬性 (例如 attributes.<key> = <value> 或 attributes.<key1> = <value1> AND attributes.<key2> = <value2>) 支援 deliveryVehicles.list 的查詢。此外，所有屬性都會儲存為字串，因此唯一支援與屬性的比較是字串比較。如要與數字或布林值比較，您必須明確加上引號，才能視為字串 (例如 attributes.<key> = "10" 或 attributes.<key> = "true")。

篩選查詢最多可包含 50 個限制。限制是 attribute.<KEY> <COMPARATOR> <VALUE> 格式查詢的一部分，例如 attributes.foo = bar 是 1 項限制。
viewport

object (Viewport)

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

要求主體

要求主體必須為空白。

回應主體

deliveryVehicles.list 回應訊息。

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

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

object (DeliveryVehicle)

符合所規定篩選條件的運送車輛組合。如未指定篩選條件，要求會傳回所有運送車輛。成功的回應也可以空白。如果回應空白，代表找不到符合要求的篩選條件的貨運車輛。
nextPageToken

string

您可以在 ListDeliveryVehiclesRequest 中傳遞這個權杖，繼續列出結果。當所有結果都傳回時，這個欄位不會包含或在回應中，而是空白字串。
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)

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