- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- ビューポート
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
リクエストのオプションに一致するプロバイダに関連付けられている車両を、ページ分けされたリストで返します。
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)演算です。最大 50 個の requiredAttributes を使用できます。車両で許可される最大属性数と一致します。繰り返される各文字列は「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 |
必須。ビューポートの上限。 |