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
}
Поля
textQuery

string

Обязательно. Текстовый запрос для текстового поиска.

languageCode

string

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

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

regionCode

string

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

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

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

rankPreference

enum ( RankPreference )

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

includedType

string

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

openNow

boolean

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

minRating

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 будет проигнорировано.

pageSize

integer

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

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

pageToken

string

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

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

priceLevels[]

enum ( PriceLevel )

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

strictTypeFiltering

boolean

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

locationBias

object ( LocationBias )

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

locationRestriction

object ( LocationRestriction )

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

evOptions

object ( EVOptions )

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

routingParameters

object ( RoutingParameters )

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

searchAlongRouteParameters

object ( SearchAlongRouteParameters )

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

includePureServiceAreaBusinesses

boolean

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

Ответный текст

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

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

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

object ( Place )

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

routingSummaries[]

object ( RoutingSummary )

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

contextualContents[]

object ( ContextualContent )

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

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

nextPageToken

string

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

searchUri

string

Ссылка позволяет пользователю выполнить поиск в Google Maps с использованием того же текстового запроса, что и в исходном запросе.

Области полномочий

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform

RankPreference

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

Перечисления
RANK_PREFERENCE_UNSPECIFIED Для категориальных запросов, таких как "Рестораны в Нью-Йорке", значение RELEVANCE является значением по умолчанию. Для некатегориальных запросов, таких как "Маунтин-Вью, Калифорния", мы рекомендуем не задавать параметр rankPreference.
DISTANCE Результаты ранжируются по расстоянию.
RELEVANCE Результаты ранжируются по релевантности. Порядок сортировки определяется стандартным алгоритмом ранжирования.

LocationBias

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

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)
  ]
}
Поля
minimumChargingRateKw

number

Необязательно. Минимально необходимая скорость зарядки в киловаттах. Места со скоростью зарядки ниже указанной отфильтровываются.

connectorTypes[]

enum ( EVConnectorType )

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

SearchAlongRouteParameters

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

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

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

object ( Polyline )

Обязательно. Полилиния маршрута.

Полилиния

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

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 . Указывает тип полилинии. По умолчанию для вывода API маршрутов используется значение encoded_polyline . polyline_type может принимать только одно из следующих значений:
encodedPolyline

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 может быть только одним из следующих:

reviewJustification

object ( ReviewJustification )

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

businessAvailabilityAttributesJustification

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)
  }
}
Поля
highlightedText

object ( HighlightedText )

review

object ( Review )

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

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

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

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

string

highlightedTextRanges[]

object ( HighlightedTextRange )

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

HighlightedTextRange

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

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

integer

endIndex

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

Если в заведении есть служба доставки.

dineIn

boolean

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