Route Matrix

Класс RouteMatrix

google.maps.routes.RouteMatrix класс

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

Чтобы получить доступ, позвоните по номеру const {RouteMatrix} = await google.maps.importLibrary("routes").
Подробнее о библиотеках Maps JavaScript API…
computeRouteMatrix
computeRouteMatrix(request)
Параметры: 
Возвращаемое значение:  Promise<{matrix:RouteMatrix}>
Принимает список пунктов отправления и назначения и возвращает матрицу с информацией о маршруте для каждой комбинации пункта отправления и назначения.

Примечание. При использовании этого метода необходимо указать маску поля ответа в запросе, задав свойство ComputeRouteMatrixRequest.fields. Значение – это список путей к полям.

Например:
  • Маска поля для всех доступных полей: fields: ['*'].
  • Маска поля для продолжительности и расстояния на уровне маршрута: fields: ['durationMillis', 'distanceMeters'].

Использовать маску поля ответа с подстановочным знаком fields: ['*'] не рекомендуется по следующим причинам:
  • Выбирая только нужные поля, вы помогаете нашему серверу экономить вычислительные циклы, что позволяет нам возвращать вам результат с меньшей задержкой.
  • Чтобы обеспечить стабильную задержку, выбирайте только те поля, которые нужны для рабочей задачи. В будущем мы можем добавить дополнительные поля ответов, для которых может потребоваться дополнительное время вычислений. Если вы выберете все поля или все поля на верхнем уровне, то производительность может снизиться, поскольку любое новое поле, которое мы добавим, будет автоматически включено в ответ.
  • Выбирая только нужные поля, вы уменьшаете размер ответа и ускоряете его загрузку по сети.
rows
Строки матрицы. Каждая строка соответствует пункту отправления и содержит массив элементов RouteMatrixItem, каждый из которых представляет маршрут до пункта назначения.
toJSON
toJSON()
Параметры: нет.
Возвращаемое значение:  Object
Преобразует в объект.

Класс RouteMatrixRow

google.maps.routes.RouteMatrixRow класс

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

Чтобы получить доступ, позвоните по номеру const {RouteMatrixRow} = await google.maps.importLibrary("routes").
Подробнее о библиотеках Maps JavaScript API…
items
Информация о маршруте для каждого пункта назначения.
toJSON
toJSON()
Параметры: нет.
Возвращаемое значение:  Object
Преобразует в объект.

Класс RouteMatrixItem

google.maps.routes.RouteMatrixItem класс

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

Чтобы получить доступ, позвоните по номеру const {RouteMatrixItem} = await google.maps.importLibrary("routes").
Подробнее о библиотеках Maps JavaScript API…
condition
Тип:  RouteMatrixItemCondition optional
Указывает, был ли найден маршрут.
distanceMeters
Тип:  number optional
Расстояние маршрута в метрах.
durationMillis
Тип:  number optional
Время, необходимое для прохождения маршрута, в миллисекундах. Если для ComputeRouteMatrixRequest.routingPreference задано значение TRAFFIC_UNAWARE, то это значение совпадает с RouteMatrixItem.staticDurationMillis. Если для параметра ComputeRouteMatrixRequest.routingPreference задано значение TRAFFIC_AWARE или TRAFFIC_AWARE_OPTIMAL, то это значение рассчитывается с учетом загруженности дорог.

Примечание. Если продолжительность превышает 2^53 миллисекунд, то это значение равно Number.POSITIVE_INFINITY.
error
Тип:  RouteMatrixItemError optional
Ошибка, возникшая при расчете маршрута.
fallbackInfo
Тип:  FallbackInfo optional
В некоторых случаях, когда сервер не может рассчитать маршрут с заданными настройками для этой конкретной пары отправления и назначения, он может вернуться к использованию другого режима расчета. Если используется резервный вариант, это поле содержит подробную информацию о резервном ответе. В противном случае это поле не задано.
localizedValues
Текстовые представления свойств RouteMatrixItem.
staticDurationMillis
Тип:  number optional
Продолжительность поездки по маршруту без учета загруженности дорог.

Примечание. Если продолжительность превышает 2^53 миллисекунд, то это значение равно Number.POSITIVE_INFINITY.
travelAdvisory
Тип:  RouteTravelAdvisory optional
Дополнительная информация о маршруте.
toJSON
toJSON()
Параметры: нет.
Возвращаемое значение:  Object
Преобразует в объект.

Интерфейс ComputeRouteMatrixRequest

google.maps.routes.ComputeRouteMatrixRequest интерфейс

Запрос матрицы маршрутов.
destinations
Массив пунктов назначения, определяющий столбцы матрицы ответа. Значение, переданное в виде строки, может быть адресом, плюс-кодом или названием ресурса места. Значения высоты не учитываются.
fields
Тип:  Iterable<string>
Набор полей, которые нужно получить. Укажите ["*"] для всех полей.
origins
Массив пунктов отправления, определяющий строки матрицы ответа. Значение, переданное в виде строки, может быть адресом, плюс-кодом или названием ресурса места. Значения высоты не учитываются.

На количество уникальных значений пунктов отправления и назначения накладывается несколько ограничений:
  • Общее количество пунктов отправления и назначения, указанных в виде string или Place, не должно превышать 50.
  • Произведение количества пунктов отправления и количества пунктов назначения не должно превышать 625.
  • Если для параметра ComputeRouteMatrixRequest.routingPreference задано значение TRAFFIC_AWARE_OPTIMAL, результат умножения числа пунктов отправления и назначения не должен превышать 100.
  • Если для параметра ComputeRouteMatrixRequest.travelMode задано значение TRANSIT, результат умножения числа пунктов отправления и назначения не должен превышать 100.
arrivalTime optional
Тип:  Date optional
Время прибытия.

Примечание. Это значение можно задать, только если для параметра ComputeRouteMatrixRequest.travelMode установлено значение TRANSIT. Вы можете указать либо ComputeRouteMatrixRequest.departureTime, либо ComputeRouteMatrixRequest.arrivalTime, но не оба значения. Вы можете посмотреть маршруты общественного транспорта за последние 7 дней или на 100 дней вперед.
departureTime optional
Тип:  Date optional
Время отправления. Если вы не зададите это значение, по умолчанию будет использоваться время, когда вы сделали запрос.

Примечание. Вы можете указать время в прошлом, только если для параметра ComputeRouteMatrixRequest.travelMode задано значение TRANSIT. Вы можете посмотреть маршруты общественного транспорта за последние 7 дней или на 100 дней вперед.
extraComputations optional
Список дополнительных вычислений, которые могут использоваться для выполнения запроса.

Примечание. В результате этих дополнительных вычислений в ответе могут появиться дополнительные поля. Чтобы эти дополнительные поля возвращались в ответе, их также необходимо указать в ComputeRouteMatrixRequest.fields.
language optional
Тип:  string optional
Код языка по стандарту BCP-47, например "ru-RU" или "sr-Latn". Подробнее об идентификаторах региональных настроек Unicode… Список поддерживаемых языков приведен в разделе Поддержка языков. Если это значение не указано, язык определяется на основе настроек локализации Google Maps JavaScript API. В противном случае язык определяется по местоположению первого источника.
region optional
Тип:  string optional
Код региона, указываемый как двухсимвольное значение национального домена верхнего уровня (ccTLD). Подробнее о национальных доменах верхнего уровня… Если вы не укажете это значение, регион будет определяться на основе настроек локализации Google Maps JavaScript API. В противном случае регион определяется по местоположению первого источника.
routingPreference optional
Тип:  RoutingPreference optional
Указывает, как рассчитать матрицу маршрутов. Сервер пытается использовать выбранные настройки маршрутизации для расчета матрицы маршрутов. Если предпочтительный маршрут приводит к ошибке или слишком большой задержке, возвращается ошибка. Этот параметр можно указать, только если для ComputeRouteMatrixRequest.travelMode задано значение DRIVING или TWO_WHEELER. В противном случае запрос не будет выполнен.
trafficModel optional
Тип:  TrafficModel optional
Определяет выбор модели расчета в зависимости от загруженности дорог. Этот параметр влияет на возвращаемое значение поля RouteMatrixItem.durationMillis (прогнозируемое время в пути с учетом средних статистических показателей). ComputeRouteMatrixRequest.trafficModel доступен только для запросов, в которых для ComputeRouteMatrixRequest.routingPreference задано значение TRAFFIC_AWARE_OPTIMAL, а для ComputeRouteMatrixRequest.travelMode – DRIVING. Значение по умолчанию – BEST_GUESS.
transitPreference optional
Тип:  TransitPreference optional
Задает предпочтения, которые влияют на маршрут, возвращаемый для маршрутов TRANSIT.

Примечание. Можно указать, только если для параметра ComputeRouteMatrixRequest.travelMode задано значение TRANSIT.
travelMode optional
Тип:  TravelMode optional
Указывает способ передвижения.
units optional
Тип:  UnitSystem optional
Указывает единицы измерения для полей отображения. Если вы не укажете это значение, единицы измерения будут определяться по местоположению первого пункта отправления.

Константы ComputeRouteMatrixExtraComputation

google.maps.routes.ComputeRouteMatrixExtraComputation константы

Дополнительные вычисления, которые нужно выполнить для запроса RouteMatrix.computeRouteMatrix.

Чтобы получить доступ, позвоните по номеру const {ComputeRouteMatrixExtraComputation} = await google.maps.importLibrary("routes").
Подробнее о библиотеках Maps JavaScript API…
TOLLS Информация о плате за проезд для элементов матрицы.

Константы RouteMatrixItemCondition

google.maps.routes.RouteMatrixItemCondition константы

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

Чтобы получить доступ, позвоните по номеру const {RouteMatrixItemCondition} = await google.maps.importLibrary("routes").
Подробнее о библиотеках Maps JavaScript API…
ROUTE_EXISTS Маршрут найден.
ROUTE_NOT_FOUND Маршрут не найден.

Класс RouteMatrixItemError

google.maps.routes.RouteMatrixItemError класс

Ошибка, которая произошла во время RouteMatrix.computeRouteMatrix для определенной пары пунктов отправления и назначения.

Этот класс расширяет Error.

Чтобы получить доступ, позвоните по номеру const {RouteMatrixItemError} = await google.maps.importLibrary("routes").
Подробнее о библиотеках Maps JavaScript API…
toJSON
toJSON()
Параметры: нет.
Возвращаемое значение:  Object
Преобразует в объект.

Класс RouteMatrixItemLocalizedValues

google.maps.routes.RouteMatrixItemLocalizedValues класс

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

Чтобы получить доступ, позвоните по номеру const {RouteMatrixItemLocalizedValues} = await google.maps.importLibrary("routes").
Подробнее о библиотеках Maps JavaScript API…
distance
Тип:  string optional
Расстояние маршрута в текстовом формате.
distanceLanguage
Тип:  string optional
Код языка по стандарту BCP-47, например "ru-RU" или "sr-Latn".

Подробную информацию можно найти на странице http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
duration
Тип:  string optional
Продолжительность в текстовом формате, локализованная для региона запроса. Учитывает загруженность дорог.

Примечание. Если вы не запрашивали информацию о трафике, это значение будет совпадать со значением RouteMatrixItemLocalizedValues.staticDuration.
durationLanguage
Тип:  string optional
Код языка по стандарту BCP-47, например "ru-RU" или "sr-Latn".

Подробную информацию можно найти на странице http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
Тип:  string optional
Продолжительность без учета загруженности дорог, представленная в текстовом формате.
staticDurationLanguage
Тип:  string optional
Код языка по стандарту BCP-47, например "ru-RU" или "sr-Latn".
transitFare
Тип:  string optional
Стоимость проезда в текстовом формате.
transitFareLanguage
Тип:  string optional
Код языка по стандарту BCP-47, например "ru-RU" или "sr-Latn".

Подробную информацию можно найти на странице http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
toJSON
toJSON()
Параметры: нет.
Возвращаемое значение:  Object
Преобразует в объект.

Интерфейс RouteMatrixOrigin

google.maps.routes.RouteMatrixOrigin интерфейс

Один источник для ComputeRouteMatrixRequest.
waypoint
Местоположение источника. Значение, переданное в виде строки, может быть адресом или плюс-кодом. Значения высоты не учитываются.
routeModifiers optional
Тип:  RouteModifiers optional
Модификаторы для каждого маршрута, который использует это место в качестве начальной точки.