Класс геокодера
google.maps . Geocoder
Сервис для преобразования адреса в координаты LatLng
.
Доступ осуществляется путем вызова const {Geocoder} = await google.maps.importLibrary("geocoding")
.
См. Библиотеки в Maps JavaScript API .
Конструктор | |
---|---|
Geocoder | Geocoder() Параметры: нет Создает новый экземпляр Geocoder , который отправляет запросы геокодирования на серверы Google. |
Методы | |
---|---|
geocode | geocode(request[, callback]) Параметры:
Возвращаемое значение: Promise < GeocoderResponse > Геокодировать запрос. |
Интерфейс GeocoderRequest
google.maps . GeocoderRequest
Спецификация запроса на геокодирование, отправляемого Geocoder
.
Характеристики | |
---|---|
address optional | Тип: string optional Адрес для геокодирования. Необходимо указать только один из параметров: address , location и placeId . |
bounds optional | Тип: LatLngBounds | LatLngBoundsLiteral optional LatLngBounds в пределах которых выполняется поиск. Необязательно. |
componentRestrictions optional | Тип: GeocoderComponentRestrictions optional Компоненты используются для ограничения результатов поиска определённой областью. Фильтр может состоять из одного или нескольких следующих параметров: route , locality , administrativeArea , postalCode , country . Будут возвращены только результаты, соответствующие всем фильтрам. Значения фильтра поддерживают те же методы проверки орфографии и частичного соответствия, что и другие запросы геокодирования. Необязательно. |
| Тип: Array < ExtraGeocodeComputation > optional Список дополнительных вычислений, которые могут быть использованы для выполнения запроса. Примечание: эти дополнительные вычисления могут возвращать дополнительные поля в ответе. |
fulfillOnZeroResults optional | Тип: boolean optional Выполнить обещание по статусу ZERO_RESULT в ответе. Это может быть желательно, поскольку даже при нулевых результатах геокодирования могут быть возвращены дополнительные поля уровня ответа. |
language optional | Тип: string optional Идентификатор языка, на котором, по возможности, должны быть возвращены результаты. См. список поддерживаемых языков . |
location optional | Тип: LatLng | LatLngLiteral optional LatLng (или LatLngLiteral ), по которому выполняется поиск. Геокодер выполняет обратное геокодирование. Подробнее см. раздел «Обратное геокодирование» . Необходимо указать только один из параметров: address , location и placeId . |
placeId optional | Тип: string optional Идентификатор места, связанный с местоположением. Идентификаторы места однозначно идентифицируют место в базе данных Google Places и на Google Картах. Подробнее об идентификаторах места см. в руководстве разработчика API Places. Геокодер выполняет обратное геокодирование. Подробнее см. в разделе «Обратное геокодирование» . Необходимо указать только один из параметров: address , location и placeId . |
region optional | Тип: string optional Код страны, используемый для смещения поиска, указывается как двухсимвольный (не числовой) субтег региона Unicode / идентификатор CLDR. Необязательно. Информацию о поддерживаемых регионах см. в разделе «Подробности покрытия платформы Google Карт» . |
Интерфейс GeocoderComponentRestrictions
google.maps . GeocoderComponentRestrictions
GeocoderComponentRestrictions
представляет собой набор фильтров, определяющих область. Подробнее о том, как это работает, см. в разделе Фильтрация компонентов геокодирования .
Характеристики | |
---|---|
administrativeArea optional | Тип: string optional Соответствует всем administrative_area levels . Необязательно. |
country optional | Тип: string optional Соответствует названию страны или двухбуквенному коду страны ISO 3166-1. Необязательно. |
locality optional | Тип: string optional Совпадает с типами locality и sublocality . Необязательно. |
postalCode optional | Тип: string optional Соответствует postal_code и postal_code_prefix . Необязательно. |
route optional | Тип: string optional Соответствует длинному или короткому названию route . Необязательно. |
Константы ExtraGeocodeComputation
google.maps . ExtraGeocodeComputation
Дополнительные вычисления, выполняемые при выполнении запроса на геокодирование.
Доступ осуществляется путем вызова const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
.
См. Библиотеки в Maps JavaScript API .
Константы | |
---|---|
ADDRESS_DESCRIPTORS | Сгенерировать дескриптор адреса. |
Константы GeocoderStatus
google.maps . GeocoderStatus
Статус, возвращаемый Geocoder
после завершения вызова geocode()
. Укажите его значением или именем константы. Например, 'OK'
или google.maps.GeocoderStatus.OK
.
Доступ осуществляется путем вызова const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
.
См. Библиотеки в Maps JavaScript API .
Константы | |
---|---|
ERROR | Возникла проблема при соединении с серверами Google. |
INVALID_REQUEST | Этот GeocoderRequest оказался недействительным. |
OK | Ответ содержит допустимый GeocoderResponse . |
OVER_QUERY_LIMIT | Веб-страница превысила лимит запросов за слишком короткий промежуток времени. |
REQUEST_DENIED | Веб-странице запрещено использовать геокодер. |
UNKNOWN_ERROR | Запрос на геокодирование не удалось обработать из-за ошибки сервера. Запрос может быть выполнен успешно, если вы повторите попытку. |
ZERO_RESULTS | По данному GeocoderRequest ничего не найдено. |
Интерфейс GeocoderResponse
google.maps . GeocoderResponse
Ответ Geocoder, возвращаемый Geocoder
, содержащий список GeocoderResult
.
Характеристики | |
---|---|
results | Тип: Array < GeocoderResult > Список GeocoderResult s. |
| Тип: AddressDescriptor optional Реляционное описание местоположения. Включает ранжированный набор близлежащих ориентиров и областей, содержащих целевое местоположение. Заполняется только для запросов обратного геокодирования и только при включенном параметре ExtraGeocodeComputation.ADDRESS_DESCRIPTORS . |
plus_code optional | Тип: PlacePlusCode optional Плюс-код, связанный с местоположением. |
Интерфейс GeocoderResult
google.maps . GeocoderResult
Один результат геокодирования, полученный с сервера геокодирования. Запрос геокодирования может возвращать несколько объектов результатов. Обратите внимание, что, хотя этот результат и похож на JSON, он не является JSON в строгом смысле, поскольку косвенно включает объект LatLng
.
Характеристики | |
---|---|
address_components | Тип: Array < GeocoderAddressComponent > Массив GeocoderAddressComponent s |
formatted_address | Тип: string Строка, содержащая понятный человеку адрес этого местоположения. |
geometry | Тип: GeocoderGeometry Объект GeocoderGeometry |
place_id | Тип: string Идентификатор места, связанный с местоположением. Идентификаторы места однозначно идентифицируют место в базе данных Google Places и на Google Картах. Подробнее об идентификаторах места читайте в руководстве разработчика API Places. |
types | Тип: Array <string> Массив строк, обозначающий тип возвращаемого геокодированного элемента. Список возможных строк см. в разделе «Типы компонентов адреса» Руководства разработчика. |
| Тип: AddressDescriptor optional Реляционное описание местоположения, связанного с этим геокодом. Включает ранжированный набор близлежащих ориентиров и областей, содержащих целевое местоположение. Это описание будет заполняться только для запросов прямого геокодирования и поиска идентификаторов мест, только при включенном параметре ExtraGeocodeComputation.ADDRESS_DESCRIPTORS и только для определённых локализованных мест. |
partial_match optional | Тип: boolean optional Если геокодер не вернул точное совпадение для исходного запроса, хотя ему удалось сопоставить часть запрошенного адреса. Если совпадение точное, значение будет undefined . |
plus_code optional | Тип: PlacePlusCode optional Плюс-код, связанный с местоположением. |
postcode_localities optional | Тип: Array <string> optional Массив строк, обозначающий все населённые пункты, содержащиеся в почтовом индексе. Присутствует только в том случае, если результат представляет собой почтовый индекс, содержащий несколько населённых пунктов. |
Интерфейс AddressDescriptor
google.maps . AddressDescriptor
Относительное описание местоположения. Включает в себя ранжированный набор близлежащих ориентиров и областей, содержащих целевое местоположение.
Характеристики | |
---|---|
areas | Ранжированный список содержащих или смежных областей. Наиболее полезные (распознаваемые и точные) области ранжируются первыми. |
landmarks | Рейтинг ближайших достопримечательностей. Самые полезные (узнаваемые и расположенные поблизости) достопримечательности находятся в начале списка. |
Интерфейс GeocoderAddressComponent
google.maps . GeocoderAddressComponent
Один компонент адреса в GeocoderResult
. Полный адрес может состоять из нескольких компонентов адреса.
Характеристики | |
---|---|
long_name | Тип: string Полный текст адресной части |
short_name | Тип: string Сокращенный, краткий текст данного компонента адреса |
types | Тип: Array <string> Массив строк, указывающий тип этого компонента адреса. Список допустимых типов можно найти здесь. |
Интерфейс GeocoderGeometry
google.maps . GeocoderGeometry
Информация о геометрии этого GeocoderResult
Характеристики | |
---|---|
location | Тип: LatLng Координаты широты/долготы этого результата |
location_type | Тип: GeocoderLocationType Тип местоположения, возвращаемый в location |
viewport | Тип:
|