Method: places.searchText

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

HTTP-запрос

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

URL имеет синтаксис gRPC Transcoding.

Тело запроса

Ниже приведена структура данных в теле запроса.

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,
  "includeFutureOpeningBusinesses": boolean
}
Поля
textQuery

string

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

languageCode

string

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

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

regionCode

string

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

Дополнительную информацию можно найти на странице 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. Отрицательные значения возвращают ошибку INVALID_ARGUMENT.

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

pageSize

integer

Необязательное поле. Максимальное количество результатов на странице, которое может быть возвращено. Если количество доступных результатов больше pageSize, возвращается nextPageToken, который можно передать в pageToken, чтобы получить следующую страницу результатов в последующих запросах. Если указано значение 0 или значение не указано, по умолчанию используется 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)

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

locationRestriction

object (LocationRestriction)

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

evOptions

object (EVOptions)

Необязательное поле. Задайте параметры поиска станций зарядки электромобилей.

routingParameters

object (RoutingParameters)

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

searchAlongRouteParameters

object (SearchAlongRouteParameters)

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

includePureServiceAreaBusinesses

boolean

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

includeFutureOpeningBusinesses

boolean

Необязательное поле. Если задано значение true, в результаты включаются компании, которые ещё не открылись, но откроются в будущем.

Тело ответа

Протокол ответа для 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.

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

nextPageToken

string

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

searchUri

string

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

Области авторизации

Требует одной из следующих областей применения OAuth:

  • https://www.googleapis.com/auth/maps-platform.places.textsearch
  • https://www.googleapis.com/auth/maps-platform.places
  • https://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 (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of mutually exclusive fields.
}
Поля
Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
rectangle

object (Viewport)

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

circle

object (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 (Viewport)
  }
  // End of mutually exclusive fields.
}
Поля
Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
rectangle

object (Viewport)

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

Конец взаимоисключающих полей.

EVOptions

Параметры поиска ЭМ в запросе на поиск мест.

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

number

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

connectorTypes[]

enum (EVConnectorType)

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

SearchAlongRouteParameters

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

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

JSON-представление
{
  "polyline": {
    object (Polyline)
  }
}
Поля
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

string

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

Конец взаимоисключающих полей.

ContextualContent

Контент, соответствующий запросу о месте.

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

object (Review)

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

photos[]

object (Photo)

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

justifications[]

object (Justification)

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

Ваши аргументы

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

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": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of mutually exclusive fields.
}
Поля
Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
reviewJustification

object (ReviewJustification)

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Конец взаимоисключающих полей.

ReviewJustification

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

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

object (HighlightedText)

review

object (Review)

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

HighlightedText

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

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

string

highlightedTextRanges[]

object (HighlightedTextRange)

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

HighlightedTextRange

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

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

integer

endIndex

integer

BusinessAvailabilityAttributesJustification

Обоснования BusinessAvailabilityAttributes. Здесь показаны некоторые атрибуты компании, которые могут заинтересовать конечного пользователя.

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

boolean

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

delivery

boolean

Есть ли доставка.

dineIn

boolean

Можно ли поесть в самом ресторане.