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://telease.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 IL, США.
US_IL_IPASS IL, США.
US_IN_EZPASSIN В США.
US_KS_BESTPASS_HORIZON KS, США.
US_KS_KTAG KS, США.
US_KS_NATIONALPASS KS, США.
US_KS_PREPASS_ELITEPASS KS, США.
US_LA_GEAUXPASS LA, США.
US_LA_TOLL_TAG LA, США.
US_MA_EZPASSMA Ма, США.
US_MD_EZPASSMD MD, США.
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 NC, США.
US_NC_PEACH_PASS NC, США.
US_NC_QUICK_PASS NC, США.
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 SC, США.
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 UT, США.
US_VA_EZPASSVA VA, США.
US_WA_BREEZEBY WA, США.
US_WA_GOOD_TO_GO WA, США.
US_WV_EZPASSWV WV, США.
US_WV_MEMORIAL_BRIDGE_TICKETS WV, США.
US_WV_NEWELL_TOLL_BRIDGE_TICKET WV, США.

Единицы

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

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

FehishemissionType

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

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

Автомобильнфо

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

Поля
emission_type

VehicleEmissionType

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

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

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

Поля
via

bool

На этой путевой точке отмечается как веха, а не остановка. Для каждой не VIA Waypoint в запросе ответ добавляет запись в массив legs , чтобы предоставить подробности остановок на этой ноге поездки. Установите это значение True, когда вы хотите, чтобы маршрут прошел через эту путевую точку, не останавливаясь. С через путевые точки не приводят к добавлению входа в массив legs , но они направляют путешествие по дорожной точке. Вы можете установить это значение только на путевые точки, которые являются промежуточными. Запрос не удается, если вы установите это поле на пути к терминалу. Если ComputionOutesRequest.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_type . Различные способы представлять местоположение. location_type может быть только одним из следующих:
location

Location

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

place_id

string

ID POI Place, связанный с путевой точкой.

,

Индекс

Пускок

Маршруты предпочитают API.

ComputeCustomroutes

rpc ComputeCustomRoutes( ComputeCustomRoutesRequest ) returns ( ComputeCustomRoutesResponse )

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

ПРИМЕЧАНИЕ. Этот метод требует, чтобы вы указали маску поля ответа на входе. Вы можете предоставить маску поля ответа, используя поля или fields параметра URL-адреса $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 .

ComputerouteMatrix

rpc ComputeRouteMatrix( ComputeRouteMatrixRequest ) returns ( RouteMatrixElement )

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

ПРИМЕЧАНИЕ. Этот метод требует, чтобы вы указали маску поля ответа на входе. Вы можете предоставить маску поля ответа, используя поля или fields параметра URL-адреса $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 )

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

ПРИМЕЧАНИЕ. Этот метод требует, чтобы вы указали маску поля ответа на входе. Вы можете предоставить маску поля ответа, используя $fields или fields параметра URL-адреса или с помощью HTTP/GRPC Header 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 .

ComputeCustomRoutesRequest

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

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

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

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

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

SwarkbackInfo

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

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

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

Поля
routing_mode

FallbackRoutingMode

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

routing_mode_reason

FallbackReason

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

route_objective

FallbackRouteObjective

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

SwarkbackRouteObjective

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

Перечисления
FALLBACK_ROUTE_OBJECTIVE_UNSPECIFIED Благоприятный маршрут Цель неуточена.
FALLBACK_RATECARD_WITHOUT_TOLL_PRICE_DATA Если клиенты запрашивают Ratecard и Sets, включают в себя_tolls true, и Google не имеет платежей цены на маршрут, API возвращается в RateCard без учета платной цены.

ComputerouteMatrixRequest

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

Поля
origins[]

RouteMatrixOrigin

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

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

RouteMatrixDestination

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

travel_mode

RouteTravelMode

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

routing_preference

RoutingPreference

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

departure_time

Timestamp

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

ComputionEsRequest

Сообщение запроса компьютерных компьютеров.

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

Если OptimizeWayPointOrder установлен на True, предпринимается попытка повторно заказать указанные промежуточные путевые точки, чтобы минимизировать общую стоимость маршрута. Если какая -либо из промежуточных путевых точек проходит через путевую точку, запрос не выполняется. Используйте ComputOutSresponse.routes.optimized_Intermediate_waypoint_index, чтобы найти новый заказ. Если routes.optimized_intermediate_waypoint_index не запрашивается в заголовке X-Goog-FieldMask , запрос сбой. Если OptimizeWayPointOrder устанавливается на false, ComputionSresponse.optimized_Intermediate_waypoint_index пуст.

ComputeroutSresponse

Compultouts отвечает на сообщение.

Поля
routes[]

Route

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

fallback_info

FallbackInfo

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

Customroute

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

Поля
route

Route

Маршрут считался «лучшим» для объектива маршрута ввода.

token

string

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

SwarkbackInfo

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

Поля
routing_mode

FallbackRoutingMode

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

reason

FallbackReason

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

ПРИНЯТЕЛЬНЫЙ РЕЗУН

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

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

SwarkbackRoutingMode

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

Перечисления
FALLBACK_ROUTING_MODE_UNSPECIFIED Не используется.
FALLBACK_TRAFFIC_UNAWARE Указывает, что для вычисления ответа использовался режим маршрутизации «Traff_unaware».
FALLBACK_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 . Инкапсулирует тип полилинии. По умолчанию кодировать_полилин. 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

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

Routeleg

Инкапсулирует сегмент между не 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

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

Routelegstep

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

Поля
distance_meters

int32

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

static_duration

Duration

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

polyline

Polyline

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

start_location

Location

Начало этого шага.

end_location

Location

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

navigation_instruction

NavigationInstruction

Навигационные инструкции.

travel_advisory

RouteLegStepTravelAdvisory

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

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).

Routelegtraveladvisory

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

Поля
toll_info

TollInfo

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

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).

RoutematrixDestination

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

Поля
waypoint

Waypoint

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

RoutematrixElement

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

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

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

RoutematrixElementCondition

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

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

Routematrixorigin

Одно происхождение для компьютерного эпоха

Поля
waypoint

Waypoint

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

route_modifiers

RouteModifiers

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

Рукодификаторы

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

Поля
avoid_tolls

bool

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

avoid_highways

bool

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

avoid_ferries

bool

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

avoid_indoor

bool

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

vehicle_info

VehicleInfo

Указывает информацию о транспортном средстве.

toll_passes[]

TollPass

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

RouteObjective

Инкапсулирует цель для оптимизации для ComputeCustomroutes.

Поля
rate_card

RateCard

Цель RateCard.

Рейбчата

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

Поля
cost_per_minute

MonetaryCost

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

cost_per_km

MonetaryCost

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

include_tolls

bool

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

Монетарикост

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

Поля
value

double

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

RouteTraveladVisory

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

Поля
toll_info

TollInfo

Инкапсулирует информацию о протяженности по маршруту. Это поле населено только в том случае, если мы ожидаем, что на маршруте есть платы. Если это поле устанавливается, но подполе Ayrated_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).

RouteTravelMode

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

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

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

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

RoutingPreference

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

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

SpeedReadingInterval

Индикатор плотности трафика на смежном сегменте полилинии или пути. Given a path with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval defines an interval and describes its traffic using the following categories.

Поля
start_polyline_point_index

int32

The starting index of this interval in the polyline. In JSON, when the index is 0, the field appears to be unpopulated.

end_polyline_point_index

int32

The ending index of this interval in the polyline. In JSON, when the index is 0, the field appears to be unpopulated.

speed

Speed

Traffic speed in this interval.

Скорость

The classification of polyline speed based on traffic data.

Перечисления
SPEED_UNSPECIFIED Значение по умолчанию. This value is unused.
NORMAL Normal speed, no slowdown is detected.
SLOW Slowdown detected, but no traffic jam formed.
TRAFFIC_JAM Traffic jam detected.

TollInfo

Encapsulates toll information on a Route or on a RouteLeg .

Поля
estimated_price[]

Money

The monetary amount of tolls for the corresponding Route or RouteLeg. This list contains a money amount for each currency that is expected to be charged by the toll stations. Typically this list will contain only one item for routes with tolls in one currency. For international trips, this list may contain multiple items to reflect tolls in different currencies.

TollPass

List of toll passes around the world that we support.

Перечисления
TOLL_PASS_UNSPECIFIED Не используется. If this value is used, then the request fails.
AU_ETOLL_TAG One of many Sydney toll pass providers. https://www.myetoll.com.au
AU_EWAY_TAG One of many Sydney toll pass providers. https://www.tollpay.com.au/
AU_LINKT Australia-wide toll pass. See additional details at https://www.linkt.com.au/ .
AR_TELEPASE Argentina toll pass. See additional details at https://telepase.com.ar
BR_AUTO_EXPRESO Brazil toll pass. See additional details at https://www.autoexpreso.com
BR_CONECTCAR Brazil toll pass. See additional details at https://conectcar.com .
BR_MOVE_MAIS Brazil toll pass. See additional details at https://movemais.com .
BR_PASSA_RAPIDO Brazil toll pass. See additional details at https://pasorapido.gob.do/
BR_SEM_PARAR Brazil toll pass. See additional details at https://www.semparar.com.br .
BR_TAGGY Brazil toll pass. See additional details at https://taggy.com.br .
BR_VELOE Brazil toll pass. See additional details at https://veloe.com.br/site/onde-usar .
CA_US_AKWASASNE_SEAWAY_CORPORATE_CARD Canada to United States border crossing.
CA_US_AKWASASNE_SEAWAY_TRANSIT_CARD Canada to United States border crossing.
CA_US_BLUE_WATER_EDGE_PASS Ontario, Canada to Michigan, United States border crossing.
CA_US_CONNEXION Ontario, Canada to Michigan, United States border crossing.
CA_US_NEXUS_CARD Canada to United States border crossing.
ID_E_TOLL Индонезия. E-card provided by multiple banks used to pay for tolls. All e-cards via banks are charged the same so only one enum value is needed. Eg 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 India, HP state plate exemption.
MX_TAG_IAVE Mexico toll pass.
MX_TAG_TELEVIA Mexico toll pass company. One of many operating in Mexico City. See additional details at https://www.televia.com.mx .
MX_VIAPASS Mexico toll pass. See additional details at https://www.viapass.com.mx/viapass/web_home.aspx .
US_AL_FREEDOM_PASS AL, USA.
US_AK_ANTON_ANDERSON_TUNNEL_BOOK_OF_10_TICKETS AK, USA.
US_CA_FASTRAK CA, USA.
US_CA_FASTRAK_CAV_STICKER Indicates driver has any FasTrak pass in addition to the DMV issued Clean Air Vehicle (CAV) sticker. https://www.bayareafastrak.org/en/guide/doINeedFlex.shtml
US_CO_EXPRESSTOLL CO, USA.
US_CO_GO_PASS CO, USA.
US_DE_EZPASSDE DE, USA.
US_FL_BOB_SIKES_TOLL_BRIDGE_PASS FL, USA.
US_FL_DUNES_COMMUNITY_DEVELOPMENT_DISTRICT_EXPRESSCARD FL, USA.
US_FL_EPASS FL, USA.
US_FL_GIBA_TOLL_PASS FL, USA.
US_FL_LEEWAY FL, USA.
US_FL_SUNPASS FL, USA.
US_FL_SUNPASS_PRO FL, USA.
US_IL_EZPASSIL IL, USA.
US_IL_IPASS IL, USA.
US_IN_EZPASSIN IN, USA.
US_KS_BESTPASS_HORIZON KS, USA.
US_KS_KTAG KS, USA.
US_KS_NATIONALPASS KS, USA.
US_KS_PREPASS_ELITEPASS KS, USA.
US_LA_GEAUXPASS LA, USA.
US_LA_TOLL_TAG LA, USA.
US_MA_EZPASSMA MA, USA.
US_MD_EZPASSMD MD, USA.
US_ME_EZPASSME ME, USA.
US_MI_AMBASSADOR_BRIDGE_PREMIER_COMMUTER_CARD MI, USA.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG MI, USA.
US_MI_IQ_PROX_CARD MI, USA.
US_MI_MACKINAC_BRIDGE_MAC_PASS MI, USA.
US_MI_NEXPRESS_TOLL MI, USA.
US_MN_EZPASSMN MN, USA.
US_NC_EZPASSNC NC, USA.
US_NC_PEACH_PASS NC, USA.
US_NC_QUICK_PASS NC, USA.
US_NH_EZPASSNH NH, USA.
US_NJ_DOWNBEACH_EXPRESS_PASS NJ, USA.
US_NJ_EZPASSNJ NJ, USA.
US_NY_EXPRESSPASS NY, USA.
US_NY_EZPASSNY NY, USA.
US_OH_EZPASSOH OH, USA.
US_PA_EZPASSPA PA, USA.
US_RI_EZPASSRI RI, USA.
US_SC_PALPASS SC, USA.
US_TX_BANCPASS TX, USA.
US_TX_DEL_RIO_PASS TX, USA.
US_TX_EFAST_PASS TX, USA.
US_TX_EAGLE_PASS_EXPRESS_CARD TX, USA.
US_TX_EPTOLL TX, USA.
US_TX_EZ_CROSS TX, USA.
US_TX_EZTAG TX, USA.
US_TX_LAREDO_TRADE_TAG TX, USA.
US_TX_PLUSPASS TX, USA.
US_TX_TOLLTAG TX, USA.
US_TX_TXTAG TX, USA.
US_TX_XPRESS_CARD TX, USA.
US_UT_ADAMS_AVE_PARKWAY_EXPRESSCARD UT, USA.
US_VA_EZPASSVA VA, USA.
US_WA_BREEZEBY WA, USA.
US_WA_GOOD_TO_GO WA, USA.
US_WV_EZPASSWV WV, USA.
US_WV_MEMORIAL_BRIDGE_TICKETS WV, USA.
US_WV_NEWELL_TOLL_BRIDGE_TICKET WV, USA.

Единицы

A set of values that specify the unit of measure used in the display.

Перечисления
UNITS_UNSPECIFIED Units of measure not specified. Defaults to the unit of measure inferred from the request.
METRIC Metric units of measure.
IMPERIAL Imperial (English) units of measure.

VehicleEmissionType

A set of values describing the vehicle's emission type. Applies only to the DRIVE travel mode.

Перечисления
VEHICLE_EMISSION_TYPE_UNSPECIFIED No emission type specified. Default to GASOLINE.
GASOLINE Gasoline/petrol fueled vehicle.
ELECTRIC Electricity powered vehicle.
HYBRID Hybrid fuel (such as gasoline + electric) vehicle.

VehicleInfo

Encapsulates the vehicle information, such as the license plate last character.

Поля
emission_type

VehicleEmissionType

Describes the vehicle's emission type. Applies only to the DRIVE travel mode.

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

Encapsulates a waypoint. Waypoints mark both the beginning and end of a route, and include intermediate stops along the route.

Поля
via

bool

Marks this waypoint as a milestone rather a stopping point. For each non-via waypoint in the request, the response appends an entry to the legs array to provide the details for stopovers on that leg of the trip. Set this value to true when you want the route to pass through this waypoint without stopping over. Via waypoints don't cause an entry to be added to the legs array, but they do route the journey through the waypoint. You can only set this value on waypoints that are intermediates. The request fails if you set this field on terminal waypoints. If ComputeRoutesRequest.optimize_waypoint_order is set to true then this field cannot be set to true; otherwise, the request fails.

vehicle_stopover

bool

Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pickup or drop-off. When you set this value, the calculated route won't include non- via waypoints on roads that are unsuitable for pickup and drop-off. This option works only for DRIVE and TWO_WHEELER travel modes, and when the location_type is location .

side_of_road

bool

Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option works only for 'DRIVE' and 'TWO_WHEELER' travel modes, and when the 'location_type' is set to 'location'.

Union field location_type . Different ways to represent a location. location_type can be only one of the following:
location

Location

A point specified using geographic coordinates, including an optional heading.

place_id

string

The POI Place ID associated with the waypoint.

,

Индекс

RoutesPreferred

The Routes Preferred API.

ComputeCustomRoutes

rpc ComputeCustomRoutes( ComputeCustomRoutesRequest ) returns ( ComputeCustomRoutesResponse )

Given a set of terminal and intermediate waypoints, and a route objective, computes the best route for the route objective. Also returns fastest route and shortest route as reference routes.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter $fields or fields , or by using the HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers . The value is a comma separated list of field paths. See this detailed documentation about how to construct the field paths .

For example, in this method:

  • Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
  • Field mask of route distances, durations, token and toll info: X-Goog-FieldMask: routes.route.distanceMeters,routes.route.duration,routes.token,routes.route.travelAdvisory.tollInfo

Google discourages the use of the wildcard ( * ) response field mask, or specifying the field mask at the top level ( routes ), because:

  • Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
  • Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
  • Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.
Области авторизации

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

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

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

ComputeRouteMatrix

rpc ComputeRouteMatrix( ComputeRouteMatrixRequest ) returns ( RouteMatrixElement )

Takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter $fields or fields , or by using the HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers . The value is a comma separated list of field paths. See this detailed documentation about how to construct the field paths .

For example, in this method:

  • Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
  • Field mask of route durations, distances, element status, condition, and element indices (an example production setup): X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

It is critical that you include status in your field mask as otherwise all messages will appear to be OK. Google discourages the use of the wildcard ( * ) response field mask, because:

  • Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
  • Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
  • Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.
Области авторизации

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

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

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

ComputeRoutes

rpc ComputeRoutes( ComputeRoutesRequest ) returns ( ComputeRoutesResponse )

Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using URL parameter $fields or fields , or by using an HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers . The value is a comma separated list of field paths. See detailed documentation about how to construct the field paths .

For example, in this method:

  • Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
  • Field mask of Route-level duration, distance, and polyline (an example production setup): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google discourage the use of the wildcard ( * ) response field mask, or specifying the field mask at the top level ( routes ), because:

  • Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
  • Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
  • Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.
Области авторизации

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

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

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

ComputeCustomRoutesRequest

ComputeCustomRoutes request message.

Поля
origin

Waypoint

Необходимый. Origin waypoint.

destination

Waypoint

Необходимый. Destination waypoint.

intermediates[]

Waypoint

Необязательный. A set of waypoints along the route (excluding terminal points), for either stopping at or passing by. Up to 25 intermediate waypoints are supported.

travel_mode

RouteTravelMode

Необязательный. Specifies the mode of transportation. Only DRIVE is supported now.

routing_preference

RoutingPreference

Необязательный. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, then an error is returned. In the future, we might implement a fallback mechanism to use a different option when the preferred option does not give a valid result. You can specify this option only when the travel_mode is DRIVE or TWO_WHEELER , otherwise the request fails.

polyline_quality

PolylineQuality

Необязательный. Specifies your preference for the quality of the polyline.

polyline_encoding

PolylineEncoding

Необязательный. Specifies the preferred encoding for the polyline.

departure_time

Timestamp

Необязательный. The departure time. If you don't set this value, then this value defaults to the time that you made the request. If you set this value to a time that has already occurred, then the request fails.

route_modifiers

RouteModifiers

Необязательный. A set of conditions to satisfy that affect the way routes are calculated.

route_objective

RouteObjective

Необходимый. A route objective to optimize for.

language_code

string

Необязательный. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier . See Language Support for the list of supported languages. When you don't provide this value, the display language is inferred from the location of the route request.

units

Units

Необязательный. Specifies the units of measure for the display fields. This includes the instruction field in NavigationInstruction . The units of measure used for the route, leg, step distance, and duration are not affected by this value. If you don't provide this value, then the display units are inferred from the location of the request.

ComputeCustomRoutesResponse

ComputeCustomRoutes response message.

Поля
routes[]

CustomRoute

The 'best' routes for the input route objective.

fastest_route

CustomRoute

The fastest reference route.

shortest_route

CustomRoute

The shortest reference route.

fallback_info

FallbackInfo

Fallback info for custom routes.

FallbackInfo

Encapsulates fallback info for ComputeCustomRoutes. ComputeCustomRoutes performs two types of fallbacks:

  1. If it cannot compute the route using the routing_preference requested by the customer, it will fallback to another routing mode. In this case fallback_routing_mode and routing_mode_fallback_reason are used to communicate the fallback routing mode used, as well as the reason for fallback.

  2. If it cannot compute a 'best' route for the route objective specified by the customer, it might fallback to another objective. fallback_route_objective is used to communicate the fallback route objective.

Поля
routing_mode

FallbackRoutingMode

Routing mode used for the response. If fallback was triggered, the mode may be different from routing preference set in the original client request.

routing_mode_reason

FallbackReason

The reason why fallback response was used instead of the original response. This field is only populated when the fallback mode is triggered and the fallback response is returned.

route_objective

FallbackRouteObjective

The route objective used for the response. If fallback was triggered, the objective may be different from the route objective provided in the original client request.

FallbackRouteObjective

RouteObjective used for the response.

Перечисления
FALLBACK_ROUTE_OBJECTIVE_UNSPECIFIED Fallback route objective unspecified.
FALLBACK_RATECARD_WITHOUT_TOLL_PRICE_DATA If customer requests RateCard and sets include_tolls to true, and Google does not have toll price data for the route, the API falls back to RateCard without considering toll price.

ComputeRouteMatrixRequest

ComputeRouteMatrix request message

Поля
origins[]

RouteMatrixOrigin

Необходимый. Array of origins, which determines the rows of the response matrix. Several size restrictions apply to the cardinality of origins and destinations:

  • The number of elements (origins × destinations) must be no greater than 625 in any case.
  • The number of elements (origins × destinations) must be no greater than 100 if routing_preference is set to TRAFFIC_AWARE_OPTIMAL .
  • The number of waypoints (origins + destinations) specified as place_id must be no greater than 50.
destinations[]

RouteMatrixDestination

Необходимый. Array of destinations, which determines the columns of the response matrix.

travel_mode

RouteTravelMode

Необязательный. Specifies the mode of transportation.

routing_preference

RoutingPreference

Необязательный. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, an error is returned. In the future, we might implement a fallback mechanism to use a different option when the preferred option does not give a valid result. You can specify this option only when the travel_mode is DRIVE or TWO_WHEELER , otherwise the request fails.

departure_time

Timestamp

Необязательный. The departure time. If you don't set this value, this defaults to the time that you made the request. If you set this value to a time that has already occurred, the request fails.

ComputeRoutesRequest

ComputeRoutes request message.

Поля
origin

Waypoint

Необходимый. Origin waypoint.

destination

Waypoint

Необходимый. Destination waypoint.

intermediates[]

Waypoint

Необязательный. A set of waypoints along the route (excluding terminal points), for either stopping at or passing by. Up to 25 intermediate waypoints are supported.

travel_mode

RouteTravelMode

Необязательный. Specifies the mode of transportation.

routing_preference

RoutingPreference

Необязательный. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, then an error is returned. In the future, we might implement a fallback mechanism to use a different option when the preferred option does not give a valid result. You can specify this option only when the travel_mode is DRIVE or TWO_WHEELER , otherwise the request fails.

polyline_quality

PolylineQuality

Необязательный. Specifies your preference for the quality of the polyline.

polyline_encoding

PolylineEncoding

Необязательный. Specifies the preferred encoding for the polyline.

departure_time

Timestamp

Необязательный. The departure time. If you don't set this value, then this value defaults to the time that you made the request. If you set this value to a time that has already occurred, then the request fails.

compute_alternative_routes

bool

Specifies whether to calculate alternate routes in addition to the route.

route_modifiers

RouteModifiers

Необязательный. A set of conditions to satisfy that affect the way routes are calculated.

language_code

string

Необязательный. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier . See Language Support for the list of supported languages. When you don't provide this value, the display language is inferred from the location of the route request.

units

Units

Необязательный. Specifies the units of measure for the display fields. This includes the instruction field in NavigationInstruction . The units of measure used for the route, leg, step distance, and duration are not affected by this value. If you don't provide this value, then the display units are inferred from the location of the request.

optimize_waypoint_order

bool

If optimizeWaypointOrder is set to true, an attempt is made to re-order the specified intermediate waypoints to minimize the overall cost of the route. If any of the intermediate waypoints is via waypoint the request fails. Use ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index to find the new ordering. If routes.optimized_intermediate_waypoint_index is not requested in the X-Goog-FieldMask header, the request fails. If optimizeWaypointOrder is set to false, ComputeRoutesResponse.optimized_intermediate_waypoint_index is empty.

ComputeRoutesResponse

ComputeRoutes the response message.

Поля
routes[]

Route

Contains an array of computed routes (up to three) when you specify compute_alternatives_routes, and contains just one route when you don't. When this array contains multiple entries, the first one is the most recommended route. If the array is empty, then it means no route could be found.

fallback_info

FallbackInfo

In some cases when the server is not able to compute the route results with all of the input preferences, it may fallback to using a different way of computation. When fallback mode is used, this field contains detailed info about the fallback response. Otherwise this field is unset.

CustomRoute

Encapsulates a custom route computed based on the route objective specified by the customer. CustomRoute contains a route and a route token, which can be passed to NavSDK to reconstruct the custom route for turn by turn navigation.

Поля
route

Route

The route considered 'best' for the input route objective.

token

string

Web-safe base64 encoded route token that can be passed to NavSDK, which allows NavSDK to reconstruct the route during navigation, and in the event of rerouting honor the original intention when RoutesPreferred ComputeCustomRoutes is called. Customers should treat this token as an opaque blob.

FallbackInfo

Information related to how and why a fallback result was used. If this field is set, then it means the server used a different routing mode from your preferred mode as fallback.

Поля
routing_mode

FallbackRoutingMode

Routing mode used for the response. If fallback was triggered, the mode may be different from routing preference set in the original client request.

reason

FallbackReason

The reason why fallback response was used instead of the original response. This field is only populated when the fallback mode is triggered and the fallback response is returned.

FallbackReason

Reasons for using fallback response.

Перечисления
FALLBACK_REASON_UNSPECIFIED No fallback reason specified.
SERVER_ERROR A server error happened while calculating routes with your preferred routing mode, but we were able to return a result calculated by an alternative mode.
LATENCY_EXCEEDED We were not able to finish the calculation with your preferred routing mode on time, but we were able to return a result calculated by an alternative mode.

FallbackRoutingMode

Actual routing mode used for returned fallback response.

Перечисления
FALLBACK_ROUTING_MODE_UNSPECIFIED Не используется.
FALLBACK_TRAFFIC_UNAWARE Indicates the "TRAFFIC_UNAWARE" routing mode was used to compute the response.
FALLBACK_TRAFFIC_AWARE Indicates the "TRAFFIC_AWARE" routing mode was used to compute the response.

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

Encapsulates a location (a geographic point, and an optional heading).

Поля
lat_lng

LatLng

The waypoint's geographic coordinates.

heading

Int32Value

The compass heading associated with the direction of the flow of traffic. This value is used to specify the side of the road to use for pickup and drop-off. Heading values can be from 0 to 360, where 0 specifies a heading of due North, 90 specifies a heading of due East, etc. You can use this field only for DRIVE and TWO_WHEELER travel modes.

Маневр

A set of values that specify the navigation action to take for the current step (eg, turn left, merge, straight, etc.).

Перечисления
MANEUVER_UNSPECIFIED Не используется.
TURN_SLIGHT_LEFT Turn slightly to the left.
TURN_SHARP_LEFT Turn sharply to the left.
UTURN_LEFT Make a left u-turn.
TURN_LEFT Поверните налево.
TURN_SLIGHT_RIGHT Turn slightly to the right.
TURN_SHARP_RIGHT Turn sharply to the right.
UTURN_RIGHT Make a right u-turn.
TURN_RIGHT Поверните направо.
STRAIGHT Езжайте прямо.
RAMP_LEFT Take the left ramp.
RAMP_RIGHT Take the right ramp.
MERGE Merge into traffic.
FORK_LEFT Take the left fork.
FORK_RIGHT Take the right fork.
FERRY Take the ferry.
FERRY_TRAIN Take the train leading onto the ferry.
ROUNDABOUT_LEFT Turn left at the roundabout.
ROUNDABOUT_RIGHT Turn right at the roundabout.
Поля
maneuver

Maneuver

Encapsulates the navigation instructions for the current step (eg, turn left, merge, straight, etc.). This field determines which icon to display.

instructions

string

Instructions for navigating this step.

Полилиния

Encapsulates an encoded polyline.

Поля
Union field polyline_type . Encapsulates the type of polyline. Defaults to encoded_polyline. polyline_type can be only one of the following:
encoded_polyline

string

The string encoding of the polyline using the polyline encoding algorithm

geo_json_linestring

Struct

Specifies a polyline using the GeoJSON LineString format

PolylineEncoding

Specifies the preferred type of polyline to be returned.

Перечисления
POLYLINE_ENCODING_UNSPECIFIED No polyline type preference specified. Defaults to ENCODED_POLYLINE .
ENCODED_POLYLINE Specifies a polyline encoded using the polyline encoding algorithm .
GEO_JSON_LINESTRING Specifies a polyline using the GeoJSON LineString format

PolylineQuality

A set of values that specify the quality of the polyline.

Перечисления
POLYLINE_QUALITY_UNSPECIFIED No polyline quality preference specified. Defaults to OVERVIEW .
HIGH_QUALITY Specifies a high-quality polyline - which is composed using more points than OVERVIEW , at the cost of increased response size. Use this value when you need more precision.
OVERVIEW Specifies an overview polyline - which is composed using a small number of points. Use this value when displaying an overview of the route. Using this option has a lower request latency compared to using the HIGH_QUALITY option.

Маршрут

Encapsulates a route, which consists of a series of connected road segments that join beginning, ending, and intermediate waypoints.

Поля
legs[]

RouteLeg

A collection of legs (path segments between waypoints) that make-up the route. Each leg corresponds to the trip between two non- via Waypoints. For example, a route with no intermediate waypoints has only one leg. A route that includes one non- via intermediate waypoint has two legs. A route that includes one via intermediate waypoint has one leg. The order of the legs matches the order of Waypoints from origin to intermediates to destination .

distance_meters

int32

The travel distance of the route, in meters.

duration

Duration

The length of time needed to navigate the route. If you set the routing_preference to TRAFFIC_UNAWARE , then this value is the same as static_duration . If you set the routing_preference to either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL , then this value is calculated taking traffic conditions into account.

static_duration

Duration

The duration of traveling through the route without taking traffic conditions into consideration.

polyline

Polyline

The overall route polyline. This polyline will be the combined polyline of all legs .

description

string

A description of the route.

warnings[]

string

An array of warnings to show when displaying the route.

viewport

Viewport

The viewport bounding box of the polyline.

travel_advisory

RouteTravelAdvisory

Additional information about the route.

optimized_intermediate_waypoint_index[]

int32

If ComputeRoutesRequest.optimize_waypoint_order is set to true, this field contains the optimized ordering of intermediates waypoints. otherwise, this field is empty. For example, suppose the input is Origin: LA; Intermediates: Dallas, Bangor, Phoenix; Destination: New York; and the optimized intermediate waypoint order is: Phoenix, Dallas, Bangor. Then this field contains the values [2, 0, 1]. The index starts with 0 for the first intermediate waypoint.

RouteLeg

Encapsulates a segment between non- via waypoints.

Поля
distance_meters

int32

The travel distance of the route leg, in meters.

duration

Duration

The length of time needed to navigate the leg. If the route_preference is set to TRAFFIC_UNAWARE , then this value is the same as static_duration . If the route_preference is either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL , then this value is calculated taking traffic conditions into account.

static_duration

Duration

The duration of traveling through the leg, calculated without taking traffic conditions into consideration.

polyline

Polyline

The overall polyline for this leg. This includes that each step 's polyline.

start_location

Location

The start location of this leg. This might be different from the provided origin . For example, when the provided origin is not near a road, this is a point on the road.

end_location

Location

The end location of this leg. This might be different from the provided destination . For example, when the provided destination is not near a road, this is a point on the road.

steps[]

RouteLegStep

An array of steps denoting segments within this leg. Each step represents one navigation instruction.

travel_advisory

RouteLegTravelAdvisory

Encapsulates the additional information that the user should be informed about, such as possible traffic zone restriction etc. on a route leg.

RouteLegStep

Encapsulates a segment of a RouteLeg . A step corresponds to a single navigation instruction. Route legs are made up of steps.

Поля
distance_meters

int32

The travel distance of this step, in meters. In some circumstances, this field might not have a value.

static_duration

Duration

The duration of travel through this step without taking traffic conditions into consideration. In some circumstances, this field might not have a value.

polyline

Polyline

The polyline associated with this step.

start_location

Location

The start location of this step.

end_location

Location

The end location of this step.

navigation_instruction

NavigationInstruction

Navigation instructions.

travel_advisory

RouteLegStepTravelAdvisory

Encapsulates the additional information that the user should be informed about, such as possible traffic zone restriction on a leg step.

RouteLegStepTravelAdvisory

Encapsulates the additional information that the user should be informed about, such as possible traffic zone restriction on a leg step.

Поля
speed_reading_intervals[]

SpeedReadingInterval

Speed reading intervals detailing traffic density. Applicable in case of TRAFFIC_AWARE and TRAFFIC_AWARE_OPTIMAL routing preferences. The intervals cover the entire polyline of the RouteLegStep without overlap. The start point of a specified interval is the same as the end point of the preceding interval.

Пример:

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

RouteLegTravelAdvisory

Encapsulates the additional information that the user should be informed about, such as possible traffic zone restriction etc. on a route leg.

Поля
toll_info

TollInfo

Encapsulates information about tolls on the specific RouteLeg. This field is only populated if we expect there are tolls on the RouteLeg. If this field is set but the estimated_price subfield is not populated, we expect that road contains tolls but we do not know an estimated price. If this field does not exist, then there is no toll on the RouteLeg.

speed_reading_intervals[]

SpeedReadingInterval

Speed reading intervals detailing traffic density. Applicable in case of TRAFFIC_AWARE and TRAFFIC_AWARE_OPTIMAL routing preferences. The intervals cover the entire polyline of the RouteLg without overlap. The start point of a specified interval is the same as the end point of the preceding interval.

Пример:

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

RouteMatrixDestination

A single destination for ComputeRouteMatrixRequest

Поля
waypoint

Waypoint

Необходимый. Destination waypoint

RouteMatrixElement

Encapsulates route information computed for an origin/destination pair in the ComputeRouteMatrix API. This proto can be streamed to the client.

Поля
origin_index

int32

Zero-based index of the origin in the request.

destination_index

int32

Zero-based index of the destination in the request.

status

Status

Error status code for this element.

condition

RouteMatrixElementCondition

Indicates whether the route was found or not. Independent of status.

distance_meters

int32

The travel distance of the route, in meters.

duration

Duration

The length of time needed to navigate the route. If you set the routing_preference to TRAFFIC_UNAWARE , then this value is the same as static_duration . If you set the routing_preference to either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL , then this value is calculated taking traffic conditions into account.

static_duration

Duration

The duration of traveling through the route without taking traffic conditions into consideration.

travel_advisory

RouteTravelAdvisory

Additional information about the route. For example: restriction information and toll information

fallback_info

FallbackInfo

In some cases when the server is not able to compute the route with the given preferences for this particular origin/destination pair, it may fall back to using a different mode of computation. When fallback mode is used, this field contains detailed information about the fallback response. Otherwise this field is unset.

RouteMatrixElementCondition

The condition of the route being returned.

Перечисления
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED Only used when the status of the element is not OK.
ROUTE_EXISTS A route was found, and the corresponding information was filled out for the element.
ROUTE_NOT_FOUND No route could be found. Fields containing route information, such as distance_meters or duration , will not be filled out in the element.

RouteMatrixOrigin

A single origin for ComputeRouteMatrixRequest

Поля
waypoint

Waypoint

Необходимый. Origin waypoint

route_modifiers

RouteModifiers

Необязательный. Modifiers for every route that takes this as the origin

RouteModifiers

Encapsulates a set of optional conditions to satisfy when calculating the routes.

Поля
avoid_tolls

bool

Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to the DRIVE and TWO_WHEELER travel modes.

avoid_highways

bool

Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to the DRIVE and TWO_WHEELER travel modes.

avoid_ferries

bool

Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to the DRIVE and TWO_WHEELER travel modes.

avoid_indoor

bool

Specifies whether to avoid navigating indoors where reasonable. Preference will be given to routes not containing indoor navigation. Applies only to the WALK travel mode.

vehicle_info

VehicleInfo

Specifies the vehicle information.

toll_passes[]

TollPass

Encapsulates information about toll passes. If toll passes are provided, the API tries to return the pass price. If toll passes are not provided, the API treats the toll pass as unknown and tries to return the cash price. Applies only to the DRIVE and TWO_WHEELER travel modes.

RouteObjective

Encapsulates an objective to optimize for by ComputeCustomRoutes.

Поля
rate_card

RateCard

The RateCard objective.

RateCard

Encapsulates a RateCard route objective.

Поля
cost_per_minute

MonetaryCost

Необязательный. Cost per minute.

cost_per_km

MonetaryCost

Необязательный. Cost per kilometer.

include_tolls

bool

Необязательный. Whether to include toll cost in the overall cost.

MonetaryCost

Encapsulates the cost used in the rate card.

Поля
value

double

Необходимый. The cost value in local currency inferred from the request.

RouteTravelAdvisory

Encapsulates the additional information that the user should be informed about, such as possible traffic zone restriction etc.

Поля
toll_info

TollInfo

Encapsulates information about tolls on the Route. This field is only populated if we expect there are tolls on the Route. If this field is set but the estimated_price subfield is not populated, we expect that road contains tolls but we do not know an estimated price. If this field is not set, then we expect there is no toll on the Route.

speed_reading_intervals[]

SpeedReadingInterval

Speed reading intervals detailing traffic density. Applicable in case of TRAFFIC_AWARE and TRAFFIC_AWARE_OPTIMAL routing preferences. The intervals cover the entire polyline of the route without overlap. The start point of a specified interval is the same as the end point of the preceding interval.

Пример:

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

RouteTravelMode

A set of values used to specify the mode of travel.

Перечисления
TRAVEL_MODE_UNSPECIFIED No travel mode specified. Defaults to DRIVE .
DRIVE Travel by passenger car.
BICYCLE Travel by bicycle.
WALK Travel by walking.
TWO_WHEELER Two-wheeled, motorized vehicle. For example, motorcycle. Note that this differs from the BICYCLE travel mode which covers human-powered mode.
TAXI

Travel by licensed taxi, which may allow the vehicle to travel on designated taxi lanes in some areas.

TAXI mode is an experimental feature. If customer requests TAXI route in a city where taxi lane data is not available, a DRIVE route is returned.

RoutingPreference

A set of values that specify factors to take into consideration when calculating the route.

Перечисления
ROUTING_PREFERENCE_UNSPECIFIED No routing preference specified. Default to TRAFFIC_AWARE .
TRAFFIC_UNAWARE Computes routes without taking traffic conditions into consideration. Suitable when traffic conditions don't matter. Using this value produces the lowest latency.
TRAFFIC_AWARE Calculates routes taking traffic conditions into consideration. In contrast to TRAFFIC_AWARE_OPTIMAL , some optimizations are applied to significantly reduce latency.
TRAFFIC_AWARE_OPTIMAL Calculates the routes taking traffic conditions into consideration, without applying most performance optimizations. Using this value produces the highest latency.

SpeedReadingInterval

Traffic density indicator on a contiguous segment of a polyline or path. Given a path with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval defines an interval and describes its traffic using the following categories.

Поля
start_polyline_point_index

int32

The starting index of this interval in the polyline. In JSON, when the index is 0, the field appears to be unpopulated.

end_polyline_point_index

int32

The ending index of this interval in the polyline. In JSON, when the index is 0, the field appears to be unpopulated.

speed

Speed

Traffic speed in this interval.

Скорость

The classification of polyline speed based on traffic data.

Перечисления
SPEED_UNSPECIFIED Значение по умолчанию. This value is unused.
NORMAL Normal speed, no slowdown is detected.
SLOW Slowdown detected, but no traffic jam formed.
TRAFFIC_JAM Traffic jam detected.

TollInfo

Encapsulates toll information on a Route or on a RouteLeg .

Поля
estimated_price[]

Money

The monetary amount of tolls for the corresponding Route or RouteLeg. This list contains a money amount for each currency that is expected to be charged by the toll stations. Typically this list will contain only one item for routes with tolls in one currency. For international trips, this list may contain multiple items to reflect tolls in different currencies.

TollPass

List of toll passes around the world that we support.

Перечисления
TOLL_PASS_UNSPECIFIED Не используется. If this value is used, then the request fails.
AU_ETOLL_TAG One of many Sydney toll pass providers. https://www.myetoll.com.au
AU_EWAY_TAG One of many Sydney toll pass providers. https://www.tollpay.com.au/
AU_LINKT Australia-wide toll pass. See additional details at https://www.linkt.com.au/ .
AR_TELEPASE Argentina toll pass. See additional details at https://telepase.com.ar
BR_AUTO_EXPRESO Brazil toll pass. See additional details at https://www.autoexpreso.com
BR_CONECTCAR Brazil toll pass. See additional details at https://conectcar.com .
BR_MOVE_MAIS Brazil toll pass. See additional details at https://movemais.com .
BR_PASSA_RAPIDO Brazil toll pass. See additional details at https://pasorapido.gob.do/
BR_SEM_PARAR Brazil toll pass. See additional details at https://www.semparar.com.br .
BR_TAGGY Brazil toll pass. See additional details at https://taggy.com.br .
BR_VELOE Brazil toll pass. See additional details at https://veloe.com.br/site/onde-usar .
CA_US_AKWASASNE_SEAWAY_CORPORATE_CARD Canada to United States border crossing.
CA_US_AKWASASNE_SEAWAY_TRANSIT_CARD Canada to United States border crossing.
CA_US_BLUE_WATER_EDGE_PASS Ontario, Canada to Michigan, United States border crossing.
CA_US_CONNEXION Ontario, Canada to Michigan, United States border crossing.
CA_US_NEXUS_CARD Canada to United States border crossing.
ID_E_TOLL Индонезия. E-card provided by multiple banks used to pay for tolls. All e-cards via banks are charged the same so only one enum value is needed. Eg 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 India, HP state plate exemption.
MX_TAG_IAVE Mexico toll pass.
MX_TAG_TELEVIA Mexico toll pass company. One of many operating in Mexico City. See additional details at https://www.televia.com.mx .
MX_VIAPASS Mexico toll pass. See additional details at https://www.viapass.com.mx/viapass/web_home.aspx .
US_AL_FREEDOM_PASS AL, USA.
US_AK_ANTON_ANDERSON_TUNNEL_BOOK_OF_10_TICKETS AK, USA.
US_CA_FASTRAK CA, USA.
US_CA_FASTRAK_CAV_STICKER Indicates driver has any FasTrak pass in addition to the DMV issued Clean Air Vehicle (CAV) sticker. https://www.bayareafastrak.org/en/guide/doINeedFlex.shtml
US_CO_EXPRESSTOLL CO, USA.
US_CO_GO_PASS CO, USA.
US_DE_EZPASSDE DE, USA.
US_FL_BOB_SIKES_TOLL_BRIDGE_PASS FL, USA.
US_FL_DUNES_COMMUNITY_DEVELOPMENT_DISTRICT_EXPRESSCARD FL, USA.
US_FL_EPASS FL, USA.
US_FL_GIBA_TOLL_PASS FL, USA.
US_FL_LEEWAY FL, USA.
US_FL_SUNPASS FL, USA.
US_FL_SUNPASS_PRO FL, USA.
US_IL_EZPASSIL IL, USA.
US_IL_IPASS IL, USA.
US_IN_EZPASSIN IN, USA.
US_KS_BESTPASS_HORIZON KS, USA.
US_KS_KTAG KS, USA.
US_KS_NATIONALPASS KS, USA.
US_KS_PREPASS_ELITEPASS KS, USA.
US_LA_GEAUXPASS LA, USA.
US_LA_TOLL_TAG LA, USA.
US_MA_EZPASSMA MA, USA.
US_MD_EZPASSMD MD, USA.
US_ME_EZPASSME ME, USA.
US_MI_AMBASSADOR_BRIDGE_PREMIER_COMMUTER_CARD MI, USA.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG MI, USA.
US_MI_IQ_PROX_CARD MI, USA.
US_MI_MACKINAC_BRIDGE_MAC_PASS MI, USA.
US_MI_NEXPRESS_TOLL MI, USA.
US_MN_EZPASSMN MN, USA.
US_NC_EZPASSNC NC, USA.
US_NC_PEACH_PASS NC, USA.
US_NC_QUICK_PASS NC, USA.
US_NH_EZPASSNH NH, USA.
US_NJ_DOWNBEACH_EXPRESS_PASS NJ, USA.
US_NJ_EZPASSNJ NJ, USA.
US_NY_EXPRESSPASS NY, USA.
US_NY_EZPASSNY NY, USA.
US_OH_EZPASSOH OH, USA.
US_PA_EZPASSPA PA, USA.
US_RI_EZPASSRI RI, USA.
US_SC_PALPASS SC, USA.
US_TX_BANCPASS TX, USA.
US_TX_DEL_RIO_PASS TX, USA.
US_TX_EFAST_PASS TX, USA.
US_TX_EAGLE_PASS_EXPRESS_CARD TX, USA.
US_TX_EPTOLL TX, USA.
US_TX_EZ_CROSS TX, USA.
US_TX_EZTAG TX, USA.
US_TX_LAREDO_TRADE_TAG TX, USA.
US_TX_PLUSPASS TX, USA.
US_TX_TOLLTAG TX, USA.
US_TX_TXTAG TX, USA.
US_TX_XPRESS_CARD TX, USA.
US_UT_ADAMS_AVE_PARKWAY_EXPRESSCARD UT, USA.
US_VA_EZPASSVA VA, USA.
US_WA_BREEZEBY WA, USA.
US_WA_GOOD_TO_GO WA, USA.
US_WV_EZPASSWV WV, USA.
US_WV_MEMORIAL_BRIDGE_TICKETS WV, USA.
US_WV_NEWELL_TOLL_BRIDGE_TICKET WV, USA.

Единицы

A set of values that specify the unit of measure used in the display.

Перечисления
UNITS_UNSPECIFIED Units of measure not specified. Defaults to the unit of measure inferred from the request.
METRIC Metric units of measure.
IMPERIAL Imperial (English) units of measure.

VehicleEmissionType

A set of values describing the vehicle's emission type. Applies only to the DRIVE travel mode.

Перечисления
VEHICLE_EMISSION_TYPE_UNSPECIFIED No emission type specified. Default to GASOLINE.
GASOLINE Gasoline/petrol fueled vehicle.
ELECTRIC Electricity powered vehicle.
HYBRID Hybrid fuel (such as gasoline + electric) vehicle.

VehicleInfo

Encapsulates the vehicle information, such as the license plate last character.

Поля
emission_type

VehicleEmissionType

Describes the vehicle's emission type. Applies only to the DRIVE travel mode.

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

Encapsulates a waypoint. Waypoints mark both the beginning and end of a route, and include intermediate stops along the route.

Поля
via

bool

Marks this waypoint as a milestone rather a stopping point. For each non-via waypoint in the request, the response appends an entry to the legs array to provide the details for stopovers on that leg of the trip. Set this value to true when you want the route to pass through this waypoint without stopping over. Via waypoints don't cause an entry to be added to the legs array, but they do route the journey through the waypoint. You can only set this value on waypoints that are intermediates. The request fails if you set this field on terminal waypoints. If ComputeRoutesRequest.optimize_waypoint_order is set to true then this field cannot be set to true; otherwise, the request fails.

vehicle_stopover

bool

Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pickup or drop-off. When you set this value, the calculated route won't include non- via waypoints on roads that are unsuitable for pickup and drop-off. This option works only for DRIVE and TWO_WHEELER travel modes, and when the location_type is location .

side_of_road

bool

Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option works only for 'DRIVE' and 'TWO_WHEELER' travel modes, and when the 'location_type' is set to 'location'.

Union field location_type . Different ways to represent a location. location_type can be only one of the following:
location

Location

A point specified using geographic coordinates, including an optional heading.

place_id

string

The POI Place ID associated with the waypoint.