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"）。

1 つのフィルタクエリで許可される制限の最大数は 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 の両方を入力する必要があります。上の定義に従い、表示されるボックスを空にすることはできません。ビューポートが空だと、エラーが発生します。

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

{ "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)

必須。ビューポートの上限。