Method: providers.deliveryVehicles.list

指定されたフィルタ条件を満たすすべての DeliveryVehicle を取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 をご覧ください。値を指定しない場合、またはフィルタに空の文字列を指定した場合は、すべての配送車両が返されます。

deliveryVehicles.list でサポートされているクエリは、車両属性（attributes.<key> = <value> や attributes.<key1> = <value1> AND attributes.<key2> = <value2> など）に関するものだけです。また、すべての属性は文字列として格納されるため、属性と比較できるのは文字列の比較のみです。数値またはブール値と比較するには、値を明示的に引用符で囲んで文字列として扱う必要があります（例: 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 の 2 つのポイントとして表されます。ビューポートは閉じた領域と見なされます。つまり、境界が含まれます。緯度境界は -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 の両方に値を入力する必要があります。また、（上記の定義で指定されているように）表されるボックスを空にすることはできません。ビューポートが空の場合はエラーが発生します。

たとえば、このビューポートはニューヨーク市を完全に囲んでいます。

{ &quot;low&quot;: { &quot;latitude&quot;: 40.477398, &quot;longitude&quot;: -74.259087 }, &quot;high&quot;: { &quot;latitude&quot;: 40.91618, &quot;longitude&quot;: -73.70018 } }

JSON 表現 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
フィールド
low

object (LatLng)

必須。ビューポートの低い部分。
high

object (LatLng)

必須。ビューポートの高さ。