Geocoder

Класс Geocoder

google.maps.Geocoder библиотека
класса "geocoding"

Сервис для преобразования адреса в LatLng и наоборот.

const {Geocoder} = await google.maps.importLibrary("geocoding");
Geocoder
Geocoder()
Параметры: нет.
Создает новый экземпляр Geocoder, который отправляет запросы геокодирования на серверы Google.
geocode
geocode(request[, callback])
Параметры:
Возвращаемое значение: Promise<GeocoderResponse>
Геокодирование запроса.

Интерфейс GeocoderRequest

google.maps.GeocoderRequest интерфейс

Спецификация для запроса геокодирования, который будет отправлен в Geocoder.

address
необязательно
Тип: string optional
Адрес для геокодирования. Необходимо указать только одно из следующих значений: address, location или placeId.
bounds
необязательно
LatLngBounds, в котором нужно выполнить поиск. Необязательное поле.
componentRestrictions
необязательно
Компоненты используются, чтобы ограничить результаты определенной областью. Фильтр состоит из одного или нескольких элементов: route, locality, administrativeArea, postalCode, country. Возвращаются только результаты, соответствующие всем критериям фильтрации. Значения фильтров поддерживают те же методы исправления орфографии и частичного соответствия, что и другие запросы геокодирования. Необязательное поле.
BetaextraComputations
необязательно
Тип: Array<ExtraGeocodeComputation> optional
Список дополнительных вычислений, которые могут использоваться для выполнения запроса. Примечание. В результате этих дополнительных вычислений в ответе могут появиться дополнительные поля.
fulfillOnZeroResults
необязательно
Тип: boolean optional
Выполнить обещание при статусе ZERO_RESULT в ответе. Это может быть полезно, поскольку даже при отсутствии результатов геокодирования могут быть возвращены дополнительные поля на уровне ответа.
language
необязательно
Тип: string optional
Идентификатор языка, на котором по возможности должны возвращаться результаты. Вы можете ознакомиться со списком поддерживаемых языков.
location
необязательно
Тип: LatLng|LatLngLiteral optional
LatLng (или LatLngLiteral), по которому нужно выполнить поиск. Геокодер выполняет обратное геокодирование. Дополнительные сведения можно найти в разделе Обратное геокодирование. Необходимо указать только одно из следующих значений: address, location или placeId.
placeId
необязательно
Тип: string optional
Идентификатор места, связанный с местоположением. Идентификатор места однозначно идентифицирует его в базе данных Google Places и на Google Картах. Подробнее об идентификаторах мест в руководстве для разработчиков Places API. Геокодер выполняет обратное геокодирование. Дополнительные сведения можно найти в разделе Обратное геокодирование. Необходимо указать только одно из следующих значений: address, location или placeId.
region
необязательно
Тип: string optional
Код страны, используемый для уточнения поиска, указывается как двухсимвольный (нечисловой) вложенный тег региона Unicode/идентификатор CLDR. Необязательное поле. Список поддерживаемых регионов приведен в статье Доступность сервисов платформы Google Карт.

Интерфейс GeocoderComponentRestrictions

google.maps.GeocoderComponentRestrictions интерфейс

GeocoderComponentRestrictions представляет собой набор фильтров, которые относятся к определенной области. Подробнее о том, как работает фильтрация компонентов геокодирования…

administrativeArea
необязательно
Тип: string optional
Соответствует всем administrative_area levels. Необязательное поле.
country
необязательно
Тип: string optional
Соответствие названию страны или двухбуквенному коду страны ISO 3166-1. Необязательное поле.
locality
необязательно
Тип: string optional
Соответствие типам locality и sublocality. Необязательное поле.
postalCode
необязательно
Тип: string optional
Соответствует postal_code и postal_code_prefix. Необязательное поле.
route
необязательно
Тип: string optional
Соответствует длинному или сокращенному названию route. Необязательное поле.

Константы ExtraGeocodeComputation

google.maps.ExtraGeocodeComputation Библиотека констант
"geocoding"

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

Эти константы также можно использовать в качестве строк. В TypeScript строковые литералы определяются типом ExtraGeocodeComputationString.

const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");
ADDRESS_DESCRIPTORS Создайте описание адреса.

Константы GeocoderStatus

google.maps.GeocoderStatus Библиотека констант
"geocoding"

Статус, возвращаемый Geocoder по завершении вызова geocode(). Укажите их по значению или по названию константы. Примеры: 'OK' или google.maps.GeocoderStatus.OK.

Эти константы также можно использовать в качестве строк. В TypeScript строковые литералы определяются типом GeocoderStatusString.

const {GeocoderStatus} = await google.maps.importLibrary("geocoding");
ERROR Проблема при попытке связаться с серверами Google.
INVALID_REQUEST Недопустимое значение в поле "GeocoderRequest".
OK Ответ содержит допустимый GeocoderResponse.
OVER_QUERY_LIMIT Веб-страница превысила допустимое число запросов за слишком короткий период времени.
REQUEST_DENIED Эта веб-страница не может использовать геокодер.
UNKNOWN_ERROR Запрос на геокодирование не обработан из-за ошибки сервера. Если повторить попытку, запрос может оказаться успешным.
ZERO_RESULTS Для этого GeocoderRequest ничего не найдено.

Интерфейс GeocoderResponse

google.maps.GeocoderResponse интерфейс

Ответ геокодера, возвращенный Geocoder и содержащий список GeocoderResult.

results
Список GeocoderResult.
Betaaddress_descriptor
необязательно
Тип: AddressDescriptor optional
Описание местоположения относительно других объектов. Включает ранжированный набор близлежащих ориентиров и областей, содержащих целевое местоположение. Оно заполняется только для запросов обратного геокодирования и только когда включен параметр ExtraGeocodeComputation.ADDRESS_DESCRIPTORS.
plus_code
необязательно
Тип: PlacePlusCode optional
Код Plus Code, связанный с местоположением.

Интерфейс GeocoderResult

google.maps.GeocoderResult интерфейс

Один результат геокодировщика, полученный от сервера геокодирования. В ответе на запрос геокодирования могут быть возвращены несколько объектов результата. Обратите внимание, что хотя этот результат похож на JSON, он не является строго JSON, поскольку косвенно включает объект LatLng.

address_components
Массив объектов GeocoderAddressComponent.
formatted_address
Тип: string
Строка, содержащая человекочитаемый адрес этого места.
geometry
Объект GeocoderGeometry
place_id
Тип: string
Идентификатор места, связанный с местоположением. Идентификатор места однозначно идентифицирует его в базе данных Google Places и на Google Картах. Подробнее об идентификаторах мест в руководстве для разработчиков Places API.
types
Тип: Array<string>
Массив строк, указывающих тип возвращенного геокодированного элемента. Список возможных строк приведен в разделе Типы компонентов адреса руководства для разработчиков.
Betaaddress_descriptor
необязательно
Тип: AddressDescriptor optional
Описание местоположения, связанного с этим геокодом. Включает ранжированный набор близлежащих ориентиров и областей, содержащих целевое местоположение. Это поле заполняется только для запросов прямого геокодирования и поиска идентификатора места, только если включен параметр ExtraGeocodeComputation.ADDRESS_DESCRIPTORS и только для определенных локализованных мест.
partial_match
необязательно
Тип: boolean optional
Геокодер не вернул точное совпадение для исходного запроса, хотя и обнаружил частичное совпадение с запрашиваемым адресом. Если совпадение точное, значение будет undefined.
plus_code
необязательно
Тип: PlacePlusCode optional
Код Plus Code, связанный с местоположением.
postcode_localities
необязательно
Тип: Array<string> optional
Массив строк, обозначающий все местоположения, которые содержатся в почтовом индексе. Используется только в том случае, если в качестве результата возвращается почтовый индекс для нескольких мест.

Интерфейс AddressDescriptor

google.maps.AddressDescriptor интерфейс

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

areas
Тип: Array<Area>
Ранжированный список содержащих или смежных областей. Наиболее полезные (узнаваемые и точные) области ранжируются первыми.
landmarks
Тип: Array<Landmark>
Рейтинговый список ориентиров поблизости. Наиболее полезные (узнаваемые и близкие) ориентиры показываются первыми.

Интерфейс GeocoderAddressComponent

google.maps.GeocoderAddressComponent интерфейс

Один компонент адреса в GeocoderResult. Полный адрес может состоять из нескольких компонентов.

long_name
Тип: string
Полный текст компонента адреса
short_name
Тип: string
Короткий, сокращенный текст данного компонента адреса
types
Тип: Array<string>
Массив строк, обозначающих тип этого компонента адреса. Список допустимых типов можно найти здесь.

Интерфейс GeocoderGeometry

google.maps.GeocoderGeometry интерфейс

Геометрическая информация об этом объекте (GeocoderResult)

location
Тип: LatLng
Координаты широты и долготы результата
location_type
Тип местоположения, возвращаемый в location.
viewport
Тип: LatLngBounds
Границы рекомендуемой области просмотра для этого объекта GeocoderResult.
bounds
необязательно
Тип: LatLngBounds optional
Точные границы этого объекта (GeocoderResult), если применимо.

Константы GeocoderLocationType

google.maps.GeocoderLocationType Библиотека констант
"geocoding"

Описывает тип местоположения, возвращенного геокодером. Укажите их по значению или по названию константы. Примеры: 'ROOFTOP' или google.maps.GeocoderLocationType.ROOFTOP.

Эти константы также можно использовать в качестве строк. В TypeScript строковые литералы определяются типом GeocoderLocationTypeString.

const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");
APPROXIMATE Возвращается приблизительный результат.
GEOMETRIC_CENTER Возвращенный результат является геометрическим центром такой линии (например, улицы) или многоугольника (региона).
RANGE_INTERPOLATED Результат содержит приближенное значение (обычно на дороге), полученное при помощи интерполяции двух точных значений (например, перекрестков). Интерполированные результаты обычно возвращаются, если для почтового адреса недоступны геокоды номеров зданий.
ROOFTOP Возвращенный результат отражает точный геокод.

Интерфейс Landmark

google.maps.Landmark интерфейс

Место, которое представляет собой ориентир для адреса.

display_name
Тип: string
Название ориентира.
display_name_language_code
Тип: string
Язык названия ориентира.
place_id
Тип: string
Идентификатор места, которое служит ориентиром. Используется для получения дополнительной информации об ориентире с помощью информации о местах или поиска по идентификатору места.
spatial_relationship
Определяет пространственное отношение между целевым местоположением и ориентиром.
straight_line_distance_meters
Тип: number
Расстояние по прямой между целевым местоположением и ориентиром.
types
Тип: Array<string>
Одно или несколько значений, указывающих тип возвращенного результата. Подробнее о типах …
travel_distance_meters
необязательно
Тип: number optional
Расстояние по дорожной сети между целевым местоположением и ориентиром. Это поле может быть пустым, если ориентир не связан с частью дорожной сети, к которой ближе всего находится целевое местоположение, или если целевое местоположение не считается находящимся на дорожной сети.

Интерфейс Area

google.maps.Area интерфейс

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

containment
Тип: Containment
Определяет пространственную связь между целевым местоположением и областью.
display_name
Тип: string
Название области.
display_name_language_code
Тип: string
Язык названия области.
place_id
Тип: string
Идентификатор места для базовой области. Его можно использовать, чтобы получить больше информации о районе с помощью Place Details или Place ID Lookup.

Константы Containment

google.maps.Containment Библиотека констант
"geocoding"

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

Эти константы также можно использовать в качестве строк. В TypeScript строковые литералы определяются типом ContainmentString.

const {Containment} = await google.maps.importLibrary("geocoding");
NEAR Целевое местоположение находится за пределами региона, но рядом с ним.
OUTSKIRTS Целевое местоположение находится в пределах региона, близко к его границе.
WITHIN Целевое местоположение находится в пределах региона, близко к центру.

Константы SpatialRelationship

google.maps.SpatialRelationship Библиотека констант
"geocoding"

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

Эти константы также можно использовать в качестве строк. В TypeScript строковые литералы определяются типом SpatialRelationshipString.

const {SpatialRelationship} = await google.maps.importLibrary("geocoding");
ACROSS_THE_ROAD Цель находится прямо напротив ориентира на другой стороне дороги.
AROUND_THE_CORNER Ориентир находится не на маршруте, но в одном повороте от него.
BEHIND Близко к достопримечательности, но дальше от точки доступа.
BESIDE Цель находится непосредственно рядом с ориентиром.
DOWN_THE_ROAD На том же маршруте, что и ориентир, но не рядом с ним и не напротив него.
NEAR Это отношение по умолчанию, если не применимы другие варианты.
WITHIN Ориентир имеет пространственную геометрию, и цель находится в его границах.