Method: providers.vehicles.list

リクエスト オプションに一致するプロバイダに関連付けられた車両のページ分けされたリストを返します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。providers/{provider} の形式で指定してください。プロバイダには、この呼び出しを行うサービス アカウントがメンバーになっている Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)を指定する必要があります。

クエリ パラメータ

パラメータ
header

object (RequestHeader)

標準の Fleet Engine リクエスト ヘッダー。

pageSize

integer

返却する車両の最大数。デフォルト値: 100

pageToken

string

前の vehicles.list の呼び出しで指定された nextPageToken の値。これにより、車両グループをページ分けできます。リクエストのフィルタ条件が前の vehicles.list 呼び出しのフィルタ条件と同じでない場合、値は未定義になります。

minimumCapacity

integer

車両に必要な最小収容人数を指定します。返されるすべての車両の maximumCapacity は、この値以上の値になります。設定する場合は、0 以上の値を指定する必要があります。

tripTypes[]

enum (TripType)

レスポンスを、指定したルート タイプを少なくとも 1 つサポートしている車両に制限します。

maximumStaleness

string (Duration format)

指定した時間内に位置情報の更新を Fleet Engine に送信した車両に応答を制限します。位置情報を送信している静止車両は、古くなったとはみなされません。存在する場合は、有効な正の値の期間を指定する必要があります。

s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

vehicleTypeCategories[]

enum (Category)

必須。レスポンスを、指定されたタイプ カテゴリのいずれかを持つ車両に制限します。UNKNOWN は許可されていません。

requiredAttributes[]

string

呼び出し元は、requiredAttributesrequiredOneOfAttributesrequiredOneOfAttributeSets のフィールドを自由に組み合わせて、複雑な論理演算を作成できます。

requiredAttributes はリストです。requiredOneOfAttributes はリストのリストを許可するメッセージを使用します。2 つのフィールドを組み合わせることで、次の式の構成が可能になります。

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

レスポンスを、指定された属性を持つ車両に制限します。このフィールドは論理積/AND 演算です。指定できる requiredAttributes は最大 50 個です。車両で許可されている属性の最大数に一致します。繰り返される各文字列は「key:value」の形式にする必要があります。

requiredOneOfAttributes[]

string

レスポンスを、各 VehicleAttributeList で指定された属性の 1 つ以上を持つ車両に制限します。各リスト内で、車両は少なくとも 1 つの属性に一致する必要があります。このフィールドは、各 VehicleAttributeList における包括的な分離/OR 演算と、VehicleAttributeList のコレクション全体での論理/AND 演算です。繰り返しの各文字列は、「key1:value1|key2:value2|key3:value3」の形式にする必要があります。

requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets は追加機能を提供します。

requiredOneOfAttributes と同様に、requiredOneOfAttributeSets はリストのリストを許可するメッセージを使用し、次のような式を許可します。

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

VehicleAttributeList 内のすべての属性に一致する車両にレスポンスを制限します。各リスト内で、車両はすべての属性に一致する必要があります。このフィールドは、各 VehicleAttributeList の論理積/AND 演算と、VehicleAttributeList のコレクション全体での包括的な分離/OR 演算です。繰り返しの各文字列は、「key1:value1|key2:value2|key3:value3」の形式にする必要があります。

vehicleState

enum (VehicleState)

この車両ステータスを持つ車両にレスポンスを制限します。

onTripOnly

boolean

現在のルートに含まれる車両のみを返却します。

filter

string

(省略可)車両を一覧表示する場合に適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。

このフィールドは、requiredAttributesrequiredOneOfAttributesrequired_one_of_attributes_sets の各フィールドを置き換えるように設計されています。空でない値をここで指定する場合、requiredAttributesrequiredOneOfAttributesrequired_one_of_attributes_sets の各フィールドは空にする必要があります。

このフィルタは、vehicleStateonTripOnly などの他の制約との AND 句として機能します。

サポートされているクエリは、車両属性(attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2> など)に関するクエリのみです。フィルタクエリで許容される制限の最大数は 50 です。

また、属性はすべて文字列として保存されるため、属性と比較できるのは文字列の比較のみです。数値またはブール値と比較するには、値を文字列として扱われるように明示的に引用符で囲む必要があります(例: attributes.<key> = "10"attributes.<key> = "true")。

viewport

object (Viewport)

(省略可)返される車両を、最後に確認された場所がビューポートで定義された長方形領域にあった車両に限定するフィルタ。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

vehicles.list レスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
フィールド
vehicles[]

object (Vehicle)

リクエストの条件に一致する車両。返される車両の最大数は、リクエストの pageSize フィールドによって決まります。

nextPageToken

string

車両の次のページを取得するためのトークン。リクエスト条件を満たす車両がこれ以上ない場合は空になります。

totalSize

string (int64 format)

必須。すべてのページにおける、リクエスト条件に一致する車両の合計数。

ビューポート

lowhigh の 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 の場合、緯度の範囲は空になります。

lowhigh の両方を入力する必要があります。また、表されているボックスを(上記の定義で指定されているとおり)空にすることはできません。空のビューポートはエラーになります。

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

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

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