Places Service

PlacesService class

google.maps.places . PlacesService

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

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

PlacesService
PlacesService(attrContainer)
Параметры:
Создает новый экземпляр PlacesService , который отображает атрибуции в указанном контейнере.
findPlaceFromPhoneNumber
findPlaceFromPhoneNumber(request, callback)
Параметры:
Возвращаемое значение: нет
Получает список мест по номеру телефона. В большинстве случаев в списке результатов должен быть только один элемент, однако, если запрос неоднозначен, может быть возвращено несколько результатов. Передаваемые в функцию обратного вызова объекты PlaceResult являются подмножествами полного PlaceResult . Ваше приложение может получить более подробный PlaceResult для каждого места, вызвав PlacesService.getDetails и передав PlaceResult.place_id нужного места.
findPlaceFromQuery
findPlaceFromQuery(request, callback)
Параметры:
Возвращаемое значение: нет
Получает список мест на основе строки запроса. В большинстве случаев в списке результатов должен быть только один элемент, однако, если запрос неоднозначен, может быть возвращено несколько результатов. Передаваемые в функцию обратного вызова объекты PlaceResult являются подмножествами полного PlaceResult . Ваше приложение может получить более подробный PlaceResult для каждого места, вызвав PlacesService.getDetails и передав PlaceResult.place_id нужного места.
getDetails
getDetails(request, callback)
Параметры:
Возвращаемое значение: нет
Возвращает сведения о месте, идентифицированном заданным placeId .
nearbySearch
nearbySearch(request, callback)
Параметры:
Возвращаемое значение: нет
Получает список мест рядом с определённым местоположением на основе ключевого слова или типа. Местоположение всегда должно быть указано либо путём передачи LatLngBounds , либо параметров location и radius . Передаваемые в функцию обратного вызова объекты PlaceResult являются подмножествами полного PlaceResult . Ваше приложение может получить более подробный PlaceResult для каждого места, отправив запрос Place Details, передав PlaceResult.place_id для нужного места. Объект PlaceSearchPagination можно использовать для получения дополнительных страниц результатов (null, если это последняя страница результатов или если есть только одна страница результатов).
textSearch
textSearch(request, callback)
Параметры:
Возвращаемое значение: нет
Получает список мест на основе строки запроса (например, «пицца в Нью-Йорке» или «обувные магазины рядом с Оттавой»). Параметры местоположения необязательны; если местоположение указано, результаты будут смещены в сторону ближайших результатов, а не ограничены местами внутри области. Используйте textSearch , когда нужно искать места по произвольной строке, а также в случаях, когда не требуется ограничивать результаты поиска конкретным местоположением. Объект PlaceSearchPagination можно использовать для получения дополнительных страниц результатов (null, если это последняя страница результатов или если есть только одна страница результатов).

Интерфейс PlaceDetailsRequest

google.maps.places . PlaceDetailsRequest

Запрос сведений о месте, который необходимо отправить в PlacesService .

placeId
Тип: string
Идентификатор места, для которого запрашиваются сведения.
fields optional
Тип: Array <string> optional
Поля, которые необходимо включить в ответ с подробными сведениями, за которые будет выставлен счёт . Если поля не указаны или передано ['ALL'] , будут возвращены все доступные поля, за которые будет выставлен счёт (это не рекомендуется для производственных развёртываний). Список полей см. в PlaceResult . Вложенные поля можно указывать с помощью точечных путей (например, "geometry.location" ).
language optional
Тип: string optional
Идентификатор языка, на котором должна быть возвращена информация. См. список поддерживаемых языков .
region optional
Тип: string optional
Региональный код пользователя. Он может влиять на то, какие фотографии будут возвращены, и, возможно, на другие параметры. Региональный код принимает двухсимвольное значение ccTLD («домен верхнего уровня») . Большинство кодов ccTLD идентичны кодам ISO 3166-1, за некоторыми заметными исключениями. Например, ccTLD Великобритании — «uk» ( .co.uk ), а её код ISO 3166-1 — «gb» (технически обозначает «Соединённое Королевство Великобритании и Северной Ирландии»).
sessionToken optional
Тип: AutocompleteSessionToken optional
Уникальная ссылка, используемая для объединения запроса подробностей с сеансом автозаполнения.

Интерфейс FindPlaceFromPhoneNumberRequest

google.maps.places . FindPlaceFromPhoneNumberRequest

Поиск места из текстового поискового запроса, отправляемого в PlacesService.findPlaceFromPhoneNumber .

fields
Тип: Array <string>
Поля, которые необходимо включить в ответ, и за которые будет выставлен счёт . Если передано ['ALL'] , будут возвращены все доступные поля, за которые будет выставлен счёт (это не рекомендуется для производственных развёртываний). Список полей см. PlaceResult . Вложенные поля можно указывать с помощью точечных путей (например, "geometry.location" ).
phoneNumber
Тип: string
Номер телефона места, которое нужно найти. Формат должен быть E.164 .
language optional
Тип: string optional
Идентификатор языка, на котором, по возможности, следует возвращать имена и адреса. См. список поддерживаемых языков .
locationBias optional
Тип: LocationBias optional
Смещение, используемое при поиске по запросу «место». Результат будет смещен в сторону указанного значения LocationBias , но не ограничивается им.

Интерфейс FindPlaceFromQueryRequest

google.maps.places . FindPlaceFromQueryRequest

Поиск места из текстового поискового запроса, отправляемого в PlacesService.findPlaceFromQuery .

fields
Тип: Array <string>
Поля, которые необходимо включить в ответ, и за которые будет выставлен счёт . Если передано ['ALL'] , будут возвращены все доступные поля, за которые будет выставлен счёт (это не рекомендуется для производственных развёртываний). Список полей см. PlaceResult . Вложенные поля можно указывать с помощью точечных путей (например, "geometry.location" ).
query
Тип: string
Запрос. Например, название или адрес места.
language optional
Тип: string optional
Идентификатор языка, на котором, по возможности, следует возвращать имена и адреса. См. список поддерживаемых языков .
locationBias optional
Тип: LocationBias optional
Смещение, используемое при поиске по запросу «место». Результат будет смещен в сторону указанного значения LocationBias , но не ограничивается им.

Интерфейс PlaceSearchRequest

google.maps.places . PlaceSearchRequest

Запрос поиска места, который будет отправлен в PlacesService .

bounds optional
Тип: LatLngBounds | LatLngBoundsLiteral optional
Границы, в пределах которых выполняется поиск мест. Если заданы bounds , location и radius будут игнорироваться.
keyword optional
Тип: string optional
Термин, который необходимо сопоставить со всеми доступными полями, включая, помимо прочего, имя, тип и адрес, а также отзывы клиентов и другой сторонний контент.
language optional
Тип: string optional
Идентификатор языка, на котором, по возможности, следует возвращать имена и адреса. См. список поддерживаемых языков .
location optional
Тип: LatLng | LatLngLiteral optional
Местоположение, вокруг которого следует искать места.
maxPriceLevel optional
Тип: number optional
Ограничивает результаты только местами с указанной ценой или ниже. Допустимые значения находятся в диапазоне от 0 (самый доступный) до 4 (самый дорогой) включительно. Значение должно быть больше или равно значению minPrice , если оно указано.
minPriceLevel optional
Тип: number optional
Ограничивает результаты только местами с указанной ценой или выше. Допустимые значения находятся в диапазоне от 0 (самый доступный) до 4 (самый дорогой) включительно. Значение должно быть меньше или равно maxPrice , если оно указано.
name optional
Тип: string optional
Эквивалентно keyword . Значения в этом поле объединяются со значениями в поле keyword и передаются как часть той же строки поиска.
openNow optional
Тип: boolean optional
Ограничивает результаты только теми местами, которые открыты в данный момент.
radius optional
Тип: number optional
Расстояние от заданного местоположения, в пределах которого выполняется поиск мест, в метрах. Максимально допустимое значение — 50 000.
rankBy optional
Тип: RankBy optional
По умолчанию: RankBy.PROMINENCE
Указывает метод ранжирования, используемый при возврате результатов. Обратите внимание: если rankBy установлен в DISTANCE , необходимо указать location но нельзя указать radius или bounds .
type optional
Тип: string optional
Поиск мест заданного типа. Тип переводится на локальный язык целевого местоположения запроса и используется в качестве строки запроса. Если также указан запрос, он добавляется к локализованной строке типа. Результаты другого типа исключаются из ответа. Используйте это поле для выполнения категориального поиска, независимого от языка и региона. Допустимые типы указаны здесь .

Интерфейс TextSearchRequest

google.maps.places . TextSearchRequest

Текстовый поисковый запрос, отправляемый в PlacesService .

bounds optional
Тип: LatLngBounds | LatLngBoundsLiteral optional
Границы, используемые для смещения результатов при поиске мест (необязательно). Если заданы bounds то и location , и radius будут игнорироваться. Результаты не будут ограничены теми, кто находится внутри этих границ; однако результаты, находящиеся внутри них, будут ранжироваться выше.
language optional
Тип: string optional
Идентификатор языка, на котором, по возможности, следует возвращать имена и адреса. См. список поддерживаемых языков .
location optional
Тип: LatLng | LatLngLiteral optional
Центр области, используемой для смещения результатов при поиске мест.
query optional
Тип: string optional
Термин запроса. Например, название места («Эйфелева башня»), категория, за которой следует название места («пицца в Нью-Йорке»), или название места, за которым следует уточнение местоположения («Starbucks в Сиднее»).
radius optional
Тип: number optional
Радиус области, используемой для смещения результатов при поиске мест, в метрах.
region optional
Тип: string optional
Код региона, к которому будут смещаться результаты поиска. Код региона принимает двухсимвольное значение ccTLD («домен верхнего уровня») . Большинство кодов ccTLD идентичны кодам ISO 3166-1, за некоторыми заметными исключениями. Например, ccTLD Великобритании — «uk» ( .co.uk ), а код ISO 3166-1 — «gb» (технически обозначает «Соединённое Королевство Великобритании и Северной Ирландии»).
type optional
Тип: string optional
Поиск мест заданного типа. Тип переводится на локальный язык целевого местоположения запроса и используется в качестве строки запроса. Если также указан запрос, он добавляется к локализованной строке типа. Результаты другого типа исключаются из ответа. Используйте это поле для выполнения категориального поиска, независимого от языка и региона. Допустимые типы указаны здесь .

Константы RankBy

google.maps.places . RankBy

Параметры ранжирования для PlaceSearchRequest.

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

DISTANCE Ранжирует результаты по расстоянию от местоположения.
PROMINENCE Ранжирует результаты по степени их значимости.

LocationBias typedef

google.maps.places . LocationBias typedef

LocationBias представляет собой мягкую границу или подсказку для поиска мест. Результаты могут быть получены из-за пределов указанной области. Чтобы использовать IP-адрес текущего пользователя в качестве смещения, можно указать строку "IP_BIAS" . Примечание: при использовании Circle необходимо указать центр и радиус.

LatLng | LatLngLiteral | LatLngAltitude | LatLngAltitudeLiteral | LatLngBounds | LatLngBoundsLiteral | Circle | CircleLiteral |string

LocationRestriction typedef

google.maps.places . LocationRestriction typedef

LocationRestriction представляет собой строгую границу, используемую при поиске мест.

LatLngBounds | LatLngBoundsLiteral

Константы PlacesServiceStatus

google.maps.places . PlacesServiceStatus

Статус, возвращаемый PlacesService по завершении поиска. Укажите его значением или именем константы. Например, 'OK' или google.maps.places.PlacesServiceStatus.OK .

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

INVALID_REQUEST Этот запрос недействителен.
NOT_FOUND Указанное место не найдено.
OK Ответ содержит действительный результат.
OVER_QUERY_LIMIT Приложение превысило квоту запросов.
REQUEST_DENIED Приложению не разрешено использовать PlacesService .
UNKNOWN_ERROR Запрос PlacesService не удалось обработать из-за ошибки сервера. Запрос может быть выполнен успешно, если вы повторите попытку.
ZERO_RESULTS По данному запросу ничего не найдено.

Интерфейс PlaceSearchPagination

google.maps.places . PlaceSearchPagination

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

hasNextPage
Тип: boolean
Указывает, доступны ли дополнительные результаты. true , если есть дополнительная страница результатов.
nextPage
nextPage()
Параметры: нет
Возвращаемое значение: void
Открывает следующую страницу результатов. Использует ту же функцию обратного вызова, что и для первого поискового запроса.

Интерфейс PlaceResult

google.maps.places . PlaceResult

Определяет информацию о месте.

address_components optional
Тип: Array < GeocoderAddressComponent > optional
Коллекция компонентов адреса для местоположения этого места. Доступно только с PlacesService.getDetails .
adr_address optional
Тип: string optional
Представление адреса места в микроформате adr . Доступно только с PlacesService.getDetails .
aspects optional
Тип: Array < PlaceAspectRating > optional
Оценка этого места на основе отзывов пользователей Google и Zagat. Оценка производится по шкале от 0 до 30.
business_status optional
Тип: BusinessStatus optional
Флаг, указывающий на операционный статус объекта, если это коммерческое предприятие (указывает, функционирует ли объект или закрыт временно или постоянно). Если данные отсутствуют, флаг не отображается в результатах поиска или в результатах с подробными сведениями.
formatted_address optional
Тип: string optional
Полный адрес места.
formatted_phone_number optional
Тип: string optional
Номер телефона места, отформатированный в соответствии с региональными правилами . Доступно только с PlacesService.getDetails .
geometry optional
Тип: PlaceGeometry optional
Информация о геометрии места.
html_attributions optional
Тип: Array <string> optional
Текст атрибуции, который будет отображаться для этого результата поиска по месту. Доступные html_attributions возвращаются всегда, независимо от запрошенных fields , и должны быть отображены.
icon optional
Тип: string optional
URL-адрес ресурса изображения, который можно использовать для представления категории этого места.
icon_background_color optional
Тип: string optional
Цвет фона для значка места. См. также PlaceResult.icon_mask_base_uri .
icon_mask_base_uri optional
Тип: string optional
Укороченный URL-адрес маски значка. Доступ к различным типам значков осуществляется путем добавления расширения файла в конец имени (например, .svg или .png ).
international_phone_number optional
Тип: string optional
Номер телефона места в международном формате. Международный формат включает код страны и знак плюс (+). Доступно только с PlacesService.getDetails .
name optional
Тип: string optional
Название места. Примечание: в случае ввода места пользователем, это необработанный текст, в том виде, в котором он был набран. Будьте осторожны при использовании этих данных, так как злоумышленники могут попытаться использовать их в качестве инструмента для атак с внедрением кода (см. http://en.wikipedia.org/wiki/Code_injection ).
opening_hours optional
Тип: PlaceOpeningHours optional
Определяет, когда место открывается или закрывается.
permanently_closed optional
Тип: boolean optional
Флаг, указывающий, закрыто ли место (постоянно или временно). Если место функционирует или данные о нём отсутствуют, флаг в ответе отсутствует.
photos optional
Тип: Array < PlacePhoto > optional
Фотографии этого места. Коллекция будет содержать до десяти объектов PlacePhoto .
place_id optional
Тип: string optional
Уникальный идентификатор места.
plus_code optional
Тип: PlacePlusCode optional
Определяет открытые коды местоположений или « плюс-коды » для места.
price_level optional
Тип: number optional
Уровень цен в данном месте по шкале от 0 до 4. Уровни цен интерпретируются следующим образом:
  • 0 : Бесплатно
  • 1 : Недорого
  • 2 : Умеренный
  • 3 : Дорого
  • 4 : Очень дорого
rating optional
Тип: number optional
Рейтинг от 1,0 до 5,0, основанный на отзывах пользователей об этом месте.
reviews optional
Тип: Array < PlaceReview > optional
Список отзывов об этом месте. Доступно только с PlacesService.getDetails .
types optional
Тип: Array <string> optional
Массив типов для этого места (например, ["political", "locality"] или ["restaurant", "establishment"] ).
url optional
Тип: string optional
URL официальной страницы Google для этого места. Это страница, принадлежащая Google, которая содержит самую актуальную информацию о месте. Доступно только с PlacesService.getDetails .
user_ratings_total optional
Тип: number optional
Количество пользовательских оценок, которые повлияли на PlaceResult.rating этого места.
utc_offset optional
Тип: number optional
Смещение текущего часового пояса места относительно UTC в минутах. Например, Сидней, Австралия, в период летнего времени опережает UTC на 11 часов, поэтому utc_offset будет равен 660 Для часовых поясов, отстающих от UTC, смещение отрицательное. Например, для Кабо-Верде utc_offset равен -60 . Доступно только с PlacesService.getDetails .
utc_offset_minutes optional
Тип: number optional
Смещение текущего часового пояса места относительно UTC в минутах. Например, Сидней, Австралия, в период летнего времени опережает UTC на 11 часов, поэтому значение utc_offset_minutes будет равно 660 Для часовых поясов, отстающих от UTC, смещение отрицательное. Например, для Кабо-Верде значение utc_offset_minutes равно -60 . Доступно только с PlacesService.getDetails .
vicinity optional
Тип: string optional
Упрощённый адрес места, включающий название улицы, номер дома и населённый пункт, но не провинцию/штат, почтовый индекс или страну. Например, для офиса Google в Сиднее, Австралия, значение близости равно "48 Pirrama Road, Pyrmont" . Доступно только с PlacesService.getDetails .