- HTTP-запрос
- Тело запроса
- Тело ответа
- Путь
- Сегмент
- Параметры аннотации
- АннотатедПат
- Аннотированный сегмент
- Атрибут сегментаSpanAttribute
- СегментSpan
- УровеньОфСервис
Возвращает пути на основе входных сегментов с аннотациями для динамических атрибутов вдоль путей.
HTTP-запрос
POST https://routes.googleapis.com/annotations/v2:annotatePaths
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "paths": [ { object ( |
Поля | |
---|---|
paths[] | Необходимый. Запрошенные маршруты должны быть заполнены данными динамических атрибутов. Все пути должны иметь один и тот же начальный сегмент, то есть сегмент, на котором в данный момент находится транспортное средство. Предполагается, что транспортное средство находится в начале первого сегмента. Если пути не начинаются в одном и том же сегменте, будет возвращена ошибка. |
annotationOptions | Необходимый. Запрошенные атрибуты динамических данных, которые следует добавить во входные пути. Если пусто, запрос не будет аннотирован. |
Тело ответа
AnnotatePathsResponse содержит входные пути с дополнительными данными, добавленными для всех запрошенных аннотаций.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"annotatedPaths": [
{
object ( |
Поля | |
---|---|
annotatedPaths[] | Пути из входных данных, аннотированные запрошенными атрибутами. |
Путь
Путь, по которому запрашиваются динамические атрибуты.
Путь должен иметь сегменты, которые связаны и доступны для движения. Предполагается, что сегменты пути следуют по логическому маршруту, и если маршрут не может быть найден во входных сегментах, будет возвращена ошибка. Например, если сегменты пути не имеют соединяющихся конечных точек или путь пуст, это приведет к ошибке.
В настоящее время длина пути ограничена 15 км. Путь измеряется от начала первого сегмента — предполагаемого местоположения транспортного средства. Будет возвращена ошибка, если сегмент пути начинается дальше, чем в 15 км от начала первого сегмента. Допускается, чтобы последний участок начинался до 15 км и заканчивался после 15 км. Частичные ответы не возвращаются.
Путь может содержать те же сегменты, что и другой путь, но аннотации сегментов могут содержать разные ответы в зависимости от различий в других частях пути.
JSON-представление |
---|
{
"segments": [
{
object ( |
Поля | |
---|---|
segments[] | Необходимый. Упорядоченный список сегментов, образующий путь. |
Сегмент
Сегмент, принадлежащий пути.
JSON-представление |
---|
{ "polyline": { object ( |
Поля | |
---|---|
polyline | Необходимый. Полилиния сегмента, которую можно использовать для идентификации сегмента, если его идентификатор не найден, а также для различения двух сегментов, если они имеют одинаковый идентификатор. Полилиния кодируется с использованием стандартного формата алгоритма кодирования полилиний платформы Google Maps. |
id поля объединения. Используется для идентификации этого сегмента в пространстве идентификаторов. Необходимый. id может быть только одним из следующих: | |
placeId | Идентификатор места для этого сегмента дороги. Используется во всех API. |
Параметры аннотации
Запрошены аннотации для входных путей.
JSON-представление |
---|
{ "includeLevelOfService": boolean } |
Поля | |
---|---|
includeLevelOfService | Необязательный. Если установлено значение true, сегменты в ответе будут помечены прогнозируемыми значениями трафика. «Уровень обслуживания» — это обычно используемый термин для описания категоризации потока трафика, но определения уровня обслуживания в этом API принадлежат только этому API. |
АннотатедПат
Копия входного пути, возвращенная с предсказанными атрибутами.
JSON-представление |
---|
{
"annotatedSegments": [
{
object ( |
Поля | |
---|---|
annotatedSegments[] | Упорядоченный список сегментов, образующий основной путь, с запрошенными атрибутами. |
Аннотированный сегмент
Сегмент, образующий путь, аннотированный атрибутами динамических данных.
JSON-представление |
---|
{ "segment": { object ( |
Поля | |
---|---|
segment | Детали сегмента используются для отличия его от других сегментов. |
segmentSpanAttributes[] | Атрибуты, присвоенные сегменту. Эти атрибуты могут различаться в зависимости от пути, по которому находится сегмент. Диапазон может охватывать весь сегмент. Диапазоны атрибутов будут располагаться в прямом порядке от местоположения транспортного средства до конца пути. |
Атрибут сегментаSpanAttribute
SegmentSpanAttribute содержит аннотации, возвращаемые API.
JSON-представление |
---|
{ "segmentSpan": { object ( |
Поля | |
---|---|
segmentSpan | Описывает, где в сегменте применяются аннотации. |
levelOfService | Прогнозируемый уровень трафика для сегмента, определяемый ожидаемой скоростью движения на этом сегменте, когда транспортное средство прибывает в начало сегмента. |
СегментSpan
Используется для разграничения подраздела сегмента. Если диапазон охватывает весь сегмент, startMeters будет равен 0, а endMeters будет длиной сегмента.
JSON-представление |
---|
{ "startMeters": integer, "endMeters": integer } |
Поля | |
---|---|
startMeters | Где начало промежутка находится в начальной точке полилинии сегмента. |
endMeters | Конец промежутка находится в начальной точке полилинии сегмента. |
УровеньОфСервис
Прогнозируемые значения сегмента трафика, которые будут использоваться для функций ADAS и соответствуют общим уровням трафика. Значения, возвращаемые этим API, независимы, и на них не следует полагаться как на соответствие другим API.
Перечисления | |
---|---|
LEVEL_OF_SERVICE_UNSPECIFIED | Значение по умолчанию. Это значение означает, что прогнозируемое значение трафика отсутствует. |
LEVEL_OF_SERVICE_STOPPED | Движение транспорта остановлено. |
LEVEL_OF_SERVICE_STOP_AND_GO | Движение стоит и идет. |
LEVEL_OF_SERVICE_SLOW | Прогнозируется замедление движения, но пробок не предвидится. |
LEVEL_OF_SERVICE_NORMAL | Скорость нормальная, замедления не предвидится. |