Route Matrix (beta)

Класс 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
Тип: Array < RouteMatrixRow >
Строки матрицы. Каждая строка соответствует исходной точке и содержит массив RouteMatrixItem , каждый из которых представляет маршрут к пункту назначения.
toJSON
toJSON()
Параметры: нет
Возвращаемое значение: Object
Преобразуется в объект.

Класс RouteMatrixRow

google.maps.routes . RouteMatrixRow

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

Доступ осуществляется путем вызова const {RouteMatrixRow} = await google.maps.importLibrary("routes") .
См. Библиотеки в Maps JavaScript API .

items
Тип: Array < RouteMatrixItem >
Информация о маршруте для каждого пункта назначения.
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
Дополнительная информация о маршруте.

Интерфейс ComputeRouteMatrixRequest

google.maps.routes . ComputeRouteMatrixRequest

Запрос на матрицу маршрутов.

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

На количество пунктов отправления и назначения накладывается ряд ограничений:
  • Общее количество пунктов отправления и назначения, указанных как string или Place , не должно превышать 50.
  • Произведение количества пунктов отправления и количества пунктов назначения не должно превышать 625.
  • Произведение количества пунктов отправления и назначения не должно превышать 100, если для ComputeRouteMatrixRequest.routingPreference задано значение TRAFFIC_AWARE_OPTIMAL .
  • Произведение количества пунктов отправления и назначения не должно превышать 100, если ComputeRouteMatrixRequest.travelMode имеет значение TRANSIT .
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, например, «en-US» или «sr-Latn». Подробнее см. в разделе «Идентификатор локали Unicode» . Список поддерживаемых языков см. в разделе « Поддержка языков» . Если это значение не указано, язык определяется на основе настроек локализации JavaScript API Google Карт. В противном случае язык определяется на основе местоположения первого источника.
region optional
Тип: string optional
Код региона, указанный как двухсимвольное значение ccTLD («домен верхнего уровня»). Подробнее см. в разделе Код страны для доменов верхнего уровня . Если это значение не указано, регион определяется на основе настроек локализации JavaScript API Google Карт. В противном случае регион определяется на основе местоположения первого источника.
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 удаленного текста, например «en-US» или «sr-Latn».

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

Примечание: если вы не запрашивали информацию о дорожном движении, это значение совпадает со значением RouteMatrixItemLocalizedValues.staticDuration .
durationLanguage
Тип: string optional
Код языка длительности текста BCP-47, например «en-US» или «sr-Latn».

Более подробную информацию см. по адресу http://www.unicode.org/reports/tr35/#Unicode_locale_identifier .
staticDuration
Тип: string optional
Продолжительность без учета дорожной обстановки, указана в текстовом виде.
staticDurationLanguage
Тип: string optional
Код языка BCP-47 статического текста длительности, например «en-US» или «sr-Latn».
transitFare
Тип: string optional
Стоимость проезда, представленная в текстовом виде.
transitFareLanguage
Тип: string optional
Код языка BCP-47 текста тарифа на проезд, например «en-US» или «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
Модификаторы для каждого маршрута, который берет эту точку в качестве отправной точки.