Method: places.searchNearby

Поиск мест рядом с локациями.

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 (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
Поля
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 .

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

included Types[]

string

Включен тип места (например, «ресторан» или «заправочная станция») из https://developers.google.com/maps/documentation/places/web-service/place-types .

Можно указать до 50 типов из Таблицы А.

Если есть какие-либо конфликтующие типы, т. е. тип появляется как в включенных типах, так и в исключенных типах, возвращается ошибка INVALID_ARGUMENT.

Если тип места указан с несколькими ограничениями типа, возвращаются только места, удовлетворяющие всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], ExcludedPrimaryTypes = ["restaurant"]}, возвращаемые места предоставляют услуги, связанные с "рестораном", но не работают в основном как "рестораны".

excluded Types[]

string

Исключен тип места (например, «ресторан» или «заправочная станция») из https://developers.google.com/maps/documentation/places/web-service/place-types .

Можно указать до 50 типов из Таблицы А.

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

Если есть какие-либо конфликтующие типы, т. е. тип появляется как в включенных типах, так и в исключенных типах, возвращается ошибка INVALID_ARGUMENT.

Если тип места указан с несколькими ограничениями типа, возвращаются только места, удовлетворяющие всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], ExcludedPrimaryTypes = ["restaurant"]}, возвращаемые места предоставляют услуги, связанные с "рестораном", но не работают в основном как "рестораны".

included Primary Types[]

string

Включен основной тип места (например, «ресторан» или «заправочная станция») из https://developers.google.com/maps/documentation/places/web-service/place-types . Место может иметь только один основной тип из связанной с ним таблицы поддерживаемых типов.

Можно указать до 50 типов из Таблицы А.

Если существуют какие-либо конфликтующие первичные типы, т. е. тип присутствует как в includePrimaryTypes, так и в ExcludedPrimaryTypes, возвращается ошибка INVALID_ARGUMENT.

Если тип места указан с несколькими ограничениями типа, возвращаются только места, удовлетворяющие всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], ExcludedPrimaryTypes = ["restaurant"]}, возвращаемые места предоставляют услуги, связанные с "рестораном", но не работают в основном как "рестораны".

excluded Primary Types[]

string

Исключен основной тип места (например, «ресторан» или «заправочная станция») из https://developers.google.com/maps/documentation/places/web-service/place-types .

Можно указать до 50 типов из Таблицы А.

Если есть какие-либо конфликтующие первичные типы, т. е. тип появляется как в includePrimaryTypes, так и в ExcludedPrimaryTypes, возвращается ошибка INVALID_ARGUMENT.

Если тип места указан с несколькими ограничениями типа, возвращаются только места, удовлетворяющие всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], ExcludedPrimaryTypes = ["restaurant"]}, возвращаемые места предоставляют услуги, связанные с "рестораном", но не работают в основном как "рестораны".

max Result Count

integer

Максимальное количество возвращаемых результатов. Оно должно быть от 1 до 20 (по умолчанию) включительно. Если число не установлено, оно возвращается к верхнему пределу. Если число установлено отрицательным или превышает верхний предел, возвращается ошибка INVALID_ARGUMENT.

location Restriction

object ( LocationRestriction )

Необходимый. Регион для поиска.

rank Preference

enum ( RankPreference )

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

routing Parameters

object ( RoutingParameters )

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

Тело ответа

Прототип ответа на запрос «Поиск поблизости».

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

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

object ( Place )

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

routing Summaries[]

object ( RoutingSummary )

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

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

Регион для поиска.

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

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

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

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

circle

object ( Circle )

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

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

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

Перечисления
RANK_PREFERENCE_UNSPECIFIED Значение RankPreference не установлено. По умолчанию будет использоваться рейтинг по ПОПУЛЯРНОСТИ.
DISTANCE Ранжирует результаты по расстоянию.
POPULARITY Ранжирует результаты по популярности.