Distance Matrix

Класс DistanceMatrixService

google.maps . DistanceMatrixService

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

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

DistanceMatrixService
DistanceMatrixService()
Параметры: нет
Создает новый экземпляр DistanceMatrixService , который отправляет запросы матрицы расстояний на серверы Google.
getDistanceMatrix
getDistanceMatrix(request[, callback])
Параметры:
Возвращаемое значение: Promise < DistanceMatrixResponse >
Выдает запрос матрицы расстояний.

Интерфейс DistanceMatrixRequest

google.maps . DistanceMatrixRequest

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

destinations
Тип: Array <string| LatLng | LatLngLiteral | Place >
Массив, содержащий строки адреса назначения, объекты LatLng или Place , для которых рассчитывается расстояние и время. Обязательно.
origins
Тип: Array <string| LatLng | LatLngLiteral | Place >
Массив, содержащий строки адреса точки отправления, объекты LatLng или Place , на основе которых рассчитывается расстояние и время. Обязательно.
travelMode
Тип: TravelMode
Запрошенный тип маршрутизации. Обязательно.
avoidFerries optional
Тип: boolean optional
Если задано значение true , сервис Distance Matrix будет избегать паромных переправ, где это возможно. Необязательно.
avoidHighways optional
Тип: boolean optional
Если задано значение true , служба Distance Matrix будет избегать автомагистралей, где это возможно. Необязательно.
avoidTolls optional
Тип: boolean optional
Если задано значение true , служба Distance Matrix будет избегать платных дорог, где это возможно. Необязательно.
drivingOptions optional
Тип: DrivingOptions optional
Настройки применяются только к запросам, где travelMode имеет DRIVING . Этот объект не будет иметь никакого эффекта для других режимов передвижения.
language optional
Тип: string optional
Идентификатор языка, на котором, по возможности, должны быть возвращены результаты. См. список поддерживаемых языков .
region optional
Тип: string optional
Региональный код, используемый в качестве смещения для запросов геокодирования. Региональный код принимает двухсимвольное значение ccTLD («домен верхнего уровня») . Большинство кодов ccTLD идентичны кодам ISO 3166-1, за некоторыми заметными исключениями. Например, ccTLD Великобритании — «uk» ( .co.uk ), а её код ISO 3166-1 — «gb» (технически обозначает «Соединённое Королевство Великобритании и Северной Ирландии»).
transitOptions optional
Тип: TransitOptions optional
Настройки применяются только к запросам, где travelMode — TRANSIT. Этот объект не будет действовать для других режимов передвижения.
unitSystem optional
Тип: UnitSystem optional
Предпочтительная система единиц измерения для отображения расстояния. Необязательно; по умолчанию используется метрическая система.

Интерфейс DistanceMatrixResponse

google.maps . DistanceMatrixResponse

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

destinationAddresses
Тип: Array <string>
Форматированные адреса назначения.
originAddresses
Тип: Array <string>
Форматированные адреса отправителей.
rows
Строки матрицы, соответствующие исходным адресам.

Интерфейс DistanceMatrixResponseRow

google.maps . DistanceMatrixResponseRow

Строка ответа на запрос DistanceMatrixService , состоящая из последовательности DistanceMatrixResponseElement — по одному для каждого соответствующего адреса назначения.

elements
Элементы строки, соответствующие адресам назначения.

Интерфейс DistanceMatrixResponseElement

google.maps . DistanceMatrixResponseElement

Отдельный элемент ответа на запрос DistanceMatrixService , который содержит длительность и расстояние от одного пункта отправления до одного пункта назначения.

distance
Тип: Distance
Расстояние для этой пары «отправитель-назначение». Это свойство может быть неопределено, поскольку расстояние может быть неизвестно.
duration
Тип: Duration
Длительность для данной пары «отправитель-направитель». Это свойство может быть неопределено, поскольку длительность может быть неизвестна.
duration_in_traffic
Тип: Duration
Продолжительность поездки для данной пары «отправитель-направитель» с учётом дорожной обстановки, указанной свойством trafficModel . Это свойство может быть undefined , так как продолжительность может быть неизвестна. Доступно только для клиентов тарифного плана Premium, если при запросе указано drivingOptions .
fare
Тип: TransitFare
Общая стоимость проезда для данной пары пунктов отправления и назначения. Применимо только к транзитным запросам.
status
Статус данной конкретной пары «отправитель-направитель».

Константы DistanceMatrixStatus

google.maps . DistanceMatrixStatus

Статус верхнего уровня запроса в целом, возвращаемый DistanceMatrixService после завершения запроса матрицы расстояний. Укажите его значением или именем константы. Например, 'OK' или google.maps.DistanceMatrixStatus.OK .

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

INVALID_REQUEST Предоставленный запрос недействителен.
MAX_DIMENSIONS_EXCEEDED Запрос содержит более 25 пунктов отправления или более 25 пунктов назначения.
MAX_ELEMENTS_EXCEEDED Произведение пунктов отправления и пунктов назначения превышает лимит на один запрос.
OK Ответ содержит действительный результат.
OVER_QUERY_LIMIT За отведённое время запрошено слишком много элементов. Запрос должен быть выполнен успешно, если вы повторите попытку через некоторое время.
REQUEST_DENIED Служба отклонила использование сервиса Distance Matrix вашей веб-страницей.
UNKNOWN_ERROR Запрос Distance Matrix не удалось обработать из-за ошибки сервера. Запрос может быть выполнен успешно, если вы повторите попытку.

Константы DistanceMatrixElementStatus

google.maps . DistanceMatrixElementStatus

Статус на уровне элемента для конкретной пары «источник-назначение», возвращаемый DistanceMatrixService после завершения запроса матрицы расстояний. Эти значения указываются в виде строк, например, 'OK' .

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

NOT_FOUND Не удалось геокодировать исходную и/или конечную точку этой пары.
OK Ответ содержит действительный результат.
ZERO_RESULTS Не удалось найти маршрут между пунктом отправления и пунктом назначения.