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

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

  • Должна быть допустимой строкой Unicode.
  • Ограничена максимальной длиной в 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

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

route[]

LatLng

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

current_route_segment

string

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

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

current_route_segment_version

Timestamp

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

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

current_route_segment_traffic

ConsumableTrafficPolyline

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

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

current_route_segment_traffic_version

Timestamp

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

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

current_route_segment_end_point

TripWaypoint

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

remaining_distance_meters

Int32Value

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

eta_to_first_waypoint

Timestamp

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

remaining_time_to_first_waypoint

Duration

Только вывод. Продолжительность с момента возврата данных Trip до времени в 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 не существует. Его рассчитывает Fleet Engine. Любые обновления от клиентов будут игнорироваться.

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

Тип поездки

Тип поездки.

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

ТрипВью

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

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

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

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

Поля
location

TerminalLocation

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

trip_id

string

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

waypoint_type

WaypointType

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

path_to_waypoint[]

LatLng

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

encoded_path_to_waypoint

string

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

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

traffic_to_waypoint

ConsumableTrafficPolyline

Условия дорожного движения на пути к этой путевой точке. Обратите внимание, что трафик доступен только для клиентов Google Map Platform Rides and Delivery Solution.

distance_meters

Int32Value

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

eta

Timestamp

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

duration

Duration

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

Обновление запроса на поездку

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

Поля
header

RequestHeader

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

name

string

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

trip

Trip

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

Следующие поля поддерживаются Fleet Engine. Не обновляйте их с помощью 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

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

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

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

Поля
header

RequestHeader

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

name

string

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

attributes[]

VehicleAttribute

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

UpdateVehicleAttributesResponse

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

Поля
attributes[]

VehicleAttribute

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

Запрос обновления транспортного средства

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

Поля
header

RequestHeader

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

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 . Также влияет на расчет расчетного времени прибытия и маршрута.

license_plate

LicensePlate

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

route[]
(deprecated)

TerminalLocation

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

current_route_segment

string

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

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

current_route_segment_traffic

TrafficPolylineData

Только ввод. Fleet Engine использует эту информацию для улучшения обмена информацией о поездках. Примечание. Это поле предназначено только для использования Driver 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 . Затем Fleet Engine сделает все возможное, чтобы интерполировать фактическую путевую точку, если она не указана полностью. Это поле игнорируется в вызовах UpdateVehicle , если не указан также current_route_segment .

remaining_distance_meters

Int32Value

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

eta_to_first_waypoint

Timestamp

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

string

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

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

bool_value

bool

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

number_value

double

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

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

Тип данных «список списков» для атрибутов транспортного средства.

Поля
attributes[]

VehicleAttribute

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

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

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

Поля
location

LatLng

Местоположение транспортного средства. Когда данные отправляются в Fleet Engine, местоположение транспортного средства определяется по 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 для транспортного средства. Если 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

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

vehicle_pickup_to_dropoff_distance_meters

Int32Value

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

trip_type

TripType

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

vehicle_trips_waypoints[]

Waypoint

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

vehicle_match_type

VehicleMatchType

Тип автомобиля соответствует.

requested_ordered_by

VehicleMatchOrder

Запрошенный заказ на сортировку транспортных средств соответствует.

ordered_by

VehicleMatchOrder

Фактический порядок, который использовался для этого автомобиля. Обычно это соответствует полю order_by из запроса; однако в определенных обстоятельствах, например, при внутренней ошибке сервера, может использоваться другой метод (например, PICKUP_POINT_STRAIGHT_DISTANCE ).

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

Тип автомобиля соответствует.

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

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

Состояние Vehicle .

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

VisualTrafficReportPolylineРендеринг

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

Поля
road_stretch[]

RoadStretch

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

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

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

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

Поля
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

Расчетное время прибытия транспортного средства в эту точку маршрута.

Тип маршрутной точки

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

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