Route - Post Route Directions Batch

Служба:
Maps
Версия API:
2025-01-01

Используется для отправки пакета запросов к Route Directions API в одном синхронном запросе.
API Route Directions Batch — это HTTP-запрос POST , который отправляет пакеты до 100 запросов за один вызов к API маршрутов .

Отправка синхронного пакетного запроса

Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API.

POST https://atlas.microsoft.com/route/directions:batch?api-version=2025-01-01

Текст POST для пакетного запроса

Для отправки запросов направлений вы будете использовать запрос, POST в котором тело запроса будет содержать batchItems массив в json формате, а Content-Type заголовок будет установлен в application/json. Ниже приведен пример текста запроса, содержащий запросы с 2 направлениями :

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithoutTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "optionalId": "a191de3c-1268-4986-98f0-03f0a5d9302a",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "shortest",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 2,
      "travelMode": "driving"
    }
  ]
}

Объект направления batchItem может принимать любое из поддерживаемыхнаправлений Тело запроса

Пакет должен содержать по крайней мере 1 запроса.

Модель пакетного ответа

Пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequests то есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент имеет один из следующих типов:

  • DirectionsResponse. Если запрос выполнен успешно.

  • Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.

POST {endpoint}/route/directions:batch?api-version=2025-01-01

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает аккаунт, предназначенный для использования с моделью безопасности Microsoft Entra ID. Этот уникальный идентификатор для Azure Maps аккаунта можно получить с управляющего плана Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps.
Accept-Language

string

Язык, в котором должны быть возвращены результаты маршрутизации.

Для получения дополнительной информации см. поддержка локализации в Azure Maps.

Текст запроса

Имя Тип Описание
batchItems

DirectionsBatchRequestItem[]

Список запросов для обработки.

Ответы

Имя Тип Описание
200 OK

DirectionsBatchResponse

Запрос выполнен успешно.
Other Status Codes

MapsErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

AadToken

Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: header

SAS Token

Это токен общего доступа, созданный из операции List SAS на ресурсе Azure Maps/c0> через плоскость управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого токена любое приложение имеет право на доступ с помощью Azure ролевые контроли доступа и тонкий контроль истечения срока действия, скорости и региона использования конкретного токена. Другими словами, SAS Token может использоваться для того, чтобы приложения могли управлять доступом более защищённо, чем общий ключ.\n\n Для публично открытых приложений мы рекомендуем настроить конкретный список разрешённых источников на ресурсе аккаунта Map , чтобы ограничить злоупотребления рендерингом и регулярно продлевать токен SAS.

Тип: apiKey
В: header

Примеры

A Route Directions Batch request containing 2 queries

Образец запроса

POST {endpoint}/route/directions:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.3368,
              47.614988
            ]
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.316067,
              47.606356
            ]
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "maxRouteCount": 3,
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "travelMode": "driving"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.3368,
              47.614988
            ]
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.316067,
              47.606356
            ]
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "maxRouteCount": 3,
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "travelMode": "driving"
    }
  ]
}

Пример ответа

Код состояния:
200 
{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "alternativeRoutes": [
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "type": "RoutePath",
                "arrivalAt": "2025-06-23T01:42:27+00:00",
                "departureAt": "2025-06-23T01:31:05+00:00",
                "distanceInMeters": 2297,
                "durationInSeconds": 586,
                "durationTrafficInSeconds": 682,
                "legs": [],
                "trafficCongestion": "Mild"
              }
            }
          ]
        },
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "type": "RoutePath",
                "arrivalAt": "2025-06-23T01:43:39+00:00",
                "departureAt": "2025-06-23T01:31:05+00:00",
                "distanceInMeters": 4253,
                "durationInSeconds": 621,
                "durationTrafficInSeconds": 754,
                "legs": [],
                "trafficCongestion": "Medium"
              }
            }
          ]
        }
      ],
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "arrivalAt": "2025-06-23T01:40:42+00:00",
            "departureAt": "2025-06-23T01:31:05+00:00",
            "distanceInMeters": 2301,
            "durationInSeconds": 514,
            "durationTrafficInSeconds": 577,
            "legs": [],
            "trafficCongestion": "Mild"
          }
        }
      ]
    },
    {
      "type": "FeatureCollection",
      "alternativeRoutes": [
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "type": "RoutePath",
                "arrivalAt": "2025-06-23T01:42:27+00:00",
                "departureAt": "2025-06-23T01:31:05+00:00",
                "distanceInMeters": 2297,
                "durationInSeconds": 586,
                "durationTrafficInSeconds": 682,
                "legs": [],
                "trafficCongestion": "Mild"
              }
            }
          ]
        },
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "type": "RoutePath",
                "arrivalAt": "2025-06-23T01:43:39+00:00",
                "departureAt": "2025-06-23T01:31:05+00:00",
                "distanceInMeters": 4253,
                "durationInSeconds": 621,
                "durationTrafficInSeconds": 754,
                "legs": [],
                "trafficCongestion": "Medium"
              }
            }
          ]
        }
      ],
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "arrivalAt": "2025-06-23T01:40:42+00:00",
            "departureAt": "2025-06-23T01:31:05+00:00",
            "distanceInMeters": 2301,
            "durationInSeconds": 514,
            "durationTrafficInSeconds": 577,
            "legs": [],
            "trafficCongestion": "Mild"
          }
        }
      ]
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 2
  }
}

Определения

Имя Описание
AdminDistrict

Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе.
AdrTunnelRestrictionCodeEnum

Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров.
AvoidEnum

Указывает ограничения, которые следует учитывать при определении маршрута. Avoid поддерживает несколько значений в одном запросе и поддерживается только для режима вождения и Truck TravelMode.\n\nПример: «избегать»: [«ограниченный доступHighways», «tollRoads»]
CommonErrorDetail

Сведения об ошибке.
CountryRegion

Представляет страну или регион, содержащую связанные сведения.
DirectionsBatchRequestBody

Список направлений запросов и запросов для обработки. Список может содержать не более 100 запросов и должен содержать не менее 1 запроса.
DirectionsBatchRequestItem

Объект Batch Query
DirectionsBatchResponse

Этот объект возвращается из успешного вызова пакетной службы "Маршруты".
DirectionsBatchResponseItem

сведения об ошибке
DirectionsBatchResponseSummary

Сводка для пакетного запроса
DrivingSideEnum

Указывает левую руку против правой стороны вождения в точке маневра.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
FeatureCollection

GeoJSON FeatureCollection объект, содержащий список компонентов. Дополнительные сведения см. в разделе RFC 7946, раздел 3.3.
FeaturesItem

Объект функции GeoJSON, содержащий объект Geometry и дополнительные свойства маршрута.
FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.
FeatureTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.
GeoJsonObjectType

Указывает тип GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.
GeoJsonPoint

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.
InputWaypointFeaturesItem

Задает входную точку пути и объект компонента viaWaypoint GeoJSON и дополнительные свойства. Дополнительные сведения см. в RFC 7946.
InputWaypointProperties

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

Тип точки пути в маршруте. Это может быть остановка или промежуточное расположение, через которое должен пройти маршрут.
Instruction

Описание маневра в наборе направлений.
ManeuverPointProperties

Указывает инструкции по вождению и дополнительные свойства для каждой точки маневра в маршруте Leg.
ManeuverTypeEnum

Тип маневра, описанный в этой подробной коллекции. Манмантип предоставляет сведения для части маневра, указанной соответствующей инструкцией. Например, тип маневра инструкции может указывать TurnLeftThenTurnRight, в то время как связанные элементы детализации могут предоставлять конкретные сведения о маневрах TurnLeft и TurnRight.
MapsErrorDetail

Сведения об ошибке.
MapsErrorResponse

Распространённый ответ на ошибку для API Azure Maps для возврата деталей ошибок при неудачных операциях.
MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
MultiLineStringGeometry

Указывает объект GeoJSON MultiLineString Geometry. Дополнительные сведения см. в RFC 7946.
NavigationPointPropertiesAddress

Административный район и регион страны для путевых точек и точек маневра на маршруте.
OptimizedWaypoint

Оптимизированный объект точки пути.
Order

Последовательность посещения путевых точек.
PointGeometry

Точка источника, передаваемая в качестве допустимого объекта GeoJSON Geometry, из которого должен вычисляться многоугольник диапазона. Дополнительные сведения см. в RFC 7946.

Note: API привязывает запрошенную точку источника к ближайшей дорожной сети и будет использовать ее для вычисления диапазона. Он будет возвращен в качестве center точки в ответе.
PropertiesTypeEnum

Тип вывода.
RouteDirectionOptimizeRouteEnum

Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике.

Пример: "optimizeRoute":"shortest"
RouteDirectionVehicleSpec

Указывает атрибуты транспортного средства, такие как размер, вес, максимальная скорость, тип груза и т. д. только для маршрутизации грузовиков. Это помогает избежать низких разрешений моста, ограничений дорожного движения, трудных поворотов, чтобы обеспечить оптимизированный маршрут грузовика на основе спецификаций транспортного средства.

ISNote: поддерживается только для грузовика travelMode.
RouteLeg

Сведения о разделе маршрута между двумя точками пути. Дополнительные сведения о полях, содержащихся в маршруте Leg:
RouteOutputOptionEnum

Желаемая информация о маршруте из ответа.
RoutePathPoint

Ссылается на индекс точки в определенной части маршрута.
RoutePathProperties

Указывает свойства, описывающие путь маршрута в ответе.
RoutePathRange

Относится к диапазону, охватываемого определенным этапом маршрута или пути.
RoutePathTravelModeEnum

Режим перемещения для пути маршрута в ответе.
RouteStep

Маршрутная нога содержит повернутые инструкции. Шаг относится к диапазону маршрута между двумя последовательными маневрами.
SideOfStreetEnum

Сторона улицы, в которой находится место назначения, зависит от направления прибытия. Это поле относится только к последнему маневру.
TrafficCongestionEnum

Уровень перегрузки трафика по маршруту. Note: поддерживается только для вождения travelMode
TravelModeEnum

Режим поездки для запрошенного маршрута. Если оно не определено, значение по умолчанию — "вождение", которое возвращает маршрут, оптимизированный для автомобилей.

Note: для грузовика travelMode запрошенный маршрут грузовика может быть недоступен для всего маршрута. Если маршрут грузовика недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим".

Пример: "travelMode":"driving"
VehicleLoadTypeEnum

Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами.
WaypointProperties

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

AdminDistrict

Объект

Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе.

Имя Тип Описание
shortName

string

Короткое имя соответствующего поля adminDistrict для adminDistrict[0], это может быть короткое имя состояния, например WA. Это доступно только для США, Канады и Мексики.

AdrTunnelRestrictionCodeEnum

Перечисление

Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров.

Значение Описание
B

Транспортные средства с кодом B ограничены дорогами с категориями B, C, D и E.
C

Транспортные средства с кодом C ограничены дорогами с категориями ADR туннеля C, D и E
D

Транспортные средства с кодом D ограничены дорогами с категориями D и E.
E

Транспортные средства с кодом E ограничены дорогами с категорией E туннеля ADR.

AvoidEnum

Перечисление

Указывает ограничения, которые следует учитывать при определении маршрута. Avoid поддерживает несколько значений в одном запросе и поддерживается только для режима вождения и Truck TravelMode.\n\nПример: «избегать»: [«ограниченный доступHighways», «tollRoads»]

Значение Описание
limitedAccessHighways

Избегает использования ограниченных шоссе доступа в маршруте.
tollRoads

Избегает использования платных дорог в маршруте.
ferries

Избегает использования паромов в маршруте.
tunnels

Избегает использования туннелей в маршруте.
borderCrossings

Избегает пересечения границ страны в маршруте.
lowEmissionZones

Избегает зон с низким уровнем выбросов в маршруте.
unpavedRoads

Избегает неотложных дорог в маршруте.

CommonErrorDetail

Объект

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

CommonErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

CountryRegion

Объект

Представляет страну или регион, содержащую связанные сведения.

Имя Тип Описание
ISO

string

ISO страны или региона представляет код региона или региона ISO 3166-1 Alpha-2
name

string

имя страны или региона

DirectionsBatchRequestBody

Объект

Список направлений запросов и запросов для обработки. Список может содержать не более 100 запросов и должен содержать не менее 1 запроса.

Имя Тип Описание
batchItems

DirectionsBatchRequestItem[]

Список запросов для обработки.

DirectionsBatchRequestItem

Объект

Объект Batch Query

Имя Тип Default value Описание
arriveAt

string (date-time)

Дата и время прибытия в точку назначения, отформатированная как значение dateTime, определенное RFC 3339, раздел 5.6. Если смещение часового пояса не указано, предполагается, что в формате UTC.

Параметр arriveAt нельзя использовать в сочетании с departAt.

Пример: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid

AvoidEnum[]

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

Пример: "избегайте": ["limitedAccessHighways", "tollRoads"]
departAt

string (date-time)

Дата и время выхода из точки источника, отформатированная как значение dateTime, определенное RFC 3339, раздел 5.6. Если смещение часового пояса не указано, предполагается, что в формате UTC.

Если departAt не задано, значение по умолчанию — текущее время.

Пример:

"departAt": "2023-06-01T09:30:00.000-07:00"
features

InputWaypointFeaturesItem[]

Маршруты для автомобилей, пешеходов и грузовиков определяются набором путевых точек (остановок) и viaWaypoints (промежуточных местоположений, через которые должен проходить маршрут). У вас может быть максимум 150 путевых точек и максимум 10 viaWaypoints между каждым набором путевых точек.

Маршрут должен иметь не менее 2 точек пути, а начальные и конечные точки маршрута не могут быть черезWaypoints.

Как точка пути, так и расположения viaWaypoint должны быть указаны в качестве допустимого объекта функции GeoJSON Point вместе с pointIndex, который указывает порядок расположений. Дополнительные сведения о формате GeoJSON см. в RFC 7946.
heading

integer (int64)

minimum: 0
maximum: 359

Начальное направление транспортного средства в градусах, начиная с истинного Севера и продолжающегося в часовой стрелке. Север составляет 0 градусов, восток составляет 90 градусов, юг составляет 180 градусов, запад — 270 градусов.
maxRouteCount

integer (int64)

minimum: 1
maximum: 6

Максимальное количество возвращаемых маршрутов. Доступно для режима движения и грузовика.

По умолчанию: "maxRouteCount":1
optimizeRoute

RouteDirectionOptimizeRouteEnum

fastestWithoutTraffic

Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике.

Пример: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

False

Повторно упорядочение точек пути маршрута с помощью быстрого эвристического алгоритма, чтобы сократить затраты на маршрут, указанные параметром оптимизации. Источник и назначение исключены из оптимизированной точки пути, и их положение считается фиксированным. Допустимые значения : true или false.
optionalId

string

Идентификатор запроса, который будет отображаться в соответствующем пакетном сайте.
routeOutputOptions

RouteOutputOptionEnum[]

[ "itinerary" ]

Добавьте нужные сведения о маршруте из ответа. По умолчанию маршрут включается в ответ.

Поддерживает несколько значений, таких как "routeOutputOptions": ["routePath", "routeerary"]
travelMode

TravelModeEnum

driving

Режим поездки для запрошенного маршрута. Если оно не определено, значение по умолчанию — "вождение", которое возвращает маршрут, оптимизированный для автомобилей.

Note: для грузовика travelMode запрошенный маршрут грузовика может быть недоступен для всего маршрута. Если маршрут грузовика недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим".

Пример: "travelMode":"driving"
type

FeatureTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.
vehicleSpec

RouteDirectionVehicleSpec

Указывает атрибуты транспортного средства, такие как размер, вес, максимальная скорость, тип груза и т. д. только для маршрутизации грузовиков. Это помогает избежать низких разрешений моста, ограничений дорожного движения, трудных поворотов, чтобы обеспечить оптимизированный маршрут грузовика на основе спецификаций транспортного средства.

Note: поддерживается только для грузовика travelMode

DirectionsBatchResponse

Объект

Этот объект возвращается из успешного вызова пакетной службы "Маршруты".

Имя Тип Описание
batchItems

DirectionsBatchResponseItem[]

Массив, содержащий результаты пакетной службы.
summary

DirectionsBatchResponseSummary

Сводка для пакетного запроса

DirectionsBatchResponseItem

Объект

сведения об ошибке

Имя Тип Описание
alternativeRoutes

FeatureCollection[]

Альтернативный маршрут.
error

CommonErrorDetail

Сведения об ошибке.
features

FeaturesItem[]

GeoJSON объект компонента, содержащий объект Geometry и дополнительные свойства. Дополнительные сведения см. в разделе RFC 7946, раздел 3.2.
optionalId

string

Идентификатор запроса, который будет отображаться в соответствующем пакетном сайте.
type

FeatureTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.

DirectionsBatchResponseSummary

Объект

Сводка для пакетного запроса

Имя Тип Описание
successfulRequests

integer (int32)

Количество успешных запросов в пакете
totalRequests

integer (int32)

Общее количество запросов в пакете

DrivingSideEnum

Перечисление

Указывает левую руку против правой стороны вождения в точке маневра.

Значение Описание
Left

Слева на стороне вождения.
Right

Правой стороной вождения.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

FeatureCollection

Объект

GeoJSON FeatureCollection объект, содержащий список компонентов. Дополнительные сведения см. в разделе RFC 7946, раздел 3.3.

Имя Тип Описание
features

FeaturesItem[]

GeoJSON объект компонента, содержащий объект Geometry и дополнительные свойства. Дополнительные сведения см. в разделе RFC 7946, раздел 3.2.
type

FeatureTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.

FeaturesItem

Объект

Объект функции GeoJSON, содержащий объект Geometry и дополнительные свойства маршрута.

Имя Тип Описание
bbox

number[] (double)

Прямоугольная область на земле, определенная как ограничивающий прямоугольник. Стороны прямоугольников определяются значениями широты и долготы. Дополнительные сведения см. в разделе RFC 7946, раздел 5.

Пример: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry RouteDirectionsGeometry:

Допустимый объект GeoJSON Geometry. Дополнительные сведения см. в RFC 7946.
properties FeatureProperties:

Задает свойства признаков маршрута, такие как маршрут, маршрут ноги и геометрия, сводка по путешествиям.
type

FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

FeaturesItemTypeEnum

Перечисление

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

Значение Описание
Feature

Указывает тип объекта компонента GeoJSON.

FeatureTypeEnum

Перечисление

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.

Значение Описание
FeatureCollection

Указывает тип объекта GeoJSONFeatureCollection.

GeoJsonObjectType

Перечисление

Указывает тип GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

Значение Описание
Point

GeoJSON Point геометрии.
MultiPoint

GeoJSON MultiPoint геометрии.
LineString

GeoJSON LineString геометрии.
MultiLineString

GeoJSON MultiLineString геометрии.
Polygon

GeoJSON Polygon геометрии.
MultiPolygon

GeoJSON MultiPolygon геометрии.
GeometryCollection

GeoJSON GeometryCollection геометрии.
Feature

Объект GeoJSON Feature.
FeatureCollection

Объект GeoJSON FeatureCollection.

GeoJsonPoint

Объект

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.

Имя Тип Описание
coordinates

number[] (double)

Position — это массив чисел с двумя или более элементами. Первые два элемента — это долготы и широты, точно в этом порядке. высоты или высоты является необязательным третьим элементом. Дополнительные сведения см. в RFC 7946.
type string:

Point

Указывает тип GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

InputWaypointFeaturesItem

Объект

Задает входную точку пути и объект компонента viaWaypoint GeoJSON и дополнительные свойства. Дополнительные сведения см. в RFC 7946.

Имя Тип Описание
geometry

GeoJsonPoint

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.
properties

InputWaypointProperties

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

FeaturesItemTypeEnum

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является Feature. Дополнительные сведения см. в RFC 7946.

InputWaypointProperties

Объект

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

Имя Тип Default value Описание
pointIndex

integer (int64)

Определите и упорядочение последовательности точек пути в маршруте. Значением по умолчанию является index value массива функций.
pointType

InputWaypointTypeEnum

waypoint

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

InputWaypointTypeEnum

Перечисление

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

Значение Описание
waypoint

Точка пути — это определенное расположение или точка вдоль маршрута или поездки, которая служит эталонной или остановочной точкой.
viaWaypoint

ViaWaypoint — это конкретная точка пути, которую необходимо пройти через или посетить вдоль маршрута или поездки.

Instruction

Объект

Описание маневра в наборе направлений.

Имя Тип Описание
drivingSide

DrivingSideEnum

Указывает левую руку против правой стороны вождения в точке маневра.
formattedText

string

Форматирование текстового описания инструкции.
maneuverType

ManeuverTypeEnum

Тип маневра, описанный в этой подробной коллекции. Манмантип предоставляет сведения для части маневра, указанной соответствующей инструкцией. Например, тип маневра инструкции может указывать TurnLeftThenTurnRight, в то время как связанные элементы детализации могут предоставлять конкретные сведения о маневрах TurnLeft и TurnRight.
text

string

Описание инструкции в виде обычного текста.

ManeuverPointProperties

Объект

Указывает инструкции по вождению и дополнительные свойства для каждой точки маневра в маршруте Leg.

Имя Тип Default value Описание
address

NavigationPointPropertiesAddress

Административный район и регион страны для путевых точек и точек маневра на маршруте.
distanceInMeters

number (float)

Физическое расстояние в метрах, охватываемого этим шагом маршрута.
durationInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance.
exitIdentifier

string

Имя или номер выхода, связанного с этим шагом маршрута.
instruction

Instruction

Описание маневра в наборе направлений.
order

Order

Последовательность посещения путевых точек.
routePathPoint

RoutePathPoint

Ссылается на индекс точки в определенной части маршрута.
sideOfStreet

SideOfStreetEnum

Сторона улицы, в которой находится место назначения, зависит от направления прибытия. Это поле относится только к последнему маневру.
signs

string[]

Текст подписи для маршрута. Может быть несколько значений знака.
steps

RouteStep[]

Шаги между двумя последовательными точками маневра.
towardsRoadName

string

Имя улицы, к которому идет маршрут в первом ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

Режим перемещения для пути маршрута в ответе.
type string:

ManeuverPoint

Тип вывода.

ManeuverTypeEnum

Перечисление

Тип маневра, описанный в этой подробной коллекции. Манмантип предоставляет сведения для части маневра, указанной соответствующей инструкцией. Например, тип маневра инструкции может указывать TurnLeftThenTurnRight, в то время как связанные элементы детализации могут предоставлять конкретные сведения о маневрах TurnLeft и TurnRight.

Значение Описание
ArriveFinish

Прибыть в конечное место назначения.
ArriveIntermediate

Прибыть в промежуточную точку пути.
BearLeft

Медведь налево.
BearLeftThenBearLeft

Медведь слева, а затем медведь оставил снова.
BearLeftThenBearRight

Медведь слева, а затем медведь справа.
BearLeftThenTurnLeft

Медведь слева, а затем вернитесь влево.
BearLeftThenTurnRight

Медведь влево, а затем вернитесь вправо.
BearRight

Держитесь справа.
BearRightThenBearLeft

Медведь справа, а затем медведь слева.
BearRightThenBearRight

Медведь право, а затем медведь снова.
BearRightThenTurnLeft

Медведь справа, а затем вернитесь влево.
BearRightThenTurnRight

Медведь справа, а затем повернуть вправо.
BearThenKeep

Инструкции медведя, а затем оставить инструкцию
DepartStart

Оставьте начальную точку.
BearThenMerge

Инструкция носителя, а затем инструкция слияния.
Continue

Продолжайте на текущей дороге.
DepartIntermediateStop

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

Оставьте промежуточную точку пути в том же направлении и на той же дороге, на которую вы прибыли.
EnterRoundabout

Введите округление.
ExitRoundabout

Выход из круглого цикла.
EnterThenExitRoundabout

Введите и закройте круглое движение.
ExitRoundaboutRight

В круглой кольцевой области выйдите справа.
ExitRoundaboutLeft

На круглой кольцевой части выйдите слева.
Follow

Follow.
GoAroundRoundabout

Идти по кругу.
KeepLeft

Держите слева на другой дороге.
KeepOnRampLeft

Держите слева и продолжайте на пандус.
KeepOnRampRight

Держите право и продолжайте на пандус.
KeepOnRampStraight

Держите прямо и продолжайте на пандус.
KeepRight

Держите прямо на другой дороге.
KeepStraight

Держите прямо на другой дороге.
KeepToStayLeft

Оставайтесь влево, чтобы остаться на той же дороге.
KeepToStayRight

Будьте правы, чтобы остаться на той же дороге.
KeepToStayStraight

Будьте прямо, чтобы остаться на той же дороге.
MergeFreeway

Слияние на автостраде.
MergeHighway

Слияние на шоссе.
MergeMotorway

Слияние на автомагистраль.
MotorwayExitLeft

Возьмите левый выход.
MotorwayExitRight

Возьмите правый выход.
None

Никаких инструкций.
RampThenHighwayLeft

Возьмите левый пандус на шоссе. Это часть объединенной инструкции.
RampThenHighwayRight

Возьмите правой рампы на шоссе. Это часть объединенной инструкции.
RampThenHighwayStraight

Оставайтесь прямо, чтобы взять пандус на шоссе. Это часть объединенной инструкции.
RoadNameChange

Изменение имени дороги.
SwitchToParallelRoad

Переключитесь на параллельную дорогу.
SwitchToMainRoad

Переключитесь на главную дорогу.
Take

Поймите дорогу. Эта инструкция используется при входе или выходе из парома.
TakeFerry

Возьмите паром.
TakeExit

Возьмите выход.
TakeRamp

Сверните на рампу.
TakeRampLeft

Возьмите пандус слева.
TakeRampRight

Возьмите пандус справа.
TakeRampStraight

Оставайтесь прямо, чтобы взять пандус.
TurnBack

Вернитесь резко.
TurnLeft

Поверните налево.
TurnLeftSharp

Возьмите резкий левый поворот.
TurnLeftThenBearLeft

Вернитесь влево, а затем слева медведь.
TurnLeftThenBearRight

Вернитесь влево, а затем вернитесь вправо.
TurnLeftThenTurnLeft

Вернитесь влево и снова вернитесь влево.
TurnLeftThenTurnRight

Вернитесь влево, а затем вернитесь вправо.
TurnRight

Поверните направо.
TurnRightSharp

Возьмите резкий правый поворот.
TurnRightThenBearLeft

Вернитесь вправо, а затем слева.
TurnRightThenBearRight

Повернуть вправо, а затем нести вправо.
TurnRightThenTurnLeft

Вернитесь вправо и верните влево.
TurnRightThenTurnRight

Повернуть вправо, а затем снова повернуть вправо
TurnThenMerge

Включите инструкцию, за которой следует инструкция слияния.
TurnToStayLeft

Вернитесь влево, чтобы остаться на той же дороге.
TurnToStayRight

Вернитесь вправо, чтобы остаться на той же дороге.
Unknown

Инструкция неизвестна.
UTurn

Сделайте u-поворот, чтобы пойти в противоположном направлении.
Wait

Ожидание
Walk

Walk

MapsErrorDetail

Объект

Сведения об ошибке.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
details

MapsErrorDetail[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror

MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

MapsErrorResponse

Объект

Распространённый ответ на ошибку для API Azure Maps для возврата деталей ошибок при неудачных операциях.

Имя Тип Описание
error

MapsErrorDetail

Сведения об ошибке.

MapsInnerError

Объект

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

Имя Тип Описание
code

string

Код ошибки.
innererror

MapsInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

MultiLineStringGeometry

Объект

Указывает объект GeoJSON MultiLineString Geometry. Дополнительные сведения см. в RFC 7946.

Имя Тип Описание
coordinates

number[] (double)

Координаты геометрии GeoJson MultiLineString.
type string:

MultiLineString

Задает тип геометрии для объекта GeoJSON Geometry. Дополнительные сведения см. в RFC 7946.
Объект

Административный район и регион страны для путевых точек и точек маневра на маршруте.

Имя Тип Описание
adminDistricts

AdminDistrict[]

Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе.
countryRegion

CountryRegion

Представляет страну или регион, содержащую связанные сведения.

OptimizedWaypoint

Объект

Оптимизированный объект точки пути.

Имя Тип Описание
inputIndex

integer (int64)

Индекс точки пути, предоставленный пользователем.
optimizedIndex

integer (int64)

Оптимизированный индекс точки пути из системы.

Order

Объект

Последовательность посещения путевых точек.

Имя Тип Описание
inputIndex

integer (int64)

Пользовательский индекс для путевой точки
optimizedIndex

integer (int64)

Оптимизированная для системы путевая точка

PointGeometry

Объект

Точка источника, передаваемая в качестве допустимого объекта GeoJSON Geometry, из которого должен вычисляться многоугольник диапазона. Дополнительные сведения см. в RFC 7946.

Note: API привязывает запрошенную точку источника к ближайшей дорожной сети и будет использовать ее для вычисления диапазона. Он будет возвращен в качестве center точки в ответе.

Имя Тип Описание
coordinates

number[] (double)

Position — это массив чисел с двумя или более элементами. Первые два элемента — это долготы и широты, точно в этом порядке. высоты или высоты является необязательным третьим элементом. Дополнительные сведения см. в RFC 7946.
type string:

Point

Задает тип геометрии для объекта GeoJSON Geometry. Дополнительные сведения см. в RFC 7946.

PropertiesTypeEnum

Перечисление

Тип вывода.

Значение Описание
ManeuverPoint

МаневрТочка — это конкретная точка на маршруте или поездке, где требуется или рекомендуется изменить направление или способ передвижения.
Waypoint

Точка пути — это определенное расположение или точка вдоль маршрута или поездки, которая служит эталонной или остановочной точкой.
RoutePath

RoutePath — это линия, представляющая путь маршрута или поездки.

RouteDirectionOptimizeRouteEnum

Перечисление

Задает параметр, используемый для оптимизации маршрута. Если значение не определено, значение по умолчанию — fastestWithoutTraffic, которое возвращает маршрут, чтобы свести к минимуму время путешествия без использования текущей информации о трафике.

Пример: "optimizeRoute":"shortest"

Значение Описание
short

Маршрут рассчитан таким образом, чтобы сбалансировать быстрое время в пути и короткое расстояние, а не отдавать приоритет только одному. Он оптимизирован как для скорости, так и для эффективности. Сведения о трафике не используются.
shortest

Маршрут вычисляется, чтобы свести к минимуму расстояние. Сведения о трафике не используются.
fastestWithoutTraffic

Находит самый быстрый маршрут, не учитывая сведения о трафике.
fastestWithTraffic

Маршрут вычисляется, чтобы свести к минимуму время с использованием текущей информации о трафике. Note: поддерживается только для вождения и грузовика travelMode.

RouteDirectionVehicleSpec

Объект

Указывает атрибуты транспортного средства, такие как размер, вес, максимальная скорость, тип груза и т. д. только для маршрутизации грузовиков. Это помогает избежать низких разрешений моста, ограничений дорожного движения, трудных поворотов, чтобы обеспечить оптимизированный маршрут грузовика на основе спецификаций транспортного средства.

ISNote: поддерживается только для грузовика travelMode.

Имя Тип Default value Описание
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

Код ограничения туннеля ADR. ADR — это европейское соглашение о международной перевозке опасных товаров по дороге. Код ограничения туннеля ADR используется для определения того, разрешено ли транспортному средству проходить через туннель с ограничениями на перевозки опасных товаров.
axleCount

integer (int64)

Количество осей на транспортном средстве.
axleWeight

integer (int64)

minimum: 0
maximum: 1000000 		0

Вес на ось транспортного средства в кг. Значение 0 означает, что ограничения веса на ось не считаются.
height

number (double)

minimum: 0
maximum: 1000000 		0

Высота транспортного средства в метрах. Значение 0 означает, что ограничения высоты не учитываются.
isVehicleCommercial

boolean

False

Используется ли автомобиль для коммерческих целей. Коммерческие транспортные средства могут быть запрещены ездить на некоторых дорогах.
length

number (double)

minimum: 0
maximum: 1000000 		0

Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.
loadType

VehicleLoadTypeEnum[]

Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами. Доступные значения vehicleLoadType — это классы US Hazmat 1–9, а также универсальные классификации для использования в других странах. Значения, начиная с USHazmat, предназначены для маршрутизации в США, а другие Хазматы должны использоваться для всех других стран. vehicleLoadType поддерживает несколько значений в запросе.
maxSpeed

integer (int64)

minimum: 0
maximum: 250 		0

Максимальная скорость транспортного средства в км/час. Максимальная скорость в профиле транспортного средства используется для проверки того, разрешено ли транспортное средство на автомагистралях.

Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута.

Значение, отличное от нуля, может быть переопределено во время планирования маршрутов. Например, текущий поток трафика составляет 60 км/час. Если максимальная скорость транспортного средства составляет 50 км/час, подсистема маршрутизации будет учитывать 60 км/час, так как это текущая ситуация. Если максимальная скорость транспортного средства предоставляется как 80 км/час, но текущий поток движения составляет 60 км/час, то подсистема маршрутизации снова будет использовать 60 км/час.
weight

integer (int64)

minimum: 0
maximum: 1000000 		0

Вес транспортного средства в килограммах. Значение 0 означает, что ограничения веса не учитываются.
width

number (double)

minimum: 0
maximum: 1000000 		0

Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.

RouteLeg

Объект

Сведения о разделе маршрута между двумя точками пути. Дополнительные сведения о полях, содержащихся в маршруте Leg:

Имя Тип Описание
arrivalAt

string (date-time)

Предполагаемое время прибытия для ноги, которое учитывает условия движения, форматируется как значение dateTime, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC.
departureAt

string (date-time)

Предполагаемое время отъезда для ноги, которое учитывает условия движения, форматируется как значение dateTime, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC.
distanceInMeters

number (float)

Физическое расстояние в метрах, охваченное маршрутом Нога.
durationInSeconds

integer (int64)

Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения.
durationTrafficInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance с текущими условиями движения. Это значение предоставляется, если optimizeRoute включает в себя рекомендации по трафику.
routePathRange

RoutePathRange

Относится к диапазону, охватываемого определенным этапом маршрута или пути.

RouteOutputOptionEnum

Перечисление

Желаемая информация о маршруте из ответа.

Значение Описание
routeSummary

Включите только время путешествия и расстояние для маршрута и не предоставляют другие сведения.
routePath

Включите geoJSON MultiLineString RFC 7946, раздел 3.1.5, описывающий путь маршрута в ответе.
itinerary

Включите подробные инструкции в ответ. Подробные инструкции предоставляются как "Маневры" и содержат такие сведения, как повернутые инструкции.

RoutePathPoint

Объект

Ссылается на индекс точки в определенной части маршрута.

Имя Тип Описание
legIndex

integer (int64)

Индекс маршрута — это последовательный номер маршрута, назначенный каждому логу маршрута, который помогает определить и различать различные сегменты маршрута.
pointIndex

integer (int64)

Индекс точки в определенной ноге.

RoutePathProperties

Объект

Указывает свойства, описывающие путь маршрута в ответе.

Имя Тип Описание
arrivalAt

string (date-time)

Предполагаемое время прибытия для ноги, которое учитывает условия движения, форматируется как dateTime значение, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC.
departureAt

string (date-time)

Предполагаемое время отъезда для ноги, которое учитывает условия движения, форматируется как dateTime значение, определенное RFC 3339, раздел 5.6. Он будет ссылаться на смещение часового пояса на departAt или arrivalAt. В противном случае будет использоваться время UTC.
distanceInMeters

number (float)

Физическое расстояние в метрах, охватываемого всем маршрутом.
durationInSeconds

integer (int64)

Предполагаемое время поездки в секундах, не включающее задержки в маршруте из-за условий дорожного движения.
durationTrafficInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance с текущими условиями движения. Это значение предоставляется, если optimizeRoute включает в себя рекомендации по трафику.
legs

RouteLeg[]

Массив маршрутов Legs. Дополнительные сведения см. в описании объекта Leg маршрута.
optimizedWaypoints

OptimizedWaypoint[]

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

TrafficCongestionEnum

Уровень перегрузки трафика по маршруту. Note: поддерживается только для вождения travelMode
type string:

RoutePath

Тип вывода.

RoutePathRange

Объект

Относится к диапазону, охватываемого определенным этапом маршрута или пути.

Имя Тип Описание
legIndex

integer (int64)

Индекс маршрута — это последовательный номер маршрута, назначенный каждому логу маршрута, который помогает определить и различать различные сегменты маршрута.
range

integer[] (int64)

Относится к диапазону, охватываемого определенным этапом маршрута или пути.

RoutePathTravelModeEnum

Перечисление

Режим перемещения для пути маршрута в ответе.

Значение Описание
driving

Маршруты, оптимизированные для автомобилей.
truck

Маршруты, оптимизированные для больших размеров грузовиков на основе спецификации транспортного средства.
walking

Маршруты, оптимизированные для пешеходов.
other

RouteTravelMode возвращается как "другой" для грузовика travelMode, если маршрут грузовика недоступен для определенного раздела маршрута.

RouteStep

Объект

Маршрутная нога содержит повернутые инструкции. Шаг относится к диапазону маршрута между двумя последовательными маневрами.

Имя Тип Описание
maneuverType

ManeuverTypeEnum

Тип маневра, описанный в этой подробной коллекции. Манмантип предоставляет сведения для части маневра, указанной соответствующей инструкцией. Например, тип маневра инструкции может указывать TurnLeftThenTurnRight, в то время как связанные элементы детализации могут предоставлять конкретные сведения о маневрах TurnLeft и TurnRight.
names

string[]

Улица, шоссе или пересечение, где происходит маневр. Если маневр сложный, в коллекции сведений может быть несколько полей имен. Поле имени также может не иметь значения. Это может произойти, если имя не известно или если улица, шоссе или пересечение не имеет имени.
routePathRange

RoutePathRange

Относится к диапазону, охватываемого определенным этапом маршрута или пути.

SideOfStreetEnum

Перечисление

Сторона улицы, в которой находится место назначения, зависит от направления прибытия. Это поле относится только к последнему маневру.

Значение Описание
Left

Налево.
Right

Так.
Unknown

Неизвестно.

TrafficCongestionEnum

Перечисление

Уровень перегрузки трафика по маршруту. Note: поддерживается только для вождения travelMode

Значение Описание
Unknown

Неизвестно.
None

Нет.
Mild

Mild.
Medium

Средняя.
Heavy

Heavy.

TravelModeEnum

Перечисление

Режим поездки для запрошенного маршрута. Если оно не определено, значение по умолчанию — "вождение", которое возвращает маршрут, оптимизированный для автомобилей.

Note: для грузовика travelMode запрошенный маршрут грузовика может быть недоступен для всего маршрута. Если маршрут грузовика недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет "другим".

Пример: "travelMode":"driving"

Значение Описание
driving

Возвращаемые маршруты оптимизированы для автомобилей.
truck

Возвращаемые маршруты оптимизированы для больших размеров грузовиков на основе спецификации транспортного средства.
walking

Возвращаемые маршруты оптимизированы для пешеходов, включая использование тротуаров.

VehicleLoadTypeEnum

Перечисление

Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены некоторыми дорогами.

Значение Описание
USHazmatClass1

Взрывчатка
USHazmatClass2

Сжатый газ
USHazmatClass3

Воспламеняемые жидкости
USHazmatClass4

Воспламеняемые твердые вещества
USHazmatClass5

Окислители
USHazmatClass6

Противоядия
USHazmatClass7

Радиоактивный
USHazmatClass8

Корросивы
USHazmatClass9

Miscellaneous
otherHazmatExplosive

Взрывчатка
otherHazmatGeneral

Miscellaneous
otherHazmatHarmfulToWater

Вредно для воды

WaypointProperties

Объект

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

Имя Тип Default value Описание
address

NavigationPointPropertiesAddress

Административный район и регион страны для путевых точек и точек маневра на маршруте.
distanceInMeters

number (float)

Физическое расстояние в метрах, охватываемого этим шагом маршрута.
durationInSeconds

integer (int64)

Время, которое требуется, в секундах, для перемещения соответствующего TravelDistance.
exitIdentifier

string

Имя или номер выхода, связанного с этим шагом маршрута.
instruction

Instruction

Описание маневра в наборе направлений.
order

Order

Последовательность посещения путевых точек.
routePathPoint

RoutePathPoint

Ссылается на индекс точки в определенной части маршрута.
sideOfStreet

SideOfStreetEnum

Сторона улицы, в которой находится место назначения, зависит от направления прибытия. Это поле относится только к последнему маневру.
signs

string[]

Текст подписи для маршрута. Может быть несколько значений знака.
steps

RouteStep[]

Шаги между двумя последовательными точками маневра.
towardsRoadName

string

Имя улицы, к которому идет маршрут в первом ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

Режим перемещения для пути маршрута в ответе.
type string:

Waypoint

Тип вывода.