REST Resource: providers.vehicles

Ресурс: Транспортное средство

Метаданные автомобиля.

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

Общее количество пассажиров, которое может перевозить этот автомобиль. Драйвер не учитывается в этом значении. Это значение должно быть больше или равно единице.

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 использует эту информацию для улучшения обмена информацией о поездках. Примечание. Это поле предназначено только для использования Driver SDK.

currentRouteSegmentVersion

string ( Timestamp format)

Только вывод. Время установки currentRouteSegment . Он может быть сохранен клиентом и передан в будущих запросах vehicles.get , чтобы предотвратить возвращение маршрутов, которые не изменились.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

currentRouteSegmentEndPoint

object ( TripWaypoint )

Путевая точка, где заканчивается currentRouteSegment . Водители могут предоставить его при вызове vehicles.update либо как полную точку маршрута, либо как точку LatLng , либо как последнюю LatLng из currentRouteSegment . Затем Fleet Engine сделает все возможное, чтобы интерполировать фактическую путевую точку, если она не указана полностью. Это поле игнорируется в вызовах vehicles.update , если не указан также currentRouteSegment .

remainingDistanceMeters

integer

Оставшееся расстояние поездки для currentRouteSegment . Это значение также возвращается в Trip.remaining_distance_meters для всех активных поездок, назначенных транспортному средству. Значение не указано, если поле currentRouteSegment пусто.

etaToFirstWaypoint

string ( Timestamp format)

Расчетное время прибытия до первой записи в поле waypoints . Значение не указано, если поле waypoints пусто или поле Vehicle.current_route_segment пусто.

При обновлении транспортного средства remainingTimeSeconds имеет приоритет над etaToFirstWaypoint в том же запросе.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

remainingTimeSeconds

integer

Только ввод. Оставшееся время в пути для currentRouteSegment . Значение не указано, если поле waypoints пусто или поле Vehicle.current_route_segment пусто. Это значение должно соответствовать etaToFirstWaypoint — current_time , если все стороны используют одни и те же часы.

При обновлении транспортного средства remainingTimeSeconds имеет приоритет над etaToFirstWaypoint в том же запросе.

waypoints[]

object ( TripWaypoint )

Остальные путевые точки назначены этому Транспортному средству.

waypointsVersion

string ( Timestamp format)

Только вывод. Последний раз поле waypoints обновлялось. Клиенты должны кэшировать это значение и передавать его в GetVehicleRequest , чтобы гарантировать, что поле waypoints возвращается только в случае его обновления.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

backToBackEnabled

boolean

Указывает, согласен ли водитель на двусторонние поездки. Если true , vehicles.search может включать транспортное средство, даже если оно в настоящее время назначено для поездки. Значение по умолчанию false .

navigationStatus

enum ( NavigationStatus )

Статус навигации автомобиля.

deviceSettings

object ( DeviceSettings )

Только ввод. Информация о настройках мобильного устройства, используемого водителем.

Состояние транспортного средства

Состояние Vehicle .

Перечисления
UNKNOWN_VEHICLE_STATE По умолчанию, используется для неуказанных или нераспознанных состояний автомобиля.
OFFLINE Транспортное средство не принимает новые поездки. Примечание: в этом состоянии автомобиль может продолжать работу во время выполнения назначенного ему рейса.
ONLINE Транспортное средство принимает новые поездки.

Атрибут транспортного средства

Описывает атрибут транспортного средства как пару ключ-значение. Длина строки «ключ:значение» не может превышать 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 . Значение атрибута может иметь строковый, логический или двойной тип. vehicle_attribute_value может быть только одним из следующих:
stringValue

string

Значение атрибута строкового типа.

Примечание. Это идентично полю value , которое со временем станет устаревшим. Для методов создания или обновления можно использовать любое поле, но настоятельно рекомендуется использовать stringValue . Если установлены и stringValue , и value , они должны быть идентичными, иначе будет выдана ошибка. Оба поля заполняются в ответах.

boolValue

boolean

Значение атрибута логического типа.

numberValue

number

Значение атрибута с двойным типом.

Тип машины

Тип транспортного средства.

JSON-представление
{
  "category": enum (Category)
}
Поля
category

enum ( Category )

Категория типа транспортного средства

Категория

Категории типов транспортных средств

Перечисления
UNKNOWN По умолчанию, используется для неуказанных или нераспознанных категорий транспортных средств.
AUTO Автомобиль.
TAXI Любое транспортное средство, выполняющее функции такси (обычно лицензированное или регулируемое).
TRUCK Как правило, это автомобиль с большой вместительностью.
TWO_WHEELER Мотоцикл, мопед или другое двухколесное транспортное средство.
BICYCLE Транспорт, приводимый в движение человеком.
PEDESTRIAN Транспортер-человек, обычно идущий или бегущий, передвигающийся по пешеходным дорожкам.

Номерной знак

Информация о номерном знаке ТС. Чтобы избежать хранения информации, позволяющей установить личность, как часть объекта хранится только минимальная информация о номерном знаке.

JSON-представление
{
  "countryCode": string,
  "lastCharacter": string
}
Поля
countryCode

string

Необходимый. Код страны/региона CLDR. Например, US для США или IN для Индии.

lastCharacter

string

Последняя цифра номерного знака или «-1», обозначающая отсутствие числового значения, присутствует в номерном знаке.

  • «АВС 1234» -> «4»
  • «АБ 123 CD» -> «3»
  • «ABCDEF» -> «-1»

ТрафикПолилинияДанные

Условия дорожного движения по предполагаемому маршруту движения транспортного средства.

JSON-представление
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Поля
trafficRendering

object ( VisualTrafficReportPolylineRendering )

Полилинейное отображение скорости движения во всех регионах на одном участке поездки клиента.

VisualTrafficReportPolylineРендеринг

Описывает, как клиенты должны раскрасить одну часть полилинии вдоль маршрута.

JSON-представление
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Поля
roadStretch[]

object ( RoadStretch )

Необязательный. Участки дороги, которые необходимо отрисовать вдоль полилинии. Участки гарантированно не перекрываются и не обязательно охватывают весь маршрут.

При отсутствии изменения стиля дороги клиент должен применить к маршруту значение по умолчанию.

ДорогаРастяжка

Один участок дороги, который необходимо отрендерить.

JSON-представление
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Поля
style

enum ( Style )

Необходимый. Стиль, который нужно применить.

offsetMeters

integer

Необходимый. Стиль следует применять между [offsetMeters, offsetMeters + lengthMeters) .

lengthMeters

integer

Необходимый. Длина пути, к которому применяется стиль.

Стиль

Стиль движения, указывающий скорость движения.

Перечисления
STYLE_UNSPECIFIED Стиль не выбран.
SLOWER_TRAFFIC Движение замедляется.
TRAFFIC_JAM Есть пробка.

Настройки устройства

Информация о различных настройках мобильного устройства.

JSON-представление
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
Поля
locationPowerSaveMode

enum ( LocationPowerSaveMode )

Как функции определения местоположения настроены на работу на устройстве при включенной экономии заряда батареи.

isPowerSaveMode

boolean

Находится ли устройство в режиме энергосбережения.

isInteractive

boolean

Находится ли устройство в интерактивном состоянии.

batteryInfo

object ( BatteryInfo )

Информация о состоянии батареи.

МестоположениеPowerSaveMode

Как функции определения местоположения настраиваются на мобильном устройстве, когда на устройстве включена функция экономии заряда батареи. ( https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode() )

Перечисления
UNKNOWN_LOCATION_POWER_SAVE_MODE Неопределенное местоположениеPowerSaveMode
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 будет регулировать все запросы к поставщикам, когда устройство неинтерактивно.

Информация о батарее

Информация об аккумуляторе устройства.

JSON-представление
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Поля
batteryStatus

enum ( BatteryStatus )

Состояние аккумулятора: полный или заряжающийся и т. д.

powerSource

enum ( PowerSource )

Состояние источника питания аккумулятора.

batteryPercentage

number

Текущий процент заряда батареи [0-100].

Заряд батареи

Состояние аккумулятора: полный или заряжающийся и т. д.

Перечисления
UNKNOWN_BATTERY_STATUS Состояние батареи неизвестно.
BATTERY_STATUS_CHARGING Аккумулятор заряжается.
BATTERY_STATUS_DISCHARGING Батарея разряжается.
BATTERY_STATUS_FULL Аккумулятор заряжен.
BATTERY_STATUS_NOT_CHARGING Аккумулятор не заряжается.
BATTERY_STATUS_POWER_LOW Батарея разряжена.

Источник питания

Тип зарядного устройства, используемого для зарядки аккумулятора.

Перечисления
UNKNOWN_POWER_SOURCE Источник питания неизвестен.
POWER_SOURCE_AC Источником питания является зарядное устройство переменного тока.
POWER_SOURCE_USB Источником питания является USB-порт.
POWER_SOURCE_WIRELESS Источник питания беспроводной.
POWER_SOURCE_UNPLUGGED Аккумулятор отключен.

Методы

create

 Создает экземпляр нового транспортного средства, связанного с поставщиком услуг совместного использования поездок или доставки по требованию.

get

 Возвращает транспортное средство из Fleet Engine.

list

 Возвращает постраничный список транспортных средств, связанных с поставщиком, которые соответствуют параметрам запроса.
Возвращает список транспортных средств, соответствующих параметрам запроса.

searchFuzzed
(deprecated)

 Устарело: вместо этого используйте SearchVehicles .

update

 Записывает обновленные данные автомобиля в Fleet Engine.

updateAttributes

 Частично обновляет характеристики автомобиля.

updateLocation
(deprecated)

 Устарело: вместо этого используйте метод UpdateVehicle .