リクエスト オプションに一致するプロバイダに関連付けられた車両のページ分けされたリストを返します。
HTTP リクエスト
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。 |
クエリ パラメータ
パラメータ | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
pageSize |
返却する車両の最大数。デフォルト値: 100 |
pageToken |
前の |
minimumCapacity |
車両に必要な最小収容人数を指定します。返されるすべての車両の |
tripTypes[] |
レスポンスを、指定したルート タイプを少なくとも 1 つサポートしている車両に制限します。 |
maximumStaleness |
指定した時間内に位置情報の更新を Fleet Engine に送信した車両に応答を制限します。位置情報を送信している静止車両は、古くなったとはみなされません。存在する場合は、有効な正の値の期間を指定する必要があります。 「 |
vehicleTypeCategories[] |
必須。レスポンスを、指定されたタイプ カテゴリのいずれかを持つ車両に制限します。 |
requiredAttributes[] |
呼び出し元は、
レスポンスを、指定された属性を持つ車両に制限します。このフィールドは論理積/AND 演算です。指定できる requiredAttributes は最大 50 個です。車両で許可されている属性の最大数に一致します。繰り返される各文字列は「key:value」の形式にする必要があります。 |
requiredOneOfAttributes[] |
レスポンスを、各 |
requiredOneOfAttributeSets[] |
|
vehicleState |
この車両ステータスを持つ車両にレスポンスを制限します。 |
onTripOnly |
現在のルートに含まれる車両のみを返却します。 |
filter |
(省略可)車両を一覧表示する場合に適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。 このフィールドは、 このフィルタは、 サポートされているクエリは、車両属性( また、属性はすべて文字列として保存されるため、属性と比較できるのは文字列の比較のみです。数値またはブール値と比較するには、値を文字列として扱われるように明示的に引用符で囲む必要があります(例: |
viewport |
(省略可)返される車両を、最後に確認された場所がビューポートで定義された長方形領域にあった車両に限定するフィルタ。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
vehicles.list
レスポンス メッセージ。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"vehicles": [
{
object ( |
フィールド | |
---|---|
vehicles[] |
リクエストの条件に一致する車両。返される車両の最大数は、リクエストの |
nextPageToken |
車両の次のページを取得するためのトークン。リクエスト条件を満たす車両がこれ以上ない場合は空になります。 |
totalSize |
必須。すべてのページにおける、リクエスト条件に一致する車両の合計数。 |
ビューポート
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 ( |
フィールド | |
---|---|
low |
必須。ビューポートの下限。 |
high |
必須。ビューポートの高点。 |