- HTTP-запрос
- Тело запроса
- Тело ответа
- Области авторизации
- RankPreference
- LocationBias
- LocationRestriction
- EVOptions
- SearchAlongRouteParameters
- Polyline
- ContextualContent
- Обоснование
- ReviewJustification
- HighlightedText
- HighlightedTextRange
- BusinessAvailabilityAttributesJustification
Поиск мест по текстовому запросу.
HTTP-запрос
POST https://places.googleapis.com/v1/places:searchText
URL имеет синтаксис gRPC Transcoding.
Тело запроса
Ниже приведена структура данных в теле запроса.
| JSON-представление |
|---|
{ "textQuery": string, "languageCode": string, "regionCode": string, "rankPreference": enum ( |
| Поля | |
|---|---|
textQuery |
Обязательно. Текстовый запрос для текстового поиска. |
languageCode |
Информация о месте будет показана на предпочитаемом языке, если он доступен. Если код языка не указан или не распознан, может быть возвращена информация о месте на любом языке, предпочтительно на английском, если она доступна. Список поддерживаемых языков: https://developers.google.com/maps/faq#languagesupport. |
regionCode |
Код страны или региона (CLDR) в формате Unicode, откуда поступает запрос. Этот параметр используется для отображения информации о месте, например названия места в определенном регионе, если оно доступно. Параметр может влиять на результаты в соответствии с действующим законодательством. Дополнительную информацию можно найти на странице https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Обратите внимание, что трехзначные коды регионов в настоящее время не поддерживаются. |
rankPreference |
Как результаты будут ранжироваться в ответе. |
includedType |
Тип места, указанный в запросе. Полный список поддерживаемых типов: https://developers.google.com/maps/documentation/places/web-service/place-types. Поддерживается только один включенный тип. |
openNow |
Используется для ограничения поиска местами, которые открыты в текущий момент. По умолчанию присваивается значение false. |
minRating |
Фильтровать результаты, средняя оценка которых строго меньше этого ограничения. Допустимое значение должно быть числом с плавающей запятой от 0 до 5 (включительно) с шагом 0,5, то есть [0, 0,5, 1,0, ... , 5,0] включительно. Введенная оценка будет округлена до ближайшего значения, кратного 0,5. Например, если вы укажете оценку 0,6, то будут исключены все результаты с оценкой ниже 1,0. |
maxResultCount |
Устарело. Используйте вместо него Максимальное количество результатов на странице, которое может быть возвращено. Если количество доступных результатов больше, чем Если указаны оба параметра ( |
pageSize |
Необязательное поле. Максимальное количество результатов на странице, которое может быть возвращено. Если количество доступных результатов больше Если указаны оба параметра ( |
pageToken |
Необязательное поле. Токен страницы, полученный из предыдущего вызова TextSearch. Укажите его, чтобы получить следующую страницу. При разбиении на страницы все параметры, кроме |
priceLevels[] |
Используется для ограничения поиска местами, которые отмечены как имеющие определенный уровень цен. Пользователи могут выбрать любую комбинацию ценовых уровней. По умолчанию выбраны все уровни цен. |
strictTypeFiltering |
Используется для настройки строгой фильтрации по типу для includedType. Если задано значение True, будут возвращены только результаты того же типа. Значение по умолчанию – false. |
locationBias |
Регион, в котором выполняется поиск. Это местоположение служит смещением, то есть могут быть возвращены результаты, относящиеся к указанному местоположению. Нельзя использовать вместе с locationRestriction. |
locationRestriction |
Регион, в котором выполняется поиск. Это местоположение служит ограничением, то есть результаты за пределами указанного местоположения возвращаться не будут. Нельзя использовать вместе с locationBias. |
evOptions |
Необязательное поле. Задайте параметры поиска станций зарядки электромобилей. |
routingParameters |
Необязательное поле. Дополнительные параметры для маршрутизации к результатам. |
searchAlongRouteParameters |
Необязательное поле. Протокол дополнительных параметров для поиска вдоль маршрута. |
includePureServiceAreaBusinesses |
Необязательное поле. Если для поля задано значение true, включить компании, обслуживающие только определенную территорию. Компания, обслуживающая определенную территорию, осуществляет услуги и доставку непосредственно клиентам, но не обслуживает клиентов по адресу компании. Примеры: компании, предлагающие уборку помещений, ремонт сантехники и т. п. У таких компаний нет физического адреса или местоположения на Google Картах. Places не будет возвращать поля, включая |
includeFutureOpeningBusinesses |
Необязательное поле. Если задано значение true, в результаты включаются компании, которые ещё не открылись, но откроются в будущем. |
Тело ответа
Протокол ответа для places.searchText.
Ниже приведена структура данных в ответе, полученном на запрос.
| JSON-представление |
|---|
{ "places": [ { object ( |
| Поля | |
|---|---|
places[] |
Список мест, соответствующих критериям текстового поиска пользователя. |
routingSummaries[] |
Список сводок маршрутов, в котором каждая запись связана с соответствующим местом в том же индексе в поле |
contextualContents[] |
Экспериментальная функция. Подробнее: https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. Список контекстных материалов, в котором каждая запись связана с соответствующим местом в том же индексе в поле мест. Предпочтение отдается контенту, который соответствует значению |
nextPageToken |
Токен, который можно отправить как |
searchUri |
Ссылка позволяет пользователю выполнить поиск в Google Картах с тем же текстовым запросом, который указан в запросе. |
Области авторизации
Требует одной из следующих областей применения OAuth:
https://www.googleapis.com/auth/maps-platform.places.textsearchhttps://www.googleapis.com/auth/maps-platform.placeshttps://www.googleapis.com/auth/cloud-platform
RankPreference
Как результаты будут ранжироваться в ответе.
| Перечисления | |
|---|---|
RANK_PREFERENCE_UNSPECIFIED |
Для запросов по категориям, например "Рестораны в Москве", по умолчанию используется значение RELEVANCE. Для некатегориальных запросов, таких как "Маунтин-Вью, Калифорния", рекомендуем оставить rankPreference незаданным. |
DISTANCE |
Результаты ранжируются по расстоянию. |
RELEVANCE |
Результаты сортируются по релевантности. Порядок сортировки определяется обычным стеком ранжирования. |
LocationBias
Регион, в котором выполняется поиск. Это местоположение служит смещением, то есть могут быть возвращены результаты, относящиеся к указанному местоположению.
| JSON-представление |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "rectangle": { object ( |
| Поля | |
|---|---|
| Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
rectangle |
Прямоугольник, заданный северо-восточным и юго-западным углами. |
circle |
Окружность, определяемая центральной точкой и радиусом. |
| Конец взаимоисключающих полей. | |
LocationRestriction
Регион, в котором выполняется поиск. Это местоположение служит ограничением, то есть результаты за пределами указанного местоположения возвращаться не будут.
| JSON-представление |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"rectangle": {
object ( |
| Поля | |
|---|---|
| Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
rectangle |
Прямоугольник, заданный северо-восточным и юго-западным углами. |
| Конец взаимоисключающих полей. | |
EVOptions
Параметры поиска ЭМ в запросе на поиск мест.
| JSON-представление |
|---|
{
"minimumChargingRateKw": number,
"connectorTypes": [
enum ( |
| Поля | |
|---|---|
minimumChargingRateKw |
Необязательное поле. Минимальная требуемая скорость зарядки в киловаттах. Места, где скорость зарядки ниже указанной, будут отфильтрованы. |
connectorTypes[] |
Необязательное поле. Список предпочитаемых типов коннекторов для электромобилей. Места, которые не поддерживают ни один из перечисленных типов коннекторов, будут отфильтрованы. |
SearchAlongRouteParameters
Указывает предварительно рассчитанную ломаную линию из Routes API, определяющую маршрут для поиска. Поиск вдоль маршрута похож на использование параметра запроса locationBias или locationRestriction для смещения результатов поиска. Однако если параметры locationBias и locationRestriction позволяют указать регион, чтобы уточнить результаты поиска, то этот параметр позволяет уточнить результаты по маршруту поездки.
Результаты не обязательно будут находиться на указанном маршруте. Они ранжируются в области поиска, заданной ломаной линией и, при необходимости, параметрами locationBias или locationRestriction, на основе минимального времени отклонения от маршрута между пунктами отправления и назначения. Результаты могут быть расположены вдоль альтернативного маршрута, особенно если предоставленная ломаная линия не определяет оптимальный маршрут от пункта отправления до пункта назначения.
| JSON-представление |
|---|
{
"polyline": {
object ( |
| Поля | |
|---|---|
polyline |
Обязательно. Ломаная линия маршрута. |
Polyline
Ломаная линия маршрута. Поддерживается только закодированная ломаная линия, которая может передаваться в виде строки и включает сжатие с минимальными потерями. Это выходные данные Routes API по умолчанию.
| JSON-представление |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "encodedPolyline": string // End of mutually exclusive fields. } |
| Поля | |
|---|---|
Инкапсулирует тип ломаной линии. По умолчанию Routes API возвращает encoded_polyline. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: |
|
encodedPolyline |
Закодированная ломаная линия, возвращаемая Routes API по умолчанию. См. инструменты кодирования и декодирования. |
| Конец взаимоисключающих полей. | |
ContextualContent
Контент, соответствующий запросу о месте.
| JSON-представление |
|---|
{ "reviews": [ { object ( |
| Поля | |
|---|---|
reviews[] |
Список отзывов об этом месте, соответствующих запросу. |
photos[] |
Информация (включая ссылки) о фотографиях этого места, контекстуальная для запроса места. |
justifications[] |
Обоснования для места. |
Ваши аргументы
Обоснования для места. Обоснования отвечают на вопрос, почему место может заинтересовать конечного пользователя.
| JSON-представление |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "reviewJustification": { object ( |
| Поля | |
|---|---|
| Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
reviewJustification |
|
businessAvailabilityAttributesJustification |
|
| Конец взаимоисключающих полей. | |
ReviewJustification
Обоснования на основе отзывов пользователей. Это позволяет выделить раздел отзыва, который может заинтересовать конечного пользователя. Например, если поисковый запрос – "пицца на дровах", то в обосновании будет выделен текст, соответствующий этому запросу.
| JSON-представление |
|---|
{ "highlightedText": { object ( |
| Поля | |
|---|---|
highlightedText |
|
review |
Отзыв, на основе которого создан выделенный текст. |
HighlightedText
Текст, выделенный в обосновании. Это подмножество самого отзыва. Точное слово, которое нужно выделить, отмечено HighlightedTextRange. В тексте может быть выделено несколько слов.
| JSON-представление |
|---|
{
"text": string,
"highlightedTextRanges": [
{
object ( |
| Поля | |
|---|---|
text |
|
highlightedTextRanges[] |
Список диапазонов выделенного текста. |
HighlightedTextRange
Диапазон выделенного текста.
| JSON-представление |
|---|
{ "startIndex": integer, "endIndex": integer } |
| Поля | |
|---|---|
startIndex |
|
endIndex |
|
BusinessAvailabilityAttributesJustification
Обоснования BusinessAvailabilityAttributes. Здесь показаны некоторые атрибуты компании, которые могут заинтересовать конечного пользователя.
| JSON-представление |
|---|
{ "takeout": boolean, "delivery": boolean, "dineIn": boolean } |
| Поля | |
|---|---|
takeout |
Можно ли заказать еду навынос. |
delivery |
Есть ли доставка. |
dineIn |
Можно ли поесть в самом ресторане. |