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

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

includedTypes[]

string

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

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

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

Если для типа «Место» указано несколько ограничений по типу, возвращаются только те места, которые удовлетворяют всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, то возвращаемые места предоставляют услуги, связанные с ресторанами, но не функционируют в первую очередь как рестораны.

excludedTypes[]

string

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

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

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

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

Если для типа «Место» указано несколько ограничений по типу, возвращаются только те места, которые удовлетворяют всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, то возвращаемые места предоставляют услуги, связанные с ресторанами, но не функционируют в первую очередь как рестораны.

includedPrimaryTypes[]

string

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

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

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

Если для типа «Место» указано несколько ограничений по типу, возвращаются только те места, которые удовлетворяют всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, то возвращаемые места предоставляют услуги, связанные с ресторанами, но не функционируют в первую очередь как рестораны.

excludedPrimaryTypes[]

string

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

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

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

Если для типа «Место» указано несколько ограничений по типу, возвращаются только те места, которые удовлетворяют всем ограничениям. Например, если у нас есть {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, то возвращаемые места предоставляют услуги, связанные с ресторанами, но не функционируют в первую очередь как рестораны.

maxResultCount

integer

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

locationRestriction

object ( LocationRestriction )

Обязательно. Регион для поиска.

rankPreference

enum ( RankPreference )

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

routingParameters

object ( RoutingParameters )

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

includeFutureOpeningBusinesses

boolean

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

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

Прототип ответа для функции «Поиск поблизости».

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

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

object ( Place )

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

routingSummaries[]

object ( RoutingSummary )

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

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

Требуется один из следующих диапазонов аутентификации OAuth:

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

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

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

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 )

Окружность, определяемая центром и радиусом.

RankPreference

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

Перечисления
RANK_PREFERENCE_UNSPECIFIED Значение RankPreference не задано. По умолчанию будет использоваться ранжирование по популярности.
DISTANCE Результаты ранжируются по расстоянию.
POPULARITY Результаты ранжируются по популярности.