Package maps.fleetengine.v1

Индекс

TripService

Услуга по управлению поездками.

CreateTrip

rpc CreateTrip( CreateTripRequest ) returns ( Trip )

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

DeleteTrip

rpc DeleteTrip( DeleteTripRequest ) returns ( Empty )

Удаляет одну поездку.

Возвращает FAILED_PRECONDITION, если поездка активна и назначена транспортному средству.

GetTrip

rpc GetTrip( GetTripRequest ) returns ( Trip )

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

ReportBillableTrip

rpc ReportBillableTrip( ReportBillableTripRequest ) returns ( Empty )

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

SearchTrips

rpc SearchTrips( SearchTripsRequest ) returns ( SearchTripsResponse )

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

UpdateTrip

rpc UpdateTrip( UpdateTripRequest ) returns ( Trip )

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

VehicleService

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

CreateVehicle

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 DeleteVehicle( DeleteVehicleRequest ) returns ( Empty )

Удаляет транспортное средство из Fleet Engine.

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

GetVehicle

rpc GetVehicle( GetVehicleRequest ) returns ( Vehicle )

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

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

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 , а атрибуты, отсутствующие в запросе, будут удалены.

BatteryInfo

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

Поля
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 Низкий уровень заряда батареи.

Идентификатор BillingPlatformIdentifier

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

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

ConsumableTrafficPolyline

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

Поля
speed_reading_interval[]

SpeedReadingInterval

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

encoded_path_to_waypoint

string

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

CreateTripRequest

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

Промежуточные intermediate_destinations поддерживаются только EXCLUSIVE поездках.

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

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

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

CreateVehicleRequest

Сообщение-запрос 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

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

DeleteTripRequest

Запрос на удаление сообщения DeleteTrip.

Поля
header

RequestHeader

Необязательно. Стандартный заголовок запроса Fleet Engine.

name

string

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

DeleteVehicleRequest

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

Поля
header

RequestHeader

Необязательно. Стандартный заголовок запроса Fleet Engine.

name

string

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

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

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

Поля
location_power_save_mode

LocationPowerSaveMode

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

is_power_save_mode

bool

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

is_interactive

bool

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

battery_info

BatteryInfo

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

GetTripRequest

Сообщение-запрос 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
(deprecated)

Timestamp

Устарело: данные Trip.remaining_waypoints извлекаются всегда. Используйте remaining_waypoints_route_version для управления временем извлечения данных Trip.remaining_waypoints.traffic_to_waypoint и Trip.remaining_waypoints.path_to_waypoint .

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

remaining_waypoints_route_version

Timestamp

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

GetVehicleRequest

Сообщение-запрос 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», обозначающее отсутствие числового значения в номерном знаке.

  • "ABC 1234" -> "4"
  • "АБ 123 CD" -> "3"
  • "ABCDEF" -> "-1"

ListVehiclesRequest

Сообщение-запрос 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 . В каждом списке транспортное средство должно соответствовать всем атрибутам. Это поле является конъюнкцией/AND в каждом VehicleAttributeList и инклюзивной дизъюнкцией/OR во всей коллекции 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

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

ListVehiclesResponse

Ответное сообщение 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 или Assisted GPS.
NETWORK Вспомогательный GPS, идентификатор вышки сотовой связи или точка доступа WiFi.
PASSIVE Идентификатор вышки сотовой связи или точки доступа WiFi.
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 Поставщик объединённых данных о местоположении Android.
CORE_LOCATION Поставщик данных о местоположении в операционных системах Apple.

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

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

PolylineFormatType

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

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

PowerSource

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

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

ReportBillableTripRequest

Сообщение-запрос 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

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

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

trace_id

string

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

Платформа

Платформа вызова SDK.

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

SDKType

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

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

SearchTripsRequest

Сообщение-запрос 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) .

SearchTripsResponse

Ответное сообщение 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 до 10000 метров (включительно).

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 . В каждом списке транспортное средство должно соответствовать всем атрибутам. Это поле является конъюнкцией/AND в каждом VehicleAttributeList и включающей дизъюнкцией/OR во всей коллекции 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" ).

CurrentTripsPresent

Указывает типы ограничений на текущие поездки транспортного средства.

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

VehicleMatchOrder

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

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

SearchVehiclesResponse

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

Поля
matches[]

VehicleMatch

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

SpeedReadingInterval

Индикатор плотности трафика на непрерывном участке пути. Для заданного пути с точками 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 Задержки на дорогах.

StopLocation

Фактическое место остановки (посадки/высадки).

Поля
point

LatLng

Обязательно. Указывает фактическое местоположение.

timestamp

Timestamp

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

stop_time
(deprecated)

Timestamp

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

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

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

Поля
point

LatLng

Обозначает точные LatLng широты и долготы путевой точки. В качестве входных данных необходимо указать либо point , либо place . Если указаны оба, для маршрутизации будет использоваться point , а для метаданных — place . Если в качестве входных данных указано только place , point будет рассчитана на основе place и включена в выходные данные.

place

string

Имя ресурса места, представляющего это местоположение. Формат: places/{place_id} . В качестве входных данных необходимо указать либо point , либо place . Если указаны оба, point будет использоваться для маршрутизации, а place — для метаданных. place включается в выходные данные только в том случае, если оно было включено во входные данные, то есть поиск place по LatLng не выполняется.

Это экспериментальная функция.

point_location_source

PointSource

Только вывод. Источник point поля.

terminal_point_id
(deprecated)

TerminalPointId

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

access_point_id
(deprecated)

string

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

trip_id
(deprecated)

string

Устарело.

terminal_location_type
(deprecated)

WaypointType

Устаревшее: Vehicle.waypoint будет иметь эти данные.

PointSource

Указывает источник LatLng .

Перечисления
POINT_SOURCE_UNSPECIFIED Источник не указан.
POINT_SOURCE_DEVELOPER_PROVIDED LatLng были явно предоставлены разработчиком.
POINT_SOURCE_CALCULATED_FROM_PLACE LatLng были рассчитаны на основе указанного места.

TerminalPointId

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

Поля
value
(deprecated)

string

Устарело.

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

string

Устарело.

generated_id
(deprecated)

string

Устарело.

TrafficPolylineData

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

Поля
traffic_rendering

VisualTrafficReportPolylineRendering

Ломаная линия, отображающая скорость дорожного движения во всех регионах на одном участке маршрута клиента.

Путешествие

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

Поля
name

string

Только вывод. В формате "Providers/{Provider}/Trips/{Trip}"

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

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

Примечание: это поле предназначено только для использования Driver SDK и Consumer 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

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

attributes[]

TripAttribute

Список пользовательских атрибутов поездки. Каждый атрибут должен иметь уникальный ключ.

Tripattribute

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

Поля
key

string

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

Союз Филд trip_attribute_value . Значение атрибута может быть в String, Bool или Double Type. trip_attribute_value может быть только одним из следующих:
string_value

string

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

bool_value

bool

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

number_value

double

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

Трипстатус

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

Перечисления
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

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

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

traffic_to_waypoint

ConsumableTrafficPolyline

Информация о дорожной обстановке на пути к этой точке маршрута. Обратите внимание, что информация о дорожной обстановке доступна только для клиентов сервиса «Поездки и доставка» платформы Google Карт.

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

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

past_locations[]

VehicleLocation

Только вход. Места, где этот автомобиль был в прошлом, о которых еще не сообщалось в двигатель флота. Это используется в UpdateVehicleRequest для записи местоположений, которые ранее не могли быть отправлены на сервер. Как правило, это происходит, когда автомобиль не имеет подключения к Интернету.

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 как радиус, в метрах.

flp_location

LatLng

Расположение от Android Fused Provider.

flp_update_time

Timestamp

Обновление временной метки flp_location

flp_latlng_accuracy_meters

DoubleValue

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

flp_heading_degrees

Int32Value

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

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