Share via


Route - Post Route Directions Batch

를 사용하여 단일 비동기 요청에서 경로 방향 가져오기 API에 쿼리 일괄 처리를 보냅니다.

Post Route Directions Batch API는 단일 비동기 요청을 사용하여 경로 방향 가져오기 API에 쿼리 일괄 처리를 보내는 HTTP POST 요청입니다. API를 호출 Route Directions Batch 하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 700 개의 쿼리를 일괄 처리하고 최대 100 개의 쿼리를 동기화할 수 있습니다. 동기 요청에서 API를 호출 Post Route Directions Batch 하려면 경로 방향 일괄 동기화 후를 참조하세요.

비동기 일괄 처리 요청 제출

비동기 API는 비교적 복잡한 경로 요청의 대량 처리에 적합합니다.

  • 별도의 호출에서 결과를 검색할 수 있습니다(여러 다운로드 가능).
  • 비동기 API는 안정성에 최적화되어 있으며 시간 제한으로 실행되지 않을 것으로 예상됩니다.
  • 이 API의 일괄 처리 항목 수는 700 개로 제한됩니다.

비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 비동기 응답은 14 일 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

비동기 일괄 처리 요청은 장기 실행 작업입니다. 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 경로 방향 일괄 처리 POST 요청을 Azure Maps 보냅니다.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
  1. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 일괄 처리 요청이 수락되었습니다.

    HTTP Error - Batch 요청을 처리하는 동안 오류가 발생했습니다. 이는 또는 다른 Error 상태 코드일 400 Bad Request 수 있습니다.

  2. 일괄 처리 요청이 성공적으로 수락된 경우 응답의 Location 헤더에는 일괄 처리 요청의 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} 
  1. 클라이언트는 GET 3단계에서 가져온 다운로드 URL 에 대한 요청을 실행하여 일괄 처리 결과를 다운로드합니다.

일괄 처리 요청에 대한 POST 본문

경로 방향 쿼리를 보내려면 요청 본문에 배열 json 형식이 포함 batchItems 되고 Content-Type 헤더가 로 설정된 application/json요청을 사용합니다POST. 다음은 3개의 경로 방향 쿼리를 포함하는 샘플 요청 본 문입니다 .

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

일괄 처리의 경로 방향 쿼리는 프로토콜, 기본 URL, 경로, api-version 및 subscription-key 가 없는 부분 URL일 뿐입니다. 지원되는 경로 방향URI 매개 변수를 수락할 수 있습니다. 경로 방향 쿼리의 문자열 값은 제대로 이스케이프되어야 합니다(예: " 문자는 \로 이스케이프되어야 함). 또한 URL로 올바르게 인코딩되어야 합니다.

비동기 API를 사용하면 호출자가 최대 700 개의 쿼리를 일괄 처리하고 최대 100 개의 쿼리를 동기화할 수 있으며 일괄 처리에는 쿼리가 1 개 이상 포함되어야 합니다.

비동기 일괄 처리 결과 다운로드

비동기 일괄 처리 결과를 다운로드하려면 일괄 처리 다운로드 엔드포인트에 요청을 실행 GET 합니다. 이 다운로드 URL은 성공적인 POST 일괄 처리 요청의 Location 헤더에서 가져올 수 있으며 다음과 같습니다.

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

일괄 처리 결과를 다운로드하기 위한 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 다운로드 URLGET 사용하여 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 일괄 처리 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

    HTTP 200 OK - 일괄 처리 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 일괄 처리 결과가 포함됩니다.

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 비슷합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청successfulRequests의 일부인 와 성공적으로 실행된 쿼리를 나타내는 totalRequests 구성 요소가 포함되어 summary 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 batchItems 각 쿼리와 모든 쿼리에 대한 응답이 포함된 배열도 포함됩니다. 는 batchItems 원래 쿼리가 일괄 처리 요청에서 전송된 것과 동일한 순서로 결과를 포함합니다. 의 batchItems 각 항목에는 및 response 필드가 포함됩니다statusCode. 의 batchItemsresponse 유형은 다음 유형 중 하나입니다.

  • RouteDirections - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우. 응답에는 이 경우 및 message 가 포함 code 됩니다.

다음은 1의 성공 및 1 실패 결과가 있는 샘플 Batch 응답입니다.

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
format
path True

JsonFormat

원하는 응답 형식입니다. json 형식만 지원됩니다.

api-version
query True

string

Azure Maps API의 버전 번호.

요청 헤더

Name 필수 형식 Description
x-ms-client-id

string

Microsoft Entra ID 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정의 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps Microsoft Entra ID 보안을 사용하려면 다음 문서를 참조하세요.

요청 본문

Name 형식 Description
batchItems

BatchRequestItem[]

처리할 쿼리 목록입니다.

응답

Name 형식 Description
200 OK

RouteDirectionsBatchResult

일괄 처리 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 일괄 처리 결과가 포함됩니다.

202 Accepted

비동기 요청에 대해서만 지원됩니다. 요청 수락됨: 처리를 위해 요청이 수락되었습니다. 위치 헤더의 URL을 사용하여 결과를 다시 시도하거나 액세스하세요.

Headers

Location: string

Other Status Codes

ErrorResponse

예기치 않은 오류가 발생했습니다.

보안

AADToken

다음은 Microsoft Entra OAuth 2.0 흐름입니다. Azure 역할 기반 액세스 제어와 쌍을 이루는 경우 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 기본 제공 역할 또는 REST API를 Azure Maps 하나 이상의 권한으로 구성된 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.

시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하는 솔루션을 제공합니다.

참고

  • 이 보안 정의 애플리케이션이 x-ms-client-id 액세스를 요청하는 Azure Maps 리소스를 나타내기 위해 헤더를 사용해야 합니다. 이는 지도 관리 API에서 가져올 수 있습니다.

Authorization URL 은 Azure 퍼블릭 클라우드 instance 관련됩니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps Web SDK를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

이 키는 Azure Portal Azure Maps 계정을 Create PowerShell, CLI, Azure SDK 또는 REST API를 사용할 때 프로비전되는 공유 키입니다.

이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있습니다. 즉, 이 키를 발급된 계정의 master 키로 사용할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 기밀 클라이언트 애플리케이션 접근 방식을 사용하여 키를 안전하게 저장할 수 있도록 Azure Maps REST API에 액세스하는 것이 좋습니다.

Type: apiKey
In: query

SAS Token

공유 액세스 서명 토큰은 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스의 SAS 나열 작업에서 만들어집니다.

이 토큰을 사용하면 모든 애플리케이션이 Azure 역할 기반 액세스 제어 및 특정 토큰에 사용할 만료, 속도 및 지역에 대한 세분화된 제어를 사용하여 액세스할 수 있는 권한이 부여됩니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 Map 계정 리소스 에서 허용되는 특정 원본 목록을 구성하는 것이 좋습니다.

Type: apiKey
In: header

예제

Successfully submit a route direction batch request

Sample Request

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

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

Sample Response

{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}
operation-Location: URL to download the results of the long-running batch request.

정의

Name Description
BatchRequest

이 형식은 Batch 서비스에 대한 요청 본문을 나타냅니다.

BatchRequestItem

Batch 요청 개체

DelayMagnitude

인시던트에 의한 지연의 크기입니다. 이러한 값은 트래픽 인시던트 세부 정보 가져오기 API의 응답 필드 ty 값에 해당합니다.

DrivingSide

기동 지점에서 왼쪽 및 오른쪽 운전을 나타냅니다.

EffectiveSetting

이 Route API를 호출할 때 사용되는 유효 매개 변수 또는 데이터입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

오류 응답

GuidanceInstructionType

명령 유형(예: 도로 형식의 회전 또는 변경)입니다.

GuidanceManeuver

기동을 식별하는 코드입니다.

JsonFormat

원하는 응답 형식입니다. json 형식만 지원됩니다.

JunctionType

기동이 이루어지는 접합의 유형입니다. 더 큰 로터리인 경우 로터리에 들어가고 나가는 두 개의 별도 명령이 생성됩니다.

LatLongPair

위도 및 경도로 표시되는 위치입니다.

Response

쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 RouteDirections, 그렇지 않으면 ErrorResponse입니다.

ResponseSectionType

보고된 경로 응답의 섹션 형식

ResponseTravelMode

계산된 경로의 이동 모드입니다. 이 섹션에서 요청된 전송 모드를 사용할 수 없는 경우 값이 로 설정 other 됩니다.

Route
RouteDirectionsBatchItem

Route Directions Batch 서비스 호출에서 반환된 항목입니다.

RouteDirectionsBatchResult

이 개체는 Route Directions Batch 서비스 호출에서 반환됩니다.

RouteGuidance

지침 관련 요소를 포함합니다. 이 필드는 지침이 요청되고 사용할 수 있는 경우에만 존재합니다.

RouteInstruction

기동을 설명하는 특성 집합(예: '오른쪽으로 돌기', '왼쪽으로 유지', '페리 타기', '고속도로 이용', '도착')

RouteInstructionGroup

서로 관련된 명령 요소 시퀀스를 그룹. 시퀀스 범위는 firstInstructionIndex 및 lastInstructionIndex로 제한됩니다. 사람이 읽을 수 있는 문자 메시지가 지침(instructionType=text 또는 태그 지정)을 요청하면 instructionGroup에 사용 가능한 경우 요약 메시지가 반환됩니다.

RouteLeg

점 목록으로 구성된 경로의 일부에 대한 설명입니다. 요청에 제공된 각 추가 웨이포인트는 반환된 경로에 추가 레그를 생성합니다.

RouteLegSummary

경로 섹션에 대한 요약 개체입니다.

RouteOptimizedWaypoint

최적화된 방법 지점 개체입니다.

RouteReport

현재 호출에 사용된 유효 설정을 보고합니다.

RouteSection

경로 섹션에는 경로의 일부에 대한 추가 정보가 포함되어 있습니다. 각 섹션에는 최소한 , endPointIndexsectionType요소가 startPointIndex포함됩니다.

RouteSectionTec

TPEG2-TEC 표준의 정의를 사용하여 트래픽 이벤트에 대한 세부 정보입니다. effectCode를 포함할 수 있으며 요소를 발생합니다.

RouteSectionTecCause

트래픽 이벤트의 원인입니다. mainCauseCode 및 subCauseCode 요소를 포함할 수 있습니다. 아이콘 및 설명을 정의하는 데 사용할 수 있습니다.

RouteSummary

요약 개체

SimpleCategory

인시던트 유형입니다. 현재 JAM, ROAD_WORK, ROAD_CLOSURE 또는 기타일 수 있습니다. 자세한 내용은 "tec"을 참조하세요.

Summary

일괄 처리 요청에 대한 결과 요약

BatchRequest

이 형식은 Batch 서비스에 대한 요청 본문을 나타냅니다.

Name 형식 Description
batchItems

BatchRequestItem[]

처리할 쿼리 목록입니다.

BatchRequestItem

Batch 요청 개체

Name 형식 Description
query

string

이 매개 변수에는 구조화되지 않은 지오코딩 작업을 수행하는 데 사용되는 쿼리 문자열이 포함되어 있습니다. 쿼리 문자열은 처리를 위해 검색 API에 그대로 전달됩니다.

DelayMagnitude

인시던트에 의한 지연의 크기입니다. 이러한 값은 트래픽 인시던트 세부 정보 가져오기 API의 응답 필드 ty 값에 해당합니다.

Name 형식 Description
0

string

알 수 없습니다.

1

string

사소함

2

string

보통.

3

string

주요함

4

string

정의되지 않음, 도로 폐쇄 및 기타 무기한 지연에 사용됩니다.

DrivingSide

기동 지점에서 왼쪽 및 오른쪽 운전을 나타냅니다.

Name 형식 Description
LEFT

string

왼쪽.

RIGHT

string

오른쪽.

EffectiveSetting

이 Route API를 호출할 때 사용되는 유효 매개 변수 또는 데이터입니다.

Name 형식 Description
key

string

사용된 매개 변수의 이름입니다.

value

string

사용된 매개 변수의 값입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.

type

string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.

code

string

오류 코드입니다.

details

ErrorDetail[]

오류 세부 정보입니다.

message

string

오류 메시지입니다.

target

string

오류 대상입니다.

ErrorResponse

오류 응답

Name 형식 Description
error

ErrorDetail

Error 개체.

GuidanceInstructionType

명령 유형(예: 도로 형식의 회전 또는 변경)입니다.

Name 형식 Description
DIRECTION_INFO

string

방향 정보입니다.

LOCATION_ARRIVAL

string

도착 위치입니다.

LOCATION_DEPARTURE

string

출발 위치입니다.

LOCATION_WAYPOINT

string

방향 지점 위치입니다.

ROAD_CHANGE

string

도로 변경.

TURN

string

설정.

GuidanceManeuver

기동을 식별하는 코드입니다.

Name 형식 Description
ARRIVE

string

도착했습니다.

ARRIVE_LEFT

string

도착했습니다. 대상은 왼쪽에 있습니다.

ARRIVE_RIGHT

string

도착했습니다. 대상이 오른쪽에 있습니다.

BEAR_LEFT

string

곰 왼쪽.

BEAR_RIGHT

string

오른쪽 곰.

DEPART

string

남겨.

ENTER_FREEWAY

string

고속도로를 타고.

ENTER_HIGHWAY

string

고속도로를 타고.

ENTER_MOTORWAY

string

고속도로를 타고.

ENTRANCE_RAMP

string

경사로를 가져 가라.

FOLLOW

string

따라.

KEEP_LEFT

string

왼쪽으로 유지합니다.

KEEP_RIGHT

string

오른쪽으로 유지합니다.

MAKE_UTURN

string

유턴을 합니다.

MOTORWAY_EXIT_LEFT

string

왼쪽 출구를 가져 가라.

MOTORWAY_EXIT_RIGHT

string

오른쪽 출구를 가져 가라.

ROUNDABOUT_BACK

string

로터리를 돌아다닐 수 있습니다.

ROUNDABOUT_CROSS

string

로터리를 교차합니다.

ROUNDABOUT_LEFT

string

로터리에서 왼쪽의 출구를 가져 가라.

ROUNDABOUT_RIGHT

string

로터리에서 오른쪽의 출구를 가져 가라.

SHARP_LEFT

string

날카로운 왼쪽으로 돌립니다.

SHARP_RIGHT

string

날카로운 오른쪽으로 돌립니다.

STRAIGHT

string

계속 똑바로 하십시오.

SWITCH_MAIN_ROAD

string

기본 도로로 전환합니다.

SWITCH_PARALLEL_ROAD

string

병렬 도로로 전환합니다.

TAKE_EXIT

string

출구를 가져 가라.

TAKE_FERRY

string

페리를 타고.

TRY_MAKE_UTURN

string

유턴을 시도합니다.

TURN_LEFT

string

왼쪽으로 돌립니다.

TURN_RIGHT

string

오른쪽으로 돌립니다.

WAYPOINT_LEFT

string

웨이포인트에 도달했습니다. 왼쪽에 있습니다.

WAYPOINT_REACHED

string

웨이포인트에 도달했습니다.

WAYPOINT_RIGHT

string

웨이포인트에 도달했습니다. 오른쪽에 있습니다.

JsonFormat

원하는 응답 형식입니다. json 형식만 지원됩니다.

Name 형식 Description
json

string

JavaScript 개체 표기법 데이터 교환 형식

JunctionType

기동이 이루어지는 접합의 유형입니다. 더 큰 로터리인 경우 로터리에 들어가고 나가는 두 개의 별도 명령이 생성됩니다.

Name 형식 Description
BIFURCATION

string

분기

REGULAR

string

레귤러

ROUNDABOUT

string

원형 교차로

LatLongPair

위도 및 경도로 표시되는 위치입니다.

Name 형식 Description
latitude

number

위도 속성

longitude

number

경도 속성

Response

쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 RouteDirections, 그렇지 않으면 ErrorResponse입니다.

Name 형식 Description
error

ErrorDetail

Error 개체.

formatVersion

string

Format Version 속성

optimizedWaypoints

RouteOptimizedWaypoint[]

최적화된 웨이포인트 시퀀스입니다. 원래 및 최적화된 목록에 대해 사용자가 제공한 웨이포인트 시퀀스의 인덱스를 표시합니다. instance 경우 응답:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

는 원래 시퀀스가 [0, 1, 2]이고 최적화된 시퀀스가 [1, 2, 0]임을 의미합니다. 인덱스가 0으로 시작되므로 원래 는 "first, second, third"이고 최적화된 는 "second, third, first"입니다.

report

RouteReport

현재 호출에 사용된 유효 설정을 보고합니다.

routes

Route[]

경로 배열

ResponseSectionType

보고된 경로 응답의 섹션 형식

Name 형식 Description
CARPOOL

string

카풀(HOV/높은 점유 차량) 차선을 사용해야 하는 경로의 섹션입니다.

CAR_TRAIN

string

자동차 또는 열차인 경로의 섹션입니다.

COUNTRY

string

경로가 있는 국가/지역을 나타내는 섹션입니다.

FERRY

string

페리인 경로의 섹션입니다.

MOTORWAY

string

고속도로인 경로의 섹션입니다.

PEDESTRIAN

string

보행자에게만 적합한 경로의 섹션입니다.

TOLL_ROAD

string

통행료를 지불해야 하는 경로의 섹션입니다.

TOLL_VIGNETTE

string

유료 비네팅이 있어야 하는 경로의 섹션입니다.

TRAFFIC

string

트래픽 정보를 포함하는 경로의 섹션입니다.

TRAVEL_MODE

string

요청 매개 변수 travelMode와 관련된 섹션입니다.

TUNNEL

string

터널인 경로의 섹션입니다.

URBAN

string

도시 지역 내에 있는 경로의 섹션입니다.

ResponseTravelMode

계산된 경로의 이동 모드입니다. 이 섹션에서 요청된 전송 모드를 사용할 수 없는 경우 값이 로 설정 other 됩니다.

Name 형식 Description
bicycle

string

반환된 경로는 자전거 차선 사용을 포함하여 자전거에 최적화되어 있습니다.

bus

string

반환된 경로는 버스 전용 차선 사용을 포함하여 버스에 최적화되어 있습니다. BETA 기능.

car

string

반환된 경로는 자동차에 최적화되어 있습니다.

motorcycle

string

반환된 경로는 오토바이에 최적화되어 있습니다. BETA 기능.

other

string

이 섹션에서는 지정된 전송 모드를 사용할 수 없습니다.

pedestrian

string

반환된 경로는 보도 사용을 포함하여 보행자에 최적화되어 있습니다.

taxi

string

반환된 경로는 택시에 최적화되어 있습니다. BETA 기능.

truck

string

반환된 경로는 트럭과 같은 상용차에 최적화되어 있습니다.

van

string

반환된 경로는 밴에 최적화되어 있습니다. BETA 기능.

Route

Name 형식 Description
guidance

RouteGuidance

지침 관련 요소를 포함합니다. 이 필드는 지침이 요청되고 사용할 수 있는 경우에만 존재합니다.

legs

RouteLeg[]

다리 배열

sections

RouteSection[]

섹션 배열

summary

RouteSummary

요약 개체

RouteDirectionsBatchItem

Route Directions Batch 서비스 호출에서 반환된 항목입니다.

Name 형식 Description
response

Response

쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 RouteDirections, 그렇지 않으면 ErrorResponse입니다.

statusCode

integer

HTTP 요청 상태 코드.

RouteDirectionsBatchResult

이 개체는 Route Directions Batch 서비스 호출에서 반환됩니다.

Name 형식 Description
batchItems

RouteDirectionsBatchItem[]

일괄 처리 결과를 포함하는 배열입니다.

summary

Summary

일괄 처리 요청에 대한 결과 요약

RouteGuidance

지침 관련 요소를 포함합니다. 이 필드는 지침이 요청되고 사용할 수 있는 경우에만 존재합니다.

Name 형식 Description
instructionGroups

RouteInstructionGroup[]

서로 관련된 명령 요소 시퀀스를 그룹.

instructions

RouteInstruction[]

기동을 설명하는 지침 목록입니다.

RouteInstruction

기동을 설명하는 특성 집합(예: '오른쪽으로 돌기', '왼쪽으로 유지', '페리 타기', '고속도로 이용', '도착')

Name 형식 Description
combinedMessage

string

다음 명령의 메시지와 결합된 기동에 대한 사람이 읽을 수 있는 메시지입니다. 경우에 따라 두 개의 연속 명령을 단일 명령으로 결합하여 더 쉽게 따를 수 있습니다. 이 경우 가능한CombineWithNext 플래그가 true가 됩니다. 예를 들면 다음과 같습니다.

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

명령 10의 possibleCombineWithNext 플래그는 true입니다. 이는 코딩된 지침의 클라이언트에 명령 11과 결합될 수 있음을 나타냅니다. 이 지침은 사람이 읽을 수 있는 지침을 요청하는 클라이언트에 대해 자동으로 결합됩니다. combinedMessage 필드에는 결합된 메시지가 포함됩니다.

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

3자 ISO 3166-1 alpha-3 국가 코드입니다. 예: 미국

drivingSide

DrivingSide

기동 지점에서 왼쪽 및 오른쪽 주행을 나타냅니다.

exitNumber

string

현재 기동에서 가져온 고속도로 출구의 숫자입니다. 출구에 여러 개의 출구 번호가 있는 경우 ""로 구분되고 "-"(예: "10, 13-15")로 집계될 수 있습니다.

instructionType

GuidanceInstructionType

명령 유형(예: 도로 형식의 회전 또는 변경)입니다.

junctionType

JunctionType

기동이 일어나는 접합의 유형입니다. 더 큰 로터리인 경우 로터리에 들어가고 나가는 두 개의 별도 명령이 생성됩니다.

maneuver

GuidanceManeuver

기동을 식별하는 코드입니다.

message

string

기동을 위해 사람이 읽을 수 있는 메시지입니다.

point

LatLongPair

위도 및 경도로 표시되는 위치입니다.

pointIndex

integer

명령의 지점에 해당하는 다각형 "점" 목록의 점 인덱스입니다.

possibleCombineWithNext

boolean

필요에 따라 명령을 다음 명령과 결합할 수 있습니다. "왼쪽으로 돌고 오른쪽으로 돌립니다"와 같은 메시지를 작성하는 데 사용할 수 있습니다.

roadNumbers

string[]

기동 후 다음으로 중요한 도로 세그먼트 또는 따라야 할 도로의 도로 번호입니다. 예: ["E34", "N205"]

roundaboutExitNumber

string

로터리에서 수행할 종료를 나타냅니다.

routeOffsetInMeters

integer

경로 시작부터 명령 지점까지의 거리입니다.

signpostText

string

기동 또는 따라야 할 방향과 가장 관련이 있는 표지판의 텍스트입니다.

stateCode

string

ISO 3166-2 코드의 두 번째 부분으로 표현되는 국가의 세분화(예: 상태)입니다. 이는 미국, 캐나다 및 멕시코와 같은 일부 국가/지역에서만 사용할 수 있습니다.

street

string

기동 후 다음 중요한 도로 세그먼트의 거리 이름, 또는 따라야 할 거리의 이름입니다.

travelTimeInSeconds

integer

routeOffsetInMeters에 해당하는 지점까지의 예상 이동 시간입니다.

turnAngleInDecimalDegrees

integer

명령의 방향을 나타냅니다. junctionType이 턴 명령을 나타내는 경우:

  • 180 = 유턴
  • [-179, -1] = 좌회전
  • 0 = 직선 켜기('0도' 회전)
  • [1, 179] = 우회전

junctionType이 bifurcation 명령을 나타내는 경우:

  • <0 - 왼쪽 유지
  • >0 - 오른쪽 유지

RouteInstructionGroup

서로 관련된 명령 요소 시퀀스를 그룹. 시퀀스 범위는 firstInstructionIndex 및 lastInstructionIndex로 제한됩니다. 사람이 읽을 수 있는 문자 메시지가 지침(instructionType=text 또는 태그 지정)을 요청하면 instructionGroup에 사용 가능한 경우 요약 메시지가 반환됩니다.

Name 형식 Description
firstInstructionIndex

integer

지침 및 이 그룹에 속하는 첫 번째 명령의 인덱스입니다.

groupLengthInMeters

integer

그룹의 길이입니다.

groupMessage

string

사람이 읽을 수 있는 문자 메시지가 지침(instructionType=text 또는 태그 지정)을 요청하는 경우의 요약 메시지입니다.

lastInstructionIndex

integer

지침 및 이 그룹에 속한 마지막 명령의 인덱스입니다.

RouteLeg

점 목록으로 구성된 경로의 일부에 대한 설명입니다. 요청에 제공된 각 추가 웨이포인트는 반환된 경로에 추가 레그를 생성합니다.

Name 형식 Description
points

LatLongPair[]

점 배열

summary

RouteLegSummary

경로 섹션에 대한 요약 개체입니다.

RouteLegSummary

경로 섹션에 대한 요약 개체입니다.

Name 형식 Description
arrivalTime

string

경로 또는 다리의 예상 도착 시간입니다. 시간은 UTC입니다.

batteryConsumptionInkWh

number

전기 소비 모델을 사용하여 KWh(킬로와트시)의 예상 전기 에너지 소비량. vehicleEngineType이 전기로 설정되고 constantSpeedConsumptionInkWhPerHundredkm가 지정된 경우 포함됩니다. batteryConsumptionInkWh 값은 회복된 전기 에너지를 포함하므로 음수일 수 있습니다(에너지 증가를 나타냅니다). maxChargeInkWh와 currentChargeInkWh를 모두 지정하면 배터리 충전 수준이 maxChargeInkWh를 초과하지 않도록 다시 회수가 제한됩니다. maxChargeInkWh와 currentChargeInkWh가 모두 지정되지 않은 경우 사용량 계산에서 제한되지 않은 재지정이 가정됩니다.

departureTime

string

경로 또는 다리의 예상 출발 시간입니다. 시간은 UTC입니다.

fuelConsumptionInLiters

number

연소 소비 모델을 사용하여 리터의 예상 연료 소비량. vehicleEngineType이 연소 로 설정되고 constantSpeedConsumptionInLitersPerHundredkm가 지정된 경우 포함됩니다. 값은 음수가 아닌 값입니다.

historicTrafficTravelTimeInSeconds

integer

시간 종속 기록 트래픽 데이터를 사용하여 계산된 예상 이동 시간입니다. computeTravelTimeFor = 모든 가 쿼리에 사용되는 경우에만 포함됩니다.

lengthInMeters

integer

Length In 미터 속성

liveTrafficIncidentsTravelTimeInSeconds

integer

실시간 속도 데이터를 사용하여 계산된 예상 이동 시간입니다. computeTravelTimeFor = 모든 가 쿼리에 사용되는 경우에만 포함됩니다.

noTrafficTravelTimeInSeconds

integer

교통 상황(예: 혼잡)으로 인해 경로에 지연이 없는 것처럼 계산된 예상 이동 시간입니다. computeTravelTimeFor = 모든 가 쿼리에 사용되는 경우에만 포함됩니다.

trafficDelayInSeconds

integer

트래픽 정보에 따른 실시간 인시던트로 인한 예상 지연 시간(초)입니다. 향후 출발 시간으로 계획된 경로의 경우 지연은 항상 0입니다. 다양한 유형의 트래픽 정보를 사용하여 추가 이동 시간을 반환하려면 computeTravelTimeFor=all 매개 변수를 추가해야 합니다.

travelTimeInSeconds

integer

실시간 트래픽으로 인한 지연을 포함하는 예상 이동 시간(초) 속성입니다. traffic=false travelTimeInSeconds에도 트래픽으로 인한 지연이 계속 포함됩니다. DepartAt가 향후에 있는 경우 시간 종속 기록 트래픽 데이터를 사용하여 이동 시간을 계산합니다.

RouteOptimizedWaypoint

최적화된 방법 지점 개체입니다.

Name 형식 Description
optimizedIndex

integer

시스템에서 최적화된 방법 지점 인덱스입니다.

providedIndex

integer

사용자가 제공하는 방법 지점 인덱스입니다.

RouteReport

현재 호출에 사용된 유효 설정을 보고합니다.

Name 형식 Description
effectiveSettings

EffectiveSetting[]

이 Route API를 호출할 때 사용되는 유효 매개 변수 또는 데이터입니다.

RouteSection

경로 섹션에는 경로의 일부에 대한 추가 정보가 포함되어 있습니다. 각 섹션에는 최소한 , endPointIndexsectionType요소가 startPointIndex포함됩니다.

Name 형식 Description
delayInSeconds

integer

인시던트로 인한 지연 시간(초)입니다.

effectiveSpeedInKmh

integer

인시던트 유효 속도(km/h)는 전체 길이에 걸쳐 평균됩니다.

endPointIndex

integer

이 섹션이 적용되는 경로의 마지막 점(오프셋 0)의 인덱스입니다.

magnitudeOfDelay

DelayMagnitude

인시던트로 인한 지연의 크기입니다. 이러한 값은 트래픽 인시던트 가져오기 세부 정보 API의 응답 필드 ty 값에 해당합니다.

sectionType

ResponseSectionType

보고된 경로 응답의 섹션 유형

simpleCategory

SimpleCategory

인시던트 유형입니다. 현재 JAM, ROAD_WORK, ROAD_CLOSURE 또는 기타일 수 있습니다. 자세한 내용은 "tec"을 참조하세요.

startPointIndex

integer

이 섹션이 적용되는 경로의 첫 번째 점(오프셋 0)의 인덱스입니다.

tec

RouteSectionTec

TPEG2-TEC 표준의 정의를 사용하여 트래픽 이벤트에 대한 세부 정보입니다. effectCode를 포함할 수 있으며 요소를 발생합니다.

travelMode

ResponseTravelMode

계산된 경로의 이동 모드입니다. 이 섹션에서 요청된 전송 모드를 사용할 수 없는 경우 값이 로 설정 other 됩니다.

RouteSectionTec

TPEG2-TEC 표준의 정의를 사용하여 트래픽 이벤트에 대한 세부 정보입니다. effectCode를 포함할 수 있으며 요소를 발생합니다.

Name 형식 Description
causes

RouteSectionTecCause[]

배열의 원인

effectCode

integer

트래픽 흐름에 미치는 영향입니다. TPEG2-TEC 표준에 정의된 대로 tec001:EffectCode 테이블에 값을 포함합니다. 심각도에 따라 트래픽 이벤트를 색으로 코딩하는 데 사용할 수 있습니다.

RouteSectionTecCause

트래픽 이벤트의 원인입니다. mainCauseCode 및 subCauseCode 요소를 포함할 수 있습니다. 아이콘 및 설명을 정의하는 데 사용할 수 있습니다.

Name 형식 Description
mainCauseCode

integer

트래픽 이벤트의 기본 원인입니다. TPEG2-TEC 표준에 정의된 대로 tec002:CauseCode 테이블에 값을 포함합니다.

subCauseCode

integer

트래픽 이벤트의 하위 이벤트입니다. TPEG2-TEC 표준에 정의된 대로 mainCauseCode에 의해 정의된 하위 원인 테이블의 값을 포함합니다.

RouteSummary

요약 개체

Name 형식 Description
arrivalTime

string

경로 또는 다리의 예상 도착 시간입니다. 시간은 UTC입니다.

departureTime

string

경로 또는 다리의 예상 출발 시간입니다. 시간은 UTC입니다.

lengthInMeters

integer

Length In 미터 속성

trafficDelayInSeconds

integer

트래픽 정보에 따른 실시간 인시던트로 인한 예상 지연 시간(초)입니다. 향후 출발 시간으로 계획된 경로의 경우 지연은 항상 0입니다. 다양한 유형의 트래픽 정보를 사용하여 추가 이동 시간을 반환하려면 computeTravelTimeFor=all 매개 변수를 추가해야 합니다.

travelTimeInSeconds

integer

실시간 트래픽으로 인한 지연을 포함하는 예상 이동 시간(초) 속성입니다. traffic=false travelTimeInSeconds에도 트래픽으로 인한 지연이 계속 포함됩니다. DepartAt가 향후에 있는 경우 시간 종속 기록 트래픽 데이터를 사용하여 이동 시간을 계산합니다.

SimpleCategory

인시던트 유형입니다. 현재 JAM, ROAD_WORK, ROAD_CLOSURE 또는 기타일 수 있습니다. 자세한 내용은 "tec"을 참조하세요.

Name 형식 Description
JAM

string

교통 체증.

OTHER

string

기타.

ROAD_CLOSURE

string

도로 폐쇄.

ROAD_WORK

string

도로 작업.

Summary

일괄 처리 요청에 대한 결과 요약

Name 형식 Description
successfulRequests

integer

일괄 처리에서 성공한 요청 수

totalRequests

integer

일괄 처리의 총 요청 수