- HTTP-запрос
- Тело запроса
- Тело ответа
- Предвзятость местоположения
- Ограничение местоположения
- Предположение
- МестоПредсказание
- Форматтаблетекст
- StringRange
- Структурированныйформат
- ЗапросПрогнозирование
Возвращает прогнозы для заданных входных данных.
HTTP-запрос
POST https://places.googleapis.com/v1/places:autocomplete
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "input": string, "locationBias": { object ( |
Поля | |
---|---|
input | Необходимый. Текстовая строка, по которой осуществляется поиск. |
location Bias | Необязательный. Смещение результатов в указанное место. Должен быть установлен не более одного из |
location Restriction | Необязательный. Ограничить результаты указанным местоположением. Должен быть установлен не более одного из |
included Primary Types[] | Необязательный. Включен основной тип места (например, «ресторан» или «заправочная станция») в типы мест ( https://developers.google.com/maps/documentation/places/web-service/place-types) или только |
included Region Codes[] | Необязательный. Включайте результаты только в указанных регионах, указанных в виде до 15 двухсимвольных кодов регионов CLDR. Пустой набор не будет ограничивать результаты. Если установлены оба |
language Code | Необязательный. Язык, на котором возвращаются результаты. По умолчанию — en-US. Результаты могут быть на смешанных языках, если язык, используемый во |
region Code | Необязательный. Код региона в виде двухсимвольного кода региона CLDR. Это влияет на форматирование адреса, ранжирование результатов и может влиять на возвращаемые результаты. Это не ограничивает результаты указанным регионом. Чтобы ограничить результаты регионом, используйте |
origin | Необязательный. Исходная точка, от которой рассчитывается геодезическое расстояние до пункта назначения (возвращается как |
input Offset | Необязательный. Смещение символов Юникода для Если пусто, по умолчанию используется длина |
include Query Predictions | Необязательный. Если это правда, ответ будет включать в себя как прогнозы места, так и запроса. В противном случае ответ вернет только прогнозы мест. |
session Token | Необязательный. Строка, которая идентифицирует сеанс автозаполнения для целей выставления счетов. Должна быть строкой в формате Base64, безопасной для URL и имени файла, длиной не более 36 символов ASCII. В противном случае возвращается ошибка INVALID_ARGUMENT. Сеанс начинается, когда пользователь начинает вводить запрос, и завершается, когда он выбирает место и выполняет вызов функции Place Details или проверки адреса. В каждом сеансе может быть несколько запросов, за которыми следует один запрос на информацию о месте или проверку адреса. Учетные данные, используемые для каждого запроса в рамках сеанса, должны принадлежать одному и тому же проекту Google Cloud Console. После завершения сеанса токен больше не действителен; ваше приложение должно генерировать новый токен для каждого сеанса. Если параметр Мы рекомендуем следующие рекомендации:
|
include Pure Service Area Businesses | Необязательный. Включите компании, работающие исключительно в зоне обслуживания, если для поля установлено значение true. Бизнес с чистой зоной обслуживания — это бизнес, который посещает клиентов или доставляет их напрямую, но не обслуживает клиентов по их служебному адресу. Например, такие предприятия, как клининговые услуги или сантехника. У этих компаний нет физического адреса или местоположения на Картах Google. Места не будут возвращать поля, включая |
Тело ответа
Прототип ответа для Places.autocomplete.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"suggestions": [
{
object ( |
Поля | |
---|---|
suggestions[] | Содержит список предложений, упорядоченных по убыванию релевантности. |
Предвзятость местоположения
Регион для поиска. Результаты могут быть смещены в зависимости от указанного региона.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
rectangle | Окно просмотра определяется северо-восточным и юго-западным углами. |
circle | Круг, определяемый центральной точкой и радиусом. |
Ограничение местоположения
Регион для поиска. Результаты будут ограничены указанным регионом.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
rectangle | Окно просмотра определяется северо-восточным и юго-западным углами. |
circle | Круг, определяемый центральной точкой и радиусом. |
Предположение
Результат автозаполнения.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
place Prediction | Предсказание для места. |
query Prediction | Прогноз для запроса. |
МестоПредсказание
Результаты прогнозирования для подсказки автозаполнения места.
JSON-представление |
---|
{ "place": string, "placeId": string, "text": { object ( |
Поля | |
---|---|
place | Имя ресурса предлагаемого места. Это имя можно использовать в других API, которые принимают названия мест. |
place Id | Уникальный идентификатор предлагаемого места. Этот идентификатор можно использовать в других API, которые принимают идентификаторы мест. |
text | Содержит удобочитаемое имя возвращаемого результата. Для результатов учреждения это обычно название компании и адрес. Этот текст может отличаться от Может быть на смешанных языках, если |
structured Format | Разбивка прогноза места на основной текст, содержащий название места, и вторичный текст, содержащий дополнительные характеристики, устраняющие неоднозначность (например, город или регион). |
types[] | Список типов, применимых к этому месту, из таблицы A или таблицы B в https://developers.google.com/maps/documentation/places/web-service/place-types . Тип — это категоризация Места. Места с общими типами будут иметь схожие характеристики. |
distance Meters | Длина геодезической в метрах от |
Форматтаблетекст
Текст, представляющий подсказку места или запроса. Текст можно использовать как есть или отформатировать.
JSON-представление |
---|
{
"text": string,
"matches": [
{
object ( |
Поля | |
---|---|
text | Текст, который можно использовать как есть или отформатировать с |
matches[] | Список диапазонов строк, определяющих совпадение входного запроса в Эти значения представляют собой смещения символов Юникода в |
StringRange
Идентифицирует подстроку в данном тексте.
JSON-представление |
---|
{ "startOffset": integer, "endOffset": integer } |
Поля | |
---|---|
start Offset | Смещение первого символа Юникода строки (включительно), отсчитываемое от нуля. |
end Offset | Смещение последнего символа Юникода с отсчетом от нуля (исключающее). |
Структурированныйформат
Содержит разбивку подсказки места или запроса на основной и дополнительный текст.
Для подсказок мест основной текст содержит конкретное название места. Для прогнозов запроса основной текст содержит запрос.
Вторичный текст содержит дополнительные функции, устраняющие неоднозначность (например, город или регион), позволяющие дополнительно идентифицировать место или уточнить запрос.
JSON-представление |
---|
{ "mainText": { object ( |
Поля | |
---|---|
main Text | Представляет имя места или запроса. |
secondary Text | Представляет дополнительные функции, устраняющие неоднозначность (например, город или регион) для дальнейшей идентификации места или уточнения запроса. |
ЗапросПрогнозирование
Результаты прогнозирования для прогноза автозаполнения запроса.
JSON-представление |
---|
{ "text": { object ( |
Поля | |
---|---|
text | Предсказанный текст. Этот текст представляет собой не место, а текстовый запрос, который можно использовать в конечной точке поиска (например, текстовый поиск). Может быть на смешанных языках, если |
structured Format | Разбивка прогноза запроса на основной текст, содержащий запрос, и дополнительный текст, содержащий дополнительные признаки, устраняющие неоднозначность (например, город или регион). |