Запрос полилиний маршрута

Разработчики Европейской экономической зоны (ЕЭЗ)

Методы computeRoutes (REST) ​​и ComputeRoutes (gRPC) возвращают маршрут, представленный ломаной линией, в качестве части ответа. Эти API возвращают два типа ломаных линий:

  • Базовая ломаная (по умолчанию) — представляет собой маршрут без встроенной в него информации о дорожном движении. Запросы, возвращающие базовую ломаную, тарифицируются по тарифу Routes Basic. Подробнее о тарификации Routes API.

  • Полилинии с учётом дорожной ситуации содержат информацию о дорожной ситуации на маршруте. Дорожная ситуация выражается в категориях скорости ( NORMAL , SLOW , TRAFFIC_JAM ), применимых к заданному участку полилинии. Запросы на полилинии с учётом дорожной ситуации тарифицируются по тарифу Routes Preferred. Подробнее о тарификации Routes API см. в разделе «Настройка качества полилиний» .

Более подробную информацию о полилиниях см. здесь:

  • Концептуальная информация о полилиниях

  • Утилита Interactive Polyline Encoder позволяет создавать кодированные полилинии в пользовательском интерфейсе или декодировать полилинии для отображения на карте. Например, используйте эту утилиту для декодирования полилинии, созданной с помощью приведённого ниже кода.

Запросить базовую полилинию для маршрута, этапа или шага

Ломаная линия представлена ​​объектом Polyline (REST) ​​или Polyline (gRPC). Вы можете вернуть ломаную линию в ответе на уровне маршрута, участка и шага.

Укажите, какую полилинию следует вернуть, используя маску поля ответа :

  • На уровне маршрута верните полилинию в ответе, включив routes.polyline в маску поля ответа.

  • На уровне отрезка верните полилинию в ответе для каждого отрезка маршрута, включив routes.legs.polyline .

  • На уровне шага верните полилинию в ответе для каждого шага ноги, включив routes.legs.steps.polyline .

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

curl -X POST -d '{
  "origin":{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA"
  },
  "destination":{
    "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
  },
  "travelMode": "DRIVE"
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline,routes.legs.polyline,routes.legs.steps.polyline' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

Этот запрос возвращает следующий ответ, который включает полилинию маршрута, для каждого отрезка маршрута и для каждого шага отрезка:

{
  "routes": [
    {
      "legs": [
        {
          "polyline": {
              "encodedPolyline": "ipkcFfich...@Bs@?A?O?SD{A@o@B}@I?qA?_AA_@@_@?"
          }
        },
          "steps": [
              {
                  "polyline": {
                      "encodedPolyline": "kclcF...@sC@YIOKI"
                  }
              },
              {
                  "polyline": {
                      "encodedPolyline": "wblcF~...SZSF_@?"
                  }
              },
              ...
      ],
      "distanceMeters": 56901,
      "duration": "2420s",
      "polyline": {
        "encodedPolyline": "ipkcFfich...@Bs@?A?O?SD{A@o@B}@I?qA?_AA_@@_@?"
      }
    }
  ]
}

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

Если добавить в запрос промежуточную точку маршрута, то возвращаемый маршрут будет содержать два этапа:

curl -X POST -d '{
  "origin":{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA"
  },
  "destination":{
    "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
  },
  "intermediates": [
    { "address": "450 Serra Mall, Stanford, CA 94305, USA"},
  ],
  "travelMode": "DRIVE",
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline,routes.legs.polyline' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

Этот запрос возвращает два участка, каждый с уникальной полилинией, и полилинию для всего маршрута:

{
  "routes": [
    {
      "legs": [
        {
          "polyline": {
            "encodedPolyline": "kclcFfqchV?A...?I@G?GAECCCEKICBAFG"
          }
          "steps": [
            {
                "polyline": {
                    "encodedPolyline": "kclcFfqch...YIOKI"
                }
            },
        ...
        },
        {
          "polyline": {
            "encodedPolyline": "ojmcFtethV?K...QOYQOGA?_@MUG[Ga@G"
          }
          "steps": [
            {
                "polyline": {
                    "encodedPolyline": "uypeFbo`jVgJq...PoBiC"
                }
            },
        ...
        }
      ],
      "distanceMeters": 68403,
      "duration": "3759s",
      "polyline": {
          "encodedPolyline": "kclcFfqchV?A?CBKF[Ha...?GAECCCEKICBAFGJEBE"
      }
    }
  ]
}

Качество полилинии

Качество полилинии можно описать следующими терминами:

  • Точность чисел с плавающей запятой

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

    В методе computeRoutes (REST) ​​и ComputeRoutes это контролируется polylineEncoding .

  • Количество точек, составляющих полилинию

    Чем больше точек, тем более гладкой будет полилиния (особенно на кривых).

    В методе computeRoutes (REST) ​​и ComputeRoutes это контролируется polylineQuality .

Настроить тип кодировки полилинии

Используйте параметр запроса polylineEncoding для управления типом полилинии. Свойство polylineEncoding определяет, будет ли полилиния кодироваться как ENCODED_POLYLINE (по умолчанию), что означает использование формата алгоритма кодирования полилиний , или GEO_JSON_LINESTRING , что означает использование формата GeoJSON LineString .

Например, в теле запроса:

curl -X POST -d '{
  "origin":{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA"
  },
  "destination":{
    "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
  },
  "travelMode": "DRIVE",
  "polylineEncoding": "ENCODED_POLYLINE"
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline,routes.legs.polyline' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

Настроить качество полилинии

polylineQuality определяет качество полилинии: HIGH_QUALITY или OVERVIEW (по умолчанию). При OVERVIEW полилиния строится из небольшого количества точек и имеет меньшую задержку запроса, чем при HIGH_QUALITY .

Например, в теле запроса:

{
  "origin":{
    "location":{
      "latLng":{
        "latitude": 37.419734,
        "longitude": -122.0827784
      }
    }
  },
  "destination":{
    "location":{
      "latLng":{
        "latitude": 37.417670,
        "longitude": -122.079595
      }
    }
  },
  "travelMode": "DRIVE",
  "routingPreference": "TRAFFIC_AWARE",
  "polylineQuality": "HIGH_QUALITY",
  "polylineEncoding": "ENCODED_POLYLINE",
  "departureTime": "2023-10-15T15:01:23.045123456Z",
  ...
}

Запросить полилинию с учетом дорожного движения

Все представленные выше примеры возвращают базовые полилинии, то есть полилинии без информации о дорожном движении. Кроме того, вы можете запросить, чтобы полилиния содержала информацию о дорожном движении для маршрута и для каждого его участка.

Полилинии с учётом дорожного движения содержат информацию о дорожной обстановке на маршруте. Дорожная обстановка выражается в категориях скорости ( NORMAL , SLOW , TRAFFIC_JAM ) для заданного интервала полилинии ответа. Интервалы определяются индексами начальных (включая) и конечных (исключая) точек полилинии.

Например, следующий ответ показывает NORMAL движение между точками полилинии 2 и 4:

{
  "startPolylinePointIndex": 2,
  "endPolylinePointIndex": 4,
  "speed": "NORMAL"
}

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

  • Установите для поля массива extraComputations значение TRAFFIC_ON_POLYLINE , чтобы включить расчет трафика.

  • Установите параметр travelMode на DRIVE или TWO_WHEELER . Запросы на любой другой режим передвижения возвращают ошибку.

  • Укажите в запросе параметр маршрутизации TRAFFIC_AWARE или TRAFFIC_AWARE_OPTIMAL . Подробнее см. в разделе Настройка качества и задержки .

  • Задайте маску поля ответа, которая указывает, что необходимо вернуть свойства ответа:

    • На уровне маршрута верните всю информацию о поездках в ответе, включив routes.travelAdvisory в маску поля ответа. Чтобы вернуть только информацию о дорожном движении, укажите routes.travelAdvisory.speedReadingIntervals

    • На уровне сегмента маршрута возвращайте всю информацию о поездках в ответе для каждого сегмента, включив routes.legs.travelAdvisory . Чтобы вернуть только информацию о дорожном движении, укажите routes.legs.travelAdvisory.speedReadingIntervals . 

curl -X POST -d '{
  "origin":{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA"
  },
  "destination":{
    "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
  },
  "travelMode": "DRIVE",
  "extraComputations": ["TRAFFIC_ON_POLYLINE"],
  "routingPreference": "TRAFFIC_AWARE_OPTIMAL"
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline,routes.legs.polyline,routes.travelAdvisory,routes.legs.travelAdvisory' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

Пример ответа для полилинии с учетом дорожного движения

В ответе данные о дорожном движении кодируются в полилинии и содержатся в поле travelAdvisory типа объекта RouteLegTravelAdvisory (каждый участок) и объекта RouteTravelAdvisory (маршрут).

Например:

{
  "routes": [
    {
      "legs": {
        "polyline": {
          "encodedPolyline": "}boeF~zbjVAg@EmB`GWHlD"
        },
        // Traffic data for the leg.
        "travelAdvisory": {
          "speedReadingIntervals": [
            {
              "endPolylinePointIndex": 1,
              "speed": "NORMAL"
            },
            {
              "startPolylinePointIndex": 1,
              "endPolylinePointIndex": 2,
              "speed": "SLOW"
            },
            {
              "startPolylinePointIndex": 2,
              "endPolylinePointIndex": 4,
              "speed": "NORMAL"
            }
          ] 
        }
      },
      "polyline": {
        "encodedPolyline": "}boeF~zbjVAg@EmB`GWHlD"
      },
      // Traffic data for the route.
      "travelAdvisory": {
        "speedReadingIntervals": [
          {
            "endPolylinePointIndex": 1,
            "speed": "NORMAL"
          },
          {
            "startPolylinePointIndex": 1,
            "endPolylinePointIndex": 2,
            "speed": "SLOW"
          },
          {
            "startPolylinePointIndex": 2,
            "endPolylinePointIndex": 4,
            "speed": "NORMAL"
          }
        ] 
      }
    }
  ]
}

И RouteTravelAdvisory , и RouteLegTravelAdvisory включают поле массива speedReadingIntervals , содержащее информацию о скорости движения. Каждый объект в массиве представлен объектом SpeedReadingInterval (REST) ​​или SpeedReadingInterval (gRPC).

Объект SpeedReadingInterval содержит данные о скорости для интервала маршрута, например NORMAL , SLOW или TRAFFIC_JAM . Весь массив объектов покрывает всю ломаную линию маршрута без перекрытия. Начальная точка указанного интервала совпадает с конечной точкой предыдущего интервала.

Каждый интервал описывается своими startPolylinePointIndex , endPolylinePointIndex и соответствующей категорией скорости. Обратите внимание, что отсутствие начального индекса внутри интервала соответствует индексу 0 в соответствии с практикой proto3 .

Значения startPolylinePointIndex и endPolylinePointIndex не всегда являются последовательными. Например: 

{
  "startPolylinePointIndex": 2,
  "endPolylinePointIndex": 4,
  "speed": "NORMAL"
}

В данном случае условия дорожного движения были одинаковыми от индекса 2 до индекса 4.

Отрисовка полилиний с учетом дорожного движения с помощью Maps SDK

Мы рекомендуем отображать на карте полилинии с учётом дорожного движения, используя различные функции Google Maps SDK, включая пользовательские цвета, штрихи и узоры вдоль участков полилиний. Подробнее об использовании полилиний см. в разделах «Функции полилиний для Android» и «Функции полилиний для iOS» .

Пример рендеринга полилинии

Пользователи Maps SDK могут настроить логику сопоставления между категориями скорости и схемами рендеринга полилиний. Например, можно выбрать отображение скорости «NORMAL» (нормальная) толстой синей линией на карте, а скорости «SLOW» (медленная) — толстой оранжевой линией.

Следующие фрагменты кода добавляют толстую синюю ломаную линию с геодезическими сегментами от Мельбурна до Перта. Подробнее см. в разделах «Настройка внешнего вида» (для Android) и «Настройка ломаной линии» (для iOS).

Андроид

Ява 

Polyline line = map.addPolyline(new PolylineOptions()
    .add(new LatLng(-37.81319, 144.96298), new LatLng(-31.95285, 115.85734))
    .width(25)
    .color(Color.BLUE)
    .geodesic(true));

Котлин 

val line: Polyline = map.addPolyline(
  PolylineOptions()
    .add(LatLng(-37.81319, 144.96298), LatLng(-31.95285, 115.85734))
    .width(25f)
    .color(Color.BLUE)
    .geodesic(true)
)

iOS

Objective-C 

GMSMutablePath *path = [GMSMutablePath path];
[path addLatitude:-37.81319 longitude:144.96298];
[path addLatitude:-31.95285 longitude:115.85734];
GMSPolyline *polyline = [GMSPolyline polylineWithPath:path];
polyline.strokeWidth = 10.f;
polyline.strokeColor = .blue;
polyline.geodesic = YES;
polyline.map = mapView;

Быстрый 

let path = GMSMutablePath()
path.addLatitude(-37.81319, longitude: 144.96298)
path.addLatitude(-31.95285, longitude: 115.85734)
let polyline = GMSPolyline(path: path)
polyline.strokeWidth = 10.0
polyline.geodesic = true
polyline.map = mapView

Используйте кодированные полилинии с функцией поиска по маршруту

Используйте текстовый поиск Places API для поиска по рассчитанному маршруту. Кодированная ломаная линия предварительно рассчитанного маршрута передается из функции Compute Routes API в запрос Text Search. Ответ содержит места, соответствующие критериям поиска и расположенные рядом с указанным маршрутом. Подробнее см. в разделе «Поиск по маршруту» .

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

Node.js 

const API_KEY = 'YOUR_API_KEY';
const routes_service = 'https://routes.googleapis.com/directions/v2:computeRoutes';
const textSearch_service = 'https://places.googleapis.com/v1/places:searchText';



function init(){
    const routes_request = {
        "origin":{
            "address": "1600 Amphitheatre Parkway, Mountain View, CA"
        },
        "destination":{
            "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
        },
        "travelMode": "DRIVE"
    };
    const textSearch_request = {
        "textQuery": "cafe",
        "searchAlongRouteParameters": {
            "polyline": {
                "encodedPolyline": ""
            }
        }
    };
    fetchResources(routes_service,routes_request).then(routes => {
        textSearch_request.searchAlongRouteParameters.polyline.encodedPolyline = routes.routes[0].polyline.encodedPolyline;
        fetchResources(textSearch_service,textSearch_request).then(places => {
            console.log(places);
        });
    });
}
async function fetchResources(resource,reqBody){
    const response = await fetch(resource, {
        method: 'POST',
        body: JSON.stringify(reqBody),
        headers: {
            'Content-Type': 'application/json',
            'X-Goog-Api-Key': API_KEY,
            'X-Goog-FieldMask': '*'
        }
    });
    const responseJSON = await response.json();
    return responseJSON;
}
init();