- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- ビューポート
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
指定されたフィルタ条件を満たすすべての DeliveryVehicle
を取得します。
HTTP リクエスト
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。 |
クエリ パラメータ
パラメータ | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
pageSize |
省略可。返される車両の最大数。サービスはこの数より少ない値を返すことがあります。この値を指定しない場合、返される結果の数はサーバーが決定します。 |
pageToken |
省略可。前回の ページ分割を行う場合、 |
filter |
省略可。配達車両を一覧表示する場合に適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。値を指定しない場合、またはフィルタで空の文字列を指定した場合は、すべての配送車両が返されます。
1 つのフィルタクエリで許可される制限の最大数は 50 です。制限は、 |
viewport |
省略可。返される車両を、最後に確認された場所がビューポートで定義された長方形の領域内にあった車両に制限するフィルタ。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
deliveryVehicles.list
レスポンス メッセージ。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"deliveryVehicles": [
{
object ( |
フィールド | |
---|---|
deliveryVehicles[] |
リクエストされたフィルタ条件を満たす配送車両のセット。フィルタが指定されていない場合は、すべての配達車両が返されます。成功のレスポンスは空にすることもできます。空のレスポンスは、リクエストされたフィルタ条件を満たす配送車両が見つからなかったことを示します。 |
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 |
必須。ビューポートの上限。 |