Package google.maps.routes.v1

Содержание

RoutesPreferred

Routes Preferred API.

ComputeCustomRoutes

rpc ComputeCustomRoutes(ComputeCustomRoutesRequest) returns (ComputeCustomRoutesResponse)

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

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

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

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

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

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

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

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

Подробнее о протоколе OAuth 2.0…
ComputeRouteMatrix

rpc ComputeRouteMatrix(ComputeRouteMatrixRequest) returns (RouteMatrixElement)

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

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

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

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

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

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

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

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

Подробнее о протоколе OAuth 2.0…
ComputeRoutes

rpc ComputeRoutes(ComputeRoutesRequest) returns (ComputeRoutesResponse)

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

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

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

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

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

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

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

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

Подробнее о протоколе OAuth 2.0…

ComputeCustomRoutesRequest

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

Поля
origin

Waypoint

Обязательно. Путевая точка отправления.
destination

Waypoint

Обязательно. Путевая точка пункта назначения.
intermediates[]

Waypoint

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

RouteTravelMode

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

RoutingPreference

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

PolylineQuality

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

PolylineEncoding

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

Timestamp

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

RouteModifiers

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

RouteObjective

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

string

Необязательное поле. Код языка по стандарту BCP-47, например "ru-RU" или "sr-Latn". Подробнее об идентификаторах локали Unicode… Список поддерживаемых языков приведен в разделе Поддержка языков. Если вы не укажете это значение, язык интерфейса будет определен на основе местоположения запроса маршрута.
units

Units

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

ComputeCustomRoutesResponse

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

Поля
routes[]

CustomRoute

Лучшие маршруты для заданной цели.
fastest_route

CustomRoute

Самый быстрый маршрут.
shortest_route

CustomRoute

Самый короткий маршрут.
fallback_info

FallbackInfo

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

FallbackInfo

Содержит резервную информацию для ComputeCustomRoutes. ComputeCustomRoutes выполняет резервные пути двух типов:

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

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

Поля
routing_mode

FallbackRoutingMode

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

FallbackReason

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

FallbackRouteObjective

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

FallbackRouteObjective

Цель маршрута, использованная для ответа.

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

ComputeRouteMatrixRequest

Запрос ComputeRouteMatrix

Поля
origins[]

RouteMatrixOrigin

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

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

RouteMatrixDestination

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

RouteTravelMode

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

RoutingPreference

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

Timestamp

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

ComputeRoutesRequest

ComputeRoutes.

Поля
origin

Waypoint

Обязательно. Путевая точка отправления.
destination

Waypoint

Обязательно. Путевая точка пункта назначения.
intermediates[]

Waypoint

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

RouteTravelMode

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

RoutingPreference

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

PolylineQuality

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

PolylineEncoding

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

Timestamp

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

bool

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

RouteModifiers

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

string

Необязательное поле. Код языка по стандарту BCP-47, например "ru-RU" или "sr-Latn". Подробнее об идентификаторах локали Unicode… Список поддерживаемых языков приведен в разделе Поддержка языков. Если вы не укажете это значение, язык интерфейса будет определен на основе местоположения запроса маршрута.
units

Units

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

bool

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

ComputeRoutesResponse

ComputeRoutes – ответное сообщение.

Поля
routes[]

Route

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

FallbackInfo

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

CustomRoute

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

Поля
route

Route

Маршрут, который считается лучшим для цели входного маршрута.
token

string

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

FallbackInfo

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

Поля
routing_mode

FallbackRoutingMode

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

FallbackReason

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

FallbackReason

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

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

FallbackRoutingMode

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

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

Местоположение

Содержит информацию о местоположении (географической точке и, при необходимости, направлении).

Поля
lat_lng

LatLng

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

Int32Value

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

Маневр

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

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

Maneuver

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

string

Инструкции по выполнению этого шага.

Polyline

Содержит кодированную ломаную линию.

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

string

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

Struct

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

PolylineEncoding

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

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

PolylineQuality

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

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

Маршрут

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

Поля
legs[]

RouteLeg

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

int32

Расстояние маршрута в метрах.
duration

Duration

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

Duration

Время в пути без учета загруженности дорог.
polyline

Polyline

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

string

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

string

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

Viewport

Граничная рамка области просмотра ломаной линии.
travel_advisory

RouteTravelAdvisory

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

int32

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

RouteLeg

Содержит сегмент между путевыми точками, не относящимися к via.

Поля
distance_meters

int32

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

Duration

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

Duration

Время поездки по участку без учета загруженности дорог.
polyline

Polyline

Общая ломаная линия для этого участка. в том числе ломаную линию каждого объекта step.
start_location

Location

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

Location

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

RouteLegStep

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

RouteLegTravelAdvisory

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

RouteLegStep

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

Поля
distance_meters

int32

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

Duration

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

Polyline

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

Location

Начальная точка этого шага.
end_location

Location

Конечная точка этого шага.
navigation_instruction

NavigationInstruction

инструкции по навигации;
travel_advisory

RouteLegStepTravelAdvisory

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

RouteLegStepTravelAdvisory

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

Поля
speed_reading_intervals[]

SpeedReadingInterval

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

RouteLegTravelAdvisory

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

Поля
toll_info

TollInfo

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

SpeedReadingInterval

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

Пример:

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

RouteMatrixDestination

один пункт назначения для ComputeRouteMatrixRequest;

Поля
waypoint

Waypoint

Обязательно. Путевая точка назначения

RouteMatrixElement

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

Поля
origin_index

int32

Индекс источника в запросе, начиная с нуля.
destination_index

int32

Индекс пункта назначения в запросе (начинается с нуля).
status

Status

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

RouteMatrixElementCondition

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

int32

Расстояние маршрута в метрах.
duration

Duration

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

Duration

Время в пути без учета загруженности дорог.
travel_advisory

RouteTravelAdvisory

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

FallbackInfo

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

RouteMatrixElementCondition

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

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

RouteMatrixOrigin

Один источник для ComputeRouteMatrixRequest

Поля
waypoint

Waypoint

Обязательно. Путевая точка отправления
route_modifiers

RouteModifiers

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

RouteModifiers

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

Поля
avoid_tolls

bool

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

bool

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

bool

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

bool

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

VehicleInfo

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

TollPass

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

RouteObjective

Содержит цель оптимизации для ComputeCustomRoutes.

Поля
Объединенное поле objective. Цель маршрута. objective может иметь одно из следующих значений:
rate_card

RateCard

Цель RateCard.

RateCard

Содержит цель маршрута RateCard.

Поля
cost_per_minute

MonetaryCost

Необязательное поле. Цена за минуту.
cost_per_km

MonetaryCost

Необязательное поле. Цена за километр.
include_tolls

bool

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

MonetaryCost

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

Поля
value

double

Обязательно. Значение стоимости в местной валюте, полученное из запроса.

RouteTravelAdvisory

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

Поля
toll_info

TollInfo

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

SpeedReadingInterval

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

Пример:

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

RouteTravelMode

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

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

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

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

RoutingPreference

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

Перечисления
ROUTING_PREFERENCE_UNSPECIFIED Предпочтения в отношении маршрутов не указаны. Значение по умолчанию – TRAFFIC_AWARE.
TRAFFIC_UNAWARE Маршруты строятся без учета загруженности дорог. Подходит, когда загруженность дорог не имеет значения или неприменима. Это значение обеспечивает наименьшую задержку. Примечание. Для режимов RouteTravelMode "Автомобиль" и "Мотоцикл" маршрут и время в пути выбираются на основе дорожной сети и средней загруженности дорог, а не текущих дорожных условий. Вследствие этого маршрут может включать временно закрытые дороги. Результаты такого запроса могут меняться со временем в связи с изменениями дорожной сети и средней загруженности дорог или как следствие распределенной архитектуры сервиса. Результаты также могут быть разными для практически равноценных маршрутов в зависимости от времени и частоты запросов.
TRAFFIC_AWARE Рассчитывает маршруты с учетом загруженности дорог. В отличие от TRAFFIC_AWARE_OPTIMAL, некоторые оптимизации применяются для значительного снижения задержки.
TRAFFIC_AWARE_OPTIMAL Рассчитывает маршруты с учетом загруженности дорог, но без применения большинства оптимизаций производительности. При использовании этого значения задержка будет самой большой.

SpeedReadingInterval

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

Поля
start_polyline_point_index

int32

Начальный индекс этого интервала в ломаной линии. В JSON, если индекс равен 0, поле выглядит пустым.
end_polyline_point_index

int32

Конечный индекс этого интервала в ломаной линии. В JSON, если индекс равен 0, поле выглядит пустым.
speed

Speed

Скорость движения транспорта в этом интервале.

Скорость

Классификация скорости ломаной линии на основе данных о дорожной обстановке.

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

TollInfo

Содержит информацию об оплате за проезд на устройстве Route или RouteLeg.

Поля
estimated_price[]

Money

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

TollPass

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

Перечисления
TOLL_PASS_UNSPECIFIED Не используется. Если используется это значение, запрос не выполняется.
AU_ETOLL_TAG Один из многих поставщиков абонементов на проезд по платным дорогам в Сиднее. https://www.myetoll.com.au
AU_EWAY_TAG Один из многих поставщиков абонементов на проезд по платным дорогам в Сиднее. https://www.tollpay.com.au/
AU_LINKT Австралийский абонемент на проезд по платным дорогам. Дополнительную информацию можно найти на сайте https://www.linkt.com.au/.
AR_TELEPASE Абонемент на проезд по платным дорогам в Аргентине. Дополнительную информацию можно найти на сайте https://telepase.com.ar.
BR_AUTO_EXPRESO Абонемент на проезд по платным дорогам в Бразилии. Дополнительную информацию можно найти на сайте https://www.autoexpreso.com.
BR_CONECTCAR Абонемент на проезд по платным дорогам в Бразилии. Дополнительную информацию можно найти на сайте https://conectcar.com.
BR_MOVE_MAIS Абонемент на проезд по платным дорогам в Бразилии. Дополнительную информацию можно найти на сайте https://movemais.com.
BR_PASSA_RAPIDO Абонемент на проезд по платным дорогам в Бразилии. Подробнее: https://pasorapido.gob.do/.
BR_SEM_PARAR Абонемент на проезд по платным дорогам в Бразилии. Дополнительную информацию можно найти на сайте https://www.semparar.com.br.
BR_TAGGY Абонемент на проезд по платным дорогам в Бразилии. Дополнительную информацию можно найти на сайте https://taggy.com.br.
BR_VELOE Абонемент на проезд по платным дорогам в Бразилии. Дополнительную информацию можно найти на странице https://veloe.com.br/site/onde-usar.
CA_US_AKWASASNE_SEAWAY_CORPORATE_CARD Пересечение границы между Канадой и США.
CA_US_AKWASASNE_SEAWAY_TRANSIT_CARD Пересечение границы между Канадой и США.
CA_US_BLUE_WATER_EDGE_PASS Пересечение границы между Онтарио (Канада) и Мичиганом (США).
CA_US_CONNEXION Пересечение границы между Онтарио (Канада) и Мичиганом (США).
CA_US_NEXUS_CARD Пересечение границы между Канадой и США.
ID_E_TOLL Индонезия. Электронная карта, выпущенная несколькими банками и используемая для оплаты проезда по платным дорогам. Все электронные карты банков имеют одинаковую комиссию, поэтому достаточно одного значения перечисления. Примеры: Bank Mandiri https://www.bankmandiri.co.id/e-money, BCA https://www.bca.co.id/flazz, BNI https://www.bni.co.id/id-id/ebanking/tapcash.
IN_FASTAG Индия.
IN_LOCAL_HP_PLATE_EXEMPT Индия, освобождение от уплаты налогов в штате Химачал-Прадеш.
JP_ETC Япония, ETC. Беспроводная электронная система взимания платы за проезд. https://www.go-etc.jp/
JP_ETC2 ETC2.0 (Япония). Новая версия ETC с дополнительной скидкой и двусторонней связью между устройствами в автомобилях и антеннами на дорогах. https://www.go-etc.jp/etc2/index.html
MX_IAVE Мексика https://iave.capufe.gob.mx/#/
MX_PASE Мексика https://www.pase.com.mx
MX_QUICKPASS Мексика https://operadoravial.com/quick-pass/
MX_SISTEMA_TELEPEAJE_CHIHUAHUA Мексика http://appsh.chihuahua.gob.mx/transparencia/?doc=/ingresos/TelepeajeFormato4.pdf
MX_TAG_IAVE Мексика
MX_TAG_TELEVIA Компания, предоставляющая абонементы на проезд по платным дорогам в Мексике. Одна из многих, работающих в Мехико. Дополнительную информацию можно найти на сайте https://www.televia.com.mx.
MX_TELEVIA Компания, предоставляющая абонементы на проезд по платным дорогам в Мексике. Одна из многих компаний, работающих в Мехико. https://www.televia.com.mx
MX_VIAPASS пропуск для платных дорог в Мексике; Дополнительную информацию можно найти на странице https://www.viapass.com.mx/viapass/web_home.aspx.
US_AL_FREEDOM_PASS Алабама, США.
US_AK_ANTON_ANDERSON_TUNNEL_BOOK_OF_10_TICKETS Аляска, США.
US_CA_FASTRAK Калифорния, США.
US_CA_FASTRAK_CAV_STICKER Указывает, что у водителя есть проездной FasTrak в дополнение к наклейке для экологически чистого автомобиля, выданной Управлением автомобильного транспорта. https://www.bayareafastrak.org/en/guide/doINeedFlex.shtml
US_CO_EXPRESSTOLL Колорадо, США.
US_CO_GO_PASS Колорадо, США.
US_DE_EZPASSDE Германии и США.
US_FL_BOB_SIKES_TOLL_BRIDGE_PASS Флорида, США.
US_FL_DUNES_COMMUNITY_DEVELOPMENT_DISTRICT_EXPRESSCARD Флорида, США.
US_FL_EPASS Флорида, США.
US_FL_GIBA_TOLL_PASS Флорида, США.
US_FL_LEEWAY Флорида, США.
US_FL_SUNPASS Флорида, США.
US_FL_SUNPASS_PRO Флорида, США.
US_IL_EZPASSIL Иллинойс, США.
US_IL_IPASS Иллинойс, США.
US_IN_EZPASSIN Индия, США.
US_KS_BESTPASS_HORIZON в штате Канзас, США.
US_KS_KTAG в штате Канзас, США.
US_KS_NATIONALPASS в штате Канзас, США.
US_KS_PREPASS_ELITEPASS в штате Канзас, США.
US_LA_GEAUXPASS Лос-Анджелес, США.
US_LA_TOLL_TAG Лос-Анджелес, США.
US_MA_EZPASSMA Массачусетс, США.
US_MD_EZPASSMD Мэриленд, США.
US_ME_EZPASSME Мэн, США.
US_MI_AMBASSADOR_BRIDGE_PREMIER_COMMUTER_CARD Мичиган, США.
US_MI_BCPASS Мичиган, США.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG Мичиган, США.
US_MI_IQ_PROX_CARD

Мичиган, США. Устарело, так как этого типа карт больше не существует.
US_MI_IQ_TAG Мичиган, США.
US_MI_MACKINAC_BRIDGE_MAC_PASS Мичиган, США.
US_MI_NEXPRESS_TOLL Мичиган, США.
US_MN_EZPASSMN Миннесота, США.
US_NC_EZPASSNC Северная Каролина, США.
US_NC_PEACH_PASS Северная Каролина, США.
US_NC_QUICK_PASS Северная Каролина, США.
US_NH_EZPASSNH Нью-Гэмпшир, США.
US_NJ_DOWNBEACH_EXPRESS_PASS Нью-Джерси, США.
US_NJ_EZPASSNJ Нью-Джерси, США.
US_NY_EXPRESSPASS Нью-Йорк, США.
US_NY_EZPASSNY Нью-Йорк, США.
US_OH_EZPASSOH Огайо, США.
US_PA_EZPASSPA Пенсильвания, США.
US_RI_EZPASSRI Род-Айленд, США.
US_SC_PALPASS Южная Каролина, США.
US_TX_AVI_TAG Техас, США.
US_TX_BANCPASS Техас, США.
US_TX_DEL_RIO_PASS Техас, США.
US_TX_EFAST_PASS Техас, США.
US_TX_EAGLE_PASS_EXPRESS_CARD Техас, США.
US_TX_EPTOLL Техас, США.
US_TX_EZ_CROSS Техас, США.
US_TX_EZTAG Техас, США.
US_TX_FUEGO_TAG Техас, США.
US_TX_LAREDO_TRADE_TAG Техас, США.
US_TX_PLUSPASS Техас, США.
US_TX_TOLLTAG Техас, США.
US_TX_TXTAG Техас, США.
US_TX_XPRESS_CARD Техас, США.
US_UT_ADAMS_AVE_PARKWAY_EXPRESSCARD Юта, США.
US_VA_EZPASSVA Вирджиния, США.
US_WA_BREEZEBY Вашингтон, США.
US_WA_GOOD_TO_GO Вашингтон, США.
US_WV_EZPASSWV Западная Виргиния, США.
US_WV_MEMORIAL_BRIDGE_TICKETS Западная Виргиния, США.
US_WV_MOV_PASS Западная Виргиния, США
US_WV_NEWELL_TOLL_BRIDGE_TICKET Западная Виргиния, США.

Единицы

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

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

VehicleEmissionType

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

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

VehicleInfo

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

Поля
emission_type

VehicleEmissionType

Тип выбросов автомобиля. Применяется только к устройству DRIVE RouteTravelMode.

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

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

Поля
via

bool

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

bool

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

bool

Указывает, что в этой путевой точке транспортное средство должно остановиться на определенной стороне дороги. Если задать это значение, маршрут будет проходить через указанное место, чтобы транспортное средство могло остановиться на той стороне дороги, к которой смещено местоположение относительно центра дороги. Этот вариант доступен только для режимов "На автомобиле" и "На мотоцикле".
Объединенное поле location_type. Разные способы представления местоположения. location_type может иметь одно из следующих значений:
location

Location

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

string

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