Method: providers.deliveryVehicles.list

지정된 필터링 기준을 충족하는 모든 DeliveryVehicle를 가져옵니다.

HTTP 요청

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

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

경로 매개변수

매개변수
parent

string

필수 항목입니다. providers/{provider} 형식이어야 합니다. provider는 Google Cloud 프로젝트 ID여야 합니다. sample-cloud-project를 예로 들 수 있습니다.

쿼리 매개변수

매개변수
header

object (DeliveryRequestHeader)

선택사항. 표준 게재 API 요청 헤더입니다.
pageSize

integer

선택사항. 반환할 최대 차량 수입니다. 서비스가 이 수보다 더 적게 반환할 수 있습니다. 이 숫자를 지정하지 않으면 서버에서 표시할 결과 수를 결정합니다.
pageToken

string

선택사항. 이전 deliveryVehicles.list 호출에서 받은 페이지 토큰입니다. 이후 페이지를 가져오려면 이 정보를 제공해야 합니다.

페이지를 매길 때 deliveryVehicles.list에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.
filter

string

선택사항. 배송 차량을 나열할 때 적용할 필터 쿼리입니다. 필터 구문의 예는 http://aip.dev/160을 참조하세요. 값을 지정하지 않거나 필터에 빈 문자열을 지정하면 모든 배송 차량이 반환됩니다.

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

필터 쿼리에 허용되는 최대 제한사항은 50개입니다. 제한은 attribute.<KEY> <COMPARATOR> <VALUE> 형식의 쿼리의 일부입니다. 예를 들어 attributes.foo = bar는 제한 1개입니다.
viewport

object (Viewport)

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

요청 본문

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

응답 본문

deliveryVehicles.list 응답 메시지

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

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

object (DeliveryVehicle)

요청된 필터링 기준을 충족하는 게재 수단 집합입니다. 필터를 지정하지 않으면 요청이 모든 배송 차량을 반환합니다. 성공적인 응답은 비워둘 수도 있습니다. 빈 응답은 요청된 필터 기준을 충족하는 배송 차량을 찾지 못했음을 나타냅니다.
nextPageToken

string

ListDeliveryVehiclesRequest에 이 토큰을 전달하여 결과를 계속 나열할 수 있습니다. 모든 결과가 반환되면 이 필드는 응답에 없거나 빈 문자열이 됩니다.
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": { "위도": 40.477398, "경도": -74.259087 }, "고도": { "latitude": 40.91618, "경도": -73.70018 } }

JSON 표현 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
필드
low

object (LatLng)

필수 항목입니다. 표시 영역의 낮은 지점입니다.
high

object (LatLng)

필수 항목입니다. 표시 영역의 높은 지점입니다.