Package google.maps.routing.v2

Индекс

Маршруты

API маршрутов.

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

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 не рекомендует использовать маску поля ответа с подстановочным знаком ( * ), потому что:

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

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 ), потому что:

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

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

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

Поля
origins[]

RouteMatrixOrigin

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

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

RouteMatrixDestination

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

travel_ mode

RouteTravelMode

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

routing_ preference

RoutingPreference

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

departure_ time

Timestamp

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

arrival_ time

Timestamp

Необязательный. Время прибытия. ПРИМЕЧАНИЕ. Можно установить только в том случае, если для RouteTravelMode установлено значение TRANSIT . Вы можете указать departure_time или arrival_time , но не оба одновременно.

language_ code

string

Необязательный. Код языка BCP-47, например «en-US» или «sr-Latn». Дополнительные сведения см. в разделе Идентификатор локали Unicode . Список поддерживаемых языков см. в разделе «Поддержка языков» . Если вы не укажете это значение, язык отображения будет определяться на основе местоположения первого источника.

region_ code

string

Необязательный. Код региона в виде двухсимвольного значения ccTLD («домен верхнего уровня»). Дополнительную информацию см. в разделе Домены верхнего уровня с кодом страны .

units

Units

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

extra_ computations[]

ExtraComputation

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

traffic_ model

TrafficModel

Необязательный. Указывает предположения, которые следует использовать при расчете времени в пробке. Этот параметр влияет на значение, возвращаемое в поле длительности в RouteMatrixElement , которое содержит прогнозируемое время в трафике на основе исторических средних значений. RoutingPreferenceTRAFFIC_AWARE_OPTIMAL , а RouteTravelModeDRIVE . По умолчанию используется BEST_GUESS , если трафик запрошен, а TrafficModel не указан.

transit_ preferences

TransitPreferences

Необязательный. Указывает предпочтения, влияющие на маршрут, возвращаемый для TRANSIT маршрутов. ПРИМЕЧАНИЕ. transit_preferences можно указать только в том случае, если для RouteTravelMode установлено значение TRANSIT .

Дополнительные вычисления

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

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Не используется. Запросы, содержащие это значение, не будут выполнены.
TOLLS Информация о дорожных сборах для элемента(ов) матрицы.

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

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

Необязательный. Время отправления. Если вы не установите это значение, то по умолчанию это значение будет соответствовать времени, когда вы сделали запрос. ПРИМЕЧАНИЕ. Вы можете указать departure_time в прошлом только тогда, когда для RouteTravelMode установлено значение TRANSIT . Транзитные поездки доступны на срок до 7 дней в прошлом или 100 дней в будущем.

arrival_ time

Timestamp

Необязательный. Время прибытия. ПРИМЕЧАНИЕ. Можно установить только в том случае, если для RouteTravelMode установлено значение TRANSIT . Вы можете указать departure_time или arrival_time , но не оба одновременно. Транзитные поездки доступны на срок до 7 дней в прошлом или на 100 дней в будущем.

compute_ alternative_ routes

bool

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

route_ modifiers

RouteModifiers

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

language_ code

string

Необязательный. Код языка BCP-47, например «en-US» или «sr-Latn». Дополнительные сведения см. в разделе Идентификатор локали Unicode . Список поддерживаемых языков см. в разделе «Поддержка языков» . Если вы не укажете это значение, язык отображения будет определяться на основе местоположения запроса маршрута.

region_ code

string

Необязательный. Код региона в виде двухсимвольного значения ccTLD («домен верхнего уровня»). Дополнительную информацию см. в разделе Домены верхнего уровня с кодом страны .

units

Units

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

optimize_ waypoint_ order

bool

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

requested_ reference_ routes[]

ReferenceRoute

Необязательный. Указывает, какие эталонные маршруты следует рассчитывать в рамках запроса в дополнение к маршруту по умолчанию. Эталонный маршрут — это маршрут, цель расчета которого отличается от маршрута по умолчанию. Например, расчет эталонного маршрута FUEL_EFFICIENT учитывает различные параметры, которые позволят создать оптимальный маршрут с экономией топлива. При использовании этой функции ищите route_labels на результирующих маршрутах.

extra_ computations[]

ExtraComputation

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

traffic_ model

TrafficModel

Необязательный. Указывает предположения, которые следует использовать при расчете времени в пробке. Этот параметр влияет на значение, возвращаемое в поле длительности в Route и RouteLeg , которое содержит прогнозируемое время в трафике на основе исторических средних значений. TrafficModel доступен только для запросов, в которых для RoutingPreference установлено значение TRAFFIC_AWARE_OPTIMAL , а для RouteTravelMode — значение DRIVE . По умолчанию используется BEST_GUESS , если трафик запрошен, а TrafficModel не указан.

transit_ preferences

TransitPreferences

Необязательный. Указывает предпочтения, влияющие на маршрут, возвращаемый для TRANSIT маршрутов. ПРИМЕЧАНИЕ. transit_preferences можно указать только в том случае, если для RouteTravelMode установлено значение TRANSIT .

Дополнительные вычисления

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

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Не используется. Запросы, содержащие это значение, не будут выполнены.
TOLLS Информация о платных маршрутах.
FUEL_CONSUMPTION Ориентировочный расход топлива по маршруту(ам).
TRAFFIC_ON_POLYLINE Полилинии с учетом трафика для маршрутов.
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions представлены в виде текстовой строки в формате HTML. Этот контент предназначен для чтения «как есть». Этот контент предназначен только для отображения. Не анализируйте его программно.
FLYOVER_INFO_ON_POLYLINE Информация о эстакаде для маршрута(ов). Для возврата этой информации необходимо указать маску поля routes.polyline_details.flyover_info . В настоящее время эти данные будут заполнены только для некоторых метрополитенов Индии. Эта функция является экспериментальной, поэтому артикул/стоимость могут быть изменены.
NARROW_ROAD_INFO_ON_POLYLINE Информация об узких дорогах для маршрута(ов). Для возврата этой информации необходимо указать маску поля routes.polyline_details.narrow_road_info . В настоящее время эти данные будут заполнены только для некоторых метрополитенов Индии. Эта функция является экспериментальной, поэтому артикул/стоимость могут быть изменены.

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

Поддерживаемый эталонный маршрут в ComputeRoutesRequest.

Перечисления
REFERENCE_ROUTE_UNSPECIFIED Не используется. Запросы, содержащие это значение, завершаются неудачно.
FUEL_EFFICIENT Экономичный маршрут.
SHORTER_DISTANCE

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

В запросах DRIVE эта функция отдает предпочтение более короткому расстоянию, а не комфорту вождения. Например, он может предпочитать местные дороги автомагистралям, выбирать грунтовые дороги, проезжать через парковки и т. д. Эта функция не возвращает данные о маневрах, которые Google Maps считает незаконными.

Для запросов BICYCLE и TWO_WHEELER эта функция возвращает маршруты, аналогичные тем, которые возвращаются, если вы не указываете requested_reference_routes .

Эта функция несовместима ни с какими другими режимами путешествия, через промежуточные точки optimize_waypoint_order ; такие запросы не будут выполнены. Однако вы можете использовать его с любым routing_preference .

ComputeRoutesResponse

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

Поля
routes[]

Route

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

fallback_ info

FallbackInfo

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

geocoding_ results

GeocodingResults

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

FallbackInfo

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

Поля
routing_ mode

FallbackRoutingMode

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

reason

FallbackReason

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

FallbackПричина

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

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

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

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

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

Геокодированная путевая точка

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

Поля
geocoder_ status

Status

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

type[]

string

Тип(ы) результата в виде нуля или более тегов типа. Поддерживаемые типы: типы адресов и типы компонентов адреса .

partial_ match

bool

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

place_ id

string

Идентификатор места для этого результата.

intermediate_ waypoint_ request_ index

int32

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

Результаты геокодирования

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

Поля
origin

GeocodedWaypoint

Исходная геокодированная путевая точка.

destination

GeocodedWaypoint

Геокодированная путевая точка пункта назначения.

intermediates[]

GeocodedWaypoint

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

Локализованноевремя

Локализованное описание времени.

Поля
time

LocalizedText

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

time_ zone

string

Содержит часовой пояс. Значением является название часового пояса, определенное в базе данных часовых поясов IANA , например «Америка/Нью_Йорк».

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

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

Поля
lat_ lng

LatLng

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

heading

Int32Value

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

Маневр

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

Перечисления
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 На круговом перекрестке поверните направо.
DEPART Начальный маневр.
NAME_CHANGE Используется для обозначения изменения названия улицы.

Инкапсулирует инструкции навигации для RouteLegStep .

Поля
maneuver

Maneuver

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

instructions

string

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

Полилиния

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

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

string

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

geo_ json_ linestring

Struct

Указывает полилинию с использованием формата GeoJSON LineString .

ПолилинияПодробнее

Детали, соответствующие заданному индексу или непрерывному сегменту полилинии. Для полилинии с точками P_0, P_1,..., P_N (индекс, начинающийся с нуля), PolylineDetails определяет интервал и связанные метаданные.

Поля
flyover_ info[]

FlyoverInfo

Детали эстакады вдоль полилинии.

narrow_ road_ info[]

NarrowRoadInfo

Детали узкой дороги вдоль полилинии.

FlyoverИнформация

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

Поля
flyover_ presence

RoadFeatureState

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

polyline_ point_ index

PolylinePointIndex

Расположение информации, связанной с эстакадой, вдоль полилинии.

УзкаяДорогаИнформация

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

Поля
narrow_ road_ presence

RoadFeatureState

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

polyline_ point_ index

PolylinePointIndex

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

ПолилинияПоинтИндекс

Инкапсулирует начальный и конечный индексы полилинии. В тех случаях, когда данные соответствуют одной точке, start_index и end_index будут равны.

Поля
start_ index

int32

Начальный индекс детали в полилинии.

end_ index

int32

Конечный индекс этой детали в полилинии.

ДорогаХарактеристикаСостояние

Инкапсулирует состояния объектов дороги вдоль участка полилинии.

Перечисления
ROAD_FEATURE_STATE_UNSPECIFIED Состояние объекта дороги не было рассчитано (значение по умолчанию).
EXISTS Объект дороги существует.
DOES_NOT_EXIST Объект дороги не существует.

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

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

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

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

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

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

Маршрут

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

Поля
route_ labels[]

RouteLabel

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

legs[]

RouteLeg

Набор участков (сегментов пути между путевыми точками), составляющих маршрут. Каждый этап соответствует поездке между двумя Waypoints , не являющимися 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

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

localized_ values

RouteLocalizedValues

Текстовые представления свойств Route .

route_ token

string

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

ПРИМЕЧАНИЕ. Route.route_token доступен только для запросов, в которых для ComputeRoutesRequest.routing_preference установлено значение TRAFFIC_AWARE или TRAFFIC_AWARE_OPTIMAL . Route.route_token не поддерживается для запросов с промежуточными точками Via.

polyline_ details

PolylineDetails

Содержит информацию о деталях вдоль полилинии.

МаршрутLocalizedValues

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

Поля
distance

LocalizedText

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

duration

LocalizedText

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

static_ duration

LocalizedText

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

transit_ fare

LocalizedText

Транзитный тариф представлен в текстовом виде.

Метка маршрута

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

Перечисления
ROUTE_LABEL_UNSPECIFIED По умолчанию – не используется.
DEFAULT_ROUTE «Лучший» маршрут по умолчанию, возвращаемый для расчета маршрута.
DEFAULT_ROUTE_ALTERNATE Альтернатива «лучшему» маршруту по умолчанию. Подобные маршруты будут возвращены, если указан параметр compute_alternative_routes .
FUEL_EFFICIENT Экономичный маршрут. Маршруты, отмеченные этим значением, считаются оптимизированными с учетом параметров Eco, таких как расход топлива.
SHORTER_DISTANCE Маршрут с более коротким расстоянием. Это экспериментальная функция.

МаршрутНога

Содержит сегмент между точками маршрута, не 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

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

localized_ values

RouteLegLocalizedValues

Текстовые представления свойств RouteLeg .

steps_ overview

StepsOverview

Обзорная информация о шагах в этом RouteLeg . Это поле заполняется только для ТРАНЗИТНЫХ маршрутов.

МаршрутЛегЛокализованныеЗначения

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

Поля
distance

LocalizedText

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

duration

LocalizedText

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

static_ duration

LocalizedText

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

ШагиОбзор

Предоставляет обзорную информацию о списке RouteLegStep .

Поля
multi_ modal_ segments[]

MultiModalSegment

Обобщенная информация о различных мультимодальных сегментах RouteLeg.steps . Это поле не заполняется, если RouteLeg не содержит мультимодальных сегментов в шагах.

Мультимодальный сегмент

Предоставляет сводную информацию о различных мультимодальных сегментах RouteLeg.steps . Мультимодальный сегмент определяется как один или несколько смежных RouteLegStep , имеющих одинаковый RouteTravelMode . Это поле не заполняется, если RouteLeg не содержит мультимодальных сегментов в шагах.

Поля
navigation_ instruction

NavigationInstruction

NavigationInstruction для мультимодального сегмента.

travel_ mode

RouteTravelMode

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

step_ start_ index

int32

Соответствующий индекс RouteLegStep , который является началом мультимодального сегмента.

step_ end_ index

int32

Соответствующий индекс RouteLegStep , который является концом мультимодального сегмента.

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

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

Поля
distance_ meters

int32

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

static_ duration

Duration

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

polyline

Polyline

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

start_ location

Location

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

end_ location

Location

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

navigation_ instruction

NavigationInstruction

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

travel_ advisory

RouteLegStepTravelAdvisory

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

localized_ values

RouteLegStepLocalizedValues

Текстовые представления свойств RouteLegStep .

transit_ details

RouteLegStepTransitDetails

Подробности, относящиеся к этому шагу, если режим движения — TRANSIT .

travel_ mode

RouteTravelMode

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

МаршрутЛегШтепЛокализованныеЗначения

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

Поля
distance

LocalizedText

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

static_ duration

LocalizedText

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

МаршрутНогаШагТранзитПодробнее

Дополнительная информация для RouteLegStep относящаяся к TRANSIT маршрутам.

Поля
stop_ details

TransitStopDetails

Информация об остановках прибытия и отправления шага.

localized_ values

TransitDetailsLocalizedValues

Текстовые представления свойств RouteLegStepTransitDetails .

headsign

string

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

headway

Duration

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

transit_ line

TransitLine

Информация о транзитной линии, используемой на этом этапе.

stop_ count

int32

Количество остановок от остановки отправления до остановки прибытия. Это количество включает остановку прибытия, но исключает остановку отправления. Например, если ваш маршрут отправляется от остановки A, проходит через остановки B и C и прибывает на остановку D,

stop_count

возвращает 3.

trip_ short_ text

string

Текст, который появляется в расписаниях и вывесках для обозначения пассажирами транзитной поездки. Текст должен однозначно идентифицировать поездку в течение дня обслуживания. Например, «538» — это trip_short_text поезда Amtrak, который отправляется из Сан-Хосе, Калифорния, в 15:10 по будням в Сакраменто, Калифорния.

TransitDetailsLocalizedValues

Локализованные описания значений RouteTransitDetails .

Поля
arrival_ time

LocalizedTime

Время в форматированном текстовом представлении с соответствующим часовым поясом.

departure_ time

LocalizedTime

Время в форматированном текстовом представлении с соответствующим часовым поясом.

Транзитная остановкаПодробнее

Подробности о транзитных остановках для RouteLegStep .

Поля
arrival_ stop

TransitStop

Информация об остановке прибытия на шаг.

arrival_ time

Timestamp

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

departure_ stop

TransitStop

Информация об остановке отправления на шаг.

departure_ time

Timestamp

Ориентировочное время выхода на шаг.

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

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

Поля
speed_ reading_ intervals[]

SpeedReadingInterval

ПРИМЕЧАНИЕ. Это поле в настоящее время не заполнено.

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

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

Поля
toll_ info

TollInfo

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

speed_ reading_ intervals[]

SpeedReadingInterval

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

Пример:

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

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

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

Поля
waypoint

Waypoint

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

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

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

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

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

localized_ values

LocalizedValues

Текстовые представления свойств RouteMatrixElement .

origin_ index

int32

Ноль индекс происхождения в запросе.

destination_ index

int32

Зоровый индекс назначения в запросе.

Локализованные

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

Поля
distance

LocalizedText

Расстояние перемещения представлено в текстовой форме.

duration

LocalizedText

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

static_ duration

LocalizedText

Продолжительность, представленная в форме текста, не принимая во внимание условия движения.

transit_ fare

LocalizedText

Транзитный тариф представлен в текстовой форме.

RoutematrixElementCondition

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

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

Routematrixorigin

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

Поля
waypoint

Waypoint

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

route_ modifiers

RouteModifiers

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

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

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

Поля
avoid_ tolls

bool

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

avoid_ highways

bool

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

avoid_ ferries

bool

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

avoid_ indoor

bool

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

vehicle_ info

VehicleInfo

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

toll_ passes[]

TollPass

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

RouteTraveladVisory

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

Поля
toll_ info

TollInfo

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

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).
fuel_ consumption_ microliters

int64

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

route_ restrictions_ partially_ ignored

bool

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

transit_ fare

Money

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

RouteTravelMode

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

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

RoutingPreference

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

Перечисления
ROUTING_PREFERENCE_UNSPECIFIED Не указано предпочтение маршрутизации. По умолчанию в TRAFFIC_UNAWARE .
TRAFFIC_UNAWARE Вычисляет маршруты, не принимая во внимание условия движения в прямом эфире. Подходит, когда условия движения не имеют значения или не применимы. Использование этого значения дает самую низкую задержку. ПРИМЕЧАНИЕ. Для RouteTravelMode DRIVE и TWO_WHEELER выбранные маршруты и продолжительность основаны на дорожной сети и средних условиях дорожного движения, а не на нынешних дорожных условиях. Следовательно, маршруты могут включать дороги, которые временно закрыты. Результаты для данного запроса могут варьироваться со временем из -за изменений в дорожной сети, обновленных средних условий движения и распределенного характера услуги. Результаты также могут варьироваться между почти эквивалентными маршрутами в любое время или частоту.
TRAFFIC_AWARE Рассчитывает маршруты, принимая во внимание условия движения в прямом эфире. В отличие от TRAFFIC_AWARE_OPTIMAL , некоторые оптимизации применяются для значительного сокращения задержки.
TRAFFIC_AWARE_OPTIMAL Рассчитывает маршруты, принимая во внимание условия движения в прямом эфире, не применяя большинство оптимизаций производительности. Использование этого значения дает самую высокую задержку.

SpeedReadingInterval

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

Поля
start_ polyline_ point_ index

int32

Начальный индекс этого интервала в полилинии.

end_ polyline_ point_ index

int32

Конечный индекс этого интервала в полилинии.

Объединение поля speed_type .

speed_type может быть только одним из следующих:

speed

Speed

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

Скорость

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

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

Толлинфо

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

Поля
estimated_ price[]

Money

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

TollPass

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

Перечисления
TOLL_PASS_UNSPECIFIED Не используется. Если это значение используется, то запрос не удается.
AU_ETOLL_TAG Sydney Toll Pass. См. Дополнительную информацию по адресу https://www.myetoll.com.au .
AU_EWAY_TAG Sydney Toll Pass. См. Дополнительную информацию по адресу https://www.tollpay.com.au .
AU_LINKT Всемирная пропуск. Смотрите дополнительную информацию на https://www.linkt.com.au/ .
AR_TELEPASE Аргентина. См. Дополнительную информацию на https://telepase.com.ar
BR_AUTO_EXPRESO Бразильский пропуск. См. Дополнительную информацию на https://www.autoexpreso.com
BR_CONECTCAR Бразильский пропуск. Смотрите дополнительную информацию на https://conectcar.com .
BR_MOVE_MAIS Бразильский пропуск. Смотрите дополнительную информацию на https://movemais.com .
BR_PASSA_RAPIDO Бразильский пропуск. См. Дополнительную информацию на https://pasorapido.gob.do/
BR_SEM_PARAR Бразильский пропуск. Смотрите дополнительную информацию на https://www.semparar.com.br .
BR_TAGGY Бразильский пропуск. Смотрите дополнительную информацию на https://taggy.com.br .
BR_VELOE Бразильский пропуск. См. Дополнительную информацию на https://veloe.com.br/site/onde-usar .
CA_US_AKWASASNE_SEAWAY_CORPORATE_CARD Канада до пересечения границы Соединенных Штатов.
CA_US_AKWASASNE_SEAWAY_TRANSIT_CARD Канада до пересечения границы Соединенных Штатов.
CA_US_BLUE_WATER_EDGE_PASS Онтарио, Канада в Мичиган, Соединенные Штаты.
CA_US_CONNEXION Онтарио, Канада в Мичиган, Соединенные Штаты.
CA_US_NEXUS_CARD Канада до пересечения границы Соединенных Штатов.
ID_E_TOLL Индонезия. Электронная карта, предоставленная несколькими банками, используемыми для платы за проезд. Все электронные карты через банки взимаются одинаковые, поэтому необходимо только одно значение перечисления. Например - Bank Mandiri https://www.bankmandiri.co.id/e -money - bca https://www.bca.co.id/flazz - bni https://www.bni.co.id/id- id/ebanking/tapcash
IN_FASTAG Индия.
IN_LOCAL_HP_PLATE_EXEMPT Индия, HP State Plate Exemption.
JP_ETC Япония и т. Д. Электронная беспроводная система для сбора платы. https://www.go-etc.jp/
JP_ETC2 Япония и т. Д.2.0. Новая версия ETC с дальнейшей дисконтом и двунаправленной связи между устройствами на транспортных средствах и антеннами на дороге. https://www.go-etc.jp/etc2/index.html
MX_IAVE Мексика пропуск. https://iave.capufe.gob.mx/#/
MX_PASE Мексика https://www.pase.com.mx
MX_QUICKPASS Мексика https://operadoravial.com/quick-pass/
MX_SISTEMA_TELEPEAJE_CHIHUAHUA http://appsh.chihuahua.gob.mx/transparencia/?doc=/ingresos/telepeajeformato4.pdf
MX_TAG_IAVE Мексика
MX_TAG_TELEVIA Мексика Toll Pass Company. Один из многих действует в Мехико. См. Дополнительную информацию на https://www.televia.com.mx .
MX_TELEVIA Мексика Toll Pass Company. Один из многих действует в Мехико. https://www.televia.com.mx
MX_VIAPASS Мексика пропуск. См. Дополнительную информацию по адресу https://www.viaspans.com.mx/viasps/web_home.aspx .
US_AL_FREEDOM_PASS Ал, США.
US_AK_ANTON_ANDERSON_TUNNEL_BOOK_OF_10_TICKETS А.К., США.
US_CA_FASTRAK CA, США.
US_CA_FASTRAK_CAV_STICKER Указывает, что у водителя есть какой -либо проход Fastrak в дополнение к наклейке DMV, выпущенной чистым воздушным транспортным средством (CAV). 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_BCPASS Ми, США.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG Ми, США.
US_MI_IQ_PROX_CARD

Ми, США. Умерен, так как этот тип прохода больше не существует.

US_MI_IQ_TAG Ми, США.
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_AVI_TAG Техас, США.
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_FUEGO_TAG Техас, США.
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_MOV_PASS WV, США
US_WV_NEWELL_TOLL_BRIDGE_TICKET WV, США.

Trafficmodel

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

Перечисления
TRAFFIC_MODEL_UNSPECIFIED Неиспользованный. Если указано, по умолчанию по умолчанию BEST_GUESS .
BEST_GUESS Указывает, что возвращаемая duration должна быть лучшей оценкой времени в пути, учитывая то, что известно как об исторических условиях движения, так и в живом движении. Живой трафик становится все более важным, чем ближе к departure_time к сейчас.
PESSIMISTIC Указывает, что возвращаемая продолжительность должна быть длиннее, чем фактическое время в пути в большинство дней, хотя случайные дни с особенно плохими условиями движения могут превышать это значение.
OPTIMISTIC Указывает, что возвращаемая продолжительность должна быть короче, чем фактическое время в пути в большинство дней, хотя случайные дни с особенно хорошими условиями движения могут быть быстрее, чем это значение.

Транстирантность

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

Поля
name

string

Название этого транзитного агентства.

phone_ number

string

Форматированный номер телефона транзитного агентства.

uri

string

Ури транзитного агентства.

Транзитная линия

Содержит информацию о транзитной линии, используемой на этом этапе.

Поля
agencies[]

TransitAgency

Транзитное агентство (или агентства), которое управляет этой транзитной линией.

name

string

Полное имя этой транзитной линии, например, «8 Avenue Local».

uri

string

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

color

string

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

icon_ uri

string

URI для значка, связанной с этой линией.

name_ short

string

Короткое название этой транзитной линии. Это имя обычно будет номером строки, таким как «M7» или «355».

text_ color

string

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

vehicle

TransitVehicle

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

Транзитпрофессионалы

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

Поля
allowed_ travel_ modes[]

TransitTravelMode

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

routing_ preference

TransitRoutingPreference

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

Трансзазационная операция

Определяет предпочтения маршрутизации для транзитных маршрутов.

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

Transittravelmode

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

Перечисления
TRANSIT_TRAVEL_MODE_UNSPECIFIED Не указан режим транзитного перемещения.
BUS Путешествие на автобусе.
SUBWAY Путешествие по метро.
TRAIN Путешествие на поезде.
LIGHT_RAIL Путешествие по скоростным трамвам или трамвам.
RAIL Путешествие по железной дороге. Это эквивалентно комбинации SUBWAY , TRAIN и LIGHT_RAIL .

Транзитстоп

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

Поля
name

string

Название транзитной остановки.

location

Location

Расположение остановки, выраженное в координатах широты/долготы.

Транзит

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

Поля
name

LocalizedText

Название этого автомобиля, капитализированное.

type

TransitVehicleType

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

icon_ uri

string

URI для значка, связанной с этим типом транспортного средства.

local_ icon_ uri

string

URI для значка, связанного с этим типом транспортного средства, на основе местных транспортных вывесок.

Transitvehicletype

Тип транспортных средств для транзитных маршрутов.

Перечисления
TRANSIT_VEHICLE_TYPE_UNSPECIFIED Неиспользованный.
BUS Автобус.
CABLE_CAR Автомобиль, который работает на кабеле, обычно на земле. Воздушные канатные дорожки могут быть типа GONDOLA_LIFT .
COMMUTER_TRAIN Пригородная железная дорога.
FERRY Перевозить.
FUNICULAR Автомобиль, который подтягивается крутым наклоном кабелем. Фуникуляр, как правило, состоит из двух автомобилей, каждый автомобиль выступает в качестве противовес для другой.
GONDOLA_LIFT Воздушная канатная машина.
HEAVY_RAIL Тяжелый рельс.
HIGH_SPEED_TRAIN Высокоскоростный поезд.
INTERCITY_BUS Межгоговый автобус.
LONG_DISTANCE_TRAIN На длинные дистанционные поезд.
METRO_RAIL Легкорель -транзит.
MONORAIL Монорельс.
OTHER Все остальные транспортные средства.
RAIL Железнодорожный.
SHARE_TAXI Доля такси - это своего рода автобус с возможностью бросить и забрать пассажиров в любом месте на своем маршруте.
SUBWAY Подземный легкоругольник.
TRAM Над наземным легкоругольником.
TROLLEYBUS Троллейбус.

Единицы

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

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

FehishemissionType

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

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

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

Содержит информацию о транспортном средстве, такую ​​как тип выбросов транспортного средства.

Поля
emission_ type

VehicleEmissionType

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

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

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

Поля
via

bool

На этой путевой точке отмечается как веха, а не остановка. Для каждой не VIA Waypoint в запросе ответ добавляет запись в массив legs , чтобы предоставить подробности остановок на этой ноге поездки. Установите это значение True, когда вы хотите, чтобы маршрут прошел через эту путевую точку, не останавливаясь. С через путевые точки не приводят к добавлению входа в массив legs , но они направляют путешествие по дорожной точке. Вы можете установить это значение только на путевые точки, которые являются промежуточными. Запрос не удается, если вы установите это поле на пути к терминалу. Если ComputeRoutesRequest.optimize_waypoint_order установлен на TRUE, то это поле не может быть установлено на TRUE; В противном случае запрос не удается.

vehicle_ stopover

bool

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

side_ of_ road

bool

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

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

Location

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

place_ id

string

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

address

string

Человеческий читаемый адрес или код плюс. Подробности см. на https://plus.codes .

,

Индекс

Маршруты

Маршруты API.

ComputerouteMatrix

rpc ComputeRouteMatrix( ComputeRouteMatrixRequest ) returns ( RouteMatrixElement )

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

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

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

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

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

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

rpc ComputeRoutes( ComputeRoutesRequest ) returns ( ComputeRoutesResponse )

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

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

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

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

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

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

ComputerouteMatrixRequest

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

Поля
origins[]

RouteMatrixOrigin

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

  • Сумма количества источников + количество направлений, указанных как place_id или address должна быть не больше 50.
  • Продукт количества происхождения × количество направлений должно быть не больше 625 в любом случае.
  • Продукт количества источников × количество направлений должно быть не больше 100, если routing_preference установлен на TRAFFIC_AWARE_OPTIMAL .
  • Продукт количества источников × количество направлений должно быть не больше 100, если Travel_Mode установлен на TRANSIT .
destinations[]

RouteMatrixDestination

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

travel_ mode

RouteTravelMode

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

routing_ preference

RoutingPreference

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

departure_ time

Timestamp

Необязательный. Время отъезда. Если вы не установите это значение, то это значение по умолчанию по умолчанию в то время, которое вы сделали запрос. ПРИМЕЧАНИЕ. Вы можете указать departure_time только в прошлом, когда RouteTravelMode установлен на TRANSIT .

arrival_ time

Timestamp

Необязательный. Время прибытия. Примечание: может быть установлено только тогда, когда RouteTravelMode установлен на TRANSIT . Вы можете указать либо departure_time , либо arrival_time , но не оба.

language_ code

string

Необязательный. Языковой код BCP-47, такой как «En-US» или «SR-Latn». Для получения дополнительной информации см. Идентификатор локали Unicode . Смотрите языковую поддержку списка поддерживаемых языков. Когда вы не предоставляете это значение, язык отображения выводится из местоположения первого происхождения.

region_ code

string

Необязательный. Код региона, указанный как CCTLD («Домен верхнего уровня»). Для получения дополнительной информации см. Код страны домены высшего уровня .

units

Units

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

extra_ computations[]

ExtraComputation

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

traffic_ model

TrafficModel

Необязательный. Определяет предположения, которые используются при расчете времени в трафике. Эта настройка влияет на значение, возвращаемое в поле продолжительности в RouteMatrixElement , которое содержит прогнозируемое время в трафике на основе исторических средних значений. RoutingPreference to TRAFFIC_AWARE_OPTIMAL и RouteTravelMode для DRIVE . По умолчанию BEST_GUESS , если запрашивается трафик, а TrafficModel не указан.

transit_ preferences

TransitPreferences

Необязательный. Указывает предпочтения, которые влияют на маршрут, возвращаемый для TRANSIT маршрутов. Примечание. Вы можете указать только transit_preferences только при TRANSIT RouteTravelMode .

Внешневатор

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

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Не используется. Запросы, содержащие это значение, потерпят неудачу.
TOLLS Информация о платежах для элемента (ы) матрицы.

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

Необязательный. Время отъезда. Если вы не установите это значение, то это значение по умолчанию по умолчанию в то время, которое вы сделали запрос. ПРИМЕЧАНИЕ. Вы можете указать departure_time только в прошлом, когда RouteTravelMode установлен на TRANSIT . Транзитные поездки доступны в течение 7 дней в прошлом или 100 дней в будущем.

arrival_ time

Timestamp

Необязательный. Время прибытия. Примечание: может быть установлено только тогда, когда RouteTravelMode установлен на TRANSIT . Вы можете указать либо departure_time , либо arrival_time , но не оба. Транзитные поездки доступны в течение 7 дней в прошлом или 100 дней в будущем.

compute_ alternative_ routes

bool

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

route_ modifiers

RouteModifiers

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

language_ code

string

Необязательный. Языковой код BCP-47, такой как «En-US» или «SR-Latn». Для получения дополнительной информации см. Идентификатор локали Unicode . Смотрите языковую поддержку списка поддерживаемых языков. Когда вы не предоставляете это значение, язык отображения выводится из местоположения запроса маршрута.

region_ code

string

Необязательный. Код региона, указанный как CCTLD («Домен верхнего уровня»). Для получения дополнительной информации см. Код страны домены высшего уровня .

units

Units

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

optimize_ waypoint_ order

bool

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

requested_ reference_ routes[]

ReferenceRoute

Необязательный. Определяет, какие эталонные маршруты для расчета в рамках запроса в дополнение к маршруту по умолчанию. Справочный маршрут - это маршрут с другой целью расчета маршрута, чем маршрут по умолчанию. Например, расчет маршрута опорного маршрута FUEL_EFFICIENT учитывает различные параметры, которые генерируют оптимальный маршрут топлива. При использовании этой функции ищите route_labels на полученных маршрутах.

extra_ computations[]

ExtraComputation

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

traffic_ model

TrafficModel

Необязательный. Определяет предположения, которые используются при расчете времени в трафике. Эта настройка влияет на значение, возвращаемое в поле продолжительности в Route и RouteLeg , которое содержит прогнозируемое время в движении, основанное на исторических средних значениях. TrafficModel доступен только для запросов, которые устанавливают RoutingPreference на TRAFFIC_AWARE_OPTIMAL и RouteTravelMode для DRIVE . По умолчанию BEST_GUESS , если запрашивается трафик, а TrafficModel не указан.

transit_ preferences

TransitPreferences

Необязательный. Указывает предпочтения, которые влияют на маршрут, возвращаемый для TRANSIT маршрутов. Примечание. Вы можете указать только transit_preferences только при TRANSIT RouteTravelMode .

Внешневатор

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

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Не используется. Запросы, содержащие это значение, потерпят неудачу.
TOLLS Информация о платежей по маршруту (и).
FUEL_CONSUMPTION Расчетный расход топлива для маршрута (ы).
TRAFFIC_ON_POLYLINE Полилички, осведомленные о трафике для маршрута (ы).
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions представленные в виде форматированной текстовой строки HTML. Этот контент предназначен для чтения как есть. Этот контент предназначен только для отображения. Не программно проанализируйте это.
FLYOVER_INFO_ON_POLYLINE Информация о эстакаде для маршрута. routes.polyline_details.flyover_info Fieldmask должен быть указан для возврата этой информации. Эти данные в настоящее время будут заполнены только для определенных метро в Индии. Эта функция экспериментальна, а SKU/заряд может быть изменена.
NARROW_ROAD_INFO_ON_POLYLINE Узкая информация о дороге для маршрута. routes.polyline_details.narrow_road_info Fieldmak должен быть указан для возврата этой информации. Эти данные в настоящее время будут заполнены только для определенных метро в Индии. Эта функция экспериментальна, а SKU/заряд может быть изменена.

Ссылка

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

Перечисления
REFERENCE_ROUTE_UNSPECIFIED Не используется. Запросы, содержащие это значение, не сбои.
FUEL_EFFICIENT Экономичный маршрут.
SHORTER_DISTANCE

Маршрут с более коротким расстоянием движения. Это экспериментальная функция.

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

Для запросов BICYCLE и TWO_WHEELER эта функция возвращает маршруты, аналогичные возвращаемым, когда вы не указываете requested_reference_routes .

Эта функция не совместима с любыми другими режимами движения, через промежуточные путевые точки или optimize_waypoint_order ; Такие запросы потерпят неудачу. Тем не менее, вы можете использовать его с любым routing_preference .

ComputeroutSresponse

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

Поля
routes[]

Route

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

fallback_ info

FallbackInfo

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

geocoding_ results

GeocodingResults

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

SwarkbackInfo

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

Поля
routing_ mode

FallbackRoutingMode

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

reason

FallbackReason

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

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 Not used.
FALLBACK_TRAFFIC_UNAWARE Indicates the TRAFFIC_UNAWARE RoutingPreference was used to compute the response.
FALLBACK_TRAFFIC_AWARE Indicates the TRAFFIC_AWARE RoutingPreference was used to compute the response.

GeocodedWaypoint

Details about the locations used as waypoints. Only populated for address waypoints. Includes details about the geocoding results for the purposes of determining what the address was geocoded to.

Поля
geocoder_ status

Status

Indicates the status code resulting from the geocoding operation.

type[]

string

The type(s) of the result, in the form of zero or more type tags. Supported types: Address types and address component types .

partial_ match

bool

Indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. Вы можете проверить исходный запрос на предмет орфографических ошибок и/или неполного адреса.

place_ id

string

The place ID for this result.

intermediate_ waypoint_ request_ index

int32

The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint.

GeocodingResults

Contains GeocodedWaypoints for origin, destination and intermediate waypoints. Only populated for address waypoints.

Поля
origin

GeocodedWaypoint

Origin geocoded waypoint.

destination

GeocodedWaypoint

Destination geocoded waypoint.

intermediates[]

GeocodedWaypoint

A list of intermediate geocoded waypoints each containing an index field that corresponds to the zero-based position of the waypoint in the order they were specified in the request.

LocalizedTime

Localized description of time.

Поля
time

LocalizedText

The time specified as a string in a given time zone.

time_ zone

string

Contains the time zone. The value is the name of the time zone as defined in the IANA Time Zone Database , eg "America/New_York".

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

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 specifies the side of the road 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, and so on. You can use this field only for DRIVE and TWO_WHEELER RouteTravelMode .

Маневр

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

Перечисления
MANEUVER_UNSPECIFIED Not used.
TURN_SLIGHT_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 Возьмите левую развилку.
FORK_RIGHT Take the right fork.
FERRY Сядьте на паром.
FERRY_TRAIN Take the train leading onto the ferry.
ROUNDABOUT_LEFT Turn left at the roundabout.
ROUNDABOUT_RIGHT Turn right at the roundabout.
DEPART Initial maneuver.
NAME_CHANGE Used to indicate a street name change.

Encapsulates navigation instructions for a RouteLegStep .

Поля
maneuver

Maneuver

Encapsulates the navigation instructions for the current step (for example, turn left, merge, or straight). 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 .

PolylineDetails

Details corresponding to a given index or contiguous segment of a polyline. Given a polyline with points P_0, P_1, ... , P_N (zero-based index), the PolylineDetails defines an interval and associated metadata.

Поля
flyover_ info[]

FlyoverInfo

Flyover details along the polyline.

narrow_ road_ info[]

NarrowRoadInfo

Narrow road details along the polyline.

FlyoverInfo

Encapsulates information about flyovers along the polyline.

Поля
flyover_ presence

RoadFeatureState

Output only. Denotes whether a flyover exists for a given stretch of the polyline.

polyline_ point_ index

PolylinePointIndex

The location of flyover related information along the polyline.

NarrowRoadInfo

Encapsulates information about narrow roads along the polyline.

Поля
narrow_ road_ presence

RoadFeatureState

Output only. Denotes whether a narrow road exists for a given stretch of the polyline.

polyline_ point_ index

PolylinePointIndex

The location of narrow road related information along the polyline.

PolylinePointIndex

Encapsulates the start and end indexes for a polyline detail. For instances where the data corresponds to a single point, start_index and end_index will be equal.

Поля
start_ index

int32

The start index of this detail in the polyline.

end_ index

int32

The end index of this detail in the polyline.

RoadFeatureState

Encapsulates the states of road features along a stretch of polyline.

Перечисления
ROAD_FEATURE_STATE_UNSPECIFIED The road feature's state was not computed (default value).
EXISTS The road feature exists.
DOES_NOT_EXIST The road feature does not exist.

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.

Маршрут

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

Поля
route_ labels[]

RouteLabel

Labels for the Route that are useful to identify specific properties of the route to compare against others.

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 travel through the route without taking traffic conditions into consideration.

polyline

Polyline

The overall route polyline. This polyline is 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 you set optimize_waypoint_order to true, this field contains the optimized ordering of intermediate waypoints. Otherwise, this field is empty. For example, if you give an input of Origin: LA; Intermediate waypoints: 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 provided in the input.

localized_ values

RouteLocalizedValues

Text representations of properties of the Route .

route_ token

string

An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route.

NOTE: Route.route_token is only available for requests that have set ComputeRoutesRequest.routing_preference to TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL . Route.route_token is not supported for requests that have Via waypoints.

polyline_ details

PolylineDetails

Contains information about details along the polyline.

RouteLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as static_duration .

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

transit_ fare

LocalizedText

Transit fare represented in text form.

RouteLabel

Labels for the Route that are useful to identify specific properties of the route to compare against others.

Перечисления
ROUTE_LABEL_UNSPECIFIED Default - not used.
DEFAULT_ROUTE The default "best" route returned for the route computation.
DEFAULT_ROUTE_ALTERNATE An alternative to the default "best" route. Routes like this will be returned when compute_alternative_routes is specified.
FUEL_EFFICIENT Fuel efficient route. Routes labeled with this value are determined to be optimized for Eco parameters such as fuel consumption.
SHORTER_DISTANCE Shorter travel distance route. Это экспериментальная функция.

RouteLeg

Contains 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 travel through the leg, calculated without taking traffic conditions into consideration.

polyline

Polyline

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

start_ location

Location

The start location of this leg. This location 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 location 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

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

localized_ values

RouteLegLocalizedValues

Text representations of properties of the RouteLeg .

steps_ overview

StepsOverview

Overview information about the steps in this RouteLeg . This field is only populated for TRANSIT routes.

RouteLegLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as static_duration.

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

StepsOverview

Provides overview information about a list of RouteLegStep s.

Поля
multi_ modal_ segments[]

MultiModalSegment

Summarized information about different multi-modal segments of the RouteLeg.steps . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

MultiModalSegment

Provides summarized information about different multi-modal segments of the RouteLeg.steps . A multi-modal segment is defined as one or more contiguous RouteLegStep that have the same RouteTravelMode . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

Поля
navigation_ instruction

NavigationInstruction

NavigationInstruction for the multi-modal segment.

travel_ mode

RouteTravelMode

The travel mode of the multi-modal segment.

step_ start_ index

int32

The corresponding RouteLegStep index that is the start of a multi-modal segment.

step_ end_ index

int32

The corresponding RouteLegStep index that is the end of a multi-modal segment.

RouteLegStep

Contains 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

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

localized_ values

RouteLegStepLocalizedValues

Text representations of properties of the RouteLegStep .

transit_ details

RouteLegStepTransitDetails

Details pertaining to this step if the travel mode is TRANSIT .

travel_ mode

RouteTravelMode

The travel mode used for this step.

RouteLegStepLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

RouteLegStepTransitDetails

Additional information for the RouteLegStep related to TRANSIT routes.

Поля
stop_ details

TransitStopDetails

Information about the arrival and departure stops for the step.

localized_ values

TransitDetailsLocalizedValues

Text representations of properties of the RouteLegStepTransitDetails .

headsign

string

Specifies the direction in which to travel on this line as marked on the vehicle or at the departure stop. The direction is often the terminus station.

headway

Duration

Specifies the expected time as a duration between departures from the same stop at this time. For example, with a headway seconds value of 600, you would expect a ten minute wait if you should miss your bus.

transit_ line

TransitLine

Information about the transit line used in this step.

stop_ count

int32

The number of stops from the departure to the arrival stop. This count includes the arrival stop, but excludes the departure stop. For example, if your route leaves from Stop A, passes through stops B and C, and arrives at stop D,

stop_count

returns 3.

trip_ short_ text

string

The text that appears in schedules and sign boards to identify a transit trip to passengers. The text should uniquely identify a trip within a service day. For example, "538" is the trip_short_text of the Amtrak train that leaves San Jose, CA at 15:10 on weekdays to Sacramento, CA.

TransitDetailsLocalizedValues

Localized descriptions of values for RouteTransitDetails .

Поля
arrival_ time

LocalizedTime

Time in its formatted text representation with a corresponding time zone.

departure_ time

LocalizedTime

Time in its formatted text representation with a corresponding time zone.

TransitStopDetails

Details about the transit stops for the RouteLegStep .

Поля
arrival_ stop

TransitStop

Information about the arrival stop for the step.

arrival_ time

Timestamp

The estimated time of arrival for the step.

departure_ stop

TransitStop

Information about the departure stop for the step.

departure_ time

Timestamp

The estimated time of departure for the step.

RouteLegStepTravelAdvisory

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

Поля
speed_ reading_ intervals[]

SpeedReadingInterval

NOTE: This field is not currently populated.

RouteLegTravelAdvisory

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

Поля
toll_ info

TollInfo

Contains 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 RouteLeg 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

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

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

localized_ values

LocalizedValues

Text representations of properties of the RouteMatrixElement .

origin_ index

int32

Zero-based index of the origin in the request.

destination_ index

int32

Zero-based index of the destination in the request.

LocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration represented in text form taking traffic conditions into consideration. Note: If traffic information was not requested, this value is the same value as static_duration.

static_ duration

LocalizedText

Duration represented in text form without taking traffic conditions into consideration.

transit_ fare

LocalizedText

Transit fare represented in text form.

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

When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ highways

bool

When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ ferries

bool

When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ indoor

bool

When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the WALK RouteTravelMode .

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

RouteTravelAdvisory

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions.

Поля
toll_ info

TollInfo

Contains information about tolls on the route. This field is only populated if tolls are expected on the route. If this field is set, but the estimatedPrice subfield is not populated, then the route contains tolls, but the estimated price is unknown. If this field is not set, then there are no tolls expected 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).
fuel_ consumption_ microliters

int64

The predicted fuel consumption in microliters.

route_ restrictions_ partially_ ignored

bool

Returned route may have restrictions that are not suitable for requested travel mode or route modifiers.

transit_ fare

Money

If present, contains the total fare or ticket costs on this route This property is only returned for TRANSIT requests and only for routes where fare information is available for all transit steps.

RouteTravelMode

A set of values used to specify the mode of travel. NOTE: WALK , BICYCLE , and TWO_WHEELER routes are in beta and might sometimes be missing clear sidewalks, pedestrian paths, or bicycling paths. You must display this warning to the user for all walking, bicycling, and two-wheel routes that you display in your app.

Перечисления
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.
TRANSIT Travel by public transit routes, where available.

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_UNAWARE .
TRAFFIC_UNAWARE Computes routes without taking live traffic conditions into consideration. Suitable when traffic conditions don't matter or are not applicable. Using this value produces the lowest latency. Note: For RouteTravelMode DRIVE and TWO_WHEELER , the route and duration chosen are based on road network and average time-independent traffic conditions, not current road conditions. Consequently, routes may include roads that are temporarily closed. Results for a given request may vary over time due to changes in the road network, updated average traffic conditions, and the distributed nature of the service. Results may also vary between nearly-equivalent routes at any time or frequency.
TRAFFIC_AWARE Calculates routes taking live 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 live 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.

end_ polyline_ point_ index

int32

The ending index of this interval in the polyline.

Union field speed_type .

speed_type can be only one of the following:

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 Not used. If this value is used, then the request fails.
AU_ETOLL_TAG Sydney toll pass. See additional details at https://www.myetoll.com.au .
AU_EWAY_TAG Sydney toll pass. See additional details at 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.
JP_ETC Japan ETC. Electronic wireless system to collect tolls. https://www.go-etc.jp/
JP_ETC2 Japan ETC2.0. New version of ETC with further discount and bidirectional communication between devices on vehicles and antennas on the road. https://www.go-etc.jp/etc2/index.html
MX_IAVE Mexico toll pass. https://iave.capufe.gob.mx/#/
MX_PASE Mexico https://www.pase.com.mx
MX_QUICKPASS Mexico https://operadoravial.com/quick-pass/
MX_SISTEMA_TELEPEAJE_CHIHUAHUA http://appsh.chihuahua.gob.mx/transparencia/?doc=/ingresos/TelepeajeFormato4.pdf
MX_TAG_IAVE Мексика
MX_TAG_TELEVIA Mexico toll pass company. One of many operating in Mexico City. See additional details at https://www.televia.com.mx .
MX_TELEVIA Mexico toll pass company. One of many operating in Mexico City. 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_BCPASS MI, USA.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG MI, USA.
US_MI_IQ_PROX_CARD

MI, USA. Deprecated as this pass type no longer exists.

US_MI_IQ_TAG 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_AVI_TAG TX, 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_FUEGO_TAG 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_MOV_PASS WV, USA
US_WV_NEWELL_TOLL_BRIDGE_TICKET WV, USA.

TrafficModel

Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the response, which contains the predicted time in traffic based on historical averages.

Перечисления
TRAFFIC_MODEL_UNSPECIFIED Неиспользованный. If specified, will default to BEST_GUESS .
BEST_GUESS Indicates that the returned duration should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.
PESSIMISTIC Indicates that the returned duration should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.
OPTIMISTIC Indicates that the returned duration should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

TransitAgency

A transit agency that operates a transit line.

Поля
name

string

The name of this transit agency.

phone_ number

string

The transit agency's locale-specific formatted phone number.

uri

string

The transit agency's URI.

TransitLine

Contains information about the transit line used in this step.

Поля
agencies[]

TransitAgency

The transit agency (or agencies) that operates this transit line.

name

string

The full name of this transit line, For example, "8 Avenue Local".

uri

string

the URI for this transit line as provided by the transit agency.

color

string

The color commonly used in signage for this line. Represented in hexadecimal.

icon_ uri

string

The URI for the icon associated with this line.

name_ short

string

The short name of this transit line. This name will normally be a line number, such as "M7" or "355".

text_ color

string

The color commonly used in text on signage for this line. Represented in hexadecimal.

vehicle

TransitVehicle

The type of vehicle that operates on this transit line.

TransitPreferences

Preferences for TRANSIT based routes that influence the route that is returned.

Поля
allowed_ travel_ modes[]

TransitTravelMode

A set of travel modes to use when getting a TRANSIT route. Defaults to all supported modes of travel.

routing_ preference

TransitRoutingPreference

A routing preference that, when specified, influences the TRANSIT route returned.

TransitRoutingPreference

Specifies routing preferences for transit routes.

Перечисления
TRANSIT_ROUTING_PREFERENCE_UNSPECIFIED No preference specified.
LESS_WALKING Indicates that the calculated route should prefer limited amounts of walking.
FEWER_TRANSFERS Indicates that the calculated route should prefer a limited number of transfers.

TransitTravelMode

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

Перечисления
TRANSIT_TRAVEL_MODE_UNSPECIFIED No transit travel mode specified.
BUS Путешествие на автобусе.
SUBWAY Travel by subway.
TRAIN Путешествие на поезде.
LIGHT_RAIL Travel by light rail or tram.
RAIL Travel by rail. This is equivalent to a combination of SUBWAY , TRAIN , and LIGHT_RAIL .

TransitStop

Information about a transit stop.

Поля
name

string

The name of the transit stop.

location

Location

The location of the stop expressed in latitude/longitude coordinates.

TransitVehicle

Information about a vehicle used in transit routes.

Поля
name

LocalizedText

The name of this vehicle, capitalized.

type

TransitVehicleType

The type of vehicle used.

icon_ uri

string

The URI for an icon associated with this vehicle type.

local_ icon_ uri

string

The URI for the icon associated with this vehicle type, based on the local transport signage.

TransitVehicleType

The type of vehicles for transit routes.

Перечисления
TRANSIT_VEHICLE_TYPE_UNSPECIFIED Неиспользованный.
BUS Автобус.
CABLE_CAR A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT .
COMMUTER_TRAIN Commuter rail.
FERRY Перевозить.
FUNICULAR A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.
GONDOLA_LIFT An aerial cable car.
HEAVY_RAIL Heavy rail.
HIGH_SPEED_TRAIN High speed train.
INTERCITY_BUS Intercity bus.
LONG_DISTANCE_TRAIN Long distance train.
METRO_RAIL Light rail transit.
MONORAIL Монорельс.
OTHER All other vehicles.
RAIL Железнодорожный.
SHARE_TAXI Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.
SUBWAY Underground light rail.
TRAM Above ground light rail.
TROLLEYBUS Троллейбус.

Единицы

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

Перечисления
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.
DIESEL Diesel fueled vehicle.

VehicleInfo

Contains the vehicle information, such as the vehicle emission type.

Поля
emission_ type

VehicleEmissionType

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

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

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

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.

address

string

Human readable address or a plus code. Подробности см. на https://plus.codes .

,

Индекс

Маршруты

The Routes API.

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

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 sum of the number of origins + the number of destinations specified as either place_id or address must be no greater than 50.
  • The product of number of origins × number of destinations must be no greater than 625 in any case.
  • The product of the number of origins × number of destinations must be no greater than 100 if routing_preference is set to TRAFFIC_AWARE_OPTIMAL .
  • The product of the number of origins × number of destinations must be no greater than 100 if travel_mode is set to TRANSIT .
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. 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, then this value defaults to the time that you made the request. NOTE: You can only specify a departure_time in the past when RouteTravelMode is set to TRANSIT .

arrival_ time

Timestamp

Необязательный. The arrival time. NOTE: Can only be set when RouteTravelMode is set to TRANSIT . You can specify either departure_time or arrival_time , but not both.

language_ code

string

Необязательный. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see 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 first origin.

region_ code

string

Необязательный. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains .

units

Units

Необязательный. Specifies the units of measure for the display fields.

extra_ computations[]

ExtraComputation

Необязательный. A list of extra computations which may be used to complete the request. Note: These extra computations may return extra fields on the response. These extra fields must also be specified in the field mask to be returned in the response.

traffic_ model

TrafficModel

Необязательный. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the RouteMatrixElement which contains the predicted time in traffic based on historical averages. RoutingPreference to TRAFFIC_AWARE_OPTIMAL and RouteTravelMode to DRIVE . Defaults to BEST_GUESS if traffic is requested and TrafficModel is not specified.

transit_ preferences

TransitPreferences

Необязательный. Specifies preferences that influence the route returned for TRANSIT routes. NOTE: You can only specify a transit_preferences when RouteTravelMode is set to TRANSIT .

ExtraComputation

Extra computations to perform while completing the request.

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Not used. Requests containing this value will fail.
TOLLS Toll information for the matrix element(s).

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. 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. NOTE: You can only specify a departure_time in the past when RouteTravelMode is set to TRANSIT . Transit trips are available for up to 7 days in the past or 100 days in the future.

arrival_ time

Timestamp

Необязательный. The arrival time. NOTE: Can only be set when RouteTravelMode is set to TRANSIT . You can specify either departure_time or arrival_time , but not both. Transit trips are available for up to 7 days in the past or 100 days in the future.

compute_ alternative_ routes

bool

Необязательный. Specifies whether to calculate alternate routes in addition to the route. No alternative routes are returned for requests that have intermediate waypoints.

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

region_ code

string

Необязательный. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains .

units

Units

Необязательный. Specifies the units of measure for the display fields. These fields include 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 first origin.

optimize_ waypoint_ order

bool

Необязательный. If set to true, the service attempts to minimize the overall cost of the route by re-ordering the specified intermediate waypoints. The request fails if any of the intermediate waypoints is a via waypoint. Use ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index to find the new ordering. If ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index is not requested in the X-Goog-FieldMask header, the request fails. If optimize_waypoint_order is set to false, ComputeRoutesResponse.optimized_intermediate_waypoint_index will be empty.

requested_ reference_ routes[]

ReferenceRoute

Необязательный. Specifies what reference routes to calculate as part of the request in addition to the default route. A reference route is a route with a different route calculation objective than the default route. For example a FUEL_EFFICIENT reference route calculation takes into account various parameters that would generate an optimal fuel efficient route. When using this feature, look for route_labels on the resulting routes.

extra_ computations[]

ExtraComputation

Необязательный. A list of extra computations which may be used to complete the request. Note: These extra computations may return extra fields on the response. These extra fields must also be specified in the field mask to be returned in the response.

traffic_ model

TrafficModel

Необязательный. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the Route and RouteLeg which contains the predicted time in traffic based on historical averages. TrafficModel is only available for requests that have set RoutingPreference to TRAFFIC_AWARE_OPTIMAL and RouteTravelMode to DRIVE . Defaults to BEST_GUESS if traffic is requested and TrafficModel is not specified.

transit_ preferences

TransitPreferences

Необязательный. Specifies preferences that influence the route returned for TRANSIT routes. NOTE: You can only specify a transit_preferences when RouteTravelMode is set to TRANSIT .

ExtraComputation

Extra computations to perform while completing the request.

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Not used. Requests containing this value will fail.
TOLLS Toll information for the route(s).
FUEL_CONSUMPTION Estimated fuel consumption for the route(s).
TRAFFIC_ON_POLYLINE Traffic aware polylines for the route(s).
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions presented as a formatted HTML text string. This content is meant to be read as-is. This content is for display only. Do not programmatically parse it.
FLYOVER_INFO_ON_POLYLINE Flyover information for the route(s). The routes.polyline_details.flyover_info fieldmask must be specified to return this information. This data will only currently be populated for certain metros in India. This feature is experimental, and the SKU/charge is subject to change.
NARROW_ROAD_INFO_ON_POLYLINE Narrow road information for the route(s). The routes.polyline_details.narrow_road_info fieldmask must be specified to return this information. This data will only currently be populated for certain metros in India. This feature is experimental, and the SKU/charge is subject to change.

ReferenceRoute

A supported reference route on the ComputeRoutesRequest.

Перечисления
REFERENCE_ROUTE_UNSPECIFIED Not used. Requests containing this value fail.
FUEL_EFFICIENT Fuel efficient route.
SHORTER_DISTANCE

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

For DRIVE requests, this feature prioritizes shorter distance over driving comfort. For example, it may prefer local roads instead of highways, take dirt roads, cut through parking lots, etc. This feature does not return any maneuvers that Google Maps knows to be illegal.

For BICYCLE and TWO_WHEELER requests, this feature returns routes similar to those returned when you don't specify requested_reference_routes .

This feature is not compatible with any other travel modes, via intermediate waypoints, or optimize_waypoint_order ; such requests will fail. However, you can use it with any routing_preference .

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.

geocoding_ results

GeocodingResults

Contains geocoding response info for waypoints specified as addresses.

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 Not used.
FALLBACK_TRAFFIC_UNAWARE Indicates the TRAFFIC_UNAWARE RoutingPreference was used to compute the response.
FALLBACK_TRAFFIC_AWARE Indicates the TRAFFIC_AWARE RoutingPreference was used to compute the response.

GeocodedWaypoint

Details about the locations used as waypoints. Only populated for address waypoints. Includes details about the geocoding results for the purposes of determining what the address was geocoded to.

Поля
geocoder_ status

Status

Indicates the status code resulting from the geocoding operation.

type[]

string

The type(s) of the result, in the form of zero or more type tags. Supported types: Address types and address component types .

partial_ match

bool

Indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. Вы можете проверить исходный запрос на предмет орфографических ошибок и/или неполного адреса.

place_ id

string

The place ID for this result.

intermediate_ waypoint_ request_ index

int32

The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint.

GeocodingResults

Contains GeocodedWaypoints for origin, destination and intermediate waypoints. Only populated for address waypoints.

Поля
origin

GeocodedWaypoint

Origin geocoded waypoint.

destination

GeocodedWaypoint

Destination geocoded waypoint.

intermediates[]

GeocodedWaypoint

A list of intermediate geocoded waypoints each containing an index field that corresponds to the zero-based position of the waypoint in the order they were specified in the request.

LocalizedTime

Localized description of time.

Поля
time

LocalizedText

The time specified as a string in a given time zone.

time_ zone

string

Contains the time zone. The value is the name of the time zone as defined in the IANA Time Zone Database , eg "America/New_York".

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

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 specifies the side of the road 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, and so on. You can use this field only for DRIVE and TWO_WHEELER RouteTravelMode .

Маневр

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

Перечисления
MANEUVER_UNSPECIFIED Not used.
TURN_SLIGHT_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 Возьмите левую развилку.
FORK_RIGHT Take the right fork.
FERRY Сядьте на паром.
FERRY_TRAIN Take the train leading onto the ferry.
ROUNDABOUT_LEFT Turn left at the roundabout.
ROUNDABOUT_RIGHT Turn right at the roundabout.
DEPART Initial maneuver.
NAME_CHANGE Used to indicate a street name change.

Encapsulates navigation instructions for a RouteLegStep .

Поля
maneuver

Maneuver

Encapsulates the navigation instructions for the current step (for example, turn left, merge, or straight). 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 .

PolylineDetails

Details corresponding to a given index or contiguous segment of a polyline. Given a polyline with points P_0, P_1, ... , P_N (zero-based index), the PolylineDetails defines an interval and associated metadata.

Поля
flyover_ info[]

FlyoverInfo

Flyover details along the polyline.

narrow_ road_ info[]

NarrowRoadInfo

Narrow road details along the polyline.

FlyoverInfo

Encapsulates information about flyovers along the polyline.

Поля
flyover_ presence

RoadFeatureState

Output only. Denotes whether a flyover exists for a given stretch of the polyline.

polyline_ point_ index

PolylinePointIndex

The location of flyover related information along the polyline.

NarrowRoadInfo

Encapsulates information about narrow roads along the polyline.

Поля
narrow_ road_ presence

RoadFeatureState

Output only. Denotes whether a narrow road exists for a given stretch of the polyline.

polyline_ point_ index

PolylinePointIndex

The location of narrow road related information along the polyline.

PolylinePointIndex

Encapsulates the start and end indexes for a polyline detail. For instances where the data corresponds to a single point, start_index and end_index will be equal.

Поля
start_ index

int32

The start index of this detail in the polyline.

end_ index

int32

The end index of this detail in the polyline.

RoadFeatureState

Encapsulates the states of road features along a stretch of polyline.

Перечисления
ROAD_FEATURE_STATE_UNSPECIFIED The road feature's state was not computed (default value).
EXISTS The road feature exists.
DOES_NOT_EXIST The road feature does not exist.

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.

Маршрут

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

Поля
route_ labels[]

RouteLabel

Labels for the Route that are useful to identify specific properties of the route to compare against others.

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 travel through the route without taking traffic conditions into consideration.

polyline

Polyline

The overall route polyline. This polyline is 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 you set optimize_waypoint_order to true, this field contains the optimized ordering of intermediate waypoints. Otherwise, this field is empty. For example, if you give an input of Origin: LA; Intermediate waypoints: 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 provided in the input.

localized_ values

RouteLocalizedValues

Text representations of properties of the Route .

route_ token

string

An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route.

NOTE: Route.route_token is only available for requests that have set ComputeRoutesRequest.routing_preference to TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL . Route.route_token is not supported for requests that have Via waypoints.

polyline_ details

PolylineDetails

Contains information about details along the polyline.

RouteLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as static_duration .

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

transit_ fare

LocalizedText

Transit fare represented in text form.

RouteLabel

Labels for the Route that are useful to identify specific properties of the route to compare against others.

Перечисления
ROUTE_LABEL_UNSPECIFIED Default - not used.
DEFAULT_ROUTE The default "best" route returned for the route computation.
DEFAULT_ROUTE_ALTERNATE An alternative to the default "best" route. Routes like this will be returned when compute_alternative_routes is specified.
FUEL_EFFICIENT Fuel efficient route. Routes labeled with this value are determined to be optimized for Eco parameters such as fuel consumption.
SHORTER_DISTANCE Shorter travel distance route. Это экспериментальная функция.

RouteLeg

Contains 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 travel through the leg, calculated without taking traffic conditions into consideration.

polyline

Polyline

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

start_ location

Location

The start location of this leg. This location 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 location 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

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

localized_ values

RouteLegLocalizedValues

Text representations of properties of the RouteLeg .

steps_ overview

StepsOverview

Overview information about the steps in this RouteLeg . This field is only populated for TRANSIT routes.

RouteLegLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as static_duration.

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

StepsOverview

Provides overview information about a list of RouteLegStep s.

Поля
multi_ modal_ segments[]

MultiModalSegment

Summarized information about different multi-modal segments of the RouteLeg.steps . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

MultiModalSegment

Provides summarized information about different multi-modal segments of the RouteLeg.steps . A multi-modal segment is defined as one or more contiguous RouteLegStep that have the same RouteTravelMode . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

Поля
navigation_ instruction

NavigationInstruction

NavigationInstruction for the multi-modal segment.

travel_ mode

RouteTravelMode

The travel mode of the multi-modal segment.

step_ start_ index

int32

The corresponding RouteLegStep index that is the start of a multi-modal segment.

step_ end_ index

int32

The corresponding RouteLegStep index that is the end of a multi-modal segment.

RouteLegStep

Contains 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

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

localized_ values

RouteLegStepLocalizedValues

Text representations of properties of the RouteLegStep .

transit_ details

RouteLegStepTransitDetails

Details pertaining to this step if the travel mode is TRANSIT .

travel_ mode

RouteTravelMode

The travel mode used for this step.

RouteLegStepLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

RouteLegStepTransitDetails

Additional information for the RouteLegStep related to TRANSIT routes.

Поля
stop_ details

TransitStopDetails

Information about the arrival and departure stops for the step.

localized_ values

TransitDetailsLocalizedValues

Text representations of properties of the RouteLegStepTransitDetails .

headsign

string

Specifies the direction in which to travel on this line as marked on the vehicle or at the departure stop. The direction is often the terminus station.

headway

Duration

Specifies the expected time as a duration between departures from the same stop at this time. For example, with a headway seconds value of 600, you would expect a ten minute wait if you should miss your bus.

transit_ line

TransitLine

Information about the transit line used in this step.

stop_ count

int32

The number of stops from the departure to the arrival stop. This count includes the arrival stop, but excludes the departure stop. For example, if your route leaves from Stop A, passes through stops B and C, and arrives at stop D,

stop_count

returns 3.

trip_ short_ text

string

The text that appears in schedules and sign boards to identify a transit trip to passengers. The text should uniquely identify a trip within a service day. For example, "538" is the trip_short_text of the Amtrak train that leaves San Jose, CA at 15:10 on weekdays to Sacramento, CA.

TransitDetailsLocalizedValues

Localized descriptions of values for RouteTransitDetails .

Поля
arrival_ time

LocalizedTime

Time in its formatted text representation with a corresponding time zone.

departure_ time

LocalizedTime

Time in its formatted text representation with a corresponding time zone.

TransitStopDetails

Details about the transit stops for the RouteLegStep .

Поля
arrival_ stop

TransitStop

Information about the arrival stop for the step.

arrival_ time

Timestamp

The estimated time of arrival for the step.

departure_ stop

TransitStop

Information about the departure stop for the step.

departure_ time

Timestamp

The estimated time of departure for the step.

RouteLegStepTravelAdvisory

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

Поля
speed_ reading_ intervals[]

SpeedReadingInterval

NOTE: This field is not currently populated.

RouteLegTravelAdvisory

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

Поля
toll_ info

TollInfo

Contains 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 RouteLeg 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

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

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

localized_ values

LocalizedValues

Text representations of properties of the RouteMatrixElement .

origin_ index

int32

Zero-based index of the origin in the request.

destination_ index

int32

Zero-based index of the destination in the request.

LocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration represented in text form taking traffic conditions into consideration. Note: If traffic information was not requested, this value is the same value as static_duration.

static_ duration

LocalizedText

Duration represented in text form without taking traffic conditions into consideration.

transit_ fare

LocalizedText

Transit fare represented in text form.

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

When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ highways

bool

When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ ferries

bool

When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ indoor

bool

When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the WALK RouteTravelMode .

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

RouteTravelAdvisory

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions.

Поля
toll_ info

TollInfo

Contains information about tolls on the route. This field is only populated if tolls are expected on the route. If this field is set, but the estimatedPrice subfield is not populated, then the route contains tolls, but the estimated price is unknown. If this field is not set, then there are no tolls expected 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).
fuel_ consumption_ microliters

int64

The predicted fuel consumption in microliters.

route_ restrictions_ partially_ ignored

bool

Returned route may have restrictions that are not suitable for requested travel mode or route modifiers.

transit_ fare

Money

If present, contains the total fare or ticket costs on this route This property is only returned for TRANSIT requests and only for routes where fare information is available for all transit steps.

RouteTravelMode

A set of values used to specify the mode of travel. NOTE: WALK , BICYCLE , and TWO_WHEELER routes are in beta and might sometimes be missing clear sidewalks, pedestrian paths, or bicycling paths. You must display this warning to the user for all walking, bicycling, and two-wheel routes that you display in your app.

Перечисления
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.
TRANSIT Travel by public transit routes, where available.

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_UNAWARE .
TRAFFIC_UNAWARE Computes routes without taking live traffic conditions into consideration. Suitable when traffic conditions don't matter or are not applicable. Using this value produces the lowest latency. Note: For RouteTravelMode DRIVE and TWO_WHEELER , the route and duration chosen are based on road network and average time-independent traffic conditions, not current road conditions. Consequently, routes may include roads that are temporarily closed. Results for a given request may vary over time due to changes in the road network, updated average traffic conditions, and the distributed nature of the service. Results may also vary between nearly-equivalent routes at any time or frequency.
TRAFFIC_AWARE Calculates routes taking live 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 live 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.

end_ polyline_ point_ index

int32

The ending index of this interval in the polyline.

Union field speed_type .

speed_type can be only one of the following:

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 Not used. If this value is used, then the request fails.
AU_ETOLL_TAG Sydney toll pass. See additional details at https://www.myetoll.com.au .
AU_EWAY_TAG Sydney toll pass. See additional details at 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.
JP_ETC Japan ETC. Electronic wireless system to collect tolls. https://www.go-etc.jp/
JP_ETC2 Japan ETC2.0. New version of ETC with further discount and bidirectional communication between devices on vehicles and antennas on the road. https://www.go-etc.jp/etc2/index.html
MX_IAVE Mexico toll pass. https://iave.capufe.gob.mx/#/
MX_PASE Mexico https://www.pase.com.mx
MX_QUICKPASS Mexico https://operadoravial.com/quick-pass/
MX_SISTEMA_TELEPEAJE_CHIHUAHUA http://appsh.chihuahua.gob.mx/transparencia/?doc=/ingresos/TelepeajeFormato4.pdf
MX_TAG_IAVE Мексика
MX_TAG_TELEVIA Mexico toll pass company. One of many operating in Mexico City. See additional details at https://www.televia.com.mx .
MX_TELEVIA Mexico toll pass company. One of many operating in Mexico City. 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_BCPASS MI, USA.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG MI, USA.
US_MI_IQ_PROX_CARD

MI, USA. Deprecated as this pass type no longer exists.

US_MI_IQ_TAG 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_AVI_TAG TX, 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_FUEGO_TAG 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_MOV_PASS WV, USA
US_WV_NEWELL_TOLL_BRIDGE_TICKET WV, USA.

TrafficModel

Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the response, which contains the predicted time in traffic based on historical averages.

Перечисления
TRAFFIC_MODEL_UNSPECIFIED Неиспользованный. If specified, will default to BEST_GUESS .
BEST_GUESS Indicates that the returned duration should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.
PESSIMISTIC Indicates that the returned duration should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.
OPTIMISTIC Indicates that the returned duration should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

TransitAgency

A transit agency that operates a transit line.

Поля
name

string

The name of this transit agency.

phone_ number

string

The transit agency's locale-specific formatted phone number.

uri

string

The transit agency's URI.

TransitLine

Contains information about the transit line used in this step.

Поля
agencies[]

TransitAgency

The transit agency (or agencies) that operates this transit line.

name

string

The full name of this transit line, For example, "8 Avenue Local".

uri

string

the URI for this transit line as provided by the transit agency.

color

string

The color commonly used in signage for this line. Represented in hexadecimal.

icon_ uri

string

The URI for the icon associated with this line.

name_ short

string

The short name of this transit line. This name will normally be a line number, such as "M7" or "355".

text_ color

string

The color commonly used in text on signage for this line. Represented in hexadecimal.

vehicle

TransitVehicle

The type of vehicle that operates on this transit line.

TransitPreferences

Preferences for TRANSIT based routes that influence the route that is returned.

Поля
allowed_ travel_ modes[]

TransitTravelMode

A set of travel modes to use when getting a TRANSIT route. Defaults to all supported modes of travel.

routing_ preference

TransitRoutingPreference

A routing preference that, when specified, influences the TRANSIT route returned.

TransitRoutingPreference

Specifies routing preferences for transit routes.

Перечисления
TRANSIT_ROUTING_PREFERENCE_UNSPECIFIED No preference specified.
LESS_WALKING Indicates that the calculated route should prefer limited amounts of walking.
FEWER_TRANSFERS Indicates that the calculated route should prefer a limited number of transfers.

TransitTravelMode

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

Перечисления
TRANSIT_TRAVEL_MODE_UNSPECIFIED No transit travel mode specified.
BUS Путешествие на автобусе.
SUBWAY Travel by subway.
TRAIN Путешествие на поезде.
LIGHT_RAIL Travel by light rail or tram.
RAIL Travel by rail. This is equivalent to a combination of SUBWAY , TRAIN , and LIGHT_RAIL .

TransitStop

Information about a transit stop.

Поля
name

string

The name of the transit stop.

location

Location

The location of the stop expressed in latitude/longitude coordinates.

TransitVehicle

Information about a vehicle used in transit routes.

Поля
name

LocalizedText

The name of this vehicle, capitalized.

type

TransitVehicleType

The type of vehicle used.

icon_ uri

string

The URI for an icon associated with this vehicle type.

local_ icon_ uri

string

The URI for the icon associated with this vehicle type, based on the local transport signage.

TransitVehicleType

The type of vehicles for transit routes.

Перечисления
TRANSIT_VEHICLE_TYPE_UNSPECIFIED Неиспользованный.
BUS Автобус.
CABLE_CAR A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT .
COMMUTER_TRAIN Commuter rail.
FERRY Перевозить.
FUNICULAR A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.
GONDOLA_LIFT An aerial cable car.
HEAVY_RAIL Heavy rail.
HIGH_SPEED_TRAIN High speed train.
INTERCITY_BUS Intercity bus.
LONG_DISTANCE_TRAIN Long distance train.
METRO_RAIL Light rail transit.
MONORAIL Монорельс.
OTHER All other vehicles.
RAIL Железнодорожный.
SHARE_TAXI Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.
SUBWAY Underground light rail.
TRAM Above ground light rail.
TROLLEYBUS Троллейбус.

Единицы

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

Перечисления
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.
DIESEL Diesel fueled vehicle.

VehicleInfo

Contains the vehicle information, such as the vehicle emission type.

Поля
emission_ type

VehicleEmissionType

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

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

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

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.

address

string

Human readable address or a plus code. Подробности см. на https://plus.codes .

,

Индекс

Маршруты

The Routes API.

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

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 sum of the number of origins + the number of destinations specified as either place_id or address must be no greater than 50.
  • The product of number of origins × number of destinations must be no greater than 625 in any case.
  • The product of the number of origins × number of destinations must be no greater than 100 if routing_preference is set to TRAFFIC_AWARE_OPTIMAL .
  • The product of the number of origins × number of destinations must be no greater than 100 if travel_mode is set to TRANSIT .
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. 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, then this value defaults to the time that you made the request. NOTE: You can only specify a departure_time in the past when RouteTravelMode is set to TRANSIT .

arrival_ time

Timestamp

Необязательный. The arrival time. NOTE: Can only be set when RouteTravelMode is set to TRANSIT . You can specify either departure_time or arrival_time , but not both.

language_ code

string

Необязательный. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see 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 first origin.

region_ code

string

Необязательный. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains .

units

Units

Необязательный. Specifies the units of measure for the display fields.

extra_ computations[]

ExtraComputation

Необязательный. A list of extra computations which may be used to complete the request. Note: These extra computations may return extra fields on the response. These extra fields must also be specified in the field mask to be returned in the response.

traffic_ model

TrafficModel

Необязательный. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the RouteMatrixElement which contains the predicted time in traffic based on historical averages. RoutingPreference to TRAFFIC_AWARE_OPTIMAL and RouteTravelMode to DRIVE . Defaults to BEST_GUESS if traffic is requested and TrafficModel is not specified.

transit_ preferences

TransitPreferences

Необязательный. Specifies preferences that influence the route returned for TRANSIT routes. NOTE: You can only specify a transit_preferences when RouteTravelMode is set to TRANSIT .

ExtraComputation

Extra computations to perform while completing the request.

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Not used. Requests containing this value will fail.
TOLLS Toll information for the matrix element(s).

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. 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. NOTE: You can only specify a departure_time in the past when RouteTravelMode is set to TRANSIT . Transit trips are available for up to 7 days in the past or 100 days in the future.

arrival_ time

Timestamp

Необязательный. The arrival time. NOTE: Can only be set when RouteTravelMode is set to TRANSIT . You can specify either departure_time or arrival_time , but not both. Transit trips are available for up to 7 days in the past or 100 days in the future.

compute_ alternative_ routes

bool

Необязательный. Specifies whether to calculate alternate routes in addition to the route. No alternative routes are returned for requests that have intermediate waypoints.

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

region_ code

string

Необязательный. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains .

units

Units

Необязательный. Specifies the units of measure for the display fields. These fields include 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 first origin.

optimize_ waypoint_ order

bool

Необязательный. If set to true, the service attempts to minimize the overall cost of the route by re-ordering the specified intermediate waypoints. The request fails if any of the intermediate waypoints is a via waypoint. Use ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index to find the new ordering. If ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index is not requested in the X-Goog-FieldMask header, the request fails. If optimize_waypoint_order is set to false, ComputeRoutesResponse.optimized_intermediate_waypoint_index will be empty.

requested_ reference_ routes[]

ReferenceRoute

Необязательный. Specifies what reference routes to calculate as part of the request in addition to the default route. A reference route is a route with a different route calculation objective than the default route. For example a FUEL_EFFICIENT reference route calculation takes into account various parameters that would generate an optimal fuel efficient route. When using this feature, look for route_labels on the resulting routes.

extra_ computations[]

ExtraComputation

Необязательный. A list of extra computations which may be used to complete the request. Note: These extra computations may return extra fields on the response. These extra fields must also be specified in the field mask to be returned in the response.

traffic_ model

TrafficModel

Необязательный. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the Route and RouteLeg which contains the predicted time in traffic based on historical averages. TrafficModel is only available for requests that have set RoutingPreference to TRAFFIC_AWARE_OPTIMAL and RouteTravelMode to DRIVE . Defaults to BEST_GUESS if traffic is requested and TrafficModel is not specified.

transit_ preferences

TransitPreferences

Необязательный. Specifies preferences that influence the route returned for TRANSIT routes. NOTE: You can only specify a transit_preferences when RouteTravelMode is set to TRANSIT .

ExtraComputation

Extra computations to perform while completing the request.

Перечисления
EXTRA_COMPUTATION_UNSPECIFIED Not used. Requests containing this value will fail.
TOLLS Toll information for the route(s).
FUEL_CONSUMPTION Estimated fuel consumption for the route(s).
TRAFFIC_ON_POLYLINE Traffic aware polylines for the route(s).
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions presented as a formatted HTML text string. This content is meant to be read as-is. This content is for display only. Do not programmatically parse it.
FLYOVER_INFO_ON_POLYLINE Flyover information for the route(s). The routes.polyline_details.flyover_info fieldmask must be specified to return this information. This data will only currently be populated for certain metros in India. This feature is experimental, and the SKU/charge is subject to change.
NARROW_ROAD_INFO_ON_POLYLINE Narrow road information for the route(s). The routes.polyline_details.narrow_road_info fieldmask must be specified to return this information. This data will only currently be populated for certain metros in India. This feature is experimental, and the SKU/charge is subject to change.

ReferenceRoute

A supported reference route on the ComputeRoutesRequest.

Перечисления
REFERENCE_ROUTE_UNSPECIFIED Not used. Requests containing this value fail.
FUEL_EFFICIENT Fuel efficient route.
SHORTER_DISTANCE

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

For DRIVE requests, this feature prioritizes shorter distance over driving comfort. For example, it may prefer local roads instead of highways, take dirt roads, cut through parking lots, etc. This feature does not return any maneuvers that Google Maps knows to be illegal.

For BICYCLE and TWO_WHEELER requests, this feature returns routes similar to those returned when you don't specify requested_reference_routes .

This feature is not compatible with any other travel modes, via intermediate waypoints, or optimize_waypoint_order ; such requests will fail. However, you can use it with any routing_preference .

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.

geocoding_ results

GeocodingResults

Contains geocoding response info for waypoints specified as addresses.

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 Not used.
FALLBACK_TRAFFIC_UNAWARE Indicates the TRAFFIC_UNAWARE RoutingPreference was used to compute the response.
FALLBACK_TRAFFIC_AWARE Indicates the TRAFFIC_AWARE RoutingPreference was used to compute the response.

GeocodedWaypoint

Details about the locations used as waypoints. Only populated for address waypoints. Includes details about the geocoding results for the purposes of determining what the address was geocoded to.

Поля
geocoder_ status

Status

Indicates the status code resulting from the geocoding operation.

type[]

string

The type(s) of the result, in the form of zero or more type tags. Supported types: Address types and address component types .

partial_ match

bool

Indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. Вы можете проверить исходный запрос на предмет орфографических ошибок и/или неполного адреса.

place_ id

string

The place ID for this result.

intermediate_ waypoint_ request_ index

int32

The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint.

GeocodingResults

Contains GeocodedWaypoints for origin, destination and intermediate waypoints. Only populated for address waypoints.

Поля
origin

GeocodedWaypoint

Origin geocoded waypoint.

destination

GeocodedWaypoint

Destination geocoded waypoint.

intermediates[]

GeocodedWaypoint

A list of intermediate geocoded waypoints each containing an index field that corresponds to the zero-based position of the waypoint in the order they were specified in the request.

LocalizedTime

Localized description of time.

Поля
time

LocalizedText

The time specified as a string in a given time zone.

time_ zone

string

Contains the time zone. The value is the name of the time zone as defined in the IANA Time Zone Database , eg "America/New_York".

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

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 specifies the side of the road 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, and so on. You can use this field only for DRIVE and TWO_WHEELER RouteTravelMode .

Маневр

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

Перечисления
MANEUVER_UNSPECIFIED Not used.
TURN_SLIGHT_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 Возьмите левую развилку.
FORK_RIGHT Take the right fork.
FERRY Сядьте на паром.
FERRY_TRAIN Take the train leading onto the ferry.
ROUNDABOUT_LEFT Turn left at the roundabout.
ROUNDABOUT_RIGHT Turn right at the roundabout.
DEPART Initial maneuver.
NAME_CHANGE Used to indicate a street name change.

Encapsulates navigation instructions for a RouteLegStep .

Поля
maneuver

Maneuver

Encapsulates the navigation instructions for the current step (for example, turn left, merge, or straight). 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 .

PolylineDetails

Details corresponding to a given index or contiguous segment of a polyline. Given a polyline with points P_0, P_1, ... , P_N (zero-based index), the PolylineDetails defines an interval and associated metadata.

Поля
flyover_ info[]

FlyoverInfo

Flyover details along the polyline.

narrow_ road_ info[]

NarrowRoadInfo

Narrow road details along the polyline.

FlyoverInfo

Encapsulates information about flyovers along the polyline.

Поля
flyover_ presence

RoadFeatureState

Output only. Denotes whether a flyover exists for a given stretch of the polyline.

polyline_ point_ index

PolylinePointIndex

The location of flyover related information along the polyline.

NarrowRoadInfo

Encapsulates information about narrow roads along the polyline.

Поля
narrow_ road_ presence

RoadFeatureState

Output only. Denotes whether a narrow road exists for a given stretch of the polyline.

polyline_ point_ index

PolylinePointIndex

The location of narrow road related information along the polyline.

PolylinePointIndex

Encapsulates the start and end indexes for a polyline detail. For instances where the data corresponds to a single point, start_index and end_index will be equal.

Поля
start_ index

int32

The start index of this detail in the polyline.

end_ index

int32

The end index of this detail in the polyline.

RoadFeatureState

Encapsulates the states of road features along a stretch of polyline.

Перечисления
ROAD_FEATURE_STATE_UNSPECIFIED The road feature's state was not computed (default value).
EXISTS The road feature exists.
DOES_NOT_EXIST The road feature does not exist.

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.

Маршрут

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

Поля
route_ labels[]

RouteLabel

Labels for the Route that are useful to identify specific properties of the route to compare against others.

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 travel through the route without taking traffic conditions into consideration.

polyline

Polyline

The overall route polyline. This polyline is 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 you set optimize_waypoint_order to true, this field contains the optimized ordering of intermediate waypoints. Otherwise, this field is empty. For example, if you give an input of Origin: LA; Intermediate waypoints: 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 provided in the input.

localized_ values

RouteLocalizedValues

Text representations of properties of the Route .

route_ token

string

An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route.

NOTE: Route.route_token is only available for requests that have set ComputeRoutesRequest.routing_preference to TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL . Route.route_token is not supported for requests that have Via waypoints.

polyline_ details

PolylineDetails

Contains information about details along the polyline.

RouteLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as static_duration .

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

transit_ fare

LocalizedText

Transit fare represented in text form.

RouteLabel

Labels for the Route that are useful to identify specific properties of the route to compare against others.

Перечисления
ROUTE_LABEL_UNSPECIFIED Default - not used.
DEFAULT_ROUTE The default "best" route returned for the route computation.
DEFAULT_ROUTE_ALTERNATE An alternative to the default "best" route. Routes like this will be returned when compute_alternative_routes is specified.
FUEL_EFFICIENT Fuel efficient route. Routes labeled with this value are determined to be optimized for Eco parameters such as fuel consumption.
SHORTER_DISTANCE Shorter travel distance route. Это экспериментальная функция.

RouteLeg

Contains 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 travel through the leg, calculated without taking traffic conditions into consideration.

polyline

Polyline

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

start_ location

Location

The start location of this leg. This location 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 location 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

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

localized_ values

RouteLegLocalizedValues

Text representations of properties of the RouteLeg .

steps_ overview

StepsOverview

Overview information about the steps in this RouteLeg . This field is only populated for TRANSIT routes.

RouteLegLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as static_duration.

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

StepsOverview

Provides overview information about a list of RouteLegStep s.

Поля
multi_ modal_ segments[]

MultiModalSegment

Summarized information about different multi-modal segments of the RouteLeg.steps . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

MultiModalSegment

Provides summarized information about different multi-modal segments of the RouteLeg.steps . A multi-modal segment is defined as one or more contiguous RouteLegStep that have the same RouteTravelMode . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

Поля
navigation_ instruction

NavigationInstruction

NavigationInstruction for the multi-modal segment.

travel_ mode

RouteTravelMode

The travel mode of the multi-modal segment.

step_ start_ index

int32

The corresponding RouteLegStep index that is the start of a multi-modal segment.

step_ end_ index

int32

The corresponding RouteLegStep index that is the end of a multi-modal segment.

RouteLegStep

Contains 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

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

localized_ values

RouteLegStepLocalizedValues

Text representations of properties of the RouteLegStep .

transit_ details

RouteLegStepTransitDetails

Details pertaining to this step if the travel mode is TRANSIT .

travel_ mode

RouteTravelMode

The travel mode used for this step.

RouteLegStepLocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

static_ duration

LocalizedText

Duration without taking traffic conditions into consideration, represented in text form.

RouteLegStepTransitDetails

Additional information for the RouteLegStep related to TRANSIT routes.

Поля
stop_ details

TransitStopDetails

Information about the arrival and departure stops for the step.

localized_ values

TransitDetailsLocalizedValues

Text representations of properties of the RouteLegStepTransitDetails .

headsign

string

Specifies the direction in which to travel on this line as marked on the vehicle or at the departure stop. The direction is often the terminus station.

headway

Duration

Specifies the expected time as a duration between departures from the same stop at this time. For example, with a headway seconds value of 600, you would expect a ten minute wait if you should miss your bus.

transit_ line

TransitLine

Information about the transit line used in this step.

stop_ count

int32

The number of stops from the departure to the arrival stop. This count includes the arrival stop, but excludes the departure stop. For example, if your route leaves from Stop A, passes through stops B and C, and arrives at stop D,

stop_count

returns 3.

trip_ short_ text

string

The text that appears in schedules and sign boards to identify a transit trip to passengers. The text should uniquely identify a trip within a service day. For example, "538" is the trip_short_text of the Amtrak train that leaves San Jose, CA at 15:10 on weekdays to Sacramento, CA.

TransitDetailsLocalizedValues

Localized descriptions of values for RouteTransitDetails .

Поля
arrival_ time

LocalizedTime

Time in its formatted text representation with a corresponding time zone.

departure_ time

LocalizedTime

Time in its formatted text representation with a corresponding time zone.

TransitStopDetails

Details about the transit stops for the RouteLegStep .

Поля
arrival_ stop

TransitStop

Information about the arrival stop for the step.

arrival_ time

Timestamp

The estimated time of arrival for the step.

departure_ stop

TransitStop

Information about the departure stop for the step.

departure_ time

Timestamp

The estimated time of departure for the step.

RouteLegStepTravelAdvisory

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

Поля
speed_ reading_ intervals[]

SpeedReadingInterval

NOTE: This field is not currently populated.

RouteLegTravelAdvisory

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

Поля
toll_ info

TollInfo

Contains 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 RouteLeg 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

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

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

localized_ values

LocalizedValues

Text representations of properties of the RouteMatrixElement .

origin_ index

int32

Zero-based index of the origin in the request.

destination_ index

int32

Zero-based index of the destination in the request.

LocalizedValues

Text representations of certain properties.

Поля
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration represented in text form taking traffic conditions into consideration. Note: If traffic information was not requested, this value is the same value as static_duration.

static_ duration

LocalizedText

Duration represented in text form without taking traffic conditions into consideration.

transit_ fare

LocalizedText

Transit fare represented in text form.

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

When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ highways

bool

When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ ferries

bool

When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ indoor

bool

When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the WALK RouteTravelMode .

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

RouteTravelAdvisory

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions.

Поля
toll_ info

TollInfo

Contains information about tolls on the route. This field is only populated if tolls are expected on the route. If this field is set, but the estimatedPrice subfield is not populated, then the route contains tolls, but the estimated price is unknown. If this field is not set, then there are no tolls expected 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).
fuel_ consumption_ microliters

int64

The predicted fuel consumption in microliters.

route_ restrictions_ partially_ ignored

bool

Returned route may have restrictions that are not suitable for requested travel mode or route modifiers.

transit_ fare

Money

If present, contains the total fare or ticket costs on this route This property is only returned for TRANSIT requests and only for routes where fare information is available for all transit steps.

RouteTravelMode

A set of values used to specify the mode of travel. NOTE: WALK , BICYCLE , and TWO_WHEELER routes are in beta and might sometimes be missing clear sidewalks, pedestrian paths, or bicycling paths. You must display this warning to the user for all walking, bicycling, and two-wheel routes that you display in your app.

Перечисления
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.
TRANSIT Travel by public transit routes, where available.

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_UNAWARE .
TRAFFIC_UNAWARE Computes routes without taking live traffic conditions into consideration. Suitable when traffic conditions don't matter or are not applicable. Using this value produces the lowest latency. Note: For RouteTravelMode DRIVE and TWO_WHEELER , the route and duration chosen are based on road network and average time-independent traffic conditions, not current road conditions. Consequently, routes may include roads that are temporarily closed. Results for a given request may vary over time due to changes in the road network, updated average traffic conditions, and the distributed nature of the service. Results may also vary between nearly-equivalent routes at any time or frequency.
TRAFFIC_AWARE Calculates routes taking live 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 live 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.

end_ polyline_ point_ index

int32

The ending index of this interval in the polyline.

Union field speed_type .

speed_type can be only one of the following:

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 Not used. If this value is used, then the request fails.
AU_ETOLL_TAG Sydney toll pass. See additional details at https://www.myetoll.com.au .
AU_EWAY_TAG Sydney toll pass. See additional details at 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.
JP_ETC Japan ETC. Electronic wireless system to collect tolls. https://www.go-etc.jp/
JP_ETC2 Japan ETC2.0. New version of ETC with further discount and bidirectional communication between devices on vehicles and antennas on the road. https://www.go-etc.jp/etc2/index.html
MX_IAVE Mexico toll pass. https://iave.capufe.gob.mx/#/
MX_PASE Mexico https://www.pase.com.mx
MX_QUICKPASS Mexico https://operadoravial.com/quick-pass/
MX_SISTEMA_TELEPEAJE_CHIHUAHUA http://appsh.chihuahua.gob.mx/transparencia/?doc=/ingresos/TelepeajeFormato4.pdf
MX_TAG_IAVE Мексика
MX_TAG_TELEVIA Mexico toll pass company. One of many operating in Mexico City. See additional details at https://www.televia.com.mx .
MX_TELEVIA Mexico toll pass company. One of many operating in Mexico City. 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_BCPASS MI, USA.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG MI, USA.
US_MI_IQ_PROX_CARD

MI, USA. Deprecated as this pass type no longer exists.

US_MI_IQ_TAG 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_AVI_TAG TX, 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_FUEGO_TAG 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_MOV_PASS WV, USA
US_WV_NEWELL_TOLL_BRIDGE_TICKET WV, USA.

TrafficModel

Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the response, which contains the predicted time in traffic based on historical averages.

Перечисления
TRAFFIC_MODEL_UNSPECIFIED Неиспользованный. If specified, will default to BEST_GUESS .
BEST_GUESS Indicates that the returned duration should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.
PESSIMISTIC Indicates that the returned duration should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.
OPTIMISTIC Indicates that the returned duration should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

TransitAgency

A transit agency that operates a transit line.

Поля
name

string

The name of this transit agency.

phone_ number

string

The transit agency's locale-specific formatted phone number.

uri

string

The transit agency's URI.

TransitLine

Contains information about the transit line used in this step.

Поля
agencies[]

TransitAgency

The transit agency (or agencies) that operates this transit line.

name

string

The full name of this transit line, For example, "8 Avenue Local".

uri

string

the URI for this transit line as provided by the transit agency.

color

string

The color commonly used in signage for this line. Represented in hexadecimal.

icon_ uri

string

The URI for the icon associated with this line.

name_ short

string

The short name of this transit line. This name will normally be a line number, such as "M7" or "355".

text_ color

string

The color commonly used in text on signage for this line. Represented in hexadecimal.

vehicle

TransitVehicle

The type of vehicle that operates on this transit line.

TransitPreferences

Preferences for TRANSIT based routes that influence the route that is returned.

Поля
allowed_ travel_ modes[]

TransitTravelMode

A set of travel modes to use when getting a TRANSIT route. Defaults to all supported modes of travel.

routing_ preference

TransitRoutingPreference

A routing preference that, when specified, influences the TRANSIT route returned.

TransitRoutingPreference

Specifies routing preferences for transit routes.

Перечисления
TRANSIT_ROUTING_PREFERENCE_UNSPECIFIED No preference specified.
LESS_WALKING Indicates that the calculated route should prefer limited amounts of walking.
FEWER_TRANSFERS Indicates that the calculated route should prefer a limited number of transfers.

TransitTravelMode

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

Перечисления
TRANSIT_TRAVEL_MODE_UNSPECIFIED No transit travel mode specified.
BUS Путешествие на автобусе.
SUBWAY Travel by subway.
TRAIN Путешествие на поезде.
LIGHT_RAIL Travel by light rail or tram.
RAIL Travel by rail. This is equivalent to a combination of SUBWAY , TRAIN , and LIGHT_RAIL .

TransitStop

Information about a transit stop.

Поля
name

string

The name of the transit stop.

location

Location

The location of the stop expressed in latitude/longitude coordinates.

TransitVehicle

Information about a vehicle used in transit routes.

Поля
name

LocalizedText

The name of this vehicle, capitalized.

type

TransitVehicleType

The type of vehicle used.

icon_ uri

string

The URI for an icon associated with this vehicle type.

local_ icon_ uri

string

The URI for the icon associated with this vehicle type, based on the local transport signage.

TransitVehicleType

The type of vehicles for transit routes.

Перечисления
TRANSIT_VEHICLE_TYPE_UNSPECIFIED Неиспользованный.
BUS Автобус.
CABLE_CAR A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT .
COMMUTER_TRAIN Commuter rail.
FERRY Перевозить.
FUNICULAR A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.
GONDOLA_LIFT An aerial cable car.
HEAVY_RAIL Heavy rail.
HIGH_SPEED_TRAIN High speed train.
INTERCITY_BUS Intercity bus.
LONG_DISTANCE_TRAIN Long distance train.
METRO_RAIL Light rail transit.
MONORAIL Монорельс.
OTHER All other vehicles.
RAIL Железнодорожный.
SHARE_TAXI Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.
SUBWAY Underground light rail.
TRAM Above ground light rail.
TROLLEYBUS Троллейбус.

Единицы

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

Перечисления
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.
DIESEL Diesel fueled vehicle.

VehicleInfo

Contains the vehicle information, such as the vehicle emission type.

Поля
emission_ type

VehicleEmissionType

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

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

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

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.

address

string

Human readable address or a plus code. Подробности см. на https://plus.codes .