指定されたフィルタ条件を満たすすべての 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 |
必須。ビューポートの高点。 |