- HTTP-запрос
- Тело запроса
- Тело ответа
- ПолилинияКачество
- ПолилинияКодирование
- Справочный маршрут
- Дополнительные вычисления
- Маршрут
- Метка маршрута
- МаршрутНога
- Полилиния
- МаршрутНогаШаг
- НавигацияИнструкция
- Маневр
- МаршрутНогаШагПутешествиеКонсультационный совет
- МаршрутЛегШтепЛокализованныеЗначения
- МаршрутНогаШагТранзитПодробнее
- Транзитная остановкаПодробнее
- ТранзитСтоп
- TransitDetailsLocalizedValues
- Локализованноевремя
- ТранзитЛайн
- Транзитное Агентство
- Транзитное транспортное средство
- Тип транзитного транспортного средства
- МаршрутНогаПутешествиеРекомендации
- МаршрутЛегЛокализованныеЗначения
- ШагиОбзор
- Мультимодальный сегмент
- Область просмотра
- МаршрутLocalizedValues
- ПолилинияПодробнее
- FlyoverИнформация
- ДорогаХарактеристикаСостояние
- ПолилинияПоинтИндекс
- УзкаяДорогаИнформация
- Результаты геокодирования
- Геокодированная путевая точка
Возвращает основной маршрут вместе с дополнительными альтернативными маршрутами, учитывая набор конечных и промежуточных путевых точек.
ПРИМЕЧАНИЕ. Для этого метода требуется указать маску поля ответа во входных данных. Вы можете предоставить маску поля ответа, используя параметр URL-адреса $fields
или fields
или используя заголовок HTTP/gRPC X-Goog-FieldMask
(см. доступные параметры и заголовки URL-адреса ). Значение представляет собой список путей к полям, разделенных запятыми. См. подробную документацию о том, как построить пути к полям .
Например, в этом методе:
- Маска всех доступных полей (для проверки вручную):
X-Goog-FieldMask: *
- Маска поля длительности, расстояния и полилинии на уровне маршрута (пример производственной настройки):
X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline
Google не рекомендует использовать маску поля ответа с подстановочным знаком ( *
) или указывать маску поля на верхнем уровне ( routes
), потому что:
- Выбор только тех полей, которые вам нужны, помогает нашему серверу сэкономить вычислительные циклы, позволяя нам возвращать вам результат с меньшей задержкой.
- Выбор только тех полей, которые вам нужны в вашем рабочем задании, обеспечивает стабильную задержку. В будущем мы можем добавить больше полей ответа, и эти новые поля могут потребовать дополнительного времени вычислений. Если вы выберете все поля или выберете все поля на верхнем уровне, производительность может снизиться, поскольку любое новое добавляемое поле будет автоматически включено в ответ.
- Выбор только тех полей, которые вам нужны, приводит к меньшему размеру ответа и, следовательно, к увеличению пропускной способности сети.
HTTP-запрос
POST https://routes.googleapis.com/directions/v2:computeRoutes
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "origin": { object ( |
Поля | |
---|---|
origin | Необходимый. Исходная путевая точка. |
destination | Необходимый. Маршрутная точка назначения. |
intermediates[] | Необязательный. Набор путевых точек на маршруте (за исключением конечных точек) для остановки или проезда. Поддерживается до 25 промежуточных путевых точек. |
travel Mode | Необязательный. Указывает вид транспорта. |
routing Preference | Необязательный. Указывает, как вычислить маршрут. Сервер пытается использовать выбранную настройку маршрутизации для расчета маршрута. Если предпочтения маршрутизации приводят к ошибке или слишком большой задержке, возвращается ошибка. Вы можете указать эту опцию, только если |
polyline Quality | Необязательный. Указывает предпочтения в отношении качества полилинии. |
polyline Encoding | Необязательный. Указывает предпочтительную кодировку полилинии. |
departure Time | Необязательный. Время отправления. Если вы не установите это значение, то по умолчанию это значение будет соответствовать времени, когда вы сделали запрос. ПРИМЕЧАНИЕ. Вы можете указать значение Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
arrival Time | Необязательный. Время прибытия. ПРИМЕЧАНИЕ. Можно установить только в том случае, если для Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
compute Alternative Routes | Необязательный. Указывает, следует ли рассчитывать альтернативные маршруты в дополнение к маршруту. Альтернативные маршруты не возвращаются для запросов, имеющих промежуточные точки. |
route Modifiers | Необязательный. Набор условий, которые необходимо выполнить, влияющие на способ расчета маршрутов. |
language Code | Необязательный. Код языка BCP-47, например «en-US» или «sr-Latn». Дополнительные сведения см. в разделе Идентификатор локали Unicode . Список поддерживаемых языков см. в разделе «Поддержка языков» . Если вы не укажете это значение, язык отображения будет определяться на основе местоположения запроса маршрута. |
region Code | Необязательный. Код региона в виде двухсимвольного значения ccTLD («домен верхнего уровня»). Дополнительную информацию см. в разделе Домены верхнего уровня с кодом страны . |
units | Необязательный. Указывает единицы измерения для полей отображения. Эти поля включают поле |
optimize Waypoint Order | Необязательный. Если установлено значение true, служба пытается минимизировать общую стоимость маршрута путем изменения порядка указанных промежуточных точек. Запрос завершается неудачей, если какая-либо из промежуточных точек является |
requested Reference Routes[] | Необязательный. Указывает, какие эталонные маршруты следует рассчитывать в рамках запроса в дополнение к маршруту по умолчанию. Эталонный маршрут — это маршрут, цель расчета которого отличается от маршрута по умолчанию. Например, расчет эталонного маршрута |
extra Computations[] | Необязательный. Список дополнительных вычислений, которые можно использовать для выполнения запроса. Примечание. Эти дополнительные вычисления могут возвращать дополнительные поля в ответе. Эти дополнительные поля также должны быть указаны в маске поля, которая будет возвращена в ответе. |
traffic Model | Необязательный. Указывает предположения, которые следует использовать при расчете времени в пробке. Этот параметр влияет на значение, возвращаемое в поле длительности в |
transit Preferences | Необязательный. Указывает предпочтения, влияющие на маршрут, возвращаемый для |
Тело ответа
v2.computeПеренаправляет ответное сообщение.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{ "routes": [ { object ( |
Поля | |
---|---|
routes[] | Содержит массив вычисленных маршрутов (до трех), если вы |
fallback Info | В некоторых случаях, когда сервер не может вычислить результаты маршрута со всеми входными предпочтениями, он может вернуться к использованию другого способа вычислений. Если используется резервный режим, это поле содержит подробную информацию о резервном ответе. В противном случае это поле не установлено. |
geocoding Results | Содержит информацию ответа геокодирования для путевых точек, указанных как адреса. |
ПолилинияКачество
Набор значений, определяющих качество полилинии.
Перечисления | |
---|---|
POLYLINE_QUALITY_UNSPECIFIED | Не указаны предпочтения качества полилиний. По умолчанию OVERVIEW . |
HIGH_QUALITY | Задает высококачественную ломаную линию, состоящую из большего количества точек, чем OVERVIEW , за счет увеличения размера ответа. Используйте это значение, когда вам нужна большая точность. |
OVERVIEW | Указывает обзорную полилинию, состоящую из небольшого количества точек. Используйте это значение при отображении обзора маршрута. Использование этого параметра обеспечивает меньшую задержку запроса по сравнению с использованием параметра HIGH_QUALITY . |
ПолилинияКодирование
Указывает предпочтительный тип возвращаемой полилинии.
Перечисления | |
---|---|
POLYLINE_ENCODING_UNSPECIFIED | Не заданы предпочтения типа полилинии. По умолчанию ENCODED_POLYLINE . |
ENCODED_POLYLINE | Указывает полилинию, закодированную с использованием алгоритма кодирования полилиний . |
GEO_JSON_LINESTRING | Определяет полилинию в формате GeoJSON LineString. |
Справочный маршрут
Поддерживаемый эталонный маршрут в ComputeRoutesRequest.
Перечисления | |
---|---|
REFERENCE_ROUTE_UNSPECIFIED | Не используется. Запросы, содержащие это значение, завершаются неудачно. |
FUEL_EFFICIENT | Экономичный маршрут. |
SHORTER_DISTANCE | Маршрут с меньшим расстоянием путешествия. Это экспериментальная функция. В запросах Для запросов Эта функция несовместима ни с какими другими режимами путешествия, через промежуточные точки или |
Дополнительные вычисления
Дополнительные вычисления, которые необходимо выполнить при выполнении запроса.
Перечисления | |
---|---|
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 . В настоящее время эти данные будут заполнены только для некоторых метрополитенов Индии. Эта функция является экспериментальной, поэтому артикул/стоимость могут быть изменены. |
Маршрут
Содержит маршрут, состоящий из ряда соединенных сегментов дороги, соединяющих начальную, конечную и промежуточную точки маршрута.
JSON-представление |
---|
{ "routeLabels": [ enum ( |
Поля | |
---|---|
route Labels[] | Метки |
legs[] | Набор участков (сегментов пути между путевыми точками), составляющих маршрут. Каждый этап соответствует поездке между двумя |
distance Meters | Дальность прохождения маршрута в метрах. |
duration | Время, необходимое для прохождения маршрута. Если вы установите для Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
static Duration | Продолжительность проезда по маршруту без учета условий движения. Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
polyline | Общая полилиния маршрута. Эта полилиния представляет собой объединенную полилинию всех |
description | Описание маршрута. |
warnings[] | Массив предупреждений, отображаемых при отображении маршрута. |
viewport | Ограничительная рамка видового экрана полилинии. |
travel Advisory | Дополнительная информация о маршруте. |
optimized Intermediate Waypoint Index[] | Если вы установите для |
localized Values | Текстовые представления свойств |
route Token | Непрозрачный токен, который можно передать в Navigation SDK для восстановления маршрута во время навигации и в случае изменения маршрута соблюдать исходное намерение при создании маршрута. Рассматривайте этот токен как непрозрачный объект. Не сравнивайте его значение в разных запросах, поскольку оно может измениться, даже если служба возвращает тот же маршрут. ПРИМЕЧАНИЕ. |
polyline Details | Содержит информацию о деталях вдоль полилинии. |
Метка маршрута
Метки
, которые полезны для определения конкретных свойств маршрута для сравнения с другими. Route
Перечисления | |
---|---|
ROUTE_LABEL_UNSPECIFIED | По умолчанию – не используется. |
DEFAULT_ROUTE | «Лучший» маршрут по умолчанию, возвращаемый для расчета маршрута. |
DEFAULT_ROUTE_ALTERNATE | Альтернатива «лучшему» маршруту по умолчанию. Маршруты, подобные этому, будут возвращены, если указан . |
FUEL_EFFICIENT | Экономичный маршрут. Маршруты, отмеченные этим значением, считаются оптимизированными с учетом параметров Eco, таких как расход топлива. |
SHORTER_DISTANCE | Маршрут с более коротким расстоянием. Это экспериментальная функция. |
МаршрутНога
Содержит сегмент между точками маршрута, не via
.
JSON-представление |
---|
{ "distanceMeters": integer, "duration": string, "staticDuration": string, "polyline": { object ( |
Поля | |
---|---|
distance Meters | Расстояние прохождения участка маршрута, в метрах. |
duration | Время, необходимое для перемещения по ноге. Если для Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
static Duration | Продолжительность проезда по участку рассчитана без учета условий движения. Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
polyline | Полная полилиния для этого участка, включающая полилинию каждого |
start Location | Начальное местоположение этого этапа. Это местоположение может отличаться от указанного |
end Location | Конечное расположение этой ноги. Это местоположение может отличаться от указанного |
steps[] | Массив шагов, обозначающий сегменты внутри этого участка. Каждый шаг представляет собой одну инструкцию навигации. |
travel Advisory | Содержит дополнительную информацию, о которой следует сообщить пользователю, например, возможные ограничения зон движения на участке маршрута. |
localized Values | Текстовые представления свойств |
steps Overview | Обзорная информация о шагах в этом |
Полилиния
Инкапсулирует закодированную полилинию.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения polyline_type . Инкапсулирует тип полилинии. По умолчанию — encoded_polyline. polyline_type может быть только одним из следующих: | |
encoded Polyline | Строковое кодирование ломаной линии с использованием алгоритма кодирования ломаной линии. |
geo Json Linestring | Указывает полилинию с использованием формата GeoJSON LineString . |
МаршрутНогаШаг
Содержит сегмент
. Шаг соответствует одной инструкции навигации. Участки маршрута состоят из ступеней. RouteLeg
JSON-представление |
---|
{ "distanceMeters": integer, "staticDuration": string, "polyline": { object ( |
Поля | |
---|---|
distance Meters | Расстояние перемещения этого шага в метрах. В некоторых случаях это поле может не иметь значения. |
static Duration | Продолжительность прохождения этого этапа без учета дорожных условий. В некоторых случаях это поле может не иметь значения. Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
polyline | Полилиния, связанная с этим шагом. |
start Location | Начальное местоположение этого шага. |
end Location | Конечная позиция этого шага. |
navigation Instruction | Инструкции по навигации. |
travel Advisory | Содержит дополнительную информацию, о которой следует сообщить пользователю, например, возможные ограничения зон движения на шаге ноги. |
localized Values | Текстовые представления свойств |
transit Details | Подробности, относящиеся к этому шагу, если режим движения — |
travel Mode | Режим движения, используемый для этого шага. |
Маневр
Набор значений, определяющих действие навигации, которое необходимо выполнить для текущего шага (например, поворот налево, слияние или прямо).
Перечисления | |
---|---|
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 | Используется для обозначения изменения названия улицы. |
МаршрутНогаШагПутешествиеКонсультационный совет
Содержит дополнительную информацию, о которой следует сообщить пользователю, например, возможные ограничения зоны движения на шаге ноги.
JSON-представление |
---|
{
"speedReadingIntervals": [
{
object ( |
Поля | |
---|---|
speed Reading Intervals[] | ПРИМЕЧАНИЕ. Это поле в настоящее время не заполнено. |
МаршрутЛегШтепЛокализованныеЗначения
Текстовые представления определенных свойств.
JSON-представление |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Расстояние путешествия представлено в текстовой форме. |
static Duration | Продолжительность без учета условий движения, представленная в текстовом виде. |
МаршрутНогаШагТранзитПодробнее
Дополнительная информация для RouteLegStep
относящаяся к TRANSIT
маршрутам.
JSON-представление |
---|
{ "stopDetails": { object ( |
Поля | |
---|---|
stop Details | Информация об остановках прибытия и отправления шага. |
localized Values | Текстовые представления свойств |
headsign | Указывает направление движения по этой линии, указанное на транспортном средстве или на остановке отправления. Направление часто является конечной станцией. |
headway | Указывает ожидаемое время как продолжительность между отправлениями с одной и той же остановки в это время. Например, если значение секунды в пути равно 600, вам придется ждать десять минут, если вы опоздаете на автобус. Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
transit Line | Информация о транзитной линии, используемой на этом этапе. |
stop Count | Количество остановок от остановки отправления до остановки прибытия. Это количество включает остановку прибытия, но исключает остановку отправления. Например, если ваш маршрут отправляется от остановки A, проходит через остановки B и C и прибывает на остановку D, возвращает 3. |
trip Short Text | Текст, который появляется в расписаниях и вывесках для обозначения пассажирами транзитной поездки. Текст должен однозначно идентифицировать поездку в течение дня обслуживания. Например, «538» — это |
Транзитная остановкаПодробнее
Подробности о транзитных остановках для RouteLegStep
.
JSON-представление |
---|
{ "arrivalStop": { object ( |
Поля | |
---|---|
arrival Stop | Информация об остановке прибытия на шаг. |
arrival Time | Расчетное время прибытия шага. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
departure Stop | Информация об остановке отправления на шаг. |
departure Time | Ориентировочное время выхода на шаг. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
ТранзитСтоп
Информация о транзитной остановке.
JSON-представление |
---|
{
"name": string,
"location": {
object ( |
Поля | |
---|---|
name | Название транзитной остановки. |
location | Местоположение остановки, выраженное в координатах широты и долготы. |
TransitDetailsLocalizedValues
Локализованные описания значений RouteTransitDetails
.
JSON-представление |
---|
{ "arrivalTime": { object ( |
Поля | |
---|---|
arrival Time | Время в форматированном текстовом представлении с соответствующим часовым поясом. |
departure Time | Время в форматированном текстовом представлении с соответствующим часовым поясом. |
Локализованноевремя
Локализованное описание времени.
JSON-представление |
---|
{
"time": {
object ( |
Поля | |
---|---|
time | Время, указанное в виде строки в заданном часовом поясе. |
time Zone | Содержит часовой пояс. Значением является название часового пояса, определенное в базе данных часовых поясов IANA , например «Америка/Нью_Йорк». |
ТранзитЛайн
Содержит информацию о транзитной линии, использованной на этом этапе.
JSON-представление |
---|
{ "agencies": [ { object ( |
Поля | |
---|---|
agencies[] | Транзитное агентство (или агентства), которое управляет этой транзитной линией. |
name | Полное название этой транспортной линии, например, «8 Avenue Local». |
uri | URI для этой транзитной линии, предоставленный транзитным агентством. |
color | Цвет, обычно используемый в вывесках этой линии. Представлено в шестнадцатеричном формате. |
icon Uri | URI для значка, связанного с этой строкой. |
name Short | Краткое название этой транзитной линии. Обычно это имя представляет собой номер строки, например «M7» или «355». |
text Color | Цвет, обычно используемый в тексте на вывесках этой линии. Представлено в шестнадцатеричном формате. |
vehicle | Тип транспортного средства, курсирующего по данной транзитной линии. |
Транзитное Агентство
Транзитное агентство, управляющее транзитной линией.
JSON-представление |
---|
{ "name": string, "phoneNumber": string, "uri": string } |
Поля | |
---|---|
name | Название этого транзитного агентства. |
phone Number | Номер телефона транзитного агентства, отформатированный в соответствии с региональным стандартом. |
uri | URI транзитного агентства. |
Транзитное транспортное средство
Сведения о транспортном средстве, используемом на транзитных маршрутах.
JSON-представление |
---|
{ "name": { object ( |
Поля | |
---|---|
name | Название этого автомобиля, с большой буквы. |
type | Тип используемого транспортного средства. |
icon Uri | URI для значка, связанного с этим типом транспортного средства. |
local Icon Uri | URI для значка, связанного с этим типом транспортного средства, на основе знаков местного транспорта. |
Тип транзитного транспортного средства
Тип транспортных средств для транзитных маршрутов.
Перечисления | |
---|---|
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 | Троллейбус. |
МаршрутНогаПутешествиеРекомендации
Содержит дополнительную информацию, о которой пользователь должен быть проинформирован на шаге ноги, например, возможные ограничения зон движения.
JSON-представление |
---|
{ "tollInfo": { object ( |
Поля | |
---|---|
toll Info | Содержит информацию о дорожных сборах на конкретном |
speed Reading Intervals[] | Интервалы считывания скорости с подробным описанием плотности трафика. Применимо в случае предпочтений маршрутизации Пример:
|
МаршрутЛегЛокализованныеЗначения
Текстовые представления определенных свойств.
JSON-представление |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Расстояние путешествия представлено в текстовой форме. |
duration | Продолжительность, представленная в текстовой форме и локализованная для региона запроса. Учитывает условия дорожного движения. Примечание. Если вы не запрашивали информацию о трафике, это значение совпадает со значением staticDuration. |
static Duration | Продолжительность без учета условий движения, представленная в текстовом виде. |
ШагиОбзор
Предоставляет обзорную информацию о списке RouteLegStep
.
JSON-представление |
---|
{
"multiModalSegments": [
{
object ( |
Поля | |
---|---|
multi Modal Segments[] | Обобщенная информация о различных мультимодальных сегментах |
Мультимодальный сегмент
Предоставляет сводную информацию о различных мультимодальных сегментах RouteLeg.steps
. Мультимодальный сегмент определяется как один или несколько смежных RouteLegStep
, имеющих одинаковый RouteTravelMode
. Это поле не заполняется, если RouteLeg
не содержит мультимодальных сегментов в шагах.
JSON-представление |
---|
{ "navigationInstruction": { object ( |
Поля | |
---|---|
navigation Instruction | NavigationInstruction для мультимодального сегмента. |
travel Mode | Режим путешествия мультимодального сегмента. |
step Start Index | Соответствующий индекс |
step End Index | Соответствующий индекс |
Область просмотра
Окно просмотра широты и долготы, представленное в виде двух диагонально противоположных low
и high
точек. Область просмотра считается закрытой областью, т. е. включает в себя ее границу. Границы широты должны находиться в диапазоне от -90 до 90 градусов включительно, а границы долготы должны находиться в диапазоне от -180 до 180 градусов включительно. Различные случаи включают в себя:
Если
low
=high
, область просмотра состоит из этой единственной точки.Если
low.longitude
>high.longitude
, диапазон долготы инвертируется (окно просмотра пересекает линию долготы в 180 градусов).Если
low.longitude
= -180 градусов иhigh.longitude
= 180 градусов, область просмотра включает все значения долготы.Если
low.longitude
= 180 градусов иhigh.longitude
= -180 градусов, диапазон долготы пуст.Если
low.latitude
>high.latitude
, диапазон широт пуст.
Оба значения low
и high
должны быть заполнены, а представленное поле не может быть пустым (как указано в определениях выше). Пустое окно просмотра приведет к ошибке.
Например, это окно просмотра полностью охватывает Нью-Йорк:
{ "низкая": { "широта": 40,477398, "долгота": -74,259087 }, "высокая": { "широта": 40,91618, "долгота": -73,70018 } }
JSON-представление |
---|
{ "low": { object ( |
Поля | |
---|---|
low | Необходимый. Нижняя точка смотрового окна. |
high | Необходимый. Самая высокая точка смотрового окна. |
МаршрутLocalizedValues
Текстовые представления определенных свойств.
JSON-представление |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Расстояние путешествия представлено в текстовой форме. |
duration | Продолжительность, представленная в текстовой форме и локализованная для региона запроса. Учитывает условия дорожного движения. Примечание. Если вы не запрашивали информацию о трафике, это значение совпадает со значением |
static Duration | Продолжительность без учета условий движения, представленная в текстовом виде. |
transit Fare | Транзитный тариф представлен в текстовом виде. |
ПолилинияПодробнее
Детали, соответствующие заданному индексу или непрерывному сегменту полилинии. Для полилинии с точками P_0, P_1,..., P_N (индекс, начинающийся с нуля), PolylineDetails
определяет интервал и связанные метаданные.
JSON-представление |
---|
{ "flyoverInfo": [ { object ( |
Поля | |
---|---|
flyover Info[] | Детали эстакады вдоль полилинии. |
narrow Road Info[] | Детали узкой дороги вдоль полилинии. |
FlyoverИнформация
Инкапсулирует информацию о развязках вдоль полилинии.
JSON-представление |
---|
{ "flyoverPresence": enum ( |
Поля | |
---|---|
flyover Presence | Только вывод. Указывает, существует ли эстакада на данном участке полилинии. |
polyline Point Index | Расположение информации, связанной с эстакадой, вдоль полилинии. |
ДорогаХарактеристикаСостояние
Инкапсулирует состояния объектов дороги вдоль участка полилинии.
Перечисления | |
---|---|
ROAD_FEATURE_STATE_UNSPECIFIED | Состояние объекта дороги не было рассчитано (значение по умолчанию). |
EXISTS | Объект дороги существует. |
DOES_NOT_EXIST | Объект дороги не существует. |
ПолилинияПоинтИндекс
Инкапсулирует начальный и конечный индексы полилинии. В тех случаях, когда данные соответствуют одной точке, startIndex
и endIndex
будут равны.
JSON-представление |
---|
{ "startIndex": integer, "endIndex": integer } |
Поля | |
---|---|
start Index | Начальный индекс детали в полилинии. |
end Index | Конечный индекс этой детали в полилинии. |
УзкаяДорогаИнформация
Инкапсулирует информацию об узких дорогах вдоль полилинии.
JSON-представление |
---|
{ "narrowRoadPresence": enum ( |
Поля | |
---|---|
narrow Road Presence | Только вывод. Указывает, существует ли узкая дорога на данном участке полилинии. |
polyline Point Index | Расположение информации, связанной с узкой дорогой, вдоль полилинии. |
Результаты геокодирования
Содержит
для точек отправления, назначения и промежуточных путевых точек. Заполняется только для адресных путевых точек. GeocodedWaypoints
JSON-представление |
---|
{ "origin": { object ( |
Поля | |
---|---|
origin | Исходная геокодированная путевая точка. |
destination | Геокодированная путевая точка пункта назначения. |
intermediates[] | Список промежуточных геокодированных путевых точек, каждая из которых содержит индексное поле, соответствующее положению путевой точки, отсчитываемому от нуля, в том порядке, в котором они были указаны в запросе. |
Геокодированная путевая точка
Подробная информация о местах, используемых в качестве путевых точек. Заполняется только для адресных путевых точек. Включает подробную информацию о результатах геокодирования для определения того, для чего был геокодирован адрес.
JSON-представление |
---|
{
"geocoderStatus": {
object ( |
Поля | |
---|---|
geocoder Status | Указывает код состояния, полученный в результате операции геокодирования. |
type[] | Тип(ы) результата в виде нуля или более тегов типа. Поддерживаемые типы: типы адресов и типы компонентов адреса . |
partial Match | Указывает, что геокодер не вернул точное соответствие исходному запросу, хотя смог сопоставить часть запрошенного адреса. Вы можете проверить исходный запрос на предмет орфографических ошибок и/или неполного адреса. |
place Id | Идентификатор места для этого результата. |
intermediate Waypoint Request Index | Индекс соответствующей промежуточной точки в запросе. Заполняется только в том случае, если соответствующая путевая точка является промежуточной. |
- HTTP-запрос
- Тело запроса
- Тело ответа
- ПолилинияКачество
- ПолилинияКодирование
- Справочный маршрут
- Дополнительные вычисления
- Маршрут
- Метка маршрута
- МаршрутНога
- Полилиния
- МаршрутНогаШаг
- НавигацияИнструкция
- Маневр
- МаршрутНогаШагПутешествиеКонсультационный совет
- МаршрутЛегШтепЛокализованныеЗначения
- МаршрутНогаШагТранзитПодробности
- Транзитная остановкаПодробнее
- ТранзитСтоп
- TransitDetailsLocalizedValues
- Локализованноевремя
- ТранзитЛайн
- Транзитное Агентство
- Транзитное транспортное средство
- Тип транзитного транспортного средства
- МаршрутНогаПутешествиеРекомендации
- МаршрутЛегЛокализованныеЗначения
- ШагиОбзор
- Мультимодальный сегмент
- Область просмотра
- МаршрутLocalizedValues
- ПолилинияПодробнее
- FlyoverИнформация
- ДорогаХарактеристикаСостояние
- ПолилинияПоинтИндекс
- УзкаяДорогаИнформация
- Результаты геокодирования
- Геокодированная путевая точка
Возвращает основной маршрут вместе с дополнительными альтернативными маршрутами, учитывая набор конечных и промежуточных точек.
ПРИМЕЧАНИЕ. Для этого метода требуется указать маску поля ответа во входных данных. Вы можете предоставить маску поля ответа, используя параметр URL-адреса $fields
или fields
или используя заголовок HTTP/gRPC X-Goog-FieldMask
(см. доступные параметры и заголовки URL-адреса ). Значение представляет собой список путей к полям, разделенных запятыми. См. подробную документацию о том, как построить пути к полям .
Например, в этом методе:
- Маска всех доступных полей (для проверки вручную):
X-Goog-FieldMask: *
- Маска поля длительности, расстояния и полилинии на уровне маршрута (пример производственной настройки):
X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline
Google не рекомендует использовать маску поля ответа с подстановочным знаком ( *
) или указывать маску поля на верхнем уровне ( routes
), потому что:
- Выбор только тех полей, которые вам нужны, помогает нашему серверу сэкономить вычислительные циклы, позволяя нам возвращать вам результат с меньшей задержкой.
- Выбор только тех полей, которые вам нужны в вашем рабочем задании, обеспечивает стабильную задержку. В будущем мы можем добавить больше полей ответа, и эти новые поля могут потребовать дополнительного времени вычислений. Если вы выберете все поля или выберете все поля на верхнем уровне, производительность может снизиться, поскольку любое новое добавляемое поле будет автоматически включено в ответ.
- Выбор только те полей, которые вам нужны, приводит к меньшему размеру отклика и, следовательно, более высокой пропускной способности сети.
Http -запрос
POST https://routes.googleapis.com/directions/v2:computeRoutes
URL использует синтаксис транскодирования GRPC .
Тело запроса
Тело запроса содержит данные со следующей структурой:
Представление JSON |
---|
{ "origin": { object ( |
Поля | |
---|---|
origin | Необходимый. Происхождение путешественника. |
destination | Необходимый. Путь назначения. |
intermediates[] | Необязательный. Набор путевых точек вдоль маршрута (за исключением точек терминала), либо для остановки, либо проходящего мимо. Поддерживается до 25 промежуточных путевых точек. |
travel Mode | Необязательный. Определяет способ транспортировки. |
routing Preference | Необязательный. Указывает, как вычислить маршрут. Сервер пытается использовать выбранное предпочтение маршрутизации для вычисления маршрута. Если предпочтение маршрутизации приводит к ошибке или дополнительной длинной задержке, то возвращается ошибка. Вы можете указать эту опцию только в том случае, когда |
polyline Quality | Необязательный. Указывает ваше предпочтение качеству полилинии. |
polyline Encoding | Необязательный. Указывает предпочтительное кодирование для полилины. |
departure Time | Необязательный. Время отъезда. Если вы не установите это значение, то это значение по умолчанию по умолчанию в то время, которое вы сделали запрос. ПРИМЕЧАНИЕ. Вы можете указать только Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
arrival Time | Необязательный. Время прибытия. Примечание: может быть установлено только тогда, когда Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
compute Alternative Routes | Необязательный. Определяет, рассчитывать ли альтернативные маршруты в дополнение к маршруту. Никаких альтернативных маршрутов не возвращаются для запросов, которые имеют промежуточные путевые точки. |
route Modifiers | Необязательный. Набор условий, чтобы удовлетворить, что влияет на то, как рассчитываются маршруты. |
language Code | Необязательный. Языковой код BCP-47, такой как «En-US» или «SR-Latn». Для получения дополнительной информации см. Идентификатор локали Unicode . Смотрите языковую поддержку списка поддерживаемых языков. Когда вы не предоставляете это значение, язык отображения выводится из местоположения запроса маршрута. |
region Code | Необязательный. Код региона, указанный как CCTLD («Домен верхнего уровня»). Для получения дополнительной информации см. Код страны домены высшего уровня . |
units | Необязательный. Определяет единицы измерения для полей дисплея. Эти поля включают поле |
optimize Waypoint Order | Необязательный. Если установить True, услуга пытается минимизировать общую стоимость маршрута путем повторного упорядочения указанных промежуточных путевых точек. Запрос не работает, если какая -либо из промежуточных путевых точек является |
requested Reference Routes[] | Необязательный. Определяет, какие эталонные маршруты для расчета в рамках запроса в дополнение к маршруту по умолчанию. Справочный маршрут - это маршрут с другой целью расчета маршрута, чем маршрут по умолчанию. Например, расчет маршрута опорного маршрута |
extra Computations[] | Необязательный. Список дополнительных вычислений, которые могут использоваться для выполнения запроса. Примечание. Эти дополнительные вычисления могут вернуть дополнительные поля в ответе. Эти дополнительные поля также должны быть указаны в полевой маске, чтобы быть возвращенным в ответе. |
traffic Model | Необязательный. Определяет предположения, которые используются при расчете времени в трафике. Эта настройка влияет на значение, возвращаемое в поле продолжительности в |
transit Preferences | Необязательный. Указывает предпочтения, которые влияют на маршрут, возвращаемый для |
Тело ответа
v2.computerouts отвечает на сообщение.
В случае успеха тело ответа содержит данные со следующей структурой:
Представление JSON |
---|
{ "routes": [ { object ( |
Поля | |
---|---|
routes[] | Содержит массив вычисленных маршрутов (до трех), когда вы указываете |
fallback Info | В некоторых случаях, когда сервер не может вычислять результаты маршрута со всеми входными предпочтениями, он может отступить для использования другого способа вычисления. Когда используется резервный режим, это поле содержит подробную информацию о ответном ответе. В противном случае это поле не является. |
geocoding Results | Содержит информацию о ответе геокодирования для путевых точек, указанных в качестве адресов. |
Полилинвальт
Набор значений, которые указывают качество полилинии.
Перечисление | |
---|---|
POLYLINE_QUALITY_UNSPECIFIED | Не указано предпочтение качественного качества. По умолчанию OVERVIEW . |
HIGH_QUALITY | Определяет высококачественную полилинию, которая состоит из большего количества точек, чем OVERVIEW , за счет увеличения размера отклика. Используйте это значение, когда вам нужно больше точности. |
OVERVIEW | Определяет обзор полилинии, который состоит из небольшого количества точек. Используйте это значение при отображении обзора маршрута. Использование этой опции имеет более низкую задержку запроса по сравнению с использованием опции HIGH_QUALITY . |
Полинозодирование
Определяет предпочтительный тип полилинии, который будет возвращен.
Перечисление | |
---|---|
POLYLINE_ENCODING_UNSPECIFIED | Не указано предпочтение типа полилины. По умолчанию ENCODED_POLYLINE . |
ENCODED_POLYLINE | Определяет полилин, кодируемый с использованием алгоритма кодирования полилины . |
GEO_JSON_LINESTRING | Определяет полилин, используя формат Geojson Linestring |
Ссылка
Поддерживаемый справочный маршрут на компьютерной области.
Перечисление | |
---|---|
REFERENCE_ROUTE_UNSPECIFIED | Не используется. Запросы, содержащие это значение, не сбои. |
FUEL_EFFICIENT | Экономичный маршрут. |
SHORTER_DISTANCE | Маршрут с более коротким расстоянием движения. Это экспериментальная функция. Для запросов Для запросов Эта функция не совместима с какими -либо другими режимами движения, через промежуточные путевые точки или |
Внешневатор
Дополнительные вычисления для выполнения при выполнении запроса.
Перечисление | |
---|---|
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/заряд может быть изменена. |
Маршрут
Содержит маршрут, который состоит из ряда подключенных дорожных сегментов, которые соединяются с началом, окончанием и промежуточными путевыми точками.
Представление JSON |
---|
{ "routeLabels": [ enum ( |
Поля | |
---|---|
route Labels[] | Метки для |
legs[] | Коллекция ног (сегменты пути между путевыми точками), которые составляют маршрут. Каждая нога соответствует поездке между двумя |
distance Meters | Расстояние прохождения маршрута, в метрах. |
duration | Продолжительность времени, необходимого для навигации по маршруту. Если вы установите Продолжительность за секунды с девятью дробными цифрами, заканчивая « |
static Duration | Продолжительность движения по маршруту без учета условий движения. Продолжительность за секунды с девятью дробными цифрами, заканчивая « |
polyline | Общий маршрут полилинии. Эта полилина является комбинированной полилинией всех |
description | Описание маршрута. |
warnings[] | Множество предупреждений, чтобы показать при отображении маршрута. |
viewport | Ограничивающая коробка просмотра полилины. |
travel Advisory | Дополнительная информация о маршруте. |
optimized Intermediate Waypoint Index[] | Если вы установите |
localized Values | Текстовые представления свойств |
route Token | Непрозрачный токен, который можно передать в SDK навигации для восстановления маршрута во время навигации, и, в случае перенаправления, соблюдайте первоначальное намерение, когда был создан маршрут. Обратитесь к этому токен как непрозрачный каплей. Не сравнивайте его значение по запросам, так как его значение может измениться, даже если служба возвращает тот же маршрут. Примечание: |
polyline Details | Содержит информацию о деталях вдоль полилины. |
RouteLabel
Метки для
, которые полезны для определения конкретных свойств маршрута для сравнения с другими. Route
Перечисление | |
---|---|
ROUTE_LABEL_UNSPECIFIED | По умолчанию - не используется. |
DEFAULT_ROUTE | По умолчанию «Лучший» маршрут вернулся для вычисления маршрута. |
DEFAULT_ROUTE_ALTERNATE | Альтернатива маршруту «Лучший» по умолчанию. Подобные маршруты будут возвращены, когда будет указана . |
FUEL_EFFICIENT | Экономичный маршрут. Маршруты, помеченные этим значением, определяются как оптимизированные для параметров ECO, таких как расход топлива. |
SHORTER_DISTANCE | Краткий маршрут расстояния прохождения. Это экспериментальная функция. |
Routeleg
Содержит сегмент между не via
путевые точки.
Представление JSON |
---|
{ "distanceMeters": integer, "duration": string, "staticDuration": string, "polyline": { object ( |
Поля | |
---|---|
distance Meters | Расстояние перемещения от ноги маршрута, в метрах. |
duration | Длина времени, необходимого для навигации по ноге. Если Продолжительность за секунды с девятью дробными цифрами, заканчивая « |
static Duration | Продолжительность перемещения через ногу, рассчитанная без учета условий движения. Продолжительность за секунды с девятью дробными цифрами, заканчивая « |
polyline | Общая полилина для этой ноги, которая включает в себя полилинию каждого |
start Location | Начальное расположение этой ноги. Это место может отличаться от предоставленного |
end Location | Конечное местоположение этой ноги. Это место может отличаться от предоставленного |
steps[] | Множество шагов, обозначающих сегменты в этой ноге. Каждый шаг представляет одну навигационную инструкцию. |
travel Advisory | Содержит дополнительную информацию, о которой должен быть проинформирован пользователь, такую как возможные ограничения зоны трафика, на ноге маршрута. |
localized Values | Текстовые представления свойств |
steps Overview | Обзор Информация о шагах в этом |
Полилиния
Инкапсулирует закодированную полилинию.
Представление JSON |
---|
{ // Union field |
Поля | |
---|---|
Полевое поле polyline_type . Инкапсулирует тип полилинии. По умолчанию кодировать_полилин. polyline_type может быть только одним из следующих: | |
encoded Polyline | Строка кодирования полилины с использованием алгоритма кодирования полилины |
geo Json Linestring | Определяет полилин, используя формат Linestring Geojson . |
Routelegstep
Содержит сегмент
. Шаг соответствует единой навигационной инструкции. Ноги маршрута состоят из ступеней. RouteLeg
Представление JSON |
---|
{ "distanceMeters": integer, "staticDuration": string, "polyline": { object ( |
Поля | |
---|---|
distance Meters | Расстояние прохождения этого шага в метрах. В некоторых случаях это поле может не иметь значения. |
static Duration | Продолжительность прохождения через этот шаг без учета условий движения. В некоторых случаях это поле может не иметь значения. Продолжительность за секунды с девятью дробными цифрами, заканчивая « |
polyline | Полилина, связанная с этим шагом. |
start Location | Начало этого шага. |
end Location | Конечное местоположение этого шага. |
navigation Instruction | Навигационные инструкции. |
travel Advisory | Содержит дополнительную информацию, о которой должен быть проинформирован пользователь, такую как возможные ограничения зоны трафика, на шаге ноги. |
localized Values | Текстовые представления свойств |
transit Details | Детали, относящиеся к этому шагу, если режим путешествий |
travel Mode | Режим движения, используемый для этого шага. |
Маневр
Набор значений, которые указывают на навигационное действие, чтобы предпринять для текущего шага (например, поверните налево, слияние или прямо).
Перечисление | |
---|---|
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 | Используется для указания изменения названия улицы. |
Routelegsteptraveladvisory
Содержит дополнительную информацию, о которой должен быть проинформирован пользователь, такую как возможные ограничения зоны трафика на шаге ноги.
Представление JSON |
---|
{
"speedReadingIntervals": [
{
object ( |
Поля | |
---|---|
speed Reading Intervals[] | Примечание: это поле в настоящее время не заполнено. |
RoutelegsteplocalizedValues
Текстовые представления определенных свойств.
Представление JSON |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Расстояние перемещения представлено в текстовой форме. |
static Duration | Продолжительность без учета условий движения, представленных в текстовой форме. |
Routelegsteptransitdetails
Дополнительная информация для RouteLegStep
связанного с TRANSIT
маршрутами.
Представление JSON |
---|
{ "stopDetails": { object ( |
Поля | |
---|---|
stop Details | Информация о прибытии и отъезде останавливается на шаге. |
localized Values | Текстовые представления свойств |
headsign | Указывает направление, в котором можно перемещаться по этой линии, как отмечено на транспортном средстве или на остановке вылета. Направление часто является станцией термина. |
headway | Определяет ожидаемое время как продолжительность между отъездами от той же остановки в это время. Например, со значением Headway Seconds 600 вы ожидаете, что вы ожидаете, если вам следует пропустить свой автобус. Продолжительность за секунды с девятью дробными цифрами, заканчивая « |
transit Line | Информация о транзитной линии, используемой на этом этапе. |
stop Count | Количество остановок от отъезда до остановки прибытия. Этот счет включает в себя остановку прибытия, но исключает остановку отъезда. Например, если ваш маршрут уходит от остановки A, проходит через остановки B и C и прибывает на Stop D, Возврат 3. |
trip Short Text | Текст, который появляется в расписаниях и досках для выявления транзитного путешествия пассажирам. Текст должен уникально идентифицировать поездку в день обслуживания. Например, «538» - это |
Transitstopdetails
Подробная информация о транзитных остановках для RouteLegStep
.
Представление JSON |
---|
{ "arrivalStop": { object ( |
Поля | |
---|---|
arrival Stop | Информация о остановке прибытия для шага. |
arrival Time | Расчетное время прибытия для шага. Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
departure Stop | Информация о остановке отъезда для шага. |
departure Time | Расчетное время отправления на шаг. Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
Транзитстоп
Информация о транзитной остановке.
Представление JSON |
---|
{
"name": string,
"location": {
object ( |
Поля | |
---|---|
name | Название транзитной остановки. |
location | Расположение остановки, выраженное в координатах широты/долготы. |
TransitdetailSlocalizedValues
Локализованные описания значений для RouteTransitDetails
.
Представление JSON |
---|
{ "arrivalTime": { object ( |
Поля | |
---|---|
arrival Time | Время в его отформатированном текстовом представлении с соответствующим часовым поясом. |
departure Time | Время в его отформатированном текстовом представлении с соответствующим часовым поясом. |
Локализованный время
Локализованное описание времени.
Представление JSON |
---|
{
"time": {
object ( |
Поля | |
---|---|
time | Время, указанное как строка в данном часовом поясе. |
time Zone | Содержит часовой пояс. Значение - это название часового пояса, как определено в базе данных IANA Time Rate , например, «America/New_york». |
Транзитная линия
Содержит информацию о транзитной линии, используемой на этом этапе.
Представление JSON |
---|
{ "agencies": [ { object ( |
Поля | |
---|---|
agencies[] | Транзитное агентство (или агентства), которое управляет этой транзитной линией. |
name | Полное имя этой транзитной линии, например, «8 Avenue Local». |
uri | URI для этой транзитной линии, как это предусмотрено транзитным агентством. |
color | Цвет обычно используется в вывесках для этой линии. Представлено в шестнадцатеричной. |
icon Uri | URI для значка, связанной с этой линией. |
name Short | Короткое название этой транзитной линии. Это имя обычно будет номером строки, таким как «M7» или «355». |
text Color | Цвет, обычно используемый в тексте на вывеске для этой линии. Представлено в шестнадцатеричной. |
vehicle | Тип транспортного средства, который работает на этой транзитной линии. |
Транстирантность
Транзитное агентство, которое управляет транзитной линией.
Представление JSON |
---|
{ "name": string, "phoneNumber": string, "uri": string } |
Поля | |
---|---|
name | Название этого транзитного агентства. |
phone Number | Форматированный номер телефона транзитного агентства. |
uri | Ури транзитного агентства. |
Транзит
Информация о транспортном средстве, используемом в транзитных маршрутах.
Представление JSON |
---|
{ "name": { object ( |
Поля | |
---|---|
name | Название этого автомобиля, капитализированное. |
type | Тип используемого транспортного средства. |
icon Uri | URI для значка, связанной с этим типом транспортного средства. |
local Icon Uri | 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 | Троллейбус. |
Routelegtraveladvisory
Содержит дополнительную информацию, о которой пользователь должен быть проинформирован на шаге ноги, такую как возможные ограничения зоны трафика.
Представление JSON |
---|
{ "tollInfo": { object ( |
Поля | |
---|---|
toll Info | Содержит информацию о просмотре на конкретном |
speed Reading Intervals[] | Интервалы скорости чтения детализируют плотность трафика. Применимо в случае Пример:
|
RouteleglocalizedValues
Текстовые представления определенных свойств.
Представление JSON |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Расстояние перемещения представлено в текстовой форме. |
duration | Продолжительность, представленная в текстовой форме и локализованная в области запроса. Принимает во внимание условия движения. Примечание. Если вы не запросили информацию о трафике, это значение является тем же значением, что и StaticDuration. |
static Duration | Продолжительность без учета условий движения, представленных в текстовой форме. |
STESTORGEVERVIEW
Предоставляет обзор информации о списке RouteLegStep
s.
Представление JSON |
---|
{
"multiModalSegments": [
{
object ( |
Поля | |
---|---|
multi Modal Segments[] | Суммировала информацию о различных мультимодальных сегментах |
Мультимодалсегмент
Предоставляет суммированную информацию о различных мультимодальных сегментах RouteLeg.steps
. Мультимодальный сегмент определяется как один или несколько смежных RouteLegStep
, которые имеют одинаковый RouteTravelMode
. Это поле не заполнено, если на RouteLeg
не содержит каких-либо мультимодальных сегментов.
Представление JSON |
---|
{ "navigationInstruction": { object ( |
Поля | |
---|---|
navigation Instruction | Навигационная инструкция для мультимодального сегмента. |
travel Mode | Режим движения мультимодального сегмента. |
step Start Index | Соответствующий индекс |
step End Index | Соответствующий индекс |
Область просмотра
Широта длительного просмотра, представленное как два диагонали напротив low
и high
точек. Viewport считается закрытым регионом, то есть он включает в себя свою границу. Границы широты должны варьироваться от -90 до 90 градусов включено, а границы долготы должны варьироваться от -180 до 180 градусов включено. Различные случаи включают:
Если
low
=high
, топорт Views состоит из этой единственной точки.Если
low.longitude
>high.longitude
.Если
low.longitude
= -180 градусов иhigh.longitude
.Если
low.longitude
= 180 градусов иhigh.longitude
Longity = -180 градусов, диапазон долготы пуст.Если
low.latitude
>high.latitude
, диапазон широты пуст.
Как low
, так и high
должен быть заполнен, а представленная коробка не может быть пустой (как указано по определениям выше). Пустой вид просмотра приведет к ошибке.
Например, этот вид VIELE полностью прилагает Нью -Йорк:
{"low": {"Latitude": 40.477398, "Londitude": -74.259087}, "High": {"Latitude": 40.91618, "Londitude": -73.70018}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}
Представление JSON |
---|
{ "low": { object ( |
Поля | |
---|---|
low | Необходимый. Низкая точка просмотра. |
high | Необходимый. Высшая точка просмотра. |
RateLocalizedValues
Текстовые представления определенных свойств.
Представление JSON |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Расстояние перемещения представлено в текстовой форме. |
duration | Продолжительность, представленная в текстовой форме и локализованная в области запроса. Принимает во внимание условия движения. Примечание. Если вы не запросили информацию о трафике, это значение является тем же значением, что и |
static Duration | Продолжительность без учета условий движения, представленных в текстовой форме. |
transit Fare | Транзитный тариф представлен в текстовой форме. |
Полилифинетисты
Детали, соответствующие данному индексу или смежному сегменту полилинии. Учитывая полилин с точками p_0, p_1, ..., p_n (индекс на основе нуля), PolylineDetails
определяют интервал и связанные метаданные.
Представление JSON |
---|
{ "flyoverInfo": [ { object ( |
Поля | |
---|---|
flyover Info[] | Детали эстакады вдоль полилины. |
narrow Road Info[] | Узкие дорожные детали вдоль полилины. |
RelooverInfo
Инкапсулирует информацию о эстакаде вдоль полилины.
Представление JSON |
---|
{ "flyoverPresence": enum ( |
Поля | |
---|---|
flyover Presence | Только вывод. Обозначает, существует ли эстакада для данного участка полилинии. |
polyline Point Index | Расположение информации, связанной с эстакадой вдоль полилины. |
Roadfeaturestate
Инкапсулирует состояния дорожных особенностей вдоль полосы полилины.
Перечисление | |
---|---|
ROAD_FEATURE_STATE_UNSPECIFIED | Состояние функции дороги не было рассчитано (значение по умолчанию). |
EXISTS | Дорожная функция существует. |
DOES_NOT_EXIST | Дорожной функции не существует. |
PolylinePointIndex
Инкапсулирует начальные и конечные индексы для детализации полилинии. Для случаев, когда данные соответствуют одной точке, startIndex
и endIndex
будут равны.
Представление JSON |
---|
{ "startIndex": integer, "endIndex": integer } |
Поля | |
---|---|
start Index | Начальный индекс этой детали в полилинии. |
end Index | Конечный индекс этой детали в полилинии. |
Узкий роудфо
Инкапсулирует информацию о узких дорогах вдоль полилины.
Представление JSON |
---|
{ "narrowRoadPresence": enum ( |
Поля | |
---|---|
narrow Road Presence | Только вывод. Обозначает, существует ли узкая дорога для данного участка полилинии. |
polyline Point Index | Расположение узкой дорожной информации вдоль полилины. |
Геокодингрессы
Содержит
для происхождения, назначения и промежуточных путевых точек. Заполнено только для адресных путевых точек. GeocodedWaypoints
Представление JSON |
---|
{ "origin": { object ( |
Поля | |
---|---|
origin | Происхождение геокодированной путевой точки. |
destination | Путешествие по геокодированию назначения. |
intermediates[] | Список промежуточных геокодированных путевых точек, каждая из которых содержит поле индекса, которое соответствует нулевой позиции путевой точки в порядке, который они были указаны в запросе. |
GeocodewayPoint
Подробности о местах, используемых в качестве путевых точек. Заполнено только для адресных путевых точек. Включает подробную информацию о результатах геокодирования для целей определения того, что был геокодирован.
Представление JSON |
---|
{
"geocoderStatus": {
object ( |
Поля | |
---|---|
geocoder Status | Указывает код состояния, возникающий в результате операции геокодирования. |
type[] | Тип (ы) результата в форме ноль или более тегов типа. Поддерживаемые типы: типы адресов и типы компонентов адресов . |
partial Match | Указывает, что геокодер не вернул точного совпадения для исходного запроса, хотя он смог сопоставить часть запрошенного адреса. Вы можете рассмотреть исходный запрос на ошибки и/или неполный адрес. |
place Id | Идентификатор места для этого результата. |
intermediate Waypoint Request Index | Индекс соответствующей промежуточной путевой точки в запросе. Заполнена только если соответствующая путевая точка является промежуточной путевой точкой. |
- Http -запрос
- Тело запроса
- Тело ответа
- Полилинвальт
- Полинозодирование
- Ссылка
- Внешневатор
- Маршрут
- RouteLabel
- Routeleg
- Полилиния
- Routelegstep
- Навигация
- Маневр
- Routelegsteptraveladvisory
- RoutelegsteplocalizedValues
- Routelegsteptransitdetails
- Transitstopdetails
- Транзитстоп
- TransitdetailSlocalizedValues
- Локализованный время
- Транзитная линия
- Транстирантность
- Транзит
- Transitvehicletype
- Routelegtraveladvisory
- RouteleglocalizedValues
- STESTORGEVERVIEW
- Мультимодалсегмент
- Область просмотра
- RateLocalizedValues
- Полилифинетисты
- RelooverInfo
- Roadfeaturestate
- PolylinePointIndex
- Узкий роудфо
- Геокодингрессы
- GeocodewayPoint
Возвращает основной маршрут вместе с дополнительными альтернативными маршрутами, учитывая набор терминальных и промежуточных путевых точек.
ПРИМЕЧАНИЕ. Этот метод требует, чтобы вы указали маску поля ответа на входе. Вы можете предоставить маску поля ответа, используя $fields
или fields
параметров URL или с помощью заголовка HTTP/GRPC X-Goog-FieldMask
(см. Доступные параметры и заголовки URL ). Значение представляет собой отдельный список полевых путей. Смотрите подробную документацию о том, как построить пути поля .
Например, в этом методе:
- Полевая маска всех доступных полей (для ручной проверки):
X-Goog-FieldMask: *
- Полевая маска продолжительности, расстояния и полилины уровня маршрута (пример производственного настройки):
X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline
.
Google отрицает использование маски поля ответов подстановочного знака ( *
) или указать маску поля на верхнем уровне ( routes
), потому что:
- Выбор только те полей, которые вам нужны, помогает нашему серверу сохранять циклы вычислений, что позволяет нам вернуть вам результат с более низкой задержкой.
- Выбор только тех полей, которые вам нужны в вашем производственном задании, обеспечивает стабильную задержку. В будущем мы могли бы добавить больше полей ответа, и эти новые поля могут потребовать дополнительного времени вычисления. Если вы выберете все поля или если вы выберете все поля на верхнем уровне, то вы можете испытать деградацию производительности, потому что любое новое поле, которое мы добавим, будет автоматически включено в ответ.
- Выбор только те полей, которые вам нужны, приводит к меньшему размеру отклика и, следовательно, более высокой пропускной способности сети.
Http -запрос
POST https://routes.googleapis.com/directions/v2:computeRoutes
URL использует синтаксис транскодирования GRPC .
Тело запроса
Тело запроса содержит данные со следующей структурой:
Представление JSON |
---|
{ "origin": { object ( |
Поля | |
---|---|
origin | Необходимый. Происхождение путешественника. |
destination | Необходимый. Путь назначения. |
intermediates[] | Необязательный. Набор путевых точек вдоль маршрута (за исключением точек терминала), либо для остановки, либо проходящего мимо. Поддерживается до 25 промежуточных путевых точек. |
travel Mode | Необязательный. Определяет способ транспортировки. |
routing Preference | Необязательный. Указывает, как вычислить маршрут. Сервер пытается использовать выбранное предпочтение маршрутизации для вычисления маршрута. Если предпочтение маршрутизации приводит к ошибке или дополнительной длинной задержке, то возвращается ошибка. Вы можете указать эту опцию только в том случае, когда |
polyline Quality | Необязательный. Указывает ваше предпочтение качеству полилинии. |
polyline Encoding | Необязательный. Указывает предпочтительное кодирование для полилины. |
departure Time | Необязательный. Время отъезда. Если вы не установите это значение, то это значение по умолчанию по умолчанию в то время, которое вы сделали запрос. ПРИМЕЧАНИЕ. Вы можете указать только Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
arrival Time | Необязательный. Время прибытия. Примечание: может быть установлено только тогда, когда Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
compute Alternative Routes | Необязательный. Определяет, рассчитывать ли альтернативные маршруты в дополнение к маршруту. Никаких альтернативных маршрутов не возвращаются для запросов, которые имеют промежуточные путевые точки. |
route Modifiers | Необязательный. Набор условий, чтобы удовлетворить, что влияет на то, как рассчитываются маршруты. |
language Code | Необязательный. Языковой код BCP-47, такой как «En-US» или «SR-Latn». Для получения дополнительной информации см. Идентификатор локали Unicode . Смотрите языковую поддержку списка поддерживаемых языков. Когда вы не предоставляете это значение, язык отображения выводится из местоположения запроса маршрута. |
region Code | Необязательный. Код региона, указанный как CCTLD («Домен верхнего уровня»). Для получения дополнительной информации см. Код страны домены высшего уровня . |
units | Необязательный. Определяет единицы измерения для полей дисплея. Эти поля включают поле |
optimize Waypoint Order | Необязательный. 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 |
requested Reference Routes[] | Необязательный. 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 |
extra Computations[] | Необязательный. 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 | Необязательный. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the |
transit Preferences | Необязательный. Specifies preferences that influence the route returned for |
Response body
v2.computeRoutes the response message.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "routes": [ { object ( |
Поля | |
---|---|
routes[] | Contains an array of computed routes (up to three) when you specify |
fallback Info | 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 | Contains geocoding response info for waypoints specified as addresses. |
PolylineQuality
A set of values that specify the quality of the polyline.
Enums | |
---|---|
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. |
PolylineEncoding
Specifies the preferred type of polyline to be returned.
Enums | |
---|---|
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 |
ReferenceRoute
A supported reference route on the ComputeRoutesRequest.
Enums | |
---|---|
REFERENCE_ROUTE_UNSPECIFIED | Not used. Requests containing this value fail. |
FUEL_EFFICIENT | Fuel efficient route. |
SHORTER_DISTANCE | Route with shorter travel distance. Это экспериментальная функция. For For This feature is not compatible with any other travel modes, via intermediate waypoints, or |
ExtraComputation
Extra computations to perform while completing the request.
Enums | |
---|---|
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. |
Маршрут
Contains a route, which consists of a series of connected road segments that join beginning, ending, and intermediate waypoints.
JSON representation |
---|
{ "routeLabels": [ enum ( |
Поля | |
---|---|
route Labels[] | Labels for the |
legs[] | A collection of legs (path segments between waypoints) that make up the route. Each leg corresponds to the trip between two non- |
distance Meters | The travel distance of the route, in meters. |
duration | The length of time needed to navigate the route. If you set the A duration in seconds with up to nine fractional digits, ending with ' |
static Duration | The duration of travel through the route without taking traffic conditions into consideration. A duration in seconds with up to nine fractional digits, ending with ' |
polyline | The overall route polyline. This polyline is the combined polyline of all |
description | A description of the route. |
warnings[] | An array of warnings to show when displaying the route. |
viewport | The viewport bounding box of the polyline. |
travel Advisory | Additional information about the route. |
optimized Intermediate Waypoint Index[] | If you set |
localized Values | Text representations of properties of the |
route Token | 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: |
polyline Details | Contains information about details along the polyline. |
RouteLabel
Labels for the
that are useful to identify specific properties of the route to compare against others. Route
Enums | |
---|---|
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 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.
JSON representation |
---|
{ "distanceMeters": integer, "duration": string, "staticDuration": string, "polyline": { object ( |
Поля | |
---|---|
distance Meters | The travel distance of the route leg, in meters. |
duration | The length of time needed to navigate the leg. If the A duration in seconds with up to nine fractional digits, ending with ' |
static Duration | The duration of travel through the leg, calculated without taking traffic conditions into consideration. A duration in seconds with up to nine fractional digits, ending with ' |
polyline | The overall polyline for this leg that includes each |
start Location | The start location of this leg. This location might be different from the provided |
end Location | The end location of this leg. This location might be different from the provided |
steps[] | An array of steps denoting segments within this leg. Each step represents one navigation instruction. |
travel Advisory | Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a route leg. |
localized Values | Text representations of properties of the |
steps Overview | Overview information about the steps in this |
Полилиния
Encapsulates an encoded polyline.
JSON representation |
---|
{ // Union field |
Поля | |
---|---|
Union field polyline_type . Encapsulates the type of polyline. Defaults to encoded_polyline. polyline_type can be only one of the following: | |
encoded Polyline | The string encoding of the polyline using the polyline encoding algorithm |
geo Json Linestring | Specifies a polyline using the GeoJSON LineString format . |
RouteLegStep
Contains a segment of a
. A step corresponds to a single navigation instruction. Route legs are made up of steps. RouteLeg
JSON representation |
---|
{ "distanceMeters": integer, "staticDuration": string, "polyline": { object ( |
Поля | |
---|---|
distance Meters | The travel distance of this step, in meters. In some circumstances, this field might not have a value. |
static Duration | The duration of travel through this step without taking traffic conditions into consideration. In some circumstances, this field might not have a value. A duration in seconds with up to nine fractional digits, ending with ' |
polyline | The polyline associated with this step. |
start Location | The start location of this step. |
end Location | The end location of this step. |
navigation Instruction | Navigation instructions. |
travel Advisory | Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a leg step. |
localized Values | Text representations of properties of the |
transit Details | Details pertaining to this step if the travel mode is |
travel Mode | The travel mode used for this step. |
Маневр
A set of values that specify the navigation action to take for the current step (for example, turn left, merge, or straight).
Enums | |
---|---|
MANEUVER_UNSPECIFIED | Not used. |
TURN_SLIGHT_LEFT | Turn slightly to the left. |
TURN_SHARP_LEFT | Turn sharply to the left. |
UTURN_LEFT | Make a left u-turn. |
TURN_LEFT | Поверните налево. |
TURN_SLIGHT_RIGHT | Turn slightly to the right. |
TURN_SHARP_RIGHT | Turn sharply to the right. |
UTURN_RIGHT | Make a right u-turn. |
TURN_RIGHT | Поверните направо. |
STRAIGHT | Езжайте прямо. |
RAMP_LEFT | Take the left ramp. |
RAMP_RIGHT | Take the right ramp. |
MERGE | Merge into traffic. |
FORK_LEFT | Take the left fork. |
FORK_RIGHT | Take the right fork. |
FERRY | Take the ferry. |
FERRY_TRAIN | Take the train leading onto the ferry. |
ROUNDABOUT_LEFT | Turn left at the roundabout. |
ROUNDABOUT_RIGHT | Turn right at the roundabout. |
DEPART | Initial maneuver. |
NAME_CHANGE | Used to indicate a street name change. |
RouteLegStepTravelAdvisory
Contains the additional information that the user should be informed about, such as possible traffic zone restrictions on a leg step.
JSON representation |
---|
{
"speedReadingIntervals": [
{
object ( |
Поля | |
---|---|
speed Reading Intervals[] | NOTE: This field is not currently populated. |
RouteLegStepLocalizedValues
Text representations of certain properties.
JSON representation |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Travel distance represented in text form. |
static Duration | Duration without taking traffic conditions into consideration, represented in text form. |
RouteLegStepTransitDetails
Additional information for the RouteLegStep
related to TRANSIT
routes.
JSON representation |
---|
{ "stopDetails": { object ( |
Поля | |
---|---|
stop Details | Information about the arrival and departure stops for the step. |
localized Values | Text representations of properties of the |
headsign | 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 | 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. A duration in seconds with up to nine fractional digits, ending with ' |
transit Line | Information about the transit line used in this step. |
stop Count | 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, returns 3. |
trip Short Text | 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 |
TransitStopDetails
Details about the transit stops for the RouteLegStep
.
JSON representation |
---|
{ "arrivalStop": { object ( |
Поля | |
---|---|
arrival Stop | Information about the arrival stop for the step. |
arrival Time | The estimated time of arrival for the step. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
departure Stop | Information about the departure stop for the step. |
departure Time | The estimated time of departure for the step. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
TransitStop
Information about a transit stop.
JSON representation |
---|
{
"name": string,
"location": {
object ( |
Поля | |
---|---|
name | The name of the transit stop. |
location | The location of the stop expressed in latitude/longitude coordinates. |
TransitDetailsLocalizedValues
Localized descriptions of values for RouteTransitDetails
.
JSON representation |
---|
{ "arrivalTime": { object ( |
Поля | |
---|---|
arrival Time | Time in its formatted text representation with a corresponding time zone. |
departure Time | Time in its formatted text representation with a corresponding time zone. |
LocalizedTime
Localized description of time.
JSON representation |
---|
{
"time": {
object ( |
Поля | |
---|---|
time | The time specified as a string in a given time zone. |
time Zone | 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". |
TransitLine
Contains information about the transit line used in this step.
JSON representation |
---|
{ "agencies": [ { object ( |
Поля | |
---|---|
agencies[] | The transit agency (or agencies) that operates this transit line. |
name | The full name of this transit line, For example, "8 Avenue Local". |
uri | the URI for this transit line as provided by the transit agency. |
color | The color commonly used in signage for this line. Represented in hexadecimal. |
icon Uri | The URI for the icon associated with this line. |
name Short | The short name of this transit line. This name will normally be a line number, such as "M7" or "355". |
text Color | The color commonly used in text on signage for this line. Represented in hexadecimal. |
vehicle | The type of vehicle that operates on this transit line. |
TransitAgency
A transit agency that operates a transit line.
JSON representation |
---|
{ "name": string, "phoneNumber": string, "uri": string } |
Поля | |
---|---|
name | The name of this transit agency. |
phone Number | The transit agency's locale-specific formatted phone number. |
uri | The transit agency's URI. |
TransitVehicle
Information about a vehicle used in transit routes.
JSON representation |
---|
{ "name": { object ( |
Поля | |
---|---|
name | The name of this vehicle, capitalized. |
type | The type of vehicle used. |
icon Uri | The URI for an icon associated with this vehicle type. |
local Icon Uri | The URI for the icon associated with this vehicle type, based on the local transport signage. |
TransitVehicleType
The type of vehicles for transit routes.
Enums | |
---|---|
TRANSIT_VEHICLE_TYPE_UNSPECIFIED | Unused. |
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 | 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 | Trolleybus. |
RouteLegTravelAdvisory
Contains the additional information that the user should be informed about on a leg step, such as possible traffic zone restrictions.
JSON representation |
---|
{ "tollInfo": { object ( |
Поля | |
---|---|
toll Info | Contains information about tolls on the specific |
speed Reading Intervals[] | Speed reading intervals detailing traffic density. Applicable in case of Пример:
|
RouteLegLocalizedValues
Text representations of certain properties.
JSON representation |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Travel distance represented in text form. |
duration | 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 staticDuration. |
static Duration | Duration without taking traffic conditions into consideration, represented in text form. |
StepsOverview
Provides overview information about a list of RouteLegStep
s.
JSON representation |
---|
{
"multiModalSegments": [
{
object ( |
Поля | |
---|---|
multi Modal Segments[] | Summarized information about different multi-modal segments of the |
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.
JSON representation |
---|
{ "navigationInstruction": { object ( |
Поля | |
---|---|
navigation Instruction | NavigationInstruction for the multi-modal segment. |
travel Mode | The travel mode of the multi-modal segment. |
step Start Index | The corresponding |
step End Index | The corresponding |
Область просмотра
A latitude-longitude viewport, represented as two diagonally opposite low
and high
points. A viewport is considered a closed region, ie it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include:
If
low
=high
, the viewport consists of that single point.If
low.longitude
>high.longitude
, the longitude range is inverted (the viewport crosses the 180 degree longitude line).If
low.longitude
= -180 degrees andhigh.longitude
= 180 degrees, the viewport includes all longitudes.If
low.longitude
= 180 degrees andhigh.longitude
= -180 degrees, the longitude range is empty.If
low.latitude
>high.latitude
, the latitude range is empty.
Both low
and high
must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error.
For example, this viewport fully encloses New York City:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
JSON representation |
---|
{ "low": { object ( |
Поля | |
---|---|
low | Необходимый. The low point of the viewport. |
high | Необходимый. The high point of the viewport. |
RouteLocalizedValues
Text representations of certain properties.
JSON representation |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Travel distance represented in text form. |
duration | 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 | Duration without taking traffic conditions into consideration, represented in text form. |
transit Fare | Transit fare represented in text form. |
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.
JSON representation |
---|
{ "flyoverInfo": [ { object ( |
Поля | |
---|---|
flyover Info[] | Flyover details along the polyline. |
narrow Road Info[] | Narrow road details along the polyline. |
FlyoverInfo
Encapsulates information about flyovers along the polyline.
JSON representation |
---|
{ "flyoverPresence": enum ( |
Поля | |
---|---|
flyover Presence | Только вывод. Denotes whether a flyover exists for a given stretch of the polyline. |
polyline Point Index | The location of flyover related information along the polyline. |
RoadFeatureState
Encapsulates the states of road features along a stretch of polyline.
Enums | |
---|---|
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. |
PolylinePointIndex
Encapsulates the start and end indexes for a polyline detail. For instances where the data corresponds to a single point, startIndex
and endIndex
will be equal.
JSON representation |
---|
{ "startIndex": integer, "endIndex": integer } |
Поля | |
---|---|
start Index | The start index of this detail in the polyline. |
end Index | The end index of this detail in the polyline. |
NarrowRoadInfo
Encapsulates information about narrow roads along the polyline.
JSON representation |
---|
{ "narrowRoadPresence": enum ( |
Поля | |
---|---|
narrow Road Presence | Только вывод. Denotes whether a narrow road exists for a given stretch of the polyline. |
polyline Point Index | The location of narrow road related information along the polyline. |
GeocodingResults
Contains
for origin, destination and intermediate waypoints. Only populated for address waypoints. GeocodedWaypoints
JSON representation |
---|
{ "origin": { object ( |
Поля | |
---|---|
origin | Origin geocoded waypoint. |
destination | Destination geocoded waypoint. |
intermediates[] | 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. |
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.
JSON representation |
---|
{
"geocoderStatus": {
object ( |
Поля | |
---|---|
geocoder Status | Indicates the status code resulting from the geocoding operation. |
type[] | 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 | 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. You may wish to examine the original request for misspellings and/or an incomplete address. |
place Id | The place ID for this result. |
intermediate Waypoint Request Index | The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint. |
- HTTP request
- Тело запроса
- Response body
- PolylineQuality
- PolylineEncoding
- ReferenceRoute
- ExtraComputation
- Маршрут
- RouteLabel
- RouteLeg
- Полилиния
- RouteLegStep
- NavigationInstruction
- Маневр
- RouteLegStepTravelAdvisory
- RouteLegStepLocalizedValues
- RouteLegStepTransitDetails
- TransitStopDetails
- TransitStop
- TransitDetailsLocalizedValues
- LocalizedTime
- TransitLine
- TransitAgency
- TransitVehicle
- TransitVehicleType
- RouteLegTravelAdvisory
- RouteLegLocalizedValues
- StepsOverview
- MultiModalSegment
- Область просмотра
- RouteLocalizedValues
- PolylineDetails
- FlyoverInfo
- RoadFeatureState
- PolylinePointIndex
- NarrowRoadInfo
- GeocodingResults
- GeocodedWaypoint
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.
HTTP request
POST https://routes.googleapis.com/directions/v2:computeRoutes
The URL uses gRPC Transcoding syntax.
Тело запроса
The request body contains data with the following structure:
JSON representation |
---|
{ "origin": { object ( |
Поля | |
---|---|
origin | Необходимый. Origin waypoint. |
destination | Необходимый. Destination waypoint. |
intermediates[] | Необязательный. 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 | Необязательный. Specifies the mode of transportation. |
routing Preference | Необязательный. 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 |
polyline Quality | Необязательный. Specifies your preference for the quality of the polyline. |
polyline Encoding | Необязательный. Specifies the preferred encoding for the polyline. |
departure Time | Необязательный. 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 A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
arrival Time | Необязательный. The arrival time. NOTE: Can only be set when A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
compute Alternative Routes | Необязательный. Specifies whether to calculate alternate routes in addition to the route. No alternative routes are returned for requests that have intermediate waypoints. |
route Modifiers | Необязательный. A set of conditions to satisfy that affect the way routes are calculated. |
language Code | Необязательный. 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 | Необязательный. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains . |
units | Необязательный. Specifies the units of measure for the display fields. These fields include the |
optimize Waypoint Order | Необязательный. 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 |
requested Reference Routes[] | Необязательный. 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 |
extra Computations[] | Необязательный. 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 | Необязательный. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the |
transit Preferences | Необязательный. Specifies preferences that influence the route returned for |
Response body
v2.computeRoutes the response message.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "routes": [ { object ( |
Поля | |
---|---|
routes[] | Contains an array of computed routes (up to three) when you specify |
fallback Info | 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 | Contains geocoding response info for waypoints specified as addresses. |
PolylineQuality
A set of values that specify the quality of the polyline.
Enums | |
---|---|
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. |
PolylineEncoding
Specifies the preferred type of polyline to be returned.
Enums | |
---|---|
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 |
ReferenceRoute
A supported reference route on the ComputeRoutesRequest.
Enums | |
---|---|
REFERENCE_ROUTE_UNSPECIFIED | Not used. Requests containing this value fail. |
FUEL_EFFICIENT | Fuel efficient route. |
SHORTER_DISTANCE | Route with shorter travel distance. Это экспериментальная функция. For For This feature is not compatible with any other travel modes, via intermediate waypoints, or |
ExtraComputation
Extra computations to perform while completing the request.
Enums | |
---|---|
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. |
Маршрут
Contains a route, which consists of a series of connected road segments that join beginning, ending, and intermediate waypoints.
JSON representation |
---|
{ "routeLabels": [ enum ( |
Поля | |
---|---|
route Labels[] | Labels for the |
legs[] | A collection of legs (path segments between waypoints) that make up the route. Each leg corresponds to the trip between two non- |
distance Meters | The travel distance of the route, in meters. |
duration | The length of time needed to navigate the route. If you set the A duration in seconds with up to nine fractional digits, ending with ' |
static Duration | The duration of travel through the route without taking traffic conditions into consideration. A duration in seconds with up to nine fractional digits, ending with ' |
polyline | The overall route polyline. This polyline is the combined polyline of all |
description | A description of the route. |
warnings[] | An array of warnings to show when displaying the route. |
viewport | The viewport bounding box of the polyline. |
travel Advisory | Additional information about the route. |
optimized Intermediate Waypoint Index[] | If you set |
localized Values | Text representations of properties of the |
route Token | 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: |
polyline Details | Contains information about details along the polyline. |
RouteLabel
Labels for the
that are useful to identify specific properties of the route to compare against others. Route
Enums | |
---|---|
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 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.
JSON representation |
---|
{ "distanceMeters": integer, "duration": string, "staticDuration": string, "polyline": { object ( |
Поля | |
---|---|
distance Meters | The travel distance of the route leg, in meters. |
duration | The length of time needed to navigate the leg. If the A duration in seconds with up to nine fractional digits, ending with ' |
static Duration | The duration of travel through the leg, calculated without taking traffic conditions into consideration. A duration in seconds with up to nine fractional digits, ending with ' |
polyline | The overall polyline for this leg that includes each |
start Location | The start location of this leg. This location might be different from the provided |
end Location | The end location of this leg. This location might be different from the provided |
steps[] | An array of steps denoting segments within this leg. Each step represents one navigation instruction. |
travel Advisory | Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a route leg. |
localized Values | Text representations of properties of the |
steps Overview | Overview information about the steps in this |
Полилиния
Encapsulates an encoded polyline.
JSON representation |
---|
{ // Union field |
Поля | |
---|---|
Union field polyline_type . Encapsulates the type of polyline. Defaults to encoded_polyline. polyline_type can be only one of the following: | |
encoded Polyline | The string encoding of the polyline using the polyline encoding algorithm |
geo Json Linestring | Specifies a polyline using the GeoJSON LineString format . |
RouteLegStep
Contains a segment of a
. A step corresponds to a single navigation instruction. Route legs are made up of steps. RouteLeg
JSON representation |
---|
{ "distanceMeters": integer, "staticDuration": string, "polyline": { object ( |
Поля | |
---|---|
distance Meters | The travel distance of this step, in meters. In some circumstances, this field might not have a value. |
static Duration | The duration of travel through this step without taking traffic conditions into consideration. In some circumstances, this field might not have a value. A duration in seconds with up to nine fractional digits, ending with ' |
polyline | The polyline associated with this step. |
start Location | The start location of this step. |
end Location | The end location of this step. |
navigation Instruction | Navigation instructions. |
travel Advisory | Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a leg step. |
localized Values | Text representations of properties of the |
transit Details | Details pertaining to this step if the travel mode is |
travel Mode | The travel mode used for this step. |
Маневр
A set of values that specify the navigation action to take for the current step (for example, turn left, merge, or straight).
Enums | |
---|---|
MANEUVER_UNSPECIFIED | Not used. |
TURN_SLIGHT_LEFT | Turn slightly to the left. |
TURN_SHARP_LEFT | Turn sharply to the left. |
UTURN_LEFT | Make a left u-turn. |
TURN_LEFT | Поверните налево. |
TURN_SLIGHT_RIGHT | Turn slightly to the right. |
TURN_SHARP_RIGHT | Turn sharply to the right. |
UTURN_RIGHT | Make a right u-turn. |
TURN_RIGHT | Поверните направо. |
STRAIGHT | Езжайте прямо. |
RAMP_LEFT | Take the left ramp. |
RAMP_RIGHT | Take the right ramp. |
MERGE | Merge into traffic. |
FORK_LEFT | Take the left fork. |
FORK_RIGHT | Take the right fork. |
FERRY | Take the ferry. |
FERRY_TRAIN | Take the train leading onto the ferry. |
ROUNDABOUT_LEFT | Turn left at the roundabout. |
ROUNDABOUT_RIGHT | Turn right at the roundabout. |
DEPART | Initial maneuver. |
NAME_CHANGE | Used to indicate a street name change. |
RouteLegStepTravelAdvisory
Contains the additional information that the user should be informed about, such as possible traffic zone restrictions on a leg step.
JSON representation |
---|
{
"speedReadingIntervals": [
{
object ( |
Поля | |
---|---|
speed Reading Intervals[] | NOTE: This field is not currently populated. |
RouteLegStepLocalizedValues
Text representations of certain properties.
JSON representation |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Travel distance represented in text form. |
static Duration | Duration without taking traffic conditions into consideration, represented in text form. |
RouteLegStepTransitDetails
Additional information for the RouteLegStep
related to TRANSIT
routes.
JSON representation |
---|
{ "stopDetails": { object ( |
Поля | |
---|---|
stop Details | Information about the arrival and departure stops for the step. |
localized Values | Text representations of properties of the |
headsign | 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 | 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. A duration in seconds with up to nine fractional digits, ending with ' |
transit Line | Information about the transit line used in this step. |
stop Count | 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, returns 3. |
trip Short Text | 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 |
TransitStopDetails
Details about the transit stops for the RouteLegStep
.
JSON representation |
---|
{ "arrivalStop": { object ( |
Поля | |
---|---|
arrival Stop | Information about the arrival stop for the step. |
arrival Time | The estimated time of arrival for the step. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
departure Stop | Information about the departure stop for the step. |
departure Time | The estimated time of departure for the step. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
TransitStop
Information about a transit stop.
JSON representation |
---|
{
"name": string,
"location": {
object ( |
Поля | |
---|---|
name | The name of the transit stop. |
location | The location of the stop expressed in latitude/longitude coordinates. |
TransitDetailsLocalizedValues
Localized descriptions of values for RouteTransitDetails
.
JSON representation |
---|
{ "arrivalTime": { object ( |
Поля | |
---|---|
arrival Time | Time in its formatted text representation with a corresponding time zone. |
departure Time | Time in its formatted text representation with a corresponding time zone. |
LocalizedTime
Localized description of time.
JSON representation |
---|
{
"time": {
object ( |
Поля | |
---|---|
time | The time specified as a string in a given time zone. |
time Zone | 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". |
TransitLine
Contains information about the transit line used in this step.
JSON representation |
---|
{ "agencies": [ { object ( |
Поля | |
---|---|
agencies[] | The transit agency (or agencies) that operates this transit line. |
name | The full name of this transit line, For example, "8 Avenue Local". |
uri | the URI for this transit line as provided by the transit agency. |
color | The color commonly used in signage for this line. Represented in hexadecimal. |
icon Uri | The URI for the icon associated with this line. |
name Short | The short name of this transit line. This name will normally be a line number, such as "M7" or "355". |
text Color | The color commonly used in text on signage for this line. Represented in hexadecimal. |
vehicle | The type of vehicle that operates on this transit line. |
TransitAgency
A transit agency that operates a transit line.
JSON representation |
---|
{ "name": string, "phoneNumber": string, "uri": string } |
Поля | |
---|---|
name | The name of this transit agency. |
phone Number | The transit agency's locale-specific formatted phone number. |
uri | The transit agency's URI. |
TransitVehicle
Information about a vehicle used in transit routes.
JSON representation |
---|
{ "name": { object ( |
Поля | |
---|---|
name | The name of this vehicle, capitalized. |
type | The type of vehicle used. |
icon Uri | The URI for an icon associated with this vehicle type. |
local Icon Uri | The URI for the icon associated with this vehicle type, based on the local transport signage. |
TransitVehicleType
The type of vehicles for transit routes.
Enums | |
---|---|
TRANSIT_VEHICLE_TYPE_UNSPECIFIED | Unused. |
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 | 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 | Trolleybus. |
RouteLegTravelAdvisory
Contains the additional information that the user should be informed about on a leg step, such as possible traffic zone restrictions.
JSON representation |
---|
{ "tollInfo": { object ( |
Поля | |
---|---|
toll Info | Contains information about tolls on the specific |
speed Reading Intervals[] | Speed reading intervals detailing traffic density. Applicable in case of Пример:
|
RouteLegLocalizedValues
Text representations of certain properties.
JSON representation |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Travel distance represented in text form. |
duration | 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 staticDuration. |
static Duration | Duration without taking traffic conditions into consideration, represented in text form. |
StepsOverview
Provides overview information about a list of RouteLegStep
s.
JSON representation |
---|
{
"multiModalSegments": [
{
object ( |
Поля | |
---|---|
multi Modal Segments[] | Summarized information about different multi-modal segments of the |
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.
JSON representation |
---|
{ "navigationInstruction": { object ( |
Поля | |
---|---|
navigation Instruction | NavigationInstruction for the multi-modal segment. |
travel Mode | The travel mode of the multi-modal segment. |
step Start Index | The corresponding |
step End Index | The corresponding |
Область просмотра
A latitude-longitude viewport, represented as two diagonally opposite low
and high
points. A viewport is considered a closed region, ie it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include:
If
low
=high
, the viewport consists of that single point.If
low.longitude
>high.longitude
, the longitude range is inverted (the viewport crosses the 180 degree longitude line).If
low.longitude
= -180 degrees andhigh.longitude
= 180 degrees, the viewport includes all longitudes.If
low.longitude
= 180 degrees andhigh.longitude
= -180 degrees, the longitude range is empty.If
low.latitude
>high.latitude
, the latitude range is empty.
Both low
and high
must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error.
For example, this viewport fully encloses New York City:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
JSON representation |
---|
{ "low": { object ( |
Поля | |
---|---|
low | Необходимый. The low point of the viewport. |
high | Необходимый. The high point of the viewport. |
RouteLocalizedValues
Text representations of certain properties.
JSON representation |
---|
{ "distance": { object ( |
Поля | |
---|---|
distance | Travel distance represented in text form. |
duration | 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 | Duration without taking traffic conditions into consideration, represented in text form. |
transit Fare | Transit fare represented in text form. |
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.
JSON representation |
---|
{ "flyoverInfo": [ { object ( |
Поля | |
---|---|
flyover Info[] | Flyover details along the polyline. |
narrow Road Info[] | Narrow road details along the polyline. |
FlyoverInfo
Encapsulates information about flyovers along the polyline.
JSON representation |
---|
{ "flyoverPresence": enum ( |
Поля | |
---|---|
flyover Presence | Только вывод. Denotes whether a flyover exists for a given stretch of the polyline. |
polyline Point Index | The location of flyover related information along the polyline. |
RoadFeatureState
Encapsulates the states of road features along a stretch of polyline.
Enums | |
---|---|
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. |
PolylinePointIndex
Encapsulates the start and end indexes for a polyline detail. For instances where the data corresponds to a single point, startIndex
and endIndex
will be equal.
JSON representation |
---|
{ "startIndex": integer, "endIndex": integer } |
Поля | |
---|---|
start Index | The start index of this detail in the polyline. |
end Index | The end index of this detail in the polyline. |
NarrowRoadInfo
Encapsulates information about narrow roads along the polyline.
JSON representation |
---|
{ "narrowRoadPresence": enum ( |
Поля | |
---|---|
narrow Road Presence | Только вывод. Denotes whether a narrow road exists for a given stretch of the polyline. |
polyline Point Index | The location of narrow road related information along the polyline. |
GeocodingResults
Contains
for origin, destination and intermediate waypoints. Only populated for address waypoints. GeocodedWaypoints
JSON representation |
---|
{ "origin": { object ( |
Поля | |
---|---|
origin | Origin geocoded waypoint. |
destination | Destination geocoded waypoint. |
intermediates[] | 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. |
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.
JSON representation |
---|
{
"geocoderStatus": {
object ( |
Поля | |
---|---|
geocoder Status | Indicates the status code resulting from the geocoding operation. |
type[] | 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 | 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. You may wish to examine the original request for misspellings and/or an incomplete address. |
place Id | The place ID for this result. |
intermediate Waypoint Request Index | The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint. |