REST Resource: providers.vehicles

리소스: Vehicle

차량 메타데이터.

JSON 표현
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}
필드
name

string

출력 전용입니다. 이 차량의 고유한 이름입니다. 형식은 providers/{provider}/vehicles/{vehicle}입니다.

vehicleState

enum (VehicleState)

차량 상태입니다.

supportedTripTypes[]

enum (TripType)

이 차량에서 지원하는 이동 유형입니다.

currentTrips[]

string

출력 전용입니다. 현재 이 차량에 할당된 여정의 tripId 목록입니다.

lastLocation

object (VehicleLocation)

차량의 마지막으로 보고된 위치입니다.

maximumCapacity

integer

이 차량이 실을 수 있는 총 탑승자 수입니다. 이 값에는 드라이버가 고려되지 않습니다. 이 값은 1 이상이어야 합니다.

attributes[]

object (VehicleAttribute)

차량 속성 목록입니다. 차량에는 최대 100개의 속성이 있을 수 있으며 각 속성에는 고유한 키가 있어야 합니다.

vehicleType

object (VehicleType)

필수 항목입니다. 이 차량의 유형입니다. vehicles.search 결과에서 차량을 필터링하는 데 사용할 수 있습니다. 도착예정시간과 경로 계산에도 영향을 줍니다.

licensePlate

object (LicensePlate)

차량의 번호판 정보입니다.

route[]
(deprecated)

object (TerminalLocation)

지원 중단됨: 대신 Vehicle.waypoints를 사용하세요.

currentRouteSegment

string

운전자 앱이 다음 경유지까지 이동하려는 경로를 지정하는 폴리라인입니다. 이 목록은 차량에 할당된 모든 활성 경로에 대해 Trip.current_route_segment에서도 반환됩니다.

참고: 이 필드는 Driver SDK에서만 사용할 수 있습니다. 디코딩은 아직 지원되지 않습니다.

currentRouteSegmentTraffic

object (TrafficPolylineData)

입력 전용입니다. Fleet Engine은 이 정보를 사용하여 이동 공유를 개선합니다. 참고: 이 필드는 드라이버 SDK에서만 사용할 수 있습니다.

currentRouteSegmentVersion

string (Timestamp format)

출력 전용입니다. currentRouteSegment가 설정된 시간입니다. 클라이언트가 저장하고 향후 vehicles.get 요청에서 전달하여 변경되지 않은 경로가 반환되지 않도록 할 수 있습니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

currentRouteSegmentEndPoint

object (TripWaypoint)

currentRouteSegment가 종료되는 웨이포인트입니다. 이는 vehicles.update 호출 시 운전자가 전체 이동 경유지, 경유지 LatLng 또는 currentRouteSegment의 마지막 LatLng로 제공할 수 있습니다. 경로가 완전히 지정되지 않은 경우 Fleet Engine에서 실제 경유지에 보간하기 위해 최선을 다합니다. currentRouteSegment도 지정하지 않는 한 이 필드는 vehicles.update 호출에서 무시됩니다.

remainingDistanceMeters

integer

currentRouteSegment의 남은 운전 거리입니다. 이 값은 차량에 할당된 모든 진행 중인 이동의 Trip.remaining_distance_meters에서도 반환됩니다. currentRouteSegment 필드가 비어 있으면 값이 지정되지 않습니다.

etaToFirstWaypoint

string (Timestamp format)

waypoints 필드의 첫 번째 항목까지의 예상 도착 시간입니다. waypoints 필드가 비어 있거나 Vehicle.current_route_segment 필드가 비어 있으면 값이 지정되지 않습니다.

차량을 업데이트할 때 동일한 요청에서 remainingTimeSecondsetaToFirstWaypoint보다 우선 적용됩니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

remainingTimeSeconds

integer

입력 전용입니다. currentRouteSegment의 남은 운전 시간입니다. waypoints 필드가 비어 있거나 Vehicle.current_route_segment 필드가 비어 있는 경우 값이 지정되지 않습니다. 모든 당사자가 동일한 시계를 사용한다면 이 값은 etaToFirstWaypoint - current_time과 일치해야 합니다.

차량을 업데이트할 때 동일한 요청에서 remainingTimeSecondsetaToFirstWaypoint보다 우선 적용됩니다.

waypoints[]

object (TripWaypoint)

이 차량에 할당된 나머지 웨이포인트입니다.

waypointsVersion

string (Timestamp format)

출력 전용입니다. waypoints 필드가 마지막으로 업데이트된 시간입니다. 클라이언트는 이 값을 캐시하고 GetVehicleRequest에 전달하여 waypoints 필드가 업데이트된 경우에만 반환되도록 해야 합니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

backToBackEnabled

boolean

운전자가 연차를 허용하는지 나타냅니다. true인 경우 vehicles.search는 현재 이동에 할당되어 있더라도 차량을 포함할 수 있습니다. 기본값은 false입니다.

navigationStatus

enum (NavigationStatus)

차량의 내비게이션 상태입니다.

deviceSettings

object (DeviceSettings)

입력 전용입니다. 운전자가 사용하는 휴대기기의 설정에 관한 정보입니다.

VehicleState

Vehicle의 상태입니다.

열거형
UNKNOWN_VEHICLE_STATE 기본값은 지정되지 않았거나 인식할 수 없는 차량 상태에 사용됩니다.
OFFLINE 차량에서 새 이동을 허용하지 않습니다. 참고: 차량은 할당된 이동을 완료하는 동안 이 상태에서 계속 작동할 수 있습니다.
ONLINE 차량에서 새로운 이동을 수락하고 있습니다.

VehicleAttribute

차량 속성을 키-값 쌍으로 설명합니다. '키:값' 문자열 길이는 256자를 초과할 수 없습니다.

JSON 표현
{
  "key": string,
  "value": string,

  // Union field vehicle_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field vehicle_attribute_value.
}
필드
key

string

속성의 키입니다. 키에는 콜론 문자(:)가 포함될 수 없습니다.

value

string

속성의 값입니다.

통합 필드 vehicle_attribute_value. 속성 값은 문자열, 부울 또는 double 형식일 수 있습니다. vehicle_attribute_value은 다음 중 하나여야 합니다.
stringValue

string

문자열 유형의 속성 값입니다.

참고: 이는 value 필드와 동일하며 value 필드는 향후 지원 중단될 예정입니다. 만들기 또는 업데이트 메서드의 경우 두 필드 중 어느 쪽이든 사용할 수 있지만 stringValue를 사용하는 것이 좋습니다. stringValuevalue가 모두 설정된 경우 두 속성이 동일해야 하며, 그렇지 않으면 오류가 발생합니다. 두 필드 모두 응답에 채워집니다.

boolValue

boolean

부울 유형의 속성 값입니다.

numberValue

number

이중 유형 속성 값

VehicleType

차량 유형입니다.

JSON 표현
{
  "category": enum (Category)
}
필드
category

enum (Category)

차량 유형 카테고리

카테고리

차량 유형 카테고리

열거형
UNKNOWN 지정되지 않거나 인식할 수 없는 차량 카테고리에 사용되는 기본값입니다.
AUTO 자동차입니다.
TAXI 택시 역할을 하는 모든 차량(일반적으로 면허를 보유하거나 규제 대상)
TRUCK 일반적으로 저장용량이 큰 차량입니다.
TWO_WHEELER 오토바이, 모페드 또는 기타 오토바이
BICYCLE 인간 기반 운송
PEDESTRIAN 보통 걷거나 뛰면서 보행자 전용 도로를 따라 이동하는 사람입니다.

LicensePlate

차량의 번호판 정보입니다. 개인 식별 정보를 저장하지 않기 위해 자동차 번호판에 대한 최소한의 정보만 법인의 일부로 저장됩니다.

JSON 표현
{
  "countryCode": string,
  "lastCharacter": string
}
필드
countryCode

string

필수 항목입니다. CLDR 국가/지역 코드입니다. 예를 들어 미국은 US, 인도는 IN입니다.

lastCharacter

string

자동차 번호판의 마지막 숫자 또는 숫자 값이 없음을 나타내는 '-1'이 자동차 번호판에 없는 경우

  • 'ABC 1234' -> '4'
  • 'AB 123 CD' -> '3'
  • 'ABCDEF' -> '-1'

TrafficPolylineData

예상 차량 경로의 교통상황

JSON 표현
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
필드
trafficRendering

object (VisualTrafficReportPolylineRendering)

고객 승차 구간의 한 구간을 따라 모든 지역의 교통상황을 보여주는 다중선 렌더링입니다.

VisualTrafficReportPolylineRendering

클라이언트가 경로를 따라 다중선의 한 부분에 색상을 지정하는 방법을 설명합니다.

JSON 표현
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
필드
roadStretch[]

object (RoadStretch)

선택사항입니다. 폴리라인을 따라 렌더링해야 하는 도로 구간입니다. 구간은 중복되지 않으며 전체 경로에 걸쳐 있지 않아도 됩니다.

스타일을 지정할 도로 구간이 없는 경우 클라이언트는 경로에 기본값을 적용해야 합니다.

RoadStretch

렌더링해야 하는 도로 구간 1개.

JSON 표현
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
필드
style

enum (Style)

필수 항목입니다. 적용할 스타일입니다.

offsetMeters

integer

필수 항목입니다. 스타일은 [offsetMeters, offsetMeters + lengthMeters) 사이에 적용되어야 합니다.

lengthMeters

integer

필수 항목입니다. 스타일을 적용할 경로의 길이입니다.

스타일

교통 속도를 나타내는 교통 스타일입니다.

열거형
STYLE_UNSPECIFIED 선택된 스타일이 없습니다.
SLOWER_TRAFFIC 트래픽이 느려지고 있습니다.
TRAFFIC_JAM 교통 체증이 있습니다.

DeviceSettings

휴대기기의 다양한 설정에 관한 정보입니다.

JSON 표현
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
필드
locationPowerSaveMode

enum (LocationPowerSaveMode)

절전 모드가 사용 설정된 경우 기기에서 위치 기능이 작동하도록 설정하는 방법입니다.

isPowerSaveMode

boolean

기기가 현재 절전 모드에 있는지 여부입니다.

isInteractive

boolean

기기가 대화형 상태인지 여부

batteryInfo

object (BatteryInfo)

배터리 상태에 관한 정보입니다.

LocationPowerSaveMode

기기의 '절전 모드' 기능이 사용 설정된 경우 모바일 기기에서 위치 기능이 작동하도록 구성하는 방법입니다. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

열거형
UNKNOWN_LOCATION_POWER_SAVE_MODE 정의되지 않은 LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE 위치 정보 제공자는 절전 모드의 영향을 받지 않거나 절전 모드가 꺼져 있습니다.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF 절전 모드가 켜져 있고 기기가 대화형이 아닌 경우 GPS 기반 위치 제공자를 사용 중지해야 합니다.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF 절전 모드가 켜져 있고 기기가 대화형이 아닌 경우 모든 위치 정보 제공자를 사용 중지해야 합니다.
LOCATION_MODE_FOREGROUND_ONLY 모든 위치 제공업체는 계속 사용할 수 있지만 위치 수정은 포그라운드 앱에만 제공해야 합니다.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF 위치 정보는 사용 중지되지 않지만 기기가 상호작용하지 않을 때 LocationManager는 제공업체에 대한 모든 요청을 제한합니다.

BatteryInfo

기기 배터리에 관한 정보입니다.

JSON 표현
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
필드
batteryStatus

enum (BatteryStatus)

배터리 상태(완전 충전 여부 등)

powerSource

enum (PowerSource)

배터리 전원 공급원의 상태입니다.

batteryPercentage

number

현재 배터리 잔량 비율은 [0~100]입니다.

BatteryStatus

배터리 상태(완전 충전 여부 등)

열거형
UNKNOWN_BATTERY_STATUS 배터리 상태를 알 수 없습니다.
BATTERY_STATUS_CHARGING 배터리가 충전 중입니다.
BATTERY_STATUS_DISCHARGING 배터리가 방전되고 있습니다.
BATTERY_STATUS_FULL 배터리가 완전히 충전되어 있습니다.
BATTERY_STATUS_NOT_CHARGING 배터리가 충전 중이 아닙니다.
BATTERY_STATUS_POWER_LOW 배터리 전원이 부족합니다.

PowerSource

배터리를 충전하는 데 사용하는 충전기 유형입니다.

열거형
UNKNOWN_POWER_SOURCE 전원을 알 수 없습니다.
POWER_SOURCE_AC 전원 소스는 AC 충전기입니다.
POWER_SOURCE_USB 전원이 USB 포트입니다.
POWER_SOURCE_WIRELESS 전원 소스가 무선입니다.
POWER_SOURCE_UNPLUGGED 배터리 전원이 뽑혀 있습니다.

메서드

create

주문형 차량 공유 또는 배송 업체와 연결된 새 차량을 인스턴스화합니다.

get

Fleet Engine에서 차량을 반환합니다.

list

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

update

업데이트된 차량 데이터를 Fleet Engine에 씁니다.

updateAttributes

차량의 속성을 부분적으로 업데이트합니다.