Method: providers.vehicles.search

요청 옵션과 일치하는 차량 목록을 반환합니다.

HTTP 요청

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

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

경로 매개변수

매개변수
parent

string

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

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현
{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}
필드
header

object (RequestHeader)

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

pickupPoint

object (TerminalLocation)

필수 항목입니다. 근처에서 검색할 수령 지점입니다.

dropoffPoint

object (TerminalLocation)

고객이 원하는 하차 위치입니다. tripTypesTripType.SHARED이 포함된 경우 이 필드는 필수입니다.

pickupRadiusMeters

integer

필수 항목입니다. 수령 지점 주변의 차량 검색 반경을 정의합니다. 검색 반경 내의 차량만 반환됩니다. 값은 400미터 이상 10,000미터 이하여야 합니다.

count

integer

필수 항목입니다. 반환할 최대 차량 수를 지정합니다. 값은 1 이상 50 이하여야 합니다.

minimumCapacity

integer

필수 항목입니다. 이동을 고려 중인 승객 수를 지정합니다. 값은 1 이상이어야 합니다. 드라이버는 용량 값에서 고려되지 않습니다.

tripTypes[]

enum (TripType)

필수 항목입니다. 제안된 이동 유형을 나타냅니다. 이용 가능한 차량은 지정된 이동 유형 중 하나 이상을 지원할 수 있는 차량입니다.

EXCLUSIVESHARED는 함께 포함할 수 없습니다. currentTripsPresentCURRENT_TRIPS_PRESENT_UNSPECIFIED일 때는 SHARED가 지원되지 않습니다. UNKNOWN_TRIP_TYPE은(는) 허용되지 않습니다.

maximumStaleness

string (Duration format)

지정된 기간 내에 Fleet Engine에 위치 업데이트를 전송한 차량으로 검색을 제한합니다. 위치를 전송하는 정적 차량은 오래된 것으로 간주되지 않습니다. 이 필드가 설정되지 않으면 서버에서 5분을 기본값으로 사용합니다.

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

vehicleTypes[]

object (VehicleType)

필수 항목입니다. 지정된 유형 중 하나를 가진 차량으로 검색을 제한합니다. 차량 유형을 하나 이상 지정해야 합니다. 카테고리가 UNKNOWN인 VehicleType은 허용되지 않습니다.

requiredAttributes[]

object (VehicleAttribute)

호출자는 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가 허용됩니다. 차량에 허용되는 최대 속성 수와 일치합니다.

requiredOneOfAttributes[]

object (VehicleAttributeList)

VehicleAttributeList에 지정된 속성 중 하나 이상이 있는 차량으로 검색을 제한합니다. 각 목록 내에서 차량은 속성 중 하나 이상과 일치해야 합니다. 이 필드는 각 VehicleAttributeList의 포괄적 분리/OR 연산과 VehicleAttributeList 컬렉션의 결합/AND 연산입니다.

requiredOneOfAttributeSets[]

object (VehicleAttributeList)

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 연산입니다.

orderBy

enum (VehicleMatchOrder)

필수 항목입니다. 결과에 대해 원하는 순서 기준을 지정합니다.

includeBackToBack

boolean

단일 이동이 포함된 차량이 다른 일치에 적합한지 여부를 나타냅니다. false인 경우 할당된 이동 경로가 있는 차량이 검색결과에서 제외됩니다. true인 경우 TripStatusENROUTE_TO_DROPOFF인 차량이 검색결과에 포함됩니다.

이 필드는 EXCLUSIVE의 단일 tripType가 지정된 경우에만 고려됩니다.

기본값은 false입니다.

tripId

string

SearchVehicleRequest과 관련된 이동을 나타냅니다.

currentTripsPresent

enum (CurrentTripsPresent)

차량이 현재 이동 경로를 기준으로 검색결과에 표시되지 않도록 제한합니다.

currentTripsPresent가 NONE 또는 ANY인 경우 tripTypesEXCLUSIVE 또는 SHARED일 수 있지만 둘 다 될 수는 없습니다.

filter

string

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

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

이 필터는 minimumCapacity 또는 vehicleTypes와 같은 다른 제약 조건이 있는 AND 절로 작동합니다.

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

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

응답 본문

성공한 경우 응답 본문에 SearchVehiclesResponse의 인스턴스가 포함됩니다.