Autocomplete Data

Класс AutocompleteSuggestion

google.maps.places.AutocompleteSuggestion класс

Результат подсказки автозаполнения.

Чтобы получить доступ, позвоните по номеру const {AutocompleteSuggestion} = await google.maps.importLibrary("places").
Подробнее о библиотеках Maps JavaScript API…
fetchAutocompleteSuggestions
fetchAutocompleteSuggestions(autocompleteRequest)
Параметры: 
Возвращаемое значение:  Promise<{suggestions:Array<AutocompleteSuggestion>}>
Получает список AutocompleteSuggestions.

Если в запросе указан AutocompleteRequest.sessionToken, то этот токен сеанса будет автоматически включен при первом вызове Place.fetchFields для каждого Place, возвращенного PlacePrediction.toPlace в результирующих PlacePrediction.
placePrediction
Тип:  PlacePrediction optional
Содержит человекочитаемое название возвращенного результата. Для заведений это обычно название и адрес.

Если в запросе AutocompleteRequest, который использовался для получения этого объекта AutocompleteSuggestion, был указан токен AutocompleteRequest.sessionToken, то этот же токен будет автоматически включен при первом вызове Place.fetchFields для объекта Place, возвращенного вызовом PlacePrediction.toPlace.

Интерфейс AutocompleteRequest

google.maps.places.AutocompleteRequest интерфейс

Интерфейс запроса для AutocompleteSuggestion.fetchAutocompleteSuggestions.
input
Тип:  string
Текстовая строка, по которой выполняется поиск.
includedPrimaryTypes optional
Тип:  Array<string> optional
Основной тип места (например, "ресторан" или "АЗС").

Место возвращается, только если его основной тип включен в этот список. Можно указать до пяти значений. Если типы не указаны, возвращаются все типы мест.
includedRegionCodes optional
Тип:  Array<string> optional
Включать в результаты только указанные регионы (не более 15 двухсимвольных кодов регионов CLDR). Если оставить поле пустым, результаты не будут ограничены. Если заданы оба параметра (locationRestriction и includedRegionCodes), результаты будут находиться в области пересечения.
inputOffset optional
Тип:  number optional
Смещение символа Юникода, начинающееся с нуля, input, указывающее положение курсора в input. Положение курсора может влиять на возвращаемые подсказки. Если не указано, по умолчанию используется длина input.
language optional
Тип:  string optional
Язык, на котором будут возвращены результаты. По умолчанию используются языковые настройки браузера. Результаты могут быть на разных языках, если язык, используемый в input, отличается от language или если для возвращенного места нет перевода с местного языка на language.
locationBias optional
Тип:  LocationBias optional
Настроить предпочтение результатов из определенного местоположения.

Можно задать только одно из значений: locationBias или locationRestriction. Если не задано ни то, ни другое, результаты будут смещены по IP-адресу, то есть IP-адрес будет сопоставлен с неточным местоположением и использован в качестве сигнала смещения.
locationRestriction optional
Тип:  LocationRestriction optional
Ограничить результаты указанным местоположением.

Можно задать только одно из полей: locationBias или locationRestriction. Если не задано ни то, ни другое, результаты будут смещены по IP-адресу, то есть IP-адрес будет сопоставлен с неточным местоположением и использован в качестве сигнала смещения.
origin optional
Тип:  LatLng|LatLngLiteral optional
Начальная точка, от которой рассчитывается геодезическое расстояние до пункта назначения (возвращается как PlacePrediction.distanceMeters). Если это значение не указано, геодезическое расстояние не возвращается.
region optional
Тип:  string optional
Код региона, указанный в виде двухсимвольного кода региона CLDR. Это влияет на форматирование адресов, ранжирование результатов и может повлиять на то, какие результаты будут возвращены. Это не ограничивает результаты указанным регионом.
sessionToken optional
Тип:  AutocompleteSessionToken optional
Токен, который идентифицирует сеанс Autocomplete для выставления счетов. Создайте новый токен сеанса с помощью AutocompleteSessionToken.

Сеанс начинается в тот момент, когда пользователь начинает вводить запрос, а завершается тогда, когда он выбирает место и вызывает Place.fetchFields. В каждом сеансе может быть несколько запросов, после которых следует один вызов fetchFields. Учетные данные, используемые для каждого запроса в рамках сеанса, должны принадлежать одному и тому же проекту консоли Google Cloud. Когда сеанс завершается, токен перестает быть действительным. Ваше приложение должно создавать новый токен для каждого сеанса. Если параметр sessionToken не указан или вы повторно используете токен сеанса, плата за сеанс будет начислена как при отсутствии токена (каждый запрос оплачивается отдельно).

Если в запросе к AutocompleteSuggestion.fetchAutocompleteSuggestions указан токен сеанса, он будет автоматически включен в первый вызов fetchFields для Place, возвращенного вызовом PlacePrediction.toPlace для одного из полученных AutocompleteSuggestion.

Мы рекомендуем следовать следующим рекомендациям:
  • Используйте токены сеансов для всех вызовов автозаполнения мест.
  • Создавайте новый токен для каждого сеанса.
  • Обязательно передавайте уникальный токен сеанса для каждого нового сеанса. Если использовать один токен для нескольких сеансов, плата за каждый сеанс будет начислена по отдельности.

Класс AutocompleteSessionToken

google.maps.places.AutocompleteSessionToken класс

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

Чтобы получить доступ, позвоните по номеру const {AutocompleteSessionToken} = await google.maps.importLibrary("places").
Подробнее о библиотеках Maps JavaScript API…
AutocompleteSessionToken
AutocompleteSessionToken()
Параметры: нет.
Создает новый экземпляр класса AutocompleteSessionToken.

Класс PlacePrediction

google.maps.places.PlacePrediction класс

Результаты подсказок автозаполнения мест.

Чтобы получить доступ, позвоните по номеру const {PlacePrediction} = await google.maps.importLibrary("places").
Подробнее о библиотеках Maps JavaScript API…
distanceMeters
Тип:  number optional
Длина геодезической линии в метрах от origin, если указано origin.
mainText
Тип:  FormattableText optional
Название места.
placeId
Тип:  string
Уникальный идентификатор предложенного места. Этот идентификатор можно использовать в других API, которые принимают идентификаторы мест.
secondaryText
Тип:  FormattableText optional
Представляет дополнительные уточняющие характеристики (например, город или регион) для дальнейшей идентификации места.
text
Тип:  FormattableText
Содержит человекочитаемое название возвращенного результата. Для заведений это обычно название и адрес.

text рекомендуется разработчикам, которые хотят показывать один элемент интерфейса. Если вы хотите показать два отдельных, но связанных элемента интерфейса, используйте PlacePrediction.mainText и PlacePrediction.secondaryText.
types
Тип:  Array<string>
Список типов, которые применяются к этому месту из таблицы A или таблицы B на странице https://developers.google.com/maps/documentation/places/web-service/place-types.
BetafetchAddressValidation
fetchAddressValidation(request)
Параметры: 
Возвращаемое значение:  Promise<AddressValidation>
Отправляет запрос Address Validation, связанный с этим сеансом автозаполнения (внутренне заполняя запрос токеном сеанса автозаполнения). Информация о месте из PlacePrediction не включается автоматически. Это удобный метод, помогающий управлять сеансами автозаполнения.
toPlace
toPlace()
Параметры: нет.
Возвращаемое значение:  Place
Возвращает представление Place этого объекта PlacePrediction. Чтобы получить полную информацию о месте, необходимо выполнить последующий вызов Place.fetchFields.

Если в объекте AutocompleteRequest, который использовался для получения этого объекта PlacePrediction, был указан токен AutocompleteRequest.sessionToken, то при вызове fetchFields будет автоматически включен тот же токен.

Если вы используете PlaceAutocompleteElement, токен сеанса будет автоматически включен в первый вызов Place.fetchFields для объекта Place, возвращенного методом PlacePrediction.toPlace.

Класс StringRange

google.maps.places.StringRange класс

Определяет подстроку в заданном тексте.

Чтобы получить доступ, позвоните по номеру const {StringRange} = await google.maps.importLibrary("places").
Подробнее о библиотеках Maps JavaScript API…
endOffset
Тип:  number
Смещение последнего символа Unicode в подстроке (не включительно). Нумерация начинается с нуля.
startOffset
Тип:  number
Смещение первого символа Unicode в подстроке (включительно) относительно нуля.

Класс FormattableText

google.maps.places.FormattableText класс

Текст, представляющий подсказку места. Текст можно использовать как есть или отформатировать.

Чтобы получить доступ, позвоните по номеру const {FormattableText} = await google.maps.importLibrary("places").
Подробнее о библиотеках Maps JavaScript API…
matches
Тип:  Array<StringRange>
Список диапазонов строк, определяющих, где входной запрос совпал с FormattableText.text. Диапазоны можно использовать для форматирования определенных частей text. Подстроки могут не совпадать с AutocompleteRequest.input, если совпадение было определено по критериям, отличным от совпадения строк (например, исправление орфографии или транслитерация). Эти значения представляют собой смещения символов Юникода для FormattableText.text. Диапазоны гарантированно упорядочены по возрастанию значений смещения.
text
Тип:  string
Текст, который можно использовать как есть или отформатировать с помощью FormattableText.matches.