Package maps.fleetengine.v1

Индекс

ТрипСервис

Служба организации поездок.

Создать поездку

rpc CreateTrip( CreateTripRequest ) returns ( Trip )

Создает поездку в Fleet Engine и возвращает новую поездку.

GetTrip

rpc GetTrip( GetTripRequest ) returns ( Trip )

Получите информацию об одной поездке.

ОтчетОплачиваемая поездка

rpc ReportBillableTrip( ReportBillableTripRequest ) returns ( Empty )

Отчет об использовании оплачиваемых поездок.

Поискпоездок

rpc SearchTrips( SearchTripsRequest ) returns ( SearchTripsResponse )

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

ОбновлениеTrip

rpc UpdateTrip( UpdateTripRequest ) returns ( Trip )

Обновляет данные о поездке.

АвтомобильСервис

Служба управления транспортным средством.

Создать транспортное средство

rpc CreateVehicle( CreateVehicleRequest ) returns ( Vehicle )

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

При создании Vehicle Vehicle обязательны следующие поля:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Следующие поля Vehicle игнорируются при создании Vehicle :

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Все остальные поля являются необязательными и используются, если они предусмотрены.

Получить транспортное средство

rpc GetVehicle( GetVehicleRequest ) returns ( Vehicle )

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

СписокТранспорт

rpc ListVehicles( ListVehiclesRequest ) returns ( ListVehiclesResponse )

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

Поиск транспортных средств

rpc SearchVehicles( SearchVehiclesRequest ) returns ( SearchVehiclesResponse )

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

Обновить транспортное средство

rpc UpdateVehicle( UpdateVehicleRequest ) returns ( Vehicle )

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

При обновлении Vehicle невозможно обновить следующие поля, поскольку они управляются сервером:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

name автомобиля также не может быть обновлено.

Если поле attributes обновляется, все атрибуты автомобиля заменяются атрибутами, указанными в запросе. Если вы хотите обновить только некоторые атрибуты, см. метод UpdateVehicleAttributes . Аналогично, поле waypoints может быть обновлено, но оно должно содержать все путевые точки, находящиеся в данный момент на транспортном средстве, и никаких других путевых точек.

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

rpc UpdateVehicleAttributes( UpdateVehicleAttributesRequest ) returns ( UpdateVehicleAttributesResponse )

Частично обновляет характеристики автомобиля. Будут обновлены только атрибуты, указанные в запросе, остальные атрибуты НЕ будут изменены. Примечание. В UpdateVehicle все по-другому, где все поле attributes будет заменено полем в UpdateVehicleRequest , атрибуты, отсутствующие в запросе, будут удалены.

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

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

Поля
battery_ status

BatteryStatus

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

power_ source

PowerSource

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

battery_ percentage

float

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

Статус батареи

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

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

Идентификатор биллинговой платформы

Набор значений, указывающих, на какой платформе был отправлен запрос.

Перечисления
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED По умолчанию. Используется для неуказанных платформ.
SERVER Платформа представляет собой клиент-сервер.
WEB Платформа представляет собой веб-браузер.
ANDROID Платформа представляет собой мобильное устройство Android.
IOS Платформа представляет собой мобильное устройство IOS.
OTHERS Другие платформы, не указанные в этом списке.

Расходные материалыТрафикПолилиния

Плотность движения на пути движения транспортного средства.

Поля
speed_ reading_ interval[]

SpeedReadingInterval

Скорость движения на пути от предыдущей путевой точки до текущей.

encoded_ path_ to_ waypoint

string

Путь, который следует водителю от предыдущей точки маршрута до текущей точки маршрута. На этом пути есть ориентиры, поэтому клиенты могут показывать маркеры трафика вдоль пути (см. speed_reading_interval ). Декодирование пока не поддерживается.

Создать запрос на поездку

Сообщение запроса CreateTrip.

Поля
header

RequestHeader

Стандартный заголовок запроса Fleet Engine.

parent

string

Необходимый. Должно быть в формате providers/{provider} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

trip_ id

string

Необходимый. Уникальный идентификатор поездки. С учетом следующих ограничений:

  • Должна быть допустимой строкой Юникода.
  • Ограничена максимальной длиной в 64 символа.
  • Нормализовано в соответствии с формой нормализации Unicode C.
  • Не может содержать следующие символы ASCII: «/», «:», «?», «,» или «#».
trip

Trip

Необходимый. Объект поездки, который необходимо создать.

При создании поездки обязательны следующие поля:

  • trip_type
  • pickup_point

Следующие поля используются, если вы их предоставите:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

Все остальные поля «Поездка» игнорируются. Например, все поездки начинаются со статуса trip_status равного NEW даже если вы передадите trip_status равный CANCELED в запросе на создание.

Только EXCLUSIVE поездки поддерживают intermediate_destinations .

Если для общей поездки задан vehicle_id , вы должны предоставить список Trip.vehicle_waypoints , чтобы указать порядок оставшихся путевых точек для транспортного средства, в противном случае порядок путевых точек будет неопределенным.

Когда вы указываете Trip.vehicle_waypoints , список должен содержать все оставшиеся путевые точки поездок транспортного средства без каких-либо дополнительных путевых точек. Вы должны расположить эти путевые точки таким образом, чтобы для данной поездки точка посадки находилась перед промежуточными пунктами назначения, а все промежуточные пункты назначения находились перед точкой высадки. Путевые точки EXCLUSIVE поездки не должны пересекаться с другими поездками.

Поля trip_id , waypoint_type и location используются, а все остальные поля TripWaypoint в vehicle_waypoints игнорируются.

Создать запрос транспортного средства

Сообщение запроса CreateVehicle .

Поля
header

RequestHeader

Стандартный заголовок запроса Fleet Engine.

parent

string

Необходимый. Должно быть в формате providers/{provider} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

vehicle_ id

string

Необходимый. Уникальный идентификатор автомобиля. С учетом следующих ограничений:

  • Должна быть допустимой строкой Unicode.
  • Ограничено максимальной длиной в 64 символа.
  • Нормализовано в соответствии с формой нормализации Unicode C.
  • Не может содержать следующие символы ASCII: «/», «:», «?», «,» или «#».
vehicle

Vehicle

Необходимый. Объект Транспортное средство, который необходимо создать. При создании ТС обязательны следующие поля:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

При создании ТС игнорируются следующие поля:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Все остальные поля являются необязательными и используются, если они предусмотрены.

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

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

Поля
location_ power_ save_ mode

LocationPowerSaveMode

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

is_ power_ save_ mode

bool

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

is_ interactive

bool

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

battery_ info

BatteryInfo

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

Получить запрос поездки

Сообщение запроса GetTrip.

Поля
header

RequestHeader

Стандартный заголовок запроса Fleet Engine.

name

string

Необходимый. Должно быть в формате providers/{provider}/trips/{trip} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

view

TripView

Подмножество полей Trip, которые должны быть возвращены, и их интерпретация.

current_ route_ segment_ version

Timestamp

Указывает минимальную временную метку (эксклюзивную), для которой извлекаются данные Trip.route или Trip.current_route_segment . Если данные маршрута не изменились с момента этой временной метки, поле маршрута не задается в ответе. Если минимум не указан, данные маршрута извлекаются всегда.

remaining_ waypoints_ version

Timestamp

Указывает минимальную временную метку (эксклюзивную), для которой извлекаются Trip.remaining_waypoints . Если они не изменились с момента этой временной метки, remaining_waypoints не устанавливаются в ответе. Если это поле не указано, remaining_waypoints всегда извлекаются.

route_ format_ type

PolylineFormatType

Возвращаемый формат текущего маршрута: LAT_LNG_LIST_TYPETrip.route ) или ENCODED_POLYLINE_TYPETrip.current_route_segment ). По умолчанию используется LAT_LNG_LIST_TYPE .

current_ route_ segment_ traffic_ version

Timestamp

Указывает минимальную временную метку (эксклюзивную), для которой извлекается Trip.current_route_segment_traffic . Если данные о трафике не изменились с момента этой временной метки, поле current_route_segment_traffic не устанавливается в ответе. Если минимум не указан, данные о трафике извлекаются всегда. Обратите внимание, что трафик доступен только для клиентов On-Demand Rides and Delivery Solution.

remaining_ waypoints_ route_ version

Timestamp

Указывает минимальную временную метку (эксклюзивную), для которой извлекаются данные Trip.remaining_waypoints.traffic_to_waypoint и Trip.remaining_waypoints.path_to_waypoint . Если данные не изменились с момента этой временной метки, приведенные выше поля не задаются в ответе. Если remaining_waypoints_route_version не указан, трафик и путь всегда извлекаются.

Получить запрос транспортного средства

Сообщение запроса GetVehicle .

Поля
header

RequestHeader

Стандартный заголовок запроса Fleet Engine.

name

string

Необходимый. Должно быть в формате providers/{provider}/vehicles/{vehicle} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

current_ route_ segment_ version

Timestamp

Указывает минимальную временную метку (эксклюзивную), для которой извлекается Vehicle.current_route_segment . Если маршрут не изменился с момента этой временной метки, поле current_route_segment не устанавливается в ответе. Если минимум не указан, всегда извлекается current_route_segment .

waypoints_ version

Timestamp

Указывает минимальную временную метку (эксклюзивную), для которой извлекаются данные Vehicle.waypoints . Если путевые точки не изменились с момента этой временной метки, данные vehicle.waypoints не задаются в ответе. Если это поле не указано, vehicle.waypoints извлекается всегда.

Лицензионная Табличка

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

Поля
country_ code

string

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

last_ character

string

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

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

Список транспортных средствЗапрос

Сообщение запроса ListVehicles .

Поля
header

RequestHeader

Стандартный заголовок запроса Fleet Engine.

parent

string

Необходимый. Должно быть в формате providers/{provider} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

page_ size

int32

Максимальное количество возвращаемых автомобилей. Значение по умолчанию: 100.

page_ token

string

Значение next_page_token предоставленное предыдущим вызовом ListVehicles , чтобы вы могли перемещаться по группам транспортных средств. Значение не определено, если критерии фильтрации запроса не совпадают с критериями фильтрации для предыдущего вызова ListVehicles .

minimum_ capacity

Int32Value

Указывает необходимую минимальную грузоподъемность автомобиля. Все возвращенные транспортные средства будут иметь maximum_capacity больше или равный этому значению. Если установлено, должно быть больше или равно 0.

trip_ types[]

TripType

Ограничивает ответ транспортными средствами, которые поддерживают хотя бы один из указанных типов поездок.

maximum_ staleness

Duration

Ограничивает ответ транспортными средствами, которые отправили обновления местоположения в Fleet Engine в течение указанного периода времени. Стационарные транспортные средства, все еще передающие свое местоположение, не считаются устаревшими. Если присутствует, должна быть действительная положительная продолжительность.

vehicle_ type_ categories[]

Category

Необходимый. Ограничивает ответ транспортными средствами одной из указанных типовых категорий. UNKNOWN не допускается.

required_ attributes[]

string

Вызывающие программы могут формировать сложные логические операции, используя любую комбинацию полей required_attributes , required_one_of_attributes и required_one_of_attribute_sets .

required_attributes — это список; required_one_of_attributes использует сообщение, которое разрешает список списков. В сочетании эти два поля позволяют составить это выражение:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Ограничивает ответ транспортными средствами с указанными атрибутами. Это поле представляет собой операцию конъюнкции/И. Разрешается максимум 50 обязательных_атрибутов. Это соответствует максимальному количеству атрибутов, разрешенных для транспортного средства. Каждая повторяющаяся строка должна иметь формат «ключ:значение».

required_ one_ of_ attributes[]

string

Ограничивает ответ транспортными средствами, имеющими хотя бы один из указанных атрибутов в каждом VehicleAttributeList . В каждом списке транспортное средство должно соответствовать хотя бы одному из атрибутов. Это поле представляет собой включающую операцию разъединения/ИЛИ в каждом VehicleAttributeList и операцию объединения/И в коллекции VehicleAttributeList . Каждая повторяющаяся строка должна иметь формат «ключ1:значение1|ключ2:значение2|ключ3:значение3».

required_ one_ of_ attribute_ sets[]

string

required_one_of_attribute_sets предоставляет дополнительную функциональность.

Подобно required_one_of_attributes , required_one_of_attribute_sets использует сообщение, которое разрешает список списков, допуская такие выражения, как это:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Ограничивает ответ транспортными средствами, которые соответствуют всем атрибутам в VehicleAttributeList . В каждом списке транспортное средство должно соответствовать всем атрибутам. Это поле представляет собой операцию соединения/И в каждом VehicleAttributeList и инклюзивную операцию разъединения/ИЛИ в коллекции VehicleAttributeList . Каждая повторяющаяся строка должна иметь формат «ключ1:значение1|ключ2:значение2|ключ3:значение3».

vehicle_ state

VehicleState

Ограничивает ответ транспортными средствами, имеющими это состояние.

on_ trip_ only

bool

Возвращайте только автомобили с текущей поездкой(ями).

filter

string

Необязательный. Запрос-фильтр, применяемый при перечислении транспортных средств. См. http://aip.dev/160 для примеров синтаксиса фильтра.

Это поле предназначено для замены полей required_attributes , required_one_of_attributes и required_one_of_attributes_sets . Если здесь указано непустое значение, следующие поля должны быть пустыми: required_attributes , required_one_of_attributes и required_one_of_attributes_sets .

Этот фильтр работает как предложение AND с другими ограничениями, такими как vehicle_state или on_trip_only .

Обратите внимание, что поддерживаются только запросы по атрибутам транспортного средства (например, attributes.<key> = <value> или attributes.<key1> = <value1> AND attributes.<key2> = <value2> ). Максимальное количество ограничений, разрешенное в запросе фильтра, — 50.

Кроме того, все атрибуты хранятся в виде строк, поэтому единственным поддерживаемым сравнением атрибутов является сравнение строк. Для сравнения с числовыми или логическими значениями значения должны быть явно заключены в кавычки, чтобы их можно было рассматривать как строки (например, attributes.<key> = "10" или attributes.<key> = "true" ).

viewport

Viewport

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

Список транспортных средствОтвет

Ответное сообщение ListVehicles .

Поля
vehicles[]

Vehicle

Транспортные средства, соответствующие критериям запроса. Максимальное количество возвращаемых автомобилей определяется полем page_size в запросе.

next_ page_ token

string

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

total_ size

int64

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

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

Датчик местоположения

Датчик или метод, используемый для определения местоположения.

Перечисления
UNKNOWN_SENSOR Датчик не указан или неизвестен.
GPS GPS или вспомогательный GPS.
NETWORK Вспомогательный GPS, идентификатор вышки сотовой связи или точка доступа Wi-Fi.
PASSIVE Идентификатор сотовой вышки или точки доступа Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Местоположение, определенное мобильным устройством как наиболее вероятное положение на дороге.
CUSTOMER_SUPPLIED_LOCATION Местоположение, предоставленное клиентом из независимого источника. Обычно это значение используется для местоположения, предоставленного из источников, отличных от мобильного устройства, на котором работает Driver SDK. Если исходный источник описан одним из других значений перечисления, используйте это значение. Местоположение, отмеченное CUSTOMER_SUPPLIED_LOCATION, обычно предоставляется через last_location.supplemental_location_sensor транспортного средства.
FLEET_ENGINE_LOCATION Местоположение, рассчитанное Fleet Engine на основе доступных ему сигналов. Только вывод. Это значение будет отклонено, если оно получено в запросе.
FUSED_LOCATION_PROVIDER Поставщик Fused Location Android.
CORE_LOCATION Поставщик местоположения в операционных системах Apple.

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

Перечисления
UNKNOWN_NAVIGATION_STATUS Неопределенный статус навигации.
NO_GUIDANCE Навигация в приложении «Драйвер» находится в режиме FREE_NAV .
ENROUTE_TO_DESTINATION Доступна пошаговая навигация, а навигация в приложении для водителей перешла в режим GUIDED_NAV .
OFF_ROUTE Транспортное средство вышло за пределы предложенного маршрута.
ARRIVED_AT_DESTINATION Транспортное средство находится примерно в 50 метрах от пункта назначения.

ПолилинияФорматТип

Тип формата полилинии.

Перечисления
UNKNOWN_FORMAT_TYPE Формат не указан или неизвестен.
LAT_LNG_LIST_TYPE Список google.type.LatLng .
ENCODED_POLYLINE_TYPE Полилиния, закодированная с помощью алгоритма сжатия полилиний. Декодирование пока не поддерживается.

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

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

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

ОтчетОплачиваемая поездкаЗапрос

Сообщение с запросом ReportBillableTrip.

Поля
name

string

Необходимый. Должно быть в формате providers/{provider}/billableTrips/{billable_trip} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

country_ code

string

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

platform

BillingPlatformIdentifier

Платформа, на которой был отправлен запрос.

related_ ids[]

string

Идентификаторы, которые напрямую связаны с сообщаемой поездкой. Обычно это идентификаторы (например, идентификаторы сеансов) операций предварительного бронирования, выполненных до того, как идентификатор поездки станет доступен. Количество related_ids ограничено 50.

solution_ type

SolutionType

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

Тип решения

Селектор для различных типов решения отчетной поездки.

Перечисления
SOLUTION_TYPE_UNSPECIFIED Значение по умолчанию. Для обеспечения обратной совместимости API по умолчанию будет использовать ON_DEMAND_RIDESHARING_AND_DELIVERIES , который является первым поддерживаемым типом решения.
ON_DEMAND_RIDESHARING_AND_DELIVERIES Решение — поездка по запросу с доставкой.

Заголовок запроса

RequestHeader содержит поля, общие для всех запросов RPC Fleet Engine.

Поля
language_ code

string

Код языка BCP-47, например en-US или sr-Latn. Для получения дополнительной информации см. http://www.unicode.org/reports/tr35/#Unicode_locale_identifier . Если ничего не указано, ответ может быть на любом языке, предпочтительно на английском языке, если такое имя существует. Пример значения поля: en-US .

region_ code

string

Необходимый. CLDR-код региона, откуда исходит запрос. Пример значения поля: US .

sdk_ version

string

Версия вызывающего SDK, если применимо. Формат версии — «major.minor.patch», пример: 1.1.2 .

os_ version

string

Версия операционной системы, в которой работает вызывающий SDK. Примеры значений полей: 4.4.1 , 12.1 .

device_ model

string

Модель устройства, на котором запущен вызывающий SDK. Примеры значений полей: iPhone12,1 , SM-G920F .

sdk_ type

SdkType

Тип SDK, отправляющего запрос.

maps_ sdk_ version

string

Версия MapSDK, от которой зависит вызывающий SDK, если применимо. Формат версии — «major.minor.patch», пример: 5.2.1 .

nav_ sdk_ version

string

Версия NavSDK, от которой зависит вызывающий SDK, если применимо. Формат версии — «major.minor.patch», пример: 2.1.0 .

platform

Platform

Платформа вызывающего SDK.

manufacturer

string

Производитель устройства Android из вызывающего SDK, применимо только для Android SDK. Пример значения поля: Samsung .

android_ api_ level

int32

Уровень Android API вызывающего SDK, применим только для Android SDK. Пример значения поля: 23 .

trace_ id

string

Необязательный идентификатор, который можно указать для целей регистрации, чтобы идентифицировать запрос.

Платформа

Платформа вызывающего SDK.

Перечисления
PLATFORM_UNSPECIFIED Значение по умолчанию. Это значение используется, если платформа опущена.
ANDROID Запрос поступает от Android.
IOS Запрос поступает от iOS.
WEB Запрос поступает из Интернета.

Тип Сдк

Возможные типы SDK.

Перечисления
SDK_TYPE_UNSPECIFIED Значение по умолчанию. Это значение используется, если sdk_type опущен.
CONSUMER Вызывающий SDK — Consumer.
DRIVER Вызывающий SDK — Driver.
JAVASCRIPT Вызывающий SDK — это JavaScript.

ПоискПоездкиЗапрос

Сообщение с запросом SearchTrips.

Поля
header

RequestHeader

Стандартный заголовок запроса Fleet Engine.

parent

string

Необходимый. Должно быть в формате providers/{provider} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

vehicle_ id

string

Транспортное средство, связанное с поездками в запросе. Если не указано, возвращенные поездки не содержат:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_ trips_ only

bool

Если установлено значение true, ответ включает поездки, влияющие на маршрут водителя.

page_ size

int32

Если не установлено, сервер определяет количество возвращаемых результатов.

page_ token

string

Установите для этого значения значение, ранее возвращенное в SearchTripsResponse чтобы продолжить работу с предыдущими результатами.

minimum_ staleness

Duration

Если указано, возвращает поездки, которые не были обновлены по истечении времени (current - minimum_staleness) .

ПоискПоездкиОтвет

Ответное сообщение SearchTrips.

Поля
trips[]

Trip

Список поездок для запрошенного автомобиля.

next_ page_ token

string

Передайте этот токен в SearchTripsRequest для пролистывания результатов списка. API возвращает список поездок при каждом вызове, и когда результатов больше не остается, список поездок пуст.

ПоискТранспортЗапрос

Сообщение запроса SearchVehicles .

Поля
header

RequestHeader

Стандартный заголовок запроса Fleet Engine.

parent

string

Необходимый. Должно быть в формате providers/{provider} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

pickup_ point

TerminalLocation

Необходимый. Пункт выдачи, который нужно искать рядом.

dropoff_ point

TerminalLocation

Предполагаемое место высадки клиента. Поле является обязательным, если trip_types содержит TripType.SHARED .

pickup_ radius_ meters

int32

Необходимый. Определяет радиус поиска автомобиля вокруг точки посадки. Возврату подлежат только транспортные средства, находящиеся в радиусе поиска. Значение должно быть от 400 до 10 000 метров (включительно).

count

int32

Необходимый. Указывает максимальное количество возвращаемых транспортных средств. Значение должно находиться в диапазоне от 1 до 50 (включительно).

minimum_ capacity

int32

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

trip_ types[]

TripType

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

maximum_ staleness

Duration

Ограничивает поиск только теми транспортными средствами, которые отправили обновления местоположения в Fleet Engine в течение указанного периода. Стационарные транспортные средства, все еще передающие свое местоположение, не считаются устаревшими. Если это поле не задано, сервер использует пять минут в качестве значения по умолчанию.

vehicle_ types[]

VehicleType

Необходимый. Ограничивает поиск транспортными средствами одного из указанных типов. Должен быть указан хотя бы один тип транспортного средства. Типы транспортных средств с категорией UNKNOWN не допускаются.

required_ attributes[]

VehicleAttribute

Вызывающие программы могут формировать сложные логические операции, используя любую комбинацию полей required_attributes , required_one_of_attributes и required_one_of_attribute_sets .

required_attributes — это список; required_one_of_attributes использует сообщение, которое разрешает список списков. В сочетании эти два поля позволяют составить это выражение:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Ограничивает поиск только теми транспортными средствами с указанными атрибутами. Это поле представляет собой операцию конъюнкции/И. Разрешается максимум 50 обязательных_атрибутов. Это соответствует максимальному количеству атрибутов, разрешенных для транспортного средства.

required_ one_ of_ attributes[]

VehicleAttributeList

Ограничивает поиск только теми транспортными средствами, у которых есть хотя бы один из указанных атрибутов в каждом VehicleAttributeList . В каждом списке транспортное средство должно соответствовать хотя бы одному из атрибутов. Это поле представляет собой включающую операцию разъединения/ИЛИ в каждом VehicleAttributeList и операцию объединения/И в коллекции VehicleAttributeList .

required_ one_ of_ attribute_ sets[]

VehicleAttributeList

required_one_of_attribute_sets предоставляет дополнительную функциональность.

Подобно required_one_of_attributes , required_one_of_attribute_sets использует сообщение, которое разрешает список списков, допуская такие выражения, как это:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Ограничивает поиск только теми транспортными средствами, которые имеют все атрибуты в VehicleAttributeList . В каждом списке транспортное средство должно соответствовать всем атрибутам. Это поле представляет собой операцию соединения/И в каждом VehicleAttributeList и инклюзивную операцию разъединения/ИЛИ в коллекции VehicleAttributeList .

order_ by

VehicleMatchOrder

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

include_ back_ to_ back

bool

Это указывает на то, подходят ли для этого поиска транспортные средства с одной активной поездкой. Это поле используется только в том случае, если current_trips_present не указано. Если current_trips_present не указано и это поле имеет значение false , транспортные средства с назначенными поездками исключаются из результатов поиска. Если current_trips_present не указано и это поле имеет значение true , результаты поиска могут включать транспортные средства с одной активной поездкой, имеющей статус ENROUTE_TO_DROPOFF . Если указано current_trips_present , для этого поля нельзя установить значение true.

Значение по умолчанию — false .

trip_ id

string

Указывает поездку, связанную с этим SearchVehicleRequest .

current_ trips_ present

CurrentTripsPresent

Это указывает на то, подходят ли для этого поиска автомобили с активными поездками. Должно быть установлено значение, отличное от CURRENT_TRIPS_PRESENT_UNSPECIFIED , если trip_type включает SHARED .

filter

string

Необязательный. Фильтрационный запрос, применяемый при поиске транспортных средств. См. http://aip.dev/160 для примеров синтаксиса фильтра.

Это поле предназначено для замены полей required_attributes , required_one_of_attributes и required_one_of_attributes_sets . Если здесь указано непустое значение, следующие поля должны быть пустыми: required_attributes , required_one_of_attributes и required_one_of_attributes_sets .

Этот фильтр работает как предложение AND с другими ограничениями, такими как minimum_capacity или vehicle_types .

Обратите внимание, что поддерживаются только запросы по атрибутам транспортного средства (например, attributes.<key> = <value> или attributes.<key1> = <value1> AND attributes.<key2> = <value2> ). Максимальное количество ограничений, разрешенное в запросе фильтра, — 50.

Кроме того, все атрибуты хранятся в виде строк, поэтому единственным поддерживаемым сравнением атрибутов является сравнение строк. Для сравнения с числовыми или логическими значениями значения должны быть явно заключены в кавычки, чтобы их можно было рассматривать как строки (например, attributes.<key> = "10" или attributes.<key> = "true" ).

ТекущееПоездкиНастоящее

Определяет типы ограничений на текущие поездки автомобиля.

Перечисления
CURRENT_TRIPS_PRESENT_UNSPECIFIED Наличие транспортных средств с рейсами определяется полем include_back_to_back .
NONE В результатах поиска могут появиться автомобили без поездок. Когда используется это значение, include_back_to_back не может иметь true .
ANY В результаты поиска включаются автомобили, имеющие не более 5 текущих поездок и 10 путевых точек. Когда используется это значение, include_back_to_back не может иметь true .

Транспортное средствоМатчЗаказ

Указывает порядок совпадений транспортных средств в ответе.

Перечисления
UNKNOWN_VEHICLE_MATCH_ORDER По умолчанию, используется для неуказанного или нераспознанного транспортного средства, соответствующего порядку.
PICKUP_POINT_ETA В порядке возрастания времени в пути автомобиля до пункта выдачи.
PICKUP_POINT_DISTANCE В порядке возрастания расстояния проезда автомобиля до пункта выдачи.
DROPOFF_POINT_ETA В порядке возрастания времени движения автомобиля до точки высадки. Этот заказ можно использовать только в том случае, если в запросе указана точка выдачи.
PICKUP_POINT_STRAIGHT_DISTANCE В порядке возрастания по расстоянию по прямой от последнего сообщенного местоположения транспортного средства до точки посадки.
COST В порядке возрастания настроенной стоимости соответствия. Стоимость матча определяется как взвешенный расчет расстояния по прямой и расчетного времени прибытия. Веса устанавливаются со значениями по умолчанию и могут быть изменены для каждого клиента. Если эти веса необходимо изменить для вашего проекта, обратитесь в службу поддержки Google.

ПоискТранспортОтвет

Ответное сообщение SearchVehicles .

Поля
matches[]

VehicleMatch

Список транспортных средств, соответствующих критериям SearchVehiclesRequest , упорядоченных по полю SearchVehiclesRequest.order_by .

СкоростьЧтенияИнтервал

Индикатор плотности движения на непрерывном участке пути. Учитывая путь с точками P_0, P_1,..., P_N (индекс, начинающийся с нуля), SpeedReadingInterval определяет интервал и описывает его трафик, используя следующие категории.

Поля
start_ polyline_ point_ index

int32

Начальный индекс этого интервала в пути. В JSON, когда индекс равен 0, поле будет незаполненным.

end_ polyline_ point_ index

int32

Конечный индекс этого интервала в пути. В JSON, когда индекс равен 0, поле будет незаполненным.

speed

Speed

Скорость движения в этом интервале.

Скорость

Классификация скорости полилинии на основе данных о трафике.

Перечисления
SPEED_UNSPECIFIED Значение по умолчанию. Это значение не используется.
NORMAL Скорость нормальная, замедлений не обнаружено.
SLOW Замедление зафиксировано, но пробки не образовалось.
TRAFFIC_JAM Обнаружена пробка.

ОстановитьМестоположение

Фактическое место, где произошла остановка (посадка/высадка).

Поля
point

LatLng

Необходимый. Обозначает фактическое местоположение.

timestamp

Timestamp

Указывает, когда произошла остановка.

stop_time
(deprecated)

Timestamp

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

ТерминалМестоположение

Описывает местоположение путевой точки.

Поля
point

LatLng

Необходимый. Обозначает местоположение путевой точки поездки.

terminal_point_id
(deprecated)

TerminalPointId

Устарело: вместо этого укажите поле point .

access_point_id
(deprecated)

string

Устарело: вместо этого укажите поле point .

trip_id
(deprecated)

string

Устарело.

terminal_location_type
(deprecated)

WaypointType

Устарело: эти данные будут содержаться в Vehicle.waypoint .

Терминалпоинтид

Устарело: точки TerminalPoints больше не поддерживаются в Fleet Engine. Вместо этого используйте TerminalLocation.point .

Поля
value
(deprecated)

string

Устарело.

Id поля объединения. Устарело. Id может быть только одним из следующих:
place_id
(deprecated)

string

Устарело.

generated_id
(deprecated)

string

Устарело.

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

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

Поля
traffic_ rendering

VisualTrafficReportPolylineRendering

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

Путешествие

Метаданные поездки.

Поля
name

string

Только вывод. В формате "провайдеры/{провайдер}/поездки/{поездка}"

vehicle_ id

string

Идентификатор транспортного средства, совершающего эту поездку.

trip_ status

TripStatus

Текущий статус поездки.

trip_ type

TripType

Тип поездки.

pickup_ point

TerminalLocation

Место, где клиент указывает, что его заберут.

actual_ pickup_ point

StopLocation

Только ввод. Фактическое место, когда и где забрали клиента. Это поле предназначено для того, чтобы поставщик предоставил отзыв о фактической информации о получении.

actual_ pickup_ arrival_ point

StopLocation

Только ввод. Фактическое время и место прибытия водителя в пункт выдачи. Это поле предназначено для предоставления поставщиком информации о фактическом прибытии в пункт выдачи.

pickup_ time

Timestamp

Только вывод. Либо предполагаемое время в будущем, когда гонщика(ов) заберут, либо фактическое время, когда их заберут.

intermediate_ destinations[]

TerminalLocation

Промежуточные остановки в соответствии с запросами на поездку (помимо посадки и высадки). Первоначально эта функция не будет поддерживаться для совместных поездок.

intermediate_ destinations_ version

Timestamp

Указывает, когда в последний раз было изменено intermediate_destinations . Ваш сервер должен кэшировать это значение и передавать его в UpdateTripRequest при обновлении intermediate_destination_index , чтобы гарантировать, что intermediate_destinations не изменены.

intermediate_ destination_ index

int32

Когда TripStatus имеет значение ENROUTE_TO_INTERMEDIATE_DESTINATION , число между [0..N-1], указывающее, какой промежуточный пункт назначения транспортное средство пересечет следующим. Когда TripStatus имеет значение ARRIVED_AT_INTERMEDIATE_DESTINATION , число между [0..N-1], указывающее, в каком промежуточном пункте назначения находится транспортное средство. Это значение устанавливает провайдер. Если intermediate_destinations нет, это поле игнорируется.

actual_ intermediate_ destination_ arrival_ points[]

StopLocation

Только ввод. Фактическое время и место прибытия водителя в промежуточный пункт назначения. Это поле предназначено для предоставления поставщиком информации о фактическом прибытии в промежуточные пункты назначения.

actual_ intermediate_ destinations[]

StopLocation

Только ввод. Фактическое время и место, когда и где клиента забрали из промежуточного пункта назначения. Это поле для поставщика, чтобы предоставить отзыв о фактической информации о получении в промежуточных направлениях.

dropoff_ point

TerminalLocation

Место, где клиент указывает, что он будет отброшен.

actual_ dropoff_ point

StopLocation

Только вход. Фактическое время и местоположение, когда и где клиент был отброшен. Это поле для провайдера, чтобы предоставить отзыв о фактической информации о высадке.

dropoff_ time

Timestamp

Только вывод. Либо предполагаемое будущее время, когда гонщик (ы) будет выпаден в конечном пункте назначения, либо фактическое время, когда их выпали.

remaining_ waypoints[]

TripWaypoint

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

vehicle_ waypoints[]

TripWaypoint

Это поле поддерживает ручной заказ путевых точек для поездки. Он содержит все оставшиеся путевые точки для назначенного транспортного средства, а также для подъема и высадки для этой поездки. Если поездка не была назначена на транспортное средство, то двигатель флота игнорирует это поле. По причинам конфиденциальности это поле только заполняется сервером на вызовах UpdateTrip и CreateTrip , а не на вызовах GetTrip .

route[]

LatLng

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

current_ route_ segment

string

Только вывод. Кодированный путь к следующей путевой точке.

Примечание. Это поле предназначено только для использования драйвером SDK и потребителя SDK. Декодирование еще не поддерживается.

current_ route_ segment_ version

Timestamp

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

Примечание. Это поле предназначено только для использования драйвером SDK и потребителя SDK.

current_ route_ segment_ traffic

ConsumableTrafficPolyline

Только вывод. Указывает условия трафика вдоль current_route_segment , когда они доступны.

Примечание. Это поле предназначено только для использования драйвером SDK и потребителя SDK.

current_ route_ segment_ traffic_ version

Timestamp

Только вывод. Указывает в последний раз, когда был изменен current_route_segment_traffic .

Примечание. Это поле предназначено только для использования драйвером SDK и потребителя SDK.

current_ route_ segment_ end_ point

TripWaypoint

Только вывод. Путь, где заканчивается current_route_segment .

remaining_ distance_ meters

Int32Value

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

eta_ to_ first_ waypoint

Timestamp

Только вывод. ETA к следующей путевой точке (первая запись в remaining_waypoints ). Значение не определено, если поездка не назначена транспортному средству, или поездка неактивна (завершена или отменена).

remaining_ time_ to_ first_ waypoint

Duration

Только вывод. Продолжительность от того, когда данные о поездке возвращаются в время в Trip.eta_to_first_waypoint . Значение не определено, если поездка не назначена транспортному средству, или поездка неактивна (завершена или отменена).

remaining_ waypoints_ version

Timestamp

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

remaining_ waypoints_ route_ version

Timestamp

Только вывод. Указывает в последний раз, когда remaining_waypoints.path_to_waypoint и remaining_waypoints.traffic_to_waypoint были изменены. Ваше клиентское приложение должно кэшировать это значение и передавать его в GetTripRequest чтобы обеспечить возвращение путей и трафик для remaining_waypoints .

number_ of_ passengers

int32

Неизменяемый. Указывает количество пассажиров в этой поездке и не включает водителя. Транспортное средство должно иметь доступную емкость, которая будет возвращена в ответе SearchVehicles .

last_ location

VehicleLocation

Только вывод. Указывает на последнее местоположение транспортного средства вдоль маршрута.

last_ location_ snappable

bool

Только вывод. Указывает, можно ли прийти к last_location транспортного средства на current_route_segment. False, если last_location или current_route_segment не существует. Он вычисляется флотом двигателем. Любое обновление от клиентов будет проигнорировано.

view

TripView

Подмножество полей поездки, которые заполнены и как их следует интерпретировать.

Трипстатус

Статус поездки, указывающий на его прогрессию.

Перечисления
UNKNOWN_TRIP_STATUS По умолчанию, используется для неуточненного или непризнанного статуса поездки.
NEW Недавно созданная поездка.
ENROUTE_TO_PICKUP Водитель находится на пути к точке пикапа.
ARRIVED_AT_PICKUP Водитель прибыл в точку пикапа.
ARRIVED_AT_INTERMEDIATE_DESTINATION Водитель прибыл в промежуточный пункт назначения и ждет гонщика.
ENROUTE_TO_INTERMEDIATE_DESTINATION Водитель идет в промежуточный пункт назначения (не точка высадки).
ENROUTE_TO_DROPOFF Водитель подобрал гонщика и находится на пути к следующему пункту назначения.
COMPLETE Всадник был выпад, а поездка завершена.
CANCELED Поездка была отменена до получения поставщика водителя, гонщика или поставщика Rideshare.

Триптип

Тип поездки.

Перечисления
UNKNOWN_TRIP_TYPE По умолчанию, используемые для неуточненных или непризнанных типов поездки.
SHARED Поездка может поделиться автомобилем с другими поездками.
EXCLUSIVE Поездка эксклюзивна для автомобиля.

Tripview

Селектор для различных наборов полей поездки в ответе GetTrip . Смотрите AIP-157 для контекста. Дополнительные просмотры могут быть добавлены.

Перечисления
TRIP_VIEW_UNSPECIFIED Значение по умолчанию. Для обратной совместимости API по умолчанию по умолчанию будет представлять SDK. Чтобы обеспечить стабильность и поддержку, клиентам рекомендуется выбрать TripView отличный от SDK .
SDK Включает в себя поля, которые могут быть не подлежат интерпретированию или поддерживаемым с использованием общедоступных библиотек.
JOURNEY_SHARING_V1S Поля поездок заполнены для использования обмена путешествиями. Это представление предназначено для сервера к серверу.

TripwayPoint

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

Поля
location

TerminalLocation

Расположение этой путевой точки.

trip_ id

string

Поездка, связанная с этой путевой точкой.

waypoint_ type

WaypointType

Роль этой путевой точки играет в этой поездке, такую ​​как пикап или снижение.

path_ to_ waypoint[]

LatLng

Путь от предыдущей путевой точки к текущей путевой точке. Не определено для первой путевой точки в списке. Это поле населено только при запросе.

encoded_ path_ to_ waypoint

string

Кодированный путь от предыдущей путевой точки до текущей путевой точки.

Примечание. Это поле предназначено только для использования драйвером SDK и потребителя SDK. Декодирование еще не поддерживается.

traffic_ to_ waypoint

ConsumableTrafficPolyline

Условия движения по пути к этой путевой точке. Обратите внимание, что трафик доступен только для поездок на платформу Google Map и поставки решений.

distance_ meters

Int32Value

Расстояние пути от предыдущей путевой точки до текущей путевой точки. Не определено для первой путевой точки в списке.

eta

Timestamp

Расчетное время прибытия в эту путевую точку. Не определено для первой путевой точки в списке.

duration

Duration

Время в пути с предыдущей путевой точки до этого момента. Не определено для первой путевой точки в списке.

UpdateTripRequest

Сообщение запроса UpdateTrip.

Поля
header

RequestHeader

Стандартный заголовок запроса двигателя флота.

name

string

Необходимый. Должен быть в providers/{provider}/trips/{trip} . Поставщиком должен быть идентификатор проекта (например, sample-consumer-project ) проекта Google Cloud, из которого учетная запись сервиса, выполняющая этот вызов, является участником.

trip

Trip

Необходимый. Поездка, связанная с обновлением.

Следующие поля поддерживаются двигателем флота. Не обновляйте их, используя Trip.update.

  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_traffic
  • current_route_segment_traffic_version
  • current_route_segment_version
  • dropoff_time
  • eta_to_next_waypoint
  • intermediate_destinations_version
  • last_location
  • name
  • number_of_passengers
  • pickup_time
  • remaining_distance_meters
  • remaining_time_to_first_waypoint
  • remaining_waypoints
  • remaining_waypoints_version
  • route

Когда вы обновляете Trip.vehicle_id для общей поездки, вы должны предоставить список Trip.vehicle_waypoints , чтобы указать порядок оставшихся путевых точек, в противном случае заказ будет не определен.

Когда вы указываете Trip.vehicle_waypoints , список должен содержать все оставшиеся путевые точки поездок автомобиля без дополнительных путевых точек. Вы должны заказать эти путевые точки так, чтобы для данной поездки точка пикапа представлена ​​до промежуточных направлений, и все промежуточные пункты назначения представляются до точки высадки. Путевые точки EXCLUSIVE поездки не должны переплетать с любыми другими поездками. Используются поля trip_id , waypoint_type и location , и все другие поля TripwayPoint в vehicle_waypoints игнорируются.

Чтобы избежать условий гонки для поездок с несколькими направлениями, вы должны предоставить Trip.intermediate_destinations_version при обновлении статуса поездки для ENROUTE_TO_INTERMEDIATE_DESTINATION . Trip.intermediate_destinations_version передается, должна соответствовать версии Fleet Engine. Если это не так, запрос терпит неудачу.

update_ mask

FieldMask

Необходимый. Полевая маска, указывающая, какие поля в поездке в обновление. update_mask должен содержать хотя бы одно поле.

UpdateVehiCLeatTributesRequest

UpdateVehicleAttributes Сообщение запроса.

Поля
header

RequestHeader

Стандартный заголовок запроса двигателя флота.

name

string

Необходимый. Должен быть в providers/{provider}/vehicles/{vehicle} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, из которого учетная запись сервиса, выполняющая этот вызов, является участником.

attributes[]

VehicleAttribute

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

UpdateVehiCLeatTributesResponse

UpdateVehicleAttributes Ответное сообщение.

Поля
attributes[]

VehicleAttribute

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

UpdateVehicLeQuest

`Сообщение запроса updatewarehicle.

Поля
header

RequestHeader

Стандартный заголовок запроса двигателя флота.

name

string

Необходимый. Должен быть в providers/{provider}/vehicles/{vehicle} . {Provider} должен быть идентификатором проекта (например, sample-cloud-project ) проекта Google Cloud, из которого учетная запись сервиса, выполняющая этот вызов, является участником.

vehicle

Vehicle

Необходимый. Значения объекта Vehicle для применения. При обновлении Vehicle , следующие поля не могут быть обновлены, поскольку они управляются сервером.

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

Если поле attributes обновляется, все атрибуты транспортного средства заменяются атрибутами, представленными в запросе. Если вы хотите обновить только некоторые атрибуты, см. Метод UpdateVehicleAttributes .

Аналогичным образом, поле waypoints можно обновить, но должно содержать все путевые точки, которые в настоящее время находятся на транспортном средстве, и никаких других путевых точек.

update_ mask

FieldMask

Необходимый. Полевая маска, указывающая, какие поля Vehicle для обновления. По крайней мере, одно имя поля должно быть предоставлено.

Транспортное средство

Метаданные транспортного средства.

Поля
name

string

Только вывод. Уникальное название для этого автомобиля. Формат - providers/{provider}/vehicles/{vehicle} .

vehicle_ state

VehicleState

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

supported_ trip_ types[]

TripType

Типы поездки поддерживаются этим автомобилем.

current_ trips[]

string

Только вывод. Список trip_id для поездок, в настоящее время назначенных на этот автомобиль.

last_ location

VehicleLocation

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

maximum_ capacity

int32

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

attributes[]

VehicleAttribute

Список атрибутов автомобиля. Автомобиль может иметь не более 100 атрибутов, и каждый атрибут должен иметь уникальный ключ.

vehicle_ type

VehicleType

Необходимый. Тип этого автомобиля. Может использоваться для фильтрации транспортных средств в результатах SearchVehicles . Также влияет на расчеты ETA и маршрута.

license_ plate

LicensePlate

Информация о номерном знаке для автомобиля.

route[]
(deprecated)

TerminalLocation

Установите: используйте Vehicle.waypoints . Вместо этого.

current_ route_ segment

string

Полилина, указывающая маршрут, который приложение драйвера намеревается перейти к следующей путевой точке. Этот список также возвращается в Trip.current_route_segment для всех активных поездок, назначенных транспортному средству.

Примечание. Это поле предназначено только для использования драйвером SDK. Декодирование еще не поддерживается.

current_ route_ segment_ traffic

TrafficPolylineData

Только вход. Fleet Engine использует эту информацию для улучшения обмена путешествиями. Примечание. Это поле предназначено только для использования драйвером SDK.

current_ route_ segment_ version

Timestamp

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

current_ route_ segment_ end_ point

TripWaypoint

Путь, где заканчивается current_route_segment . Это может быть предоставлено драйверами на вызовах UpdateVehicle или в качестве полной путевой точки, путевой LatLng , либо в качестве последнего LatLng current_route_segment . Двигатель флота будет сделан изо всех сил, чтобы интерполировать в реальную путевую точку, если он не будет полностью указан. Это поле игнорируется в вызовах UpdateVehicle , если также не указана current_route_segment .

remaining_ distance_ meters

Int32Value

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

eta_ to_ first_ waypoint

Timestamp

ETA к первой записи в поле waypoints . Значение не определено, если поле waypoints пустое или поле Vehicle.current_route_segment пусто.

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

remaining_ time_ seconds

Int32Value

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

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

waypoints[]

TripWaypoint

Оставшиеся путевые точки, назначенные этому транспортному средству.

waypoints_ version

Timestamp

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

back_ to_ back_ enabled

bool

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

navigation_ status

NavigationStatus

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

device_ settings

DeviceSettings

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

Автомобиль

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

Поля
category

Category

Категория типа автомобиля

Категория

Категории типа автомобиля

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

Автомобиль

Описывает атрибут транспортного средства как пару ключевых значений. Длина строки «ключ: значение» не может превышать 256 символов.

Поля
key

string

Ключ атрибута. Ключи могут не содержать персонажа толстой кишки (:).

value

string

Значение атрибута.

Объединение Поле vehicle_attribute_value . Значение атрибута может быть в String, Bool или Double Type. vehicle_attribute_value может быть только одним из следующих:
string_ value

string

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

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

bool_ value

bool

Логическое значение типичного атрибута.

number_ value

double

Двойное значение атрибута.

Автомобиль

Список списков данных для атрибутов автомобиля.

Поля
attributes[]

VehicleAttribute

Список атрибутов в этой коллекции.

Автомобиль

Местоположение, скорость и направление транспортного средства в момент времени.

Поля
location

LatLng

Расположение автомобиля. Когда он отправляется в двигатель флота, местонахождение автомобиля является местоположением GPS. Когда вы получаете его в ответ, местоположение транспортного средства может быть либо местоположением GPS, дополнительным местоположением или каким -либо другим предполагаемым местом. Источник указан в location_sensor .

horizontal_accuracy
(deprecated)

DoubleValue

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

latlng_ accuracy

DoubleValue

Точность location в метрах как радиус.

heading

Int32Value

Направление транспортное средство движется в градусах. 0 представляет север. Допустимый диапазон [0,360).

bearing_accuracy
(deprecated)

DoubleValue

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

heading_ accuracy

DoubleValue

Точность heading в градусах.

altitude

DoubleValue

Высота в метрах над WGS84.

vertical_accuracy
(deprecated)

DoubleValue

Установите: используйте altitude_accuracy .

altitude_ accuracy

DoubleValue

Точность altitude в метрах.

speed_kmph
(deprecated)

Int32Value

Скорость транспортного средства в километрах в час. Установилось: вместо этого используйте speed .

speed

DoubleValue

Скорость транспортного средства в метрах/секунду

speed_ accuracy

DoubleValue

Точность speed в метрах/секунд.

update_ time

Timestamp

Время, когда location сообщило датчик в соответствии с часами датчика.

server_ time

Timestamp

Только вывод. Время, когда сервер получил информацию о местоположении.

location_ sensor

LocationSensor

Поставщик данных местоположения (например, GPS ).

is_ road_ snapped

BoolValue

Постановлено ли location на дорогу.

is_ gps_ sensor_ enabled

BoolValue

Только вход. Указывает, включен ли датчик GPS на мобильном устройстве.

time_ since_ update

Int32Value

Только вход. Время (в секундах), так как это место было впервые отправлено на сервер. Это будет ноль для первого обновления. Если время неизвестно (например, когда приложение перезагружается), это значение сбрасывается до нуля.

num_stale_updates
(deprecated)

Int32Value

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

raw_ location

LatLng

Расположение необработанного транспортного средства (необработанное дорожным сноштом).

raw_ location_ time

Timestamp

Временная метка, связанная с необработанным местоположением.

raw_ location_ sensor

LocationSensor

Источник необработанного местоположения. По умолчанию GPS .

raw_ location_ accuracy

DoubleValue

Точность raw_location как радиус, в метрах.

supplemental_ location

LatLng

Дополнительное местоположение, предоставленное интегрирующим приложением.

supplemental_ location_ time

Timestamp

Временная метка, связанная с дополнительным местоположением.

supplemental_ location_ sensor

LocationSensor

Источник дополнительного местоположения. По умолчанию CUSTOMER_SUPPLIED_LOCATION .

supplemental_ location_ accuracy

DoubleValue

Точность supplemental_location как радиуса, в метрах.

road_snapped
(deprecated)

bool

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

Автомобиль

Содержит транспортное средство и связанные с ним оценки для транспортного средства, который соответствует точкам активных поездок для SearchVehiclesRequest .

Поля
vehicle

Vehicle

Необходимый. Автомобиль, который соответствует запросу.

vehicle_ pickup_ eta

Timestamp

Транспортное средство ездит на ETA к точке пикапа, указанной в запросе. Пустое значение указывает на сбой при расчете ETA для транспортного средства. Если SearchVehiclesRequest.include_back_to_back был true , и у этого транспортного средства есть активная поездка, vehicle_pickup_eta включает время, необходимое для завершения текущей активной поездки.

vehicle_ pickup_ distance_ meters

Int32Value

Расстояние от текущего местоположения транспортного средства до точки сбора, указанного в запросе, в том числе любых промежуточных точек пикапа или высадки для существующих поездок. Это расстояние включает в себя рассчитанное расстояние вождения (маршрута), плюс прямое расстояние между конечной точкой навигации и запрошенной точкой сбора. (Расстояние между конечной точкой навигации и запрашиваемой точкой подбора, как правило, мало.) Пустое значение указывает на ошибку при расчете расстояния.

vehicle_ pickup_ straight_ line_ distance_ meters

Int32Value

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

vehicle_ dropoff_ eta

Timestamp

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

vehicle_ pickup_ to_ dropoff_ distance_ meters

Int32Value

Расстояние проезда транспортного средства (в метрах) от точки сбора до точки сброса, указанной в запросе. Расстояние находится только между двумя точками и не включает в себя местоположение транспортного средства или любые другие точки, которые должны быть посещены до того, как транспортное средство посетит либо точку сбора или точку высадки. Значение будет заполнено только тогда, когда в запросе указан в dropoff_point . Пустое значение указывает на сбой при расчете расстояния от пикапа, чтобы сбросить точку, указанную в запросе.

trip_ type

TripType

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

vehicle_ trips_ waypoints[]

Waypoint

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

vehicle_ match_ type

VehicleMatchType

Тип матча автомобиля.

requested_ ordered_ by

VehicleMatchOrder

Заказ запрошен для сортировки матчей транспортных средств. Эквивалентно ordered_by .

ordered_ by

VehicleMatchOrder

Заказ запрошен для сортировки матчей транспортных средств. Эквивалентно requested_ordered_by .by.

Efacelematchtype

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

Перечисления
UNKNOWN Неизвестный тип совпадения автомобиля
EXCLUSIVE В настоящее время транспортное средство не назначено поездка, и он может перейти к точке пикапа.
BACK_TO_BACK Транспортное средство в настоящее время назначено в поездку, но может перейти к точке пикапа после завершения в процессе поездки. Расчеты ETA и расстояния принимают во внимание существующую поездку.
CARPOOL Транспортное средство имеет достаточную мощность для общей поездки.
CARPOOL_BACK_TO_BACK Автомобиль завершит свою текущую активную поездку, прежде чем перейти к точке пикапа. Расчеты ETA и расстояния принимают во внимание существующую поездку.

Автомобиль

Состояние Vehicle .

Перечисления
UNKNOWN_VEHICLE_STATE По умолчанию, используется для неуточненных или непризнанных состояний транспортного средства.
OFFLINE Автомобиль не принимает новые поездки. ПРИМЕЧАНИЕ. Транспортное средство может продолжать работать в этом состоянии при завершении поездок, назначенного ему.
ONLINE Автомобиль принимает новые поездки.

VisualTrafficReportpolylinerendering

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

Поля
road_ stretch[]

RoadStretch

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

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

Roadstrech

Один дорожный отрез, который должен быть отображен.

Поля
style

Style

Необходимый. Стиль для применения.

offset_ meters

int32

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

length_ meters

int32

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

Стиль

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

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

Путевая точка

Описывает промежуточные точки вдоль маршрута для VehicleMatch в SearchVehiclesResponse . Эта концепция представлена ​​как TripWaypoint во всех других конечных точках.

Поля
lat_ lng

LatLng

Расположение этой путевой точки.

eta

Timestamp

Предполагаемое время, когда транспортное средство поступит на эту путевую точку.

WayPointType

Тип путевой точки.

Перечисления
UNKNOWN_WAYPOINT_TYPE Неизвестный или неопределенный тип путевой точки.
PICKUP_WAYPOINT_TYPE Путевые точки для подбора гонщиков или предметов.
DROP_OFF_WAYPOINT_TYPE Путевые точки для сброса гонщиков или предметов.
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE Путевые точки для промежуточных направлений в поездке с несколькими назначениями.