지정된 필터링 기준을 충족하는 모든 DeliveryVehicle
를 가져옵니다.
HTTP 요청
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
parent |
필수 항목입니다. |
쿼리 매개변수
매개변수 | |
---|---|
header |
선택사항입니다. Standard Delivery API 요청 헤더입니다. |
pageSize |
선택사항입니다. 반납할 수 있는 최대 차량 수입니다. 서비스에서 이 수보다 적은 수를 반환할 수도 있습니다. 이 숫자를 지정하지 않으면 서버에서 반환할 결과 수를 결정합니다. |
pageToken |
선택사항입니다. 이전 페이지를 매길 때 |
filter |
선택사항입니다. 배달 차량을 나열할 때 적용할 필터 쿼리입니다. 필터 구문의 예는 http://aip.dev/160을 참조하세요. 값을 지정하지 않거나 필터에 빈 문자열을 지정하면 모든 배송 차량이 반환됩니다.
필터 쿼리에 허용되는 최대 제한사항 수는 50개입니다. 제한은 |
viewport |
선택사항입니다. 마지막으로 알려진 위치가 표시 영역에 정의된 직사각형 영역에 있었던 차량으로 되돌아가는 차량을 제한하는 필터입니다. |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
deliveryVehicles.list
응답 메시지입니다.
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{
"deliveryVehicles": [
{
object ( |
필드 | |
---|---|
deliveryVehicles[] |
요청된 필터링 기준을 충족하는 게재 차량 집합입니다. 필터를 지정하지 않으면 요청에서 모든 배송 차량을 반환합니다. 성공 응답은 비워 둘 수도 있습니다. 빈 응답은 요청된 필터 기준을 충족하는 배송 차량이 없음을 나타냅니다. |
nextPageToken |
|
totalSize |
모든 페이지에서 요청 기준과 일치하는 총 배송 차량 수입니다. |
표시 영역
위도-경도 표시 영역으로, 대각선으로 반대되는 두 개의 low
및 high
지점으로 표시됩니다. 표시 영역은 닫힌 영역으로 간주됩니다. 즉, 경계가 포함된 영역입니다. 위도 경계는 -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 |
필수 항목입니다. 표시 영역의 최고점입니다. |