Method: providers.vehicles.list

요청 옵션과 일치하는 제공업체와 연결된 페이지로 나눈 차량 목록을 반환합니다.

HTTP 요청

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. providers/{provider} 형식이어야 합니다. 제공업체는 이 호출을 실행하는 서비스 계정이 속한 Google Cloud 프로젝트의 프로젝트 ID (예: sample-cloud-project)여야 합니다.

쿼리 매개변수

매개변수
header

object (RequestHeader)

표준 Fleet Engine 요청 헤더입니다.
pageSize

integer

반납할 수 있는 최대 차량 수입니다. 기본값은 100입니다.
pageToken

string

차량 그룹을 통해 페이지로 나눌 수 있도록 이전 vehicles.list 호출에서 제공된 nextPageToken 값입니다. 요청의 필터 기준이 이전 vehicles.list 호출의 필터 기준과 같지 않으면 값이 정의되지 않습니다.
minimumCapacity

integer

차량에 필요한 최소 용량을 지정합니다. 반환되는 모든 차량의 maximumCapacity 값이 이 값보다 크거나 같습니다. 설정된 경우 0 이상이어야 합니다.
tripTypes[]

enum (TripType)

지정된 이동 유형 중 하나 이상을 지원하는 차량으로 응답을 제한합니다.
maximumStaleness

string (Duration format)

지정된 기간 내에 Fleet Engine으로 위치 업데이트를 전송한 차량으로 응답을 제한합니다. 여전히 위치를 전송 중인 정차 차량은 오래된 것으로 간주되지 않습니다. 있는 경우 유효한 양수 기간이어야 합니다.

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.
vehicleTypeCategories[]

enum (Category)

필수 항목입니다. 지정된 유형 카테고리 중 하나가 있는 차량으로 응답을 제한합니다. UNKNOWN은(는) 허용되지 않습니다.
requiredAttributes[]

string

호출자는 requiredAttributes, requiredOneOfAttributes, requiredOneOfAttributeSets 필드를 조합하여 복잡한 논리 연산을 구성할 수 있습니다.

requiredAttributes는 목록입니다. requiredOneOfAttributes는 목록 목록을 허용하는 메시지를 사용합니다. 두 필드를 함께 사용하면 다음 표현식을 작성할 수 있습니다.

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

지정된 속성이 있는 차량으로 응답을 제한합니다. 이 필드는 결합/AND 연산입니다. 최대 50개의 requiredAttributes가 허용됩니다. 차량에 허용되는 최대 속성 수와 일치합니다. 반복되는 각 문자열은 'key:value' 형식이어야 합니다.
requiredOneOfAttributes[]

string

각 VehicleAttributeList에 지정된 속성 중 하나 이상이 있는 차량으로 응답을 제한합니다. 각 목록에서 차량은 속성 중 하나 이상과 일치해야 합니다. 이 필드는 각 VehicleAttributeList의 포괄적 분리/OR 연산 및 VehicleAttributeList 컬렉션에 대한 결합/AND 연산입니다. 반복되는 각 문자열은 'key1:value1|key2:value2|key3:value3' 형식이어야 합니다.
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets는 추가 기능을 제공합니다.

requiredOneOfAttributes와 마찬가지로 requiredOneOfAttributeSets는 목록 목록을 허용하는 메시지를 사용하여 다음과 같은 표현식을 허용합니다.

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

VehicleAttributeList의 모든 속성과 일치하는 차량으로 응답을 제한합니다. 각 목록에서 차량은 모든 속성과 일치해야 합니다. 이 필드는 각 VehicleAttributeList의 결합/AND 연산과 VehicleAttributeList 컬렉션에 대한 포함의 분리/OR 연산입니다. 반복되는 각 문자열은 'key1:value1|key2:value2|key3:value3' 형식이어야 합니다.
vehicleState

enum (VehicleState)

이 차량 상태의 차량으로 응답을 제한합니다.
onTripOnly

boolean

현재 이동 중인 차량만 반납하세요.
filter

string

선택사항입니다. 차량을 나열할 때 적용할 필터 쿼리입니다. 필터 구문의 예는 http://aip.dev/160을 참조하세요.

이 필드는 requiredAttributes, requiredOneOfAttributes, required_one_of_attributes_sets 필드를 대체하도록 설계되었습니다. 여기에 비어 있지 않은 값이 지정된 경우 requiredAttributes, requiredOneOfAttributes, required_one_of_attributes_sets 필드는 비어 있어야 합니다.

이 필터는 vehicleState 또는 onTripOnly와 같은 다른 제약조건과 함께 AND 절로 작동합니다.

지원되는 유일한 쿼리는 차량 속성 (예: attributes.<key> = <value> 또는 attributes.<key1> = <value1> AND attributes.<key2> = <value2>)입니다. 필터 쿼리에 허용되는 최대 제한사항 수는 50개입니다.

또한 모든 속성은 문자열로 저장되므로 속성에 대해 지원되는 유일한 비교는 문자열 비교입니다. 숫자 또는 불리언 값과 비교하려면 값을 명시적으로 따옴표로 묶어 문자열로 처리해야 합니다 (예: attributes.<key> = "10" 또는 attributes.<key> = "true").
viewport

object (Viewport)

선택사항입니다. 마지막으로 알려진 위치가 표시 영역에 정의된 직사각형 영역에 있었던 차량으로 되돌아가는 차량을 제한하는 필터입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

vehicles.list 응답 메시지입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
필드
vehicles[]

object (Vehicle)

요청의 기준과 일치하는 차량입니다. 반환되는 최대 차량 수는 요청의 pageSize 필드에 따라 결정됩니다.
nextPageToken

string

차량의 다음 페이지를 가져오는 토큰으로, 요청 기준을 충족하는 차량이 더 이상 없는 경우 비어 있습니다.
totalSize

string (int64 format)

필수 항목입니다. 모든 페이지에서 요청 기준과 일치하는 총 차량 수입니다.

표시 영역

위도-경도 표시 영역으로, 대각선으로 반대되는 두 개의 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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
필드
low

object (LatLng)

필수 항목입니다. 표시 영역의 최저점입니다.
high

object (LatLng)

필수 항목입니다. 표시 영역의 최고점입니다.