Method: searchAlongRoute

Искать места вдоль маршрута.

HTTP-запрос

POST https://mapstools.googleapis.com/v1alpha:searchAlongRoute

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

Тело запроса

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

JSON-представление 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "routingPreference": enum (RoutingPreference),
  "includeExtendedDetails": boolean,
  "travelMode": enum (RouteTravelMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string,
  "retrievalToken": string,
  "routeEndpoints": {
    object (RouteEndpoints)
  }
  // End of mutually exclusive fields.
}
Поля
textQuery

string

Обязательно. Поисковый запрос на естественном языке, например "зарядные станции для электромобилей" или "кофе".
languageCode

string

Необязательное поле. Язык сводки и информации о месте. По умолчанию используется значение "en-US".
regionCode

string

Необязательное поле. Код страны или региона (CLDR) местоположения, например "US".
routingPreference

enum (RoutingPreference)

Необязательное поле. Необязательный параметр, определяющий, как используются данные о трафике. Значение по умолчанию – TRAFFIC_UNAWARE.
includeExtendedDetails

boolean

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

Установите для этого поля значение true, если запрос пользователя требует подробных качественных данных, динамики в реальном времени или специализированных атрибутов объектов: - Качественные отзывы, настроения клиентов и обратная связь. – конкретные предложения, например позиции меню, блюда, фирменные блюда, напитки или особенности бизнеса. - Качественная атмосфера, декор интерьера, эстетика, атмосфера или настроение. - Данные в реальном времени и характеристики специализированных учреждений, правила/советы для посетителей, время ожидания.

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

Если включить это поле, задержка может увеличиться.
travelMode

enum (RouteTravelMode)

Необязательное поле. Указывает способ передвижения, используемый для расчета маршрута и объездов. Значение по умолчанию – DRIVE. WALK и BICYCLE поддерживаются только с routeEndpoints. TRANSIT не поддерживается.
Спецификация маршрута: существующий маршрут, токен маршрута или начальная и конечная точки. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
encodedPolyline

string

Закодированная строка ломаной линии, представляющая маршрут. Подробнее: https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
retrievalToken

string

Токен извлечения, возвращенный из предыдущего вызова v1alpha.computeRoutes, представляющего маршрут.
routeEndpoints

object (RouteEndpoints)

Явные конечные точки маршрута (начальная и конечная).
Конец взаимоисключающих полей.

Тело ответа

Если ответ получен успешно, его тело содержит экземпляр SearchAlongRouteResponse.

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

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

  • https://www.googleapis.com/auth/maps-platform.mapstools