요청 옵션과 일치하는 제공업체와 연결된 차량의 페이지로 나눈 목록을 반환합니다.
HTTP 요청
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
URL은 gRPC 트랜스코딩 문법을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
parent |
필수 항목입니다. |
쿼리 매개변수
매개변수 | |
---|---|
header |
표준 Fleet Engine 요청 헤더입니다. |
pageSize |
반환할 최대 차량 수입니다. 기본값은 100입니다. |
pageToken |
차량 그룹을 통해 페이지로 나눌 수 있도록 이전 |
minimumCapacity |
차량에 필요한 최소 인원을 지정합니다. 반환된 모든 차량의 |
tripTypes[] |
지정된 이동 유형 중 하나 이상을 지원하는 차량으로 응답을 제한합니다. |
maximumStaleness |
지정된 기간 내에 Fleet Engine에 위치 업데이트를 전송한 차량으로 응답을 제한합니다. 계속 위치를 전송하는 정지 차량은 오래된 것으로 간주되지 않습니다. 있는 경우 유효한 양수 기간이어야 합니다. 소수점 아래가 최대 9자리까지이고 ' |
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
지점으로 표시되는 위도-경도 표시 영역입니다. 표시 영역은 경계가 포함된 닫힌 영역으로 간주됩니다. 위도 경계는 -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 |
필수 항목입니다. 표시 영역의 높은 지점입니다. |