Package google.maps.routes.v1

Индекс

МаршрутыПредпочтительные

API предпочтительных маршрутов.

ВычислениеПользовательскиеМаршруты

rpc ComputeCustomRoutes( ComputeCustomRoutesRequest ) returns ( ComputeCustomRoutesResponse )

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

ПРИМЕЧАНИЕ. Для этого метода требуется указать маску поля ответа во входных данных. Вы можете указать маску поля ответа, используя параметр URL-адреса $fields или fields или используя заголовок HTTP/gRPC X-Goog-FieldMask (см. доступные параметры URL-адреса и заголовки . Значение представляет собой список путей к полям, разделенных запятыми. См. подробную документацию о том , как создавать пути к полям .

Например, в этом методе:

  • Маска всех доступных полей (для проверки вручную): X-Goog-FieldMask: *
  • Маска поля с указанием расстояний, длительности маршрута, токенов и информации о платных дорогах: X-Goog-FieldMask: routes.route.distanceMeters,routes.route.duration,routes.token,routes.route.travelAdvisory.tollInfo

Google не рекомендует использовать маску поля ответа с подстановочным знаком ( * ) или указывать маску поля на верхнем уровне ( routes ), потому что:

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

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/maps-platform.routespreferred

Дополнительную информацию см. в обзоре OAuth 2.0 .

ВычислитьМаршрутМаршрут

rpc ComputeRouteMatrix( ComputeRouteMatrixRequest ) returns ( RouteMatrixElement )

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

ПРИМЕЧАНИЕ. Для этого метода требуется указать маску поля ответа во входных данных. Вы можете указать маску поля ответа, используя параметр URL-адреса $fields или fields или используя заголовок HTTP/gRPC X-Goog-FieldMask (см. доступные параметры URL-адреса и заголовки . Значение представляет собой список путей к полям, разделенных запятыми. См. подробную документацию о том , как создавать пути к полям .

Например, в этом методе:

  • Маска всех доступных полей (для проверки вручную): X-Goog-FieldMask: *
  • Маска поля длительности маршрута, расстояний, статуса элемента, состояния и индексов элементов (пример производственной настройки): X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

Крайне важно включить status в маску поля, иначе все сообщения будут выглядеть нормально. Google не рекомендует использовать маску поля ответа с подстановочным знаком ( * ), потому что:

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

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/maps-platform.routespreferred

Дополнительную информацию см. в обзоре OAuth 2.0 .

Вычислительные маршруты

rpc ComputeRoutes( ComputeRoutesRequest ) returns ( ComputeRoutesResponse )

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

ПРИМЕЧАНИЕ. Для этого метода требуется указать маску поля ответа во входных данных. Вы можете предоставить маску поля ответа, используя параметр URL-адреса $fields или fields или используя заголовок HTTP/gRPC X-Goog-FieldMask (см. доступные параметры URL-адреса и заголовки . Значение представляет собой список путей к полям, разделенных запятыми. См. подробная документация о том , как построить пути к полям .

Например, в этом методе:

  • Маска всех доступных полей (для проверки вручную): X-Goog-FieldMask: *
  • Маска поля длительности, расстояния и полилинии на уровне маршрута (пример производственной настройки): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google не рекомендует использовать маску поля ответа с подстановочным знаком ( * ) или указывать маску поля на верхнем уровне ( routes ), потому что:

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

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/maps-platform.routespreferred

Дополнительную информацию см. в обзоре OAuth 2.0 .

ВычислениеПользовательскиеМаршрутыЗапрос

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

Поля
origin

Waypoint

Необходимый. Исходная путевая точка.

destination

Waypoint

Необходимый. Маршрутная точка назначения.

intermediates[]

Waypoint

Необязательный. Набор путевых точек на маршруте (за исключением конечных точек) для остановки или проезда. Поддерживается до 25 промежуточных путевых точек.

travel_mode

RouteTravelMode

Необязательный. Указывает вид транспорта. Сейчас поддерживается только DRIVE.

routing_preference

RoutingPreference

Необязательный. Указывает, как вычислить маршрут. Сервер пытается использовать выбранную настройку маршрутизации для расчета маршрута. Если предпочтения маршрутизации приводят к ошибке или слишком большой задержке, возвращается ошибка. В будущем мы можем реализовать резервный механизм для использования другого варианта, если предпочтительный вариант не дает допустимого результата. Вы можете указать эту опцию, только если travel_mode имеет значение DRIVE или TWO_WHEELER , в противном случае запрос не будет выполнен.

polyline_quality

PolylineQuality

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

polyline_encoding

PolylineEncoding

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

departure_time

Timestamp

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

route_modifiers

RouteModifiers

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

route_objective

RouteObjective

Необходимый. Цель маршрута для оптимизации.

language_code

string

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

units

Units

Необязательный. Указывает единицы измерения для полей отображения. Сюда входит поле instruction в NavigationInstruction . Это значение не влияет на единицы измерения, используемые для маршрута, этапа, расстояния шага и продолжительности. Если вы не укажете это значение, единицы отображения будут выведены из местоположения запроса.

ComputeCustomRoutesResponse

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

Поля
routes[]

CustomRoute

«Лучшие» маршруты для цели входного маршрута.

fastest_route

CustomRoute

Самый быстрый справочный маршрут.

shortest_route

CustomRoute

Самый короткий справочный маршрут.

fallback_info

FallbackInfo

Резервная информация для пользовательских маршрутов.

FallbackInfo

Инкапсулирует резервную информацию для ComputeCustomRoutes. ComputeCustomRoutes выполняет два типа отката:

  1. Если он не может вычислить маршрут с использованием параметра маршрутизации_preference, запрошенного клиентом, он переключается на другой режим маршрутизации. В этом случае Fallback_routing_mode и router_mode_fallback_reason используются для сообщения об используемом резервном режиме маршрутизации, а также о причине резервного режима.

  2. Если он не может вычислить «лучший» маршрут для цели маршрута, указанной клиентом, он может вернуться к другой цели. Fallback_route_objective используется для сообщения цели резервного маршрута.

Поля
routing_mode

FallbackRoutingMode

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

routing_mode_reason

FallbackReason

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

route_objective

FallbackRouteObjective

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

FallbackRouteЦель

RouteObjective, используемый для ответа.

Перечисления
FALLBACK_ROUTE_OBJECTIVE_UNSPECIFIED Цель резервного маршрута не указана.
FALLBACK_RATECARD_WITHOUT_TOLL_PRICE_DATA Если клиент запрашивает тарифную карту и устанавливает для параметра include_tolls значение true, а у Google нет данных о стоимости дорожных сборов для этого маршрута, API возвращается к тарифному плану без учета стоимости дорожных сборов.

ВычислитьМаршрутМатриксЗапрос

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

Поля
origins[]

RouteMatrixOrigin

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

  • В любом случае количество элементов (источники × пункты назначения) не должно превышать 625.
  • Количество элементов (исходные точки × пункты назначения) не должно превышать 100, если для параметра router_preference установлено значение TRAFFIC_AWARE_OPTIMAL .
  • Количество путевых точек (исходные + пункты назначения), указанных как place_id не должно превышать 50.
destinations[]

RouteMatrixDestination

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

travel_mode

RouteTravelMode

Необязательный. Указывает вид транспорта.

routing_preference

RoutingPreference

Необязательный. Указывает, как вычислить маршрут. Сервер пытается использовать выбранную настройку маршрутизации для расчета маршрута. Если предпочтения маршрутизации приводят к ошибке или слишком большой задержке, возвращается ошибка. В будущем мы можем реализовать резервный механизм для использования другого варианта, если предпочтительный вариант не дает допустимого результата. Вы можете указать эту опцию, только если travel_mode имеет значение DRIVE или TWO_WHEELER , в противном случае запрос не будет выполнен.

departure_time

Timestamp

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

ВычислитьМаршрутыЗапрос

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

Поля
origin

Waypoint

Необходимый. Исходная путевая точка.

destination

Waypoint

Необходимый. Маршрутная точка назначения.

intermediates[]

Waypoint

Необязательный. Набор путевых точек на маршруте (за исключением конечных точек) для остановки или проезда. Поддерживается до 25 промежуточных путевых точек.

travel_mode

RouteTravelMode

Необязательный. Указывает вид транспорта.

routing_preference

RoutingPreference

Необязательный. Указывает, как вычислить маршрут. Сервер пытается использовать выбранную настройку маршрутизации для расчета маршрута. Если предпочтения маршрутизации приводят к ошибке или слишком большой задержке, возвращается ошибка. В будущем мы можем реализовать резервный механизм для использования другого варианта, если предпочтительный вариант не дает допустимого результата. Вы можете указать эту опцию, только если travel_mode имеет значение DRIVE или TWO_WHEELER , в противном случае запрос не будет выполнен.

polyline_quality

PolylineQuality

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

polyline_encoding

PolylineEncoding

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

departure_time

Timestamp

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

compute_alternative_routes

bool

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

route_modifiers

RouteModifiers

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

language_code

string

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

units

Units

Необязательный. Указывает единицы измерения для полей отображения. Сюда входит поле instruction в NavigationInstruction . Это значение не влияет на единицы измерения, используемые для маршрута, этапа, расстояния шага и продолжительности. Если вы не укажете это значение, единицы отображения будут выведены из местоположения запроса.

optimize_waypoint_order

bool

Если для оптимизацииWaypointOrder установлено значение true, предпринимается попытка изменить порядок указанных промежуточных путевых точек, чтобы минимизировать общую стоимость маршрута. Если какая-либо из промежуточных точек находится через точку, запрос не выполняется. Используйте ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index, чтобы найти новый порядок. Если маршруты.optimized_intermediate_waypoint_index не запрошены в заголовке X-Goog-FieldMask , запрос не будет выполнен. Если для оптимизацииWaypointOrder установлено значение false, ComputeRoutesResponse.optimized_intermediate_waypoint_index пуст.

ComputeRoutesResponse

ComputeRoutes отправляет ответное сообщение.

Поля
routes[]

Route

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

fallback_info

FallbackInfo

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

CustomRoute

Инкапсулирует пользовательский маршрут, рассчитанный на основе цели маршрута, указанной клиентом. CustomRoute содержит маршрут и токен маршрута, который можно передать в NavSDK для восстановления пользовательского маршрута для пошаговой навигации.

Поля
route

Route

Маршрут считается «лучшим» для цели входного маршрута.

token

string

Веб-безопасный токен маршрута в кодировке Base64, который можно передать в NavSDK, что позволяет NavSDK восстанавливать маршрут во время навигации и в случае изменения маршрута соблюдать исходное намерение при вызове RoutesPreferred ComputeCustomRoutes. Клиенты должны рассматривать этот токен как непрозрачный объект.

FallbackInfo

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

Поля
routing_mode

FallbackRoutingMode

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

reason

FallbackReason

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

FallbackПричина

Причины использования резервного ответа.

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

Режим резервной маршрутизации

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

Перечисления
FALLBACK_ROUTING_MODE_UNSPECIFIED Не используется.
FALLBACK_TRAFFIC_UNAWARE Указывает, что для вычисления ответа использовался режим маршрутизации «TRAFFIC_UNAWARE».
FALLBACK_TRAFFIC_AWARE Указывает, что для вычисления ответа использовался режим маршрутизации «TRAFFIC_AWARE».

Расположение

Инкапсулирует местоположение (географическую точку и необязательный заголовок).

Поля
lat_lng

LatLng

Географические координаты путевой точки.

heading

Int32Value

Курс компаса связан с направлением потока транспорта. Это значение используется для указания стороны дороги, которая будет использоваться для посадки и высадки. Значения курса могут быть от 0 до 360, где 0 указывает направление на север, 90 указывает направление на восток и т. д. Это поле можно использовать только для режимов движения DRIVE и TWO_WHEELER .

Маневр

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

Перечисления
MANEUVER_UNSPECIFIED Не используется.
TURN_SLIGHT_LEFT Повернитесь немного влево.
TURN_SHARP_LEFT Резко поверните налево.
UTURN_LEFT Сделайте разворот налево.
TURN_LEFT Поверните налево.
TURN_SLIGHT_RIGHT Повернитесь немного вправо.
TURN_SHARP_RIGHT Резко поверните направо.
UTURN_RIGHT Сделайте разворот направо.
TURN_RIGHT Поверните направо.
STRAIGHT Езжайте прямо.
RAMP_LEFT Возьмите левую рампу.
RAMP_RIGHT Возьмите правый пандус.
MERGE Вливайтесь в трафик.
FORK_LEFT Возьмите левую развилку.
FORK_RIGHT Возьмите правую вилку.
FERRY Сядьте на паром.
FERRY_TRAIN Сядьте на поезд, ведущий на паром.
ROUNDABOUT_LEFT На круговом перекрестке поверните налево.
ROUNDABOUT_RIGHT На круговом перекрестке поверните направо.
Поля
maneuver

Maneuver

Инкапсулирует инструкции навигации для текущего шага (например, повернуть налево, объединиться, прямо и т. д.). Это поле определяет, какой значок отображать.

instructions

string

Инструкции по навигации на этом этапе.

Полилиния

Инкапсулирует закодированную полилинию.

Поля
Поле объединения polyline_type . Инкапсулирует тип полилинии. По умолчанию — encoded_polyline. polyline_type может быть только одним из следующих:
encoded_polyline

string

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

geo_json_linestring

Struct

Определяет полилинию в формате GeoJSON LineString.

ПолилинияКодирование

Указывает предпочтительный тип возвращаемой полилинии.

Перечисления
POLYLINE_ENCODING_UNSPECIFIED Не заданы предпочтения типа полилинии. По умолчанию ENCODED_POLYLINE .
ENCODED_POLYLINE Указывает полилинию, закодированную с использованием алгоритма кодирования полилиний .
GEO_JSON_LINESTRING Определяет полилинию в формате GeoJSON LineString.

ПолилинияКачество

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

Перечисления
POLYLINE_QUALITY_UNSPECIFIED Не указаны предпочтения качества полилинии. По умолчанию OVERVIEW .
HIGH_QUALITY Задает высококачественную ломаную линию, состоящую из большего количества точек, чем OVERVIEW , за счет увеличения размера ответа. Используйте это значение, когда вам нужна большая точность.
OVERVIEW Указывает обзорную полилинию, состоящую из небольшого количества точек. Используйте это значение при отображении обзора маршрута. Использование этого параметра обеспечивает меньшую задержку запроса по сравнению с использованием параметра HIGH_QUALITY .

Маршрут

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

Поля
legs[]

RouteLeg

Набор участков (сегментов пути между путевыми точками), составляющих маршрут. Каждый этап соответствует поездке между двумя маршрутными точками, не являющимися via . Например, маршрут без промежуточных точек имеет только один участок. Маршрут, включающий одну промежуточную точку, не являющуюся via , имеет два участка. Маршрут, via одну промежуточную точку, имеет один участок. Порядок этапов соответствует порядку точек пути от origin к intermediates и к destination .

distance_meters

int32

Дальность прохождения маршрута в метрах.

duration

Duration

Время, необходимое для прохождения маршрута. Если вы установите для routing_preference значение TRAFFIC_UNAWARE , то это значение будет таким же, как static_duration . Если вы установите для routing_preference значение TRAFFIC_AWARE или TRAFFIC_AWARE_OPTIMAL , то это значение рассчитывается с учетом условий трафика.

static_duration

Duration

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

polyline

Polyline

Общая полилиния маршрута. Эта полилиния будет объединенной полилинией всех legs .

description

string

Описание маршрута.

warnings[]

string

Массив предупреждений, отображаемых при отображении маршрута.

viewport

Viewport

Ограничительная рамка видового экрана полилинии.

travel_advisory

RouteTravelAdvisory

Дополнительная информация о маршруте.

optimized_intermediate_waypoint_index[]

int32

Если для ComputeRoutesRequest.optimize_waypoint_order установлено значение true, это поле содержит оптимизированный порядок промежуточных путевых точек. в противном случае это поле пусто. Например, предположим, что входные данные: Происхождение: Лос-Анджелес; Промежуточные уровни: Даллас, Бангор, Финикс; Пункт назначения: Нью-Йорк; и оптимизированный порядок промежуточных точек: Феникс, Даллас, Бангор. Тогда это поле содержит значения [2, 0, 1]. Индекс начинается с 0 для первой промежуточной точки маршрута.

МаршрутНога

Инкапсулирует сегмент между точками маршрута, не via переходами.

Поля
distance_meters

int32

Расстояние прохождения участка маршрута, в метрах.

duration

Duration

Время, необходимое для перемещения по ноге. Если для route_preference установлено значение TRAFFIC_UNAWARE , то это значение совпадает со значением static_duration . Если route_preference имеет значение TRAFFIC_AWARE или TRAFFIC_AWARE_OPTIMAL , то это значение рассчитывается с учетом условий дорожного движения.

static_duration

Duration

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

polyline

Polyline

Общая полилиния для этого участка. Сюда входит полилиния каждого step .

start_location

Location

Начальное местоположение этого этапа. Это может отличаться от указанного origin . Например, если указанное origin находится не рядом с дорогой, это точка на дороге.

end_location

Location

Конечное расположение этой ноги. Это может отличаться от указанного destination . Например, если указанный destination находится не рядом с дорогой, это точка на дороге.

steps[]

RouteLegStep

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

travel_advisory

RouteLegTravelAdvisory

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

МаршрутНогаШаг

Инкапсулирует сегмент RouteLeg . Шаг соответствует одной инструкции навигации. Участки маршрута состоят из ступеней.

Поля
distance_meters

int32

Расстояние перемещения этого шага в метрах. В некоторых случаях это поле может не иметь значения.

static_duration

Duration

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

polyline

Polyline

Полилиния, связанная с этим шагом.

start_location

Location

Начальное местоположение этого шага.

end_location

Location

Конечная позиция этого шага.

navigation_instruction

NavigationInstruction

Инструкции по навигации.

travel_advisory

RouteLegStepTravelAdvisory

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

МаршрутНогаШагПутешествиеКонсультационный совет

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

Поля
speed_reading_intervals[]

SpeedReadingInterval

Интервалы считывания скорости с подробным описанием плотности трафика. Применимо в случае предпочтений маршрутизации TRAFFIC_AWARE и TRAFFIC_AWARE_OPTIMAL . Интервалы охватывают всю полилинию RouteLegStep без перекрытия. Начальная точка указанного интервала совпадает с конечной точкой предыдущего интервала.

Пример:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speed_reading_intervals: [A,C), [C,D), [D,G).

МаршрутНогаПутешествиеРекомендации

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

Поля
toll_info

TollInfo

Инкапсулирует информацию о дорожных сборах на конкретном RouteLeg. Это поле заполняется только в том случае, если мы ожидаем, что на RouteLeg есть платные дороги. Если это поле установлено, но подполе Assessment_price не заполнено, мы ожидаем, что дорога содержит плату за проезд, но мы не знаем ориентировочную цену. Если это поле не существует, плата за проезд на RouteLeg не взимается.

speed_reading_intervals[]

SpeedReadingInterval

Интервалы считывания скорости с подробным описанием плотности трафика. Применимо в случае предпочтений маршрутизации TRAFFIC_AWARE и TRAFFIC_AWARE_OPTIMAL . Интервалы охватывают всю полилинию RouteLg без перекрытия. Начальная точка указанного интервала совпадает с конечной точкой предыдущего интервала.

Пример:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speed_reading_intervals: [A,C), [C,D), [D,G).

МаршрутМатрицаНазначение

Единое назначение для ComputeRouteMatrixRequest

Поля
waypoint

Waypoint

Необходимый. Пункт назначения

МаршрутМатрицаЭлемент

Инкапсулирует информацию о маршруте, вычисленную для пары отправитель/назначение в API ComputeRouteMatrix. Этот прототип можно передать клиенту.

Поля
origin_index

int32

Индекс источника запроса, начинающийся с нуля.

destination_index

int32

Индекс назначения в запросе, начинающийся с нуля.

status

Status

Код состояния ошибки для этого элемента.

condition

RouteMatrixElementCondition

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

distance_meters

int32

Дальность прохождения маршрута, в метрах.

duration

Duration

Время, необходимое для прохождения маршрута. Если вы установите для routing_preference значение TRAFFIC_UNAWARE , то это значение будет таким же, как static_duration . Если вы установите для routing_preference значение TRAFFIC_AWARE или TRAFFIC_AWARE_OPTIMAL , то это значение рассчитывается с учетом условий трафика.

static_duration

Duration

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

travel_advisory

RouteTravelAdvisory

Дополнительная информация о маршруте. Например: информация об ограничениях и информация о платных дорогах.

fallback_info

FallbackInfo

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

МаршрутМатрицаЭлементУсловие

Состояние возвращаемого маршрута.

Перечисления
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED Используется только в том случае, если status элемента не в порядке.
ROUTE_EXISTS Маршрут найден, и для элемента заполнена соответствующая информация.
ROUTE_NOT_FOUND Маршрут не найден. Поля, содержащие информацию о маршруте, такую ​​как distance_meters или duration , не будут заполнены в элементе.

МаршрутМатрицаПроисхождение

Единый источник для ComputeRouteMatrixRequest.

Поля
waypoint

Waypoint

Необходимый. Исходная путевая точка

route_modifiers

RouteModifiers

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

Модификаторы маршрута

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

Поля
avoid_tolls

bool

Указывает, следует ли избегать платных дорог, где это возможно. Предпочтение будет отдано маршрутам, не содержащим платных дорог. Применяется только к режимам движения DRIVE и TWO_WHEELER .

avoid_highways

bool

Указывает, следует ли избегать шоссе, где это возможно. Предпочтение будет отдано маршрутам, не содержащим автомобильных дорог. Применяется только к режимам движения DRIVE и TWO_WHEELER .

avoid_ferries

bool

Указывает, следует ли избегать паромов, где это возможно. Предпочтение будет отдано маршрутам, не предполагающим переезды на паромах. Применяется только к режимам движения DRIVE и TWO_WHEELER .

avoid_indoor

bool

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

vehicle_info

VehicleInfo

Указывает информацию об автомобиле.

toll_passes[]

TollPass

Инкапсулирует информацию о платных проездных. Если предусмотрены проездные, API пытается вернуть стоимость проезда. Если проездные билеты не предоставлены, API рассматривает проездной билет как неизвестный и пытается вернуть цену наличными. Применяется только к режимам движения DRIVE и TWO_WHEELER.

МаршрутЦель

Инкапсулирует цель оптимизации с помощью ComputeCustomRoutes.

Поля
rate_card

RateCard

Цель RateCard.

тарифная карта

Инкапсулирует цель маршрута RateCard.

Поля
cost_per_minute

MonetaryCost

Необязательный. Стоимость минуты.

cost_per_km

MonetaryCost

Необязательный. Стоимость за километр.

include_tolls

bool

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

Денежная стоимость

Инкапсулирует стоимость, используемую в прейскуранте.

Поля
value

double

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

МаршрутПутешествияКонсультационные услуги

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

Поля
toll_info

TollInfo

Содержит информацию о плате за проезд по маршруту. Это поле заполняется только в том случае, если мы ожидаем, что на маршруте будут платные проезды. Если это поле установлено, но подполе Assessment_price не заполнено, мы ожидаем, что дорога содержит плату за проезд, но мы не знаем ориентировочную цену. Если это поле не установлено, то мы ожидаем, что на Маршруте нет платы за проезд.

speed_reading_intervals[]

SpeedReadingInterval

Интервалы считывания скорости с подробным описанием плотности трафика. Применимо в случае предпочтений маршрутизации TRAFFIC_AWARE и TRAFFIC_AWARE_OPTIMAL . Интервалы охватывают всю полилинию маршрута без перекрытия. Начальная точка указанного интервала совпадает с конечной точкой предыдущего интервала.

Пример:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speed_reading_intervals: [A,C), [C,D), [D,G).

МаршрутПутешествияРежим

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

Перечисления
TRAVEL_MODE_UNSPECIFIED Не указан режим движения. По умолчанию DRIVE .
DRIVE Путешествие на легковом автомобиле.
BICYCLE Путешествие на велосипеде.
WALK Путешествуйте пешком.
TWO_WHEELER Двухколесное моторизованное транспортное средство. Например, мотоцикл. Обратите внимание, что это отличается от режима движения BICYCLE , который охватывает режим с участием человека.
TAXI

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

Режим ТАКСИ — экспериментальная функция. Если клиент запрашивает маршрут TAXI в городе, где данные о полосах такси недоступны, возвращается маршрут DRIVE.

Предпочтение маршрутизации

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

Перечисления
ROUTING_PREFERENCE_UNSPECIFIED Не указаны предпочтения маршрутизации. По умолчанию TRAFFIC_AWARE .
TRAFFIC_UNAWARE Рассчитывает маршруты без учета условий движения. Подходит, когда условия дорожного движения не имеют значения. Использование этого значения обеспечивает минимальную задержку.
TRAFFIC_AWARE Рассчитывает маршруты с учетом условий движения. В отличие от TRAFFIC_AWARE_OPTIMAL , применяются некоторые оптимизации, позволяющие значительно сократить задержку.
TRAFFIC_AWARE_OPTIMAL Рассчитывает маршруты с учетом условий движения без применения большинства оптимизаций производительности. Использование этого значения приводит к самой высокой задержке.

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

Индикатор плотности трафика на непрерывном участке ломаной линии или пути. Учитывая путь с точками 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 Обнаружена пробка.

Платная информация

Инкапсулирует информацию о платных дорогах в Route или RouteLeg .

Поля
estimated_price[]

Money

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

TollPass

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

Перечисления
TOLL_PASS_UNSPECIFIED Не используется. Если это значение используется, запрос завершается неудачно.
AU_ETOLL_TAG Один из многих поставщиков проездных билетов в Сиднее. https://www.myetall.com.au
AU_EWAY_TAG Один из многих поставщиков проездных билетов в Сиднее. https://www.tollpay.com.au/
AU_LINKT Платный проезд по всей Австралии. Дополнительную информацию см. на https://www.linkt.com.au/ .
AR_TELEPASE Платный перевал в Аргентине. Дополнительную информацию см. на https://telepase.com.ar.
BR_AUTO_EXPRESO Платный перевал в Бразилии. Дополнительную информацию см. на https://www.autoexpreso.com.
BR_CONECTCAR Платный перевал в Бразилии. Дополнительную информацию см. на https://conectcar.com .
BR_MOVE_MAIS Платный перевал в Бразилии. Дополнительную информацию см. на https://movemais.com .
BR_PASSA_RAPIDO Платный перевал в Бразилии. Дополнительную информацию см. на https://pasorapido.gob.do/.
BR_SEM_PARAR Платный перевал в Бразилии. Дополнительную информацию см. на https://www.semparar.com.br .
BR_TAGGY Платный перевал в Бразилии. Дополнительную информацию см. на https://taggy.com.br .
BR_VELOE Платный перевал в Бразилии. Дополнительную информацию см. на https://veloe.com.br/site/onde-usar .
CA_US_AKWASASNE_SEAWAY_CORPORATE_CARD Пограничный переход между Канадой и США.
CA_US_AKWASASNE_SEAWAY_TRANSIT_CARD Пограничный переход между Канадой и США.
CA_US_BLUE_WATER_EDGE_PASS Пограничный переход Онтарио, Канада, Мичиган, США.
CA_US_CONNEXION Пограничный переход Онтарио, Канада, Мичиган, США.
CA_US_NEXUS_CARD Пограничный переход между Канадой и США.
ID_E_TOLL Индонезия. Электронная карта, предоставленная несколькими банками, используемая для оплаты дорожных сборов. Все электронные карты через банки взимаются одинаково, поэтому требуется только одно перечисляемое значение. Например, Bank Mandiri https://www.bankmandiri.co.id/e-money BCA https://www.bca.co.id/flazz BNI https://www.bni.co.id/id-id/ebanking /tapcash
IN_FASTAG Индия.
IN_LOCAL_HP_PLATE_EXEMPT Индия, освобождение от уплаты государственных знаков HP.
MX_TAG_IAVE Платный перевал в Мексике.
MX_TAG_TELEVIA Компания по взиманию платы за проезд в Мексике. Один из многих, работающих в Мехико. Дополнительную информацию см. на https://www.televia.com.mx .
MX_VIAPASS Платный перевал в Мексике. Дополнительную информацию см. на странице https://www.viapass.com.mx/viapass/web_home.aspx .
US_AL_FREEDOM_PASS АЛ, США.
US_AK_ANTON_ANDERSON_TUNNEL_BOOK_OF_10_TICKETS АК, США.
US_CA_FASTRAK Калифорния, США.
US_CA_FASTRAK_CAV_STICKER Указывает, что у водителя есть пропуск FasTrak в дополнение к наклейке транспортного средства с чистым воздухом (CAV), выданной DMV. https://www.bayareafastrak.org/en/guide/doINeedFlex.shtml
US_CO_EXPRESSTOLL Колорадо, США.
US_CO_GO_PASS Колорадо, США.
US_DE_EZPASSDE Делавэр, США.
US_FL_BOB_SIKES_TOLL_BRIDGE_PASS Флорида, США.
US_FL_DUNES_COMMUNITY_DEVELOPMENT_DISTRICT_EXPRESSCARD Флорида, США.
US_FL_EPASS Флорида, США.
US_FL_GIBA_TOLL_PASS Флорида, США.
US_FL_LEEWAY Флорида, США.
US_FL_SUNPASS Флорида, США.
US_FL_SUNPASS_PRO Флорида, США.
US_IL_EZPASSIL Иллинойс, США.
US_IL_IPASS Иллинойс, США.
US_IN_EZPASSIN ИН, США.
US_KS_BESTPASS_HORIZON КС, США.
US_KS_KTAG КС, США.
US_KS_NATIONALPASS КС, США.
US_KS_PREPASS_ELITEPASS КС, США.
US_LA_GEAUXPASS Лос-Анджелес, США.
US_LA_TOLL_TAG Лос-Анджелес, США.
US_MA_EZPASSMA Массачусетс, США.
US_MD_EZPASSMD Доктор медицины, США.
US_ME_EZPASSME Я, США.
US_MI_AMBASSADOR_BRIDGE_PREMIER_COMMUTER_CARD Мичиган, США.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG Мичиган, США.
US_MI_IQ_PROX_CARD Мичиган, США.
US_MI_MACKINAC_BRIDGE_MAC_PASS Мичиган, США.
US_MI_NEXPRESS_TOLL Мичиган, США.
US_MN_EZPASSMN Миннесота, США.
US_NC_EZPASSNC Северная Каролина, США.
US_NC_PEACH_PASS Северная Каролина, США.
US_NC_QUICK_PASS Северная Каролина, США.
US_NH_EZPASSNH Нью-Хэмпшир, США.
US_NJ_DOWNBEACH_EXPRESS_PASS Нью-Джерси, США.
US_NJ_EZPASSNJ Нью-Джерси, США.
US_NY_EXPRESSPASS Нью-Йорк, США.
US_NY_EZPASSNY Нью-Йорк, США.
US_OH_EZPASSOH О, США.
US_PA_EZPASSPA Пенсильвания, США.
US_RI_EZPASSRI Р.И., США.
US_SC_PALPASS СК, США.
US_TX_BANCPASS Техас, США.
US_TX_DEL_RIO_PASS Техас, США.
US_TX_EFAST_PASS Техас, США.
US_TX_EAGLE_PASS_EXPRESS_CARD Техас, США.
US_TX_EPTOLL Техас, США.
US_TX_EZ_CROSS Техас, США.
US_TX_EZTAG Техас, США.
US_TX_LAREDO_TRADE_TAG Техас, США.
US_TX_PLUSPASS Техас, США.
US_TX_TOLLTAG Техас, США.
US_TX_TXTAG Техас, США.
US_TX_XPRESS_CARD Техас, США.
US_UT_ADAMS_AVE_PARKWAY_EXPRESSCARD ЮТ, США.
US_VA_EZPASSVA Вирджиния, США.
US_WA_BREEZEBY Вашингтон, США.
US_WA_GOOD_TO_GO Вашингтон, США.
US_WV_EZPASSWV Западная Вирджиния, США.
US_WV_MEMORIAL_BRIDGE_TICKETS Западная Вирджиния, США.
US_WV_NEWELL_TOLL_BRIDGE_TICKET Западная Вирджиния, США.

Единицы

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

Перечисления
UNITS_UNSPECIFIED Единицы измерения не указаны. По умолчанию используется единица измерения, полученная из запроса.
METRIC Метрические единицы измерения.
IMPERIAL Имперские (английские) единицы измерения.

Транспортное средствоТип выбросов

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

Перечисления
VEHICLE_EMISSION_TYPE_UNSPECIFIED Тип выброса не указан. По умолчанию БЕНЗИН.
GASOLINE Автомобиль, работающий на бензине/бензине.
ELECTRIC Транспортное средство с электроприводом.
HYBRID Гибридное топливо (например, бензин + электромобиль).

Информация о транспортном средстве

Инкапсулирует информацию о транспортном средстве, например последний символ номерного знака.

Поля
emission_type

VehicleEmissionType

Описывает тип выбросов автомобиля. Применяется только к режиму движения DRIVE.

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

Инкапсулирует путевую точку. Путевые точки отмечают начало и конец маршрута и включают промежуточные остановки на маршруте.

Поля
via

bool

Отмечает эту путевую точку как веху, а не как точку остановки. Для каждой путевой точки в запросе, не являющейся транзитным, ответ добавляет запись в массив legs , чтобы предоставить подробную информацию об остановках на этом этапе поездки. Установите для этого значения значение true, если вы хотите, чтобы маршрут проходил через эту точку без остановок. Через путевые точки не добавляется запись в массив legs , но они маршрутизируют путешествие через путевую точку. Вы можете установить это значение только для промежуточных точек маршрута. Запрос не будет выполнен, если вы установите это поле для путевых точек терминала. Если ComputeRoutesRequest.optimize_waypoint_order имеет значение true, то для этого поля нельзя установить значение true; в противном случае запрос не будет выполнен.

vehicle_stopover

bool

Указывает, что путевая точка предназначена для остановки транспортных средств с намерением либо посадить, либо высадить ее. Если вы установите это значение, расчетный маршрут не будет включать via точки на дорогах, которые непригодны для посадки и высадки. Эта опция работает только для режимов движения DRIVE и TWO_WHEELER , а также когда location_type равен location .

side_of_road

bool

Указывает, что расположение этой путевой точки предназначено для того, чтобы транспортное средство остановилось на определенной стороне дороги. Если вы установите это значение, маршрут будет проходить через местоположение, так что транспортное средство сможет остановиться на той стороне дороги, к которой местоположение смещено от центра дороги. Эта опция работает только для режимов движения «DRIVE» и «TWO_WHEELER», а также когда для параметра location_type установлено значение «location».

Поле объединения location_type . Различные способы представления местоположения. location_type может быть только одним из следующих:
location

Location

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

place_id

string

Идентификатор места POI, связанный с путевой точкой.