- HTTP 요청
- 요청 본문
- 응답 본문
- RouteMatrixOrigin
- RouteMatrixDestination
- ExtraComputation
- RouteMatrixElementCondition
- LocalizedValues
출발지 및 목적지 목록을 사용하고 출발지와 목적지의 각 조합에 대한 경로 정보가 포함된 스트림을 반환합니다.
참고: 이 메서드를 사용하려면 입력에 응답 필드 마스크를 지정해야 합니다. URL 매개변수 $fields
또는 fields
를 사용하거나 HTTP/gRPC 헤더 X-Goog-FieldMask
를 사용하여 응답 필드 마스크를 제공할 수 있습니다 (사용 가능한 URL 매개변수 및 헤더 참고). 값은 필드 경로의 쉼표로 구분된 목록입니다. 필드 경로를 구성하는 방법에 관한 자세한 문서를 참고하세요.
예를 들어 다음 메서드에서
- 사용 가능한 모든 필드의 필드 마스크 (수동 검사용):
X-Goog-FieldMask: *
- 경로 시간, 거리, 요소 상태, 조건, 요소 색인의 필드 마스크 (프로덕션 설정 예시):
X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration
필드 마스크에 status
를 포함해야 합니다. 그렇지 않으면 모든 메시지가 정상적으로 표시됩니다. 와일드 카드 (*
) 응답 필드 마스크는 다음과 같은 이유로 권장되지 않습니다.
- 필요한 필드만 선택하면 서버에서 계산 주기를 절약하여 지연 시간을 줄여 결과를 반환할 수 있습니다.
- 프로덕션 작업에 필요한 필드만 선택하면 안정적인 지연 시간 성능을 보장할 수 있습니다. 향후 응답 필드가 추가될 수 있으며, 이러한 새 필드에는 추가 계산 시간이 필요할 수 있습니다. 모든 필드를 선택하거나 최상위 수준에서 모든 필드를 선택하면 추가된 새 필드가 응답에 자동으로 포함되므로 성능이 저하될 수 있습니다.
- 필요한 필드만 선택하면 응답 크기가 줄어들어 네트워크 처리량이 증가합니다.
HTTP 요청
POST https://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix
URL은 gRPC 트랜스코딩 구문을 사용합니다.
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{ "origins": [ { object ( |
필드 | |
---|---|
origins[] |
필수 항목입니다. 응답 행렬의 행을 결정하는 출처 배열입니다. 출처 및 대상의 카디널리티에는 여러 크기 제한사항이 적용됩니다.
|
destinations[] |
필수 항목입니다. 응답 행렬의 열을 결정하는 대상 배열입니다. |
travel |
선택사항입니다. 이동수단을 지정합니다. |
routing |
선택사항입니다. 경로를 계산하는 방법을 지정합니다. 서버는 선택한 라우팅 환경설정을 사용하여 경로를 계산하려고 시도합니다. 라우팅 환경설정으로 인해 오류가 발생하거나 지연 시간이 너무 길어지면 오류가 반환됩니다. |
departure |
선택사항입니다. 출발 시간입니다. 이 값을 설정하지 않으면 기본값은 요청한 시간입니다. 참고: RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
arrival |
선택사항입니다. 도착 시간입니다. 참고: RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
language |
선택사항입니다. BCP-47 언어 코드(예: 'en-US' 또는 'sr-Latn') 자세한 내용은 유니코드 언어 ID를 참고하세요. 지원되는 언어 목록은 언어 지원을 참고하세요. 이 값을 제공하지 않으면 표시 언어가 첫 번째 출처의 위치에서 추론됩니다. |
region |
선택사항입니다. ccTLD ('최상위 도메인') 두 문자 값으로 지정된 지역 코드입니다. 자세한 내용은 국가 코드 최상위 도메인을 참고하세요. |
units |
선택사항입니다. 표시 필드의 측정 단위를 지정합니다. |
extra |
선택사항입니다. 요청을 완료하는 데 사용할 수 있는 추가 계산 목록입니다. 참고: 이러한 추가 계산으로 인해 응답에 추가 필드가 반환될 수 있습니다. 이러한 추가 필드는 응답에 반환되도록 필드 마스크에 지정되어야 합니다. |
traffic |
선택사항입니다. 교통량을 고려한 시간을 계산할 때 사용할 가정을 지정합니다. 이 설정은 |
transit |
선택사항입니다. |
응답 본문
v2.computeRouteMatrix API의 출발지/도착지 쌍에 대해 계산된 경로 정보를 포함합니다. 이 프로토는 클라이언트로 스트리밍할 수 있습니다.
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
JSON 표현 |
---|
{ "status": { object ( |
필드 | |
---|---|
status |
이 요소의 오류 상태 코드입니다. |
condition |
경로를 찾았는지 여부를 나타냅니다. 상태와 관계없습니다. |
distance |
경로의 이동 거리(미터)입니다. |
duration |
경로를 탐색하는 데 걸리는 시간입니다. 소수점 아래가 최대 9자리까지이고 ' |
static |
교통상황을 고려하지 않고 경로를 통과하는 데 걸리는 시간입니다. 소수점 아래가 최대 9자리까지이고 ' |
travel |
경로에 대한 추가 정보입니다. 예: 제한사항 정보 및 통행료 정보 |
fallback |
서버가 이 특정 출발지/도착지 쌍에 대해 지정된 환경설정으로 경로를 계산할 수 없는 경우 다른 계산 모드를 사용하도록 대체할 수 있습니다. 대체 모드가 사용되면 이 필드에 대체 응답에 관한 자세한 정보가 포함됩니다. 그렇지 않으면 이 필드는 설정되지 않습니다. |
localized |
|
origin |
요청에서 0부터 시작하는 출처 색인입니다. |
destination |
요청에서 대상의 0부터 시작하는 색인입니다. |
RouteMatrixOrigin
ComputeRouteMatrixRequest의 단일 출처
JSON 표현 |
---|
{ "waypoint": { object ( |
필드 | |
---|---|
waypoint |
필수 항목입니다. 출발 경유지 |
route |
선택사항입니다. 이를 출발지로 사용하는 모든 경로의 수정자 |
RouteMatrixDestination
ComputeRouteMatrixRequest의 단일 대상
JSON 표현 |
---|
{
"waypoint": {
object ( |
필드 | |
---|---|
waypoint |
필수 항목입니다. 도착 웨이포인트 |
ExtraComputation
요청을 완료하는 동안 실행할 추가 계산입니다.
열거형 | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
사용되지 않음. 이 값이 포함된 요청은 실패합니다. |
TOLLS |
매트릭스 요소의 통행료 정보입니다. |
RouteMatrixElementCondition
반환되는 경로의 조건입니다.
열거형 | |
---|---|
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED |
요소의 status 가 좋지 않은 경우에만 사용됩니다. |
ROUTE_EXISTS |
경로가 발견되었으며 요소에 해당하는 정보가 입력되었습니다. |
ROUTE_NOT_FOUND |
경로를 찾을 수 없습니다. distanceMeters 또는 duration 와 같이 경로 정보가 포함된 필드는 요소에 채워지지 않습니다. |
LocalizedValues
특정 속성의 텍스트 표현입니다.
JSON 표현 |
---|
{ "distance": { object ( |
필드 | |
---|---|
distance |
텍스트 형식으로 표시된 이동 거리입니다. |
duration |
트래픽 상황을 고려하여 텍스트 형식으로 표시된 기간입니다. 참고: 트래픽 정보가 요청되지 않은 경우 이 값은 staticDuration과 동일한 값입니다. |
static |
트래픽 상태를 고려하지 않고 텍스트 형식으로 표시된 시간입니다. |
transit |
텍스트 형식으로 표시된 대중교통 요금입니다. |