Поиск мест рядом с локациями.
HTTP-запрос
POST https://places.googleapis.com/v1/places:searchNearby
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "languageCode": string, "regionCode": string, "includedTypes": [ string ], "excludedTypes": [ string ], "includedPrimaryTypes": [ string ], "excludedPrimaryTypes": [ string ], "maxResultCount": integer, "locationRestriction": { object ( |
Поля | |
---|---|
language Code | Информация о месте будет отображаться на предпочитаемом языке, если он доступен. Если код языка не указан или не распознан, могут быть возвращены сведения о месте на любом языке, причем предпочтение отдается английскому, если такие сведения существуют. Текущий список поддерживаемых языков: https://developers.google.com/maps/faq#languagesupport . |
region Code | Код страны/региона Unicode (CLDR) места, откуда поступает запрос. Этот параметр используется для отображения сведений о месте, например названия места для конкретного региона, если оно доступно. Параметр может повлиять на результаты в соответствии с действующим законодательством. Для получения дополнительной информации см. https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html . Обратите внимание, что трехзначные коды регионов в настоящее время не поддерживаются. |
included Types[] | Включен тип места (например, «ресторан» или «заправочная станция») из https://developers.google.com/maps/documentation/places/web-service/place-types . Можно указать до 50 типов из Таблицы А. Если есть какие-либо конфликтующие типы, т. е. тип появляется как в включенных типах, так и в исключенных типах, возвращается ошибка INVALID_ARGUMENT. Если тип места указан с несколькими ограничениями типа, возвращаются только места, удовлетворяющие всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], ExcludedPrimaryTypes = ["restaurant"]}, возвращаемые места предоставляют услуги, связанные с "рестораном", но не работают в основном как "рестораны". |
excluded Types[] | Исключен тип места (например, «ресторан» или «заправочная станция») из https://developers.google.com/maps/documentation/places/web-service/place-types . Можно указать до 50 типов из Таблицы А. Если клиент предоставляет как включенные типы (например, ресторан), так и исключенные типы (например, кафе), тогда ответ должен включать места, которые являются ресторанами, но не кафе. Ответ включает места, соответствующие хотя бы одному из включенных типов и ни одному из исключенных типов. Если есть какие-либо конфликтующие типы, т. е. тип появляется как в включенных типах, так и в исключенных типах, возвращается ошибка INVALID_ARGUMENT. Если тип места указан с несколькими ограничениями типа, возвращаются только места, удовлетворяющие всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], ExcludedPrimaryTypes = ["restaurant"]}, возвращаемые места предоставляют услуги, связанные с "рестораном", но не работают в основном как "рестораны". |
included Primary Types[] | Включен основной тип места (например, «ресторан» или «заправочная станция») из https://developers.google.com/maps/documentation/places/web-service/place-types . Место может иметь только один основной тип из связанной с ним таблицы поддерживаемых типов. Можно указать до 50 типов из Таблицы А. Если существуют какие-либо конфликтующие первичные типы, т. е. тип присутствует как в includePrimaryTypes, так и в ExcludedPrimaryTypes, возвращается ошибка INVALID_ARGUMENT. Если тип места указан с несколькими ограничениями типа, возвращаются только места, удовлетворяющие всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], ExcludedPrimaryTypes = ["restaurant"]}, возвращаемые места предоставляют услуги, связанные с "рестораном", но не работают в основном как "рестораны". |
excluded Primary Types[] | Исключен основной тип места (например, «ресторан» или «заправочная станция») из https://developers.google.com/maps/documentation/places/web-service/place-types . Можно указать до 50 типов из Таблицы А. Если есть какие-либо конфликтующие первичные типы, т. е. тип появляется как в includePrimaryTypes, так и в ExcludedPrimaryTypes, возвращается ошибка INVALID_ARGUMENT. Если тип места указан с несколькими ограничениями типа, возвращаются только места, удовлетворяющие всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], ExcludedPrimaryTypes = ["restaurant"]}, возвращаемые места предоставляют услуги, связанные с "рестораном", но не работают в основном как "рестораны". |
max Result Count | Максимальное количество возвращаемых результатов. Оно должно быть от 1 до 20 (по умолчанию) включительно. Если число не установлено, оно возвращается к верхнему пределу. Если число установлено отрицательным или превышает верхний предел, возвращается ошибка INVALID_ARGUMENT. |
location Restriction | Необходимый. Регион для поиска. |
rank Preference | Как результаты будут ранжироваться в ответе. |
routing Parameters | Необязательный. Параметры, влияющие на маршрутизацию к результатам поиска. |
Тело ответа
Прототип ответа на запрос «Поиск поблизости».
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{ "places": [ { object ( |
Поля | |
---|---|
places[] | Список мест, отвечающий требованиям пользователя, таким как типы мест, количество мест и ограничения по конкретному местоположению. |
routing Summaries[] | Список сводок маршрутизации, в котором каждая запись связана с соответствующим местом в том же индексе в поле |
Ограничение местоположения
Регион для поиска.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
circle | Круг, определяемый центральной точкой и радиусом. |
РангПредпочтение
Как результаты будут ранжироваться в ответе.
Перечисления | |
---|---|
RANK_PREFERENCE_UNSPECIFIED | Значение RankPreference не установлено. По умолчанию будет использоваться рейтинг по ПОПУЛЯРНОСТИ. |
DISTANCE | Ранжирует результаты по расстоянию. |
POPULARITY | Ранжирует результаты по популярности. |