Method: computeRoutes

Возвращает основной маршрут между указанными пунктами отправления и назначения для выбранного способа передвижения.

HTTP-запрос

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

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

Тело запроса

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

JSON-представление 
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "travelMode": enum (RouteTravelMode),
  "intermediateWaypoints": [
    {
      object (Waypoint)
    }
  ],
  "routingPreference": enum (RoutingPreference),
  "locationBias": {
    object (LatLng)
  },
  "includePolyline": boolean,
  "computeAlternativeRoutes": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "departureTime": string,
  "arrivalTime": string
  // End of mutually exclusive fields.
}
Поля
origin

object (Waypoint)

Обязательно. Начальная путевая точка.
destination

object (Waypoint)

Обязательно. Путевая точка назначения.
travelMode

enum (RouteTravelMode)

Необязательное поле. Указывает способ передвижения.
intermediateWaypoints[]

object (Waypoint)

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

Если указать больше 10 промежуточных путевых точек, стоимость и задержка будут выше. Промежуточные путевые точки не поддерживаются, если для параметра travelMode задано значение TRANSIT.
routingPreference

enum (RoutingPreference)

Необязательное поле. Определяет, как данные о трафике используются для расчета маршрута. ROUTING_PREFERENCE_TRAFFIC_AWARE_OPTIMAL не поддерживается, если travelMode имеет значение WALK или BICYCLE. Для TRANSIT это позволяет получать данные о транспорте в реальном времени, например о задержках и отменах.
locationBias

object (LatLng)

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

boolean

Необязательное поле. Следует ли включать закодированную ломаную линию в маршруты ответа. Значение по умолчанию – false. Если задано значение true, возвращается Route.encoded_polyline.
computeAlternativeRoutes

boolean

Необязательное поле. Нужно ли рассчитывать альтернативные маршруты в дополнение к рекомендуемому. По умолчанию используется значение false, при котором возвращается только рекомендуемый маршрут. Если установлено значение true, возвращаются все доступные маршруты, хотя альтернативные варианты могут быть доступны не для каждого запроса.
Указывает, когда нужно отправиться из пункта отправления или прибыть в конечную путевую точку. Если не указано, по умолчанию используется текущее время отправления. Для TRANSIT время должно быть не более 7 дней в прошлом и не более 100 дней в будущем. Для других способов передвижения время не должно быть в прошлом и должно быть не более 365 дней в будущем. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
departureTime

string (Timestamp format)

Необязательное поле. Указывает, что маршрут должен рассчитываться на основе времени отправления.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
arrivalTime

string (Timestamp format)

Необязательное поле. Указывает, что маршрут должен рассчитываться на основе времени прибытия.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
Конец взаимоисключающих полей.

Тело ответа

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

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

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

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