Method: places.searchText

Поиск места на основе текстового запроса.

HTTP-запрос

POST https://places.googleapis.com/v1/places:searchText

URL-адрес использует синтаксис транскодирования gRPC .

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean
}
Поля
text Query

string

Необходимый. Текстовый запрос для текстового поиска.

language Code

string

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

Текущий список поддерживаемых языков: https://developers.google.com/maps/faq#languagesupport .

region Code

string

Код страны/региона Unicode (CLDR) места, откуда поступает запрос. Этот параметр используется для отображения сведений о месте, например названия места для конкретного региона, если оно доступно. Параметр может повлиять на результаты в соответствии с действующим законодательством.

Для получения дополнительной информации см. https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html .

Обратите внимание, что трехзначные коды регионов в настоящее время не поддерживаются.

rank Preference

enum ( RankPreference )

Как результаты будут ранжироваться в ответе.

included Type

string

Запрошенный тип места. Полный список поддерживаемых типов: https://developers.google.com/maps/documentation/places/web-service/place-types . Поддерживается только один включенный тип.

open Now

boolean

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

min Rating

number

Отфильтровывайте результаты, средний рейтинг пользователей которых строго меньше этого предела. Допустимое значение должно быть числом с плавающей запятой от 0 до 5 (включительно) с частотой 0,5, т. е. [0, 0,5, 1,0, ..., 5,0] включительно. Входной рейтинг округляется до ближайших 0,5 (потолок). Например, рейтинг 0,6 исключит все результаты с рейтингом менее 1,0.

maxResultCount
(deprecated)

integer

Устарело: вместо этого используйте pageSize .

Максимальное количество результатов на странице, которое может быть возвращено. Если количество доступных результатов больше, чем maxResultCount , возвращается nextPageToken , который можно передать в pageToken чтобы получить следующую страницу результатов в последующих запросах. Если указано 0 или значение отсутствует, используется значение по умолчанию 20. Максимальное значение — 20; значения выше 20 будут приведены к 20. Отрицательные значения вернут ошибку INVALID_ARGUMENT.

Если указаны и maxResultCount , и pageSize , maxResultCount будет игнорироваться.

page Size

integer

Необязательный. Максимальное количество результатов на странице, которое может быть возвращено. Если количество доступных результатов больше, чем pageSize , возвращается nextPageToken , который можно передать в pageToken чтобы получить следующую страницу результатов в последующих запросах. Если указано 0 или значение отсутствует, используется значение по умолчанию 20. Максимальное значение — 20; значения выше 20 будут установлены на 20. Отрицательные значения вернут ошибку INVALID_ARGUMENT.

Если указаны и maxResultCount , и pageSize , maxResultCount будет игнорироваться.

page Token

string

Необязательный. Токен страницы, полученный в результате предыдущего вызова TextSearch. Предоставьте это, чтобы получить следующую страницу.

При разбиении на страницы все параметры, кроме pageToken , pageSize и maxResultCount , предоставленные TextSearch, должны соответствовать начальному вызову, который предоставил токен страницы. В противном случае возвращается ошибка INVALID_ARGUMENT.

price Levels[]

enum ( PriceLevel )

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

strict Type Filtering

boolean

Используется для установки строгой фильтрации типов для includeType. Если установлено значение true, будут возвращены только результаты одного типа. По умолчанию — ложь.

location Bias

object ( LocationBias )

Регион для поиска. Это местоположение служит предвзятостью, что означает, что могут быть возвращены результаты вокруг данного местоположения. Невозможно установить вместе с locationRestriction.

location Restriction

object ( LocationRestriction )

Регион для поиска. Это местоположение служит ограничением, которое означает, что результаты за пределами данного местоположения не будут возвращены. Невозможно установить вместе с locationBias.

ev Options

object ( EVOptions )

Необязательный. Установите доступные для поиска параметры EV запроса на поиск места.

routing Parameters

object ( RoutingParameters )

Необязательный. Дополнительные параметры для маршрутизации к результатам.

search Along Route Parameters

object ( SearchAlongRouteParameters )

Необязательный. Прото дополнительных параметров для поиска по маршруту.

include Pure Service Area Businesses

boolean

Необязательный. Включите компании, работающие исключительно в зоне обслуживания, если для поля установлено значение true. Бизнес с чистой зоной обслуживания — это бизнес, который посещает клиентов или доставляет их напрямую, но не обслуживает клиентов по их служебному адресу. Например, такие предприятия, как клининговые услуги или сантехника. У этих компаний нет физического адреса или местоположения на Картах Google. Места не будут возвращать поля, включая location , plusCode и другие поля, связанные с местоположением, для этих компаний.

Тело ответа

Прототип ответа для Places.searchText.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string,
  "searchUri": string
}
Поля
places[]

object ( Place )

Список мест, соответствующих критериям текстового поиска пользователя.

routing Summaries[]

object ( RoutingSummary )

Список сводок маршрутизации, в котором каждая запись связана с соответствующим местом в том же индексе в поле places . Если сводка маршрутизации недоступна для одного из мест, она будет содержать пустую запись. По запросу этот список будет содержать столько же записей, сколько и список мест.

contextual Contents[]

object ( ContextualContent )

Экспериментальный вариант: дополнительную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

Список контекстного содержимого, в котором каждая запись связана с соответствующим местом в том же индексе в поле мест. Предпочтительным является содержимое, соответствующее textQuery в запросе. Если контекстный контент недоступен для одного из мест, он вернет неконтекстный контент. Оно будет пустым только в том случае, если контент для этого места недоступен. По запросу этот список будет содержать столько же записей, сколько и список мест.

next Page Token

string

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле опущено или пусто, последующие страницы отсутствуют.

search Uri

string

Ссылка позволяет пользователю осуществлять поиск по тому же текстовому запросу, который указан в запросе на Картах Google.

РангПредпочтение

Как результаты будут ранжироваться в ответе.

Перечисления
RANK_PREFERENCE_UNSPECIFIED Для категориального запроса, такого как «Рестораны в Нью-Йорке», значением по умолчанию является РЕЛЕВАНТНОСТЬ. Для некатегорийных запросов, таких как «Маунтин-Вью, Калифорния», мы рекомендуем оставить RankPreference неустановленным.
DISTANCE Ранжирует результаты по расстоянию.
RELEVANCE Ранжирует результаты по релевантности. Порядок сортировки определяется обычным стеком ранжирования.

Предвзятость местоположения

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

JSON-представление 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Поля

type поля объединения.

type может быть только одним из следующих:

rectangle

object ( Viewport )

Прямоугольный блок, определяемый северо-восточным и юго-западным углами. rectangle.high() должен быть северо-восточной точкой области просмотра прямоугольника. rectangle.low() должен быть юго-западной точкой области просмотра прямоугольника. rectangle.low().latitude() не может быть больше rectangle.high().latitude() . Это приведет к появлению пустого диапазона широт. Прямоугольное окно просмотра не может быть шире 180 градусов.

circle

object ( Circle )

Круг, определяемый центральной точкой и радиусом.

Ограничение местоположения

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

JSON-представление 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Поля

type поля объединения.

type может быть только одним из следующих:

rectangle

object ( Viewport )

Прямоугольный блок, определяемый северо-восточным и юго-западным углами. rectangle.high() должен быть северо-восточной точкой области просмотра прямоугольника. rectangle.low() должен быть юго-западной точкой области просмотра прямоугольника. rectangle.low().latitude() не может быть больше rectangle.high().latitude() . Это приведет к появлению пустого диапазона широт. Прямоугольное окно просмотра не может быть шире 180 градусов.

EVOptions

Доступные для поиска параметры EV запроса на поиск места.

JSON-представление 
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
Поля
minimum Charging Rate Kw

number

Необязательный. Минимальная необходимая мощность зарядки в киловаттах. Место, в котором тариф начисления меньше указанного, отфильтровывается.

connector Types[]

enum ( EVConnectorType )

Необязательный. Список предпочтительных типов разъемов EV. Место, не поддерживающее ни один из перечисленных типов разъемов, отфильтровывается.

Параметры поиска вдоль маршрута

Указывает предварительно рассчитанную полилинию из API маршрутов, определяющую маршрут для поиска. Поиск по маршруту аналогичен использованию параметра запроса locationBias или locationRestriction для смещения результатов поиска. Однако, хотя параметры locationBias и locationRestriction позволяют указать регион для смещения результатов поиска, этот параметр позволяет смещать результаты по маршруту поездки.

Результаты не гарантированно находятся вдоль предоставленного маршрута, а скорее ранжируются в области поиска, определенной ломаной линией и, при необходимости, locationBias или locationRestriction на основе минимального времени объезда от источника до пункта назначения. Результаты могут быть по альтернативному маршруту, особенно если предоставленная ломаная линия не определяет оптимальный маршрут от источника к пункту назначения.

JSON-представление 
{
  "polyline": {
    object (Polyline)
  }
}
Поля
polyline

object ( Polyline )

Необходимый. Полилиния маршрута.

Полилиния

Полилиния маршрута. Поддерживается только закодированная полилиния , которую можно передать как строку и которая включает сжатие с минимальными потерями. Это вывод API Routes по умолчанию.

JSON-представление 
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
Поля
Поле объединения polyline_type . Инкапсулирует тип полилинии. Выходные данные Routes API по умолчанию имеют значение encoded_polyline . polyline_type может быть только одним из следующих:
encoded Polyline

string

Закодированная ломаная линия , возвращаемая API маршрутов по умолчанию . См. инструменты кодирования и декодера .

Контекстное содержание

Экспериментальный вариант: дополнительную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

Контент, контекстуальный запросу места.

JSON-представление 
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
Поля
reviews[]

object ( Review )

Список отзывов об этом месте, соответствующих запросу места.

photos[]

object ( Photo )

Информация (включая ссылки) о фотографиях этого места, связанных с запросом места.

justifications[]

object ( Justification )

Экспериментальный вариант: дополнительные сведения см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

Обоснование места.

Обоснование

Экспериментальный вариант: дополнительные сведения см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

Обоснование места. Обоснования отвечают на вопрос, почему место может заинтересовать конечного пользователя.

JSON-представление 
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
Поля

justification поля объединения.

justification может быть только одним из следующих:

review Justification

object ( ReviewJustification )

Экспериментальный вариант: дополнительную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

business Availability Attributes Justification

object ( BusinessAvailabilityAttributesJustification )

Экспериментальный вариант: дополнительную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

ОбзорОбоснование

Экспериментальный вариант: дополнительную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative .

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

JSON-представление 
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
Поля
highlighted Text

object ( HighlightedText )

review

object ( Review )

Обзор, на основе которого создан выделенный текст.

Выделенный текст

Текст, выделенный по обоснованию. Это часть самого обзора. Точное слово, которое нужно выделить, отмечено HighlightedTextRange. В выделенном тексте может быть несколько слов.

JSON-представление 
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
Поля
text

string

highlighted Text Ranges[]

object ( HighlightedTextRange )

Список диапазонов выделенного текста.

Выделенныйтекстовыйдиапазон

Диапазон выделенного текста.

JSON-представление 
{
  "startIndex": integer,
  "endIndex": integer
}
Поля
start Index

integer

end Index

integer

БизнесДоступностьАтрибутыОбоснование

Экспериментальный вариант: дополнительную информацию см. на странице https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative . Обоснования BusinessAvailabilityAttributes. Это показывает некоторые атрибуты бизнеса, которые могут заинтересовать конечного пользователя.

JSON-представление 
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
Поля
takeout

boolean

Если место предлагает еду на вынос.

delivery

boolean

Если место обеспечивает доставку.

dine In

boolean

Если место предоставляет возможность пообедать.