Search - Get Search Address Reverse Batch
단일 비동기 요청에서 검색 주소 역방향 API에 쿼리 일괄 처리를 보내는 데 사용합니다.
Get Search Address Reverse Batch API는 단일 비동기 API 호출에서 GET API에 쿼리 일괄 처리를 보내는 HTTP 요청입니다.
Get Search Address Reverse Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 10,000개의 쿼리를 일괄 처리하고 최대 100개의 쿼리까지 API를 동기화할 수 있습니다.
동기 일괄 처리 요청 제출
간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.
POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
비동기 일괄 처리 요청 제출
비동기 API는 비교적 복잡한 검색 요청의 큰 볼륨을 처리하는 데 적합합니다.
- 별도의 호출로 결과를 검색할 수 있습니다(여러 다운로드 가능).
- 비동기 API는 안정성에 최적화되어 있으며 시간 제한으로 실행되지 않을 것으로 예상됩니다.
- 일괄 처리 항목 수는 이 API에 대해 10,000개의 제한됩니다.
비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 비동기 응답은 14일 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.
비동기 일괄 처리 요청은 장기 실행 작업입니다. 일반적인 작업 시퀀스는 다음과 같습니다.
- 클라이언트는 Azure Maps에 검색 주소 역방향 일괄 처리
POST요청을 보냅니다.
POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}
서버는 다음 중 하나로 응답합니다.
HTTP
202 Accepted- Batch 요청이 수락되었습니다.HTTP
Error- Batch 요청을 처리하는 동안 오류가 발생했습니다.400 Bad Request또는 다른Error상태 코드일 수 있습니다.일괄 처리 요청이 성공적으로 수락된 경우 응답의
Location헤더에는 일괄 처리 요청의 결과를 다운로드하는 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.
GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- 클라이언트는 3단계에서 가져온
GET요청을 실행하여 일괄 처리 결과를 다운로드합니다.
Batch 요청에 대한 POST 본문
검색 주소 역방향 쿼리를 보내려면 요청 본문에 POST 형식의 batchItems 배열이 포함되고 json 헤더가 Content-Type설정되는 application/json 요청을 사용합니다. 다음은 5개의 검색 주소 역방향 쿼리를 포함하는 샘플 요청 본문입니다.
{
"batchItems": [
{"query": "?query=48.858561,2.294911"},
{"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
{"query": "?query=47.621028,-122.348170"},
{"query": "?query=43.722990,10.396695"},
{"query": "?query=40.750958,-73.982336"}
]
}
일괄 처리의 검색 주소 역방향 쿼리는 프로토콜, 기본 URL, 경로, api-version 및 subscription-key를 않고 부분 URL. 지원되는 검색 주소 역방향URI 매개 변수수락할 수 있습니다. 검색 주소 역방향 쿼리의 문자열 값은 올바르게 이스케이프되어야 하며(예: " 문자는 \로 이스케이프되어야 함) URL로 인코딩되어야 합니다.
비동기 API를 사용하면 호출자가 최대 10,000개의 쿼리를 일괄 처리하고 최대 100개의 쿼리를 동기화할 수 있으며, 일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.
비동기 일괄 처리 결과 다운로드
비동기 일괄 처리 결과를 다운로드하려면 일괄 다운로드 엔드포인트에 GET 요청을 실행합니다. 이 다운로드 URL 성공적인 Location 일괄 처리 요청의 POST 헤더에서 가져올 수 있으며 다음과 같습니다.
https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
일괄 처리 결과를 다운로드하기 위한 일반적인 작업 시퀀스는 다음과 같습니다.
클라이언트는
GET사용하여 요청을 보냅니다.서버는 다음 중 하나로 응답합니다.
HTTP
202 Accepted- Batch 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.HTTP
200 OK- 일괄 처리 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 일괄 처리 결과가 포함됩니다.
Batch 응답 모델
반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다.
batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다.
batchItems 각 항목에는 statusCode 및 response 필드가 포함됩니다.
response 각 batchItems 다음 유형 중 하나입니다.
SearchAddressReverseResponse- 쿼리가 성공적으로 완료된 경우Error- 쿼리가 실패한 경우 응답에는 이 경우code및message포함됩니다.
다음은 2개 성공한 및 1개 실패한 결과에 대한 샘플 Batch 응답입니다.
{
"summary": {
"successfulRequests": 2,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response":
{
"summary": {
"queryTime": 11
},
"addresses": [
{
"address": {
"country": "France",
"freeformAddress": "Avenue Anatole France, 75007 Paris"
},
"position": "48.858490,2.294820"
}
]
}
},
{
"statusCode": 200,
"response":
{
"summary": {
"queryTime": 1
},
"addresses": [
{
"address": {
"country": "United States of America",
"freeformAddress": "157th Pl NE, Redmond WA 98052"
},
"position": "47.640470,-122.129430"
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
format
|
path | True |
string |
작업을 쿼리하기 위한 일괄 처리 ID입니다. |
|
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 보안을 사용하는 방법에 대한 자세한 내용은 Azure Maps에서 인증 관리를 참조하세요. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
그래 |
|
| 202 Accepted |
비동기 요청에 대해서만 지원됩니다. 수락된 요청: 처리를 위해 요청이 수락되었습니다. 위치 헤더의 URL을 사용하여 결과를 다시 시도하거나 액세스하세요. 헤더 Location: string |
|
| Other Status Codes |
예기치 않은 오류가 발생했습니다. |
보안
AADToken
다음은 Microsoft Entra OAuth 2.0 흐름에
시나리오를 구현하려면
메모
- 이 보안 정의
x-ms-client-id헤더를 사용하여 애플리케이션이 액세스를 요청하는 Azure Maps 리소스를 나타내야 합니다. 이는 Maps 관리 API에서 가져올 수 있습니다. -
Authorization URLAzure 퍼블릭 클라우드 인스턴스와 관련이 있습니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다. - Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해
Azure 관리 평면에서 구성됩니다. - Azure Maps Web SDK 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.
- Microsoft ID 플랫폼에 대한 자세한 내용은 Microsoft ID 플랫폼 개요참조하세요.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Azure Portal에서 Azure Maps 계정 만들거나 PowerShell, CLI, Azure SDK 또는 REST API를 사용할 때 프로비전되는 공유 키입니다.
이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있습니다. 즉, 이 키를 발급된 계정에서 마스터 키로 사용할 수 있습니다.
공개적으로 노출된 애플리케이션의 경우 키를 안전하게 저장할 수 있도록 기밀 클라이언트 애플리케이션 접근 방식을 사용하여 Azure Maps REST API에 액세스하는 것이 좋습니다.
형식:
apiKey
In(다음 안에):
query
SAS Token
공유 액세스 서명 토큰은 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해
이 토큰을 사용하면 모든 애플리케이션이 Azure 역할 기반 액세스 제어를 사용하여 액세스하고 특정 토큰에 사용할 만료, 속도 및 지역에 대한 세분화된 제어 권한을 부여받습니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.
공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 맵 계정 리소스 허용된 원본의 특정 목록을 구성하는 것이 좋습니다.
형식:
apiKey
In(다음 안에):
header
예제
A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries
샘플 요청
GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0
샘플 응답
{
"summary": {
"successfulRequests": 3,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response": {
"summary": {
"queryTime": 8,
"numResults": 1
},
"addresses": [
{
"address": {
"streetNumber": "7",
"routeNumbers": [],
"streetName": "Avenue Anatole France",
"streetNameAndNumber": "7 Avenue Anatole France",
"countryCode": "FR",
"countrySubdivisionCode": "Île-de-France",
"countrySecondarySubdivision": "Paris",
"municipality": "Paris",
"postalCode": "75007",
"municipalitySubdivision": "7ème Arrondissement",
"country": "France",
"countryCodeISO3": "FRA",
"freeformAddress": "7 Avenue Anatole France, Paris, 75007",
"boundingBox": {
"northEast": "48.858321,2.295167",
"southWest": "48.858136,2.295027",
"entity": "position"
}
},
"position": "48.858231,2.295089"
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"queryTime": 8,
"numResults": 1
},
"addresses": [
{
"address": {
"routeNumbers": [],
"countryCode": "US",
"countrySubdivisionCode": "WA",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"municipality": "Redmond",
"postalCode": "98052",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Redmond, WA 98052",
"boundingBox": {
"northEast": "47.639765,-122.128661",
"southWest": "47.639502,-122.129456",
"entity": "position"
},
"countrySubdivisionName": "Washington"
},
"position": "47.639687,-122.128677"
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"queryTime": 19,
"numResults": 1
},
"addresses": [
{
"address": {
"streetNumber": "410",
"routeNumbers": [],
"streetName": "Thomas Street",
"streetNameAndNumber": "410 Thomas Street",
"countryCode": "US",
"countrySubdivisionCode": "WA",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"municipality": "Seattle",
"postalCode": "98109",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "410 Thomas Street, Seattle, WA 98109",
"boundingBox": {
"northEast": "47.620954,-122.347601",
"southWest": "47.620944,-122.348498",
"entity": "position"
},
"extendedPostalCode": "981094621",
"countrySubdivisionName": "Washington"
},
"position": "47.620945,-122.348175"
}
]
}
}
]
}
정의
| Name | Description |
|---|---|
| Address |
결과의 주소입니다. |
|
Address |
검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다. |
|
Bounding |
뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다. |
|
Bounding |
위치의 경계 상자입니다. |
| Brand |
POI와 연결된 브랜드 |
| Classification |
반환되는 POI에 대한 분류 |
|
Classification |
분류의 이름 |
|
Data |
선택적 섹션입니다. 검색 다각형 API 가져오기 사용할 참조 ID입니다. |
| Entity |
경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다. |
|
Entry |
반환되는 POI의 진입점입니다. |
|
Entry |
진입점의 형식입니다. 값은 주 또는 부 수 있습니다. |
|
Error |
리소스 관리 오류 추가 정보입니다. |
|
Error |
오류 세부 정보입니다. |
|
Error |
오류 응답 |
|
Geographic |
Geography 엔터티 형식입니다. entityType이 요청되어 사용 가능한 경우에만 표시됩니다. |
| Geometry |
결과의 기하학적 모양에 대한 정보입니다. == Geography 형식인 경우에만 존재합니다. |
|
Lat |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
|
Match |
역방향 주소 검색 작업에 대한 일치 유형입니다. |
|
Operating |
POI의 영업 시간(관심 지점). |
|
Operating |
날짜 및 시간을 나타냅니다. |
|
Operating |
하루의 여는 시간 범위 |
|
Point |
이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다. |
|
Point |
POI 범주 |
|
Query |
반환되는 쿼리 유형: NEARBY 또는 NON_NEAR. 중요: 이 특성은 폐기되었으며 답변에서 생략될 수 있습니다. |
| Response |
쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 SearchAddressResult, 그렇지 않으면 ErrorResponse입니다. |
|
Reverse |
검색 주소 역방향 Batch 서비스 호출에서 반환된 항목입니다. |
|
Reverse |
이 개체는 검색 주소 역방향 Batch 서비스 호출에서 반환됩니다. |
|
Search |
Search API 응답에 대한 결과 개체입니다. |
|
Search |
다음 중 하나입니다.
|
|
Search |
Search API 응답에 대한 요약 개체입니다. |
| Summary |
일괄 처리 요청에 대한 결과 요약 |
Address
결과의 주소입니다.
| Name | 형식 | Description |
|---|---|---|
| boundingBox |
위치의 경계 상자를 정의합니다. 이 속성은 검색 주소 역방향 API에서만 반환됩니다. 다른 모든 검색 API는 개체의 속성을 반환 |
|
| buildingNumber |
string |
거리의 건물 번호입니다.
중요: 이 속성은 더 이상 사용되지 않습니다.
|
| country |
string |
국가/지역 이름. |
| countryCode |
string |
ISO 3166-1 Alpha-2 표준에서 국가/지역과 종속 영토를 나타내기 위해 정의된 두 글자 알파벳 코드입니다. |
| countryCodeISO3 |
string |
ISO 3166-1 알파-3 표준에 의해 국가/지역과 종속 영토를 나타내기 위해 정의된 세 글자 알파벳 코드입니다. |
| countrySecondarySubdivision |
string |
국가/지역 내의 2단계 행정 구역입니다. 이는 주 또는 주(province)와 같이 주요 하위 구분보다 낮고, 지방자치단체나 이웃과 같은 작은 단위보다 위에 있는 하위 구역을 의미합니다. 예로는 미국의 카운티 와 영국의 디스트릭 트가 있습니다. |
| countrySubdivision |
string |
국가 내의 주요 행정 구역, 예를 들어 주, 주. 이는 국가 수준 이하의 1급 하위 구역을 나타내는 데 사용됩니다. |
| countrySubdivisionCode |
string |
이 속성은 그리고 |
| countrySubdivisionName |
string |
국가 또는 지역 내 1차 행정 구역(예: 주, 도, 지역)의 전체 명칭을 나타냅니다. 이 특성은 축약된 형태로 제공될 때 |
| countryTertiarySubdivision |
string |
국가/지역 내의 3단계 행정 구역입니다. 이는 카운티나 구역과 같은 2차 세분화보다도 더 세분화된 정보를 제공합니다. 예로는 시, 마을, 마을, 자치구, 타운십과 같은 지방자치단체와 시애틀의 캐피톨 힐, 그린 레이크, 월링포드와 같이 지방 자치단체 내의 더 작고 비공식적인 지리적 구역인 이웃 단위가 있습니다. |
| crossStreet |
string |
교차되는 거리의 이름입니다. 이 속성은 API에서만 |
| extendedPostalCode |
string |
확장 우편번호는 표준 숫자 집합을 넘어 더 높은 위치 정밀도를 제공하는 우편번호 형식을 의미합니다. 이 코드는 U.S. ZIP+4 코드나 유사한 확장 형식과 같은 다른 국가/지역에서 흔히 사용됩니다. 이용 가능성은 지역에 따라 다릅니다. API에서는 |
| freeformAddress |
string |
결과의 출신 국가/지역, 또는 국가/지역의 경우 전체 국가/지역 이름에 따라 포맷된 주소 라인입니다. |
| localName |
string |
관리 단위가 아닌 주소 지정을 위해 주소 지정 가능한 여러 개체를 그룹화한 지리적 영역 또는 지역 이름을 나타내는 주소 구성 요소입니다. 이 필드는 |
| municipality |
string |
도시 / 마을 |
| municipalitySubdivision |
string |
자치체 내의 하위 구역입니다. 이는 도시, 마을 또는 기타 지방 자치 단체 내에서 더 작은 행정 또는 지리적 단위를 나타냅니다. |
| neighbourhood |
string |
이웃은 독특한 특성과 주민 간의 사회적 상호 작용을 가진 도시 또는 마을 내에서 지리적으로 지역화 된 지역입니다. |
| postalCode |
string |
특정 지리적 지역을 식별하는 데 도움을 주기 위해 주소에 숫자나 글자(또는 둘 다)를 추가하는 것. 우편번호는 미국에서 우편번호의 버전이며, 다른 국가나 지역에서는 우편번호, PIN 코드, PLZ 등 다른 형식을 사용합니다. |
| routeNumbers |
string[] |
도로를 명확히 식별하는 데 사용된 코드들. 검색 주소 역방향 API에만 사용할 수 있습니다. |
| street |
string |
거리 이름입니다.
중요: 이 속성은 더 이상 사용되지 않습니다.
|
| streetName |
string |
거리 이름입니다. |
| streetNameAndNumber |
string |
거리 이름 및 번호입니다. 검색 주소 역방향 API에만 사용할 수 있습니다. |
| streetNumber |
string |
거리의 건물 번호입니다. API에서는 |
AddressRanges
검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다.
| Name | 형식 | Description |
|---|---|---|
| from |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
|
| rangeLeft |
string |
거리의 왼쪽에 있는 주소 범위입니다. |
| rangeRight |
string |
거리의 오른쪽에 있는 주소 범위입니다. |
| to |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
BoundingBox
뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다.
| Name | 형식 | Description |
|---|---|---|
| btmRightPoint |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
|
| topLeftPoint |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
BoundingBoxCompassNotation
위치의 경계 상자입니다.
| Name | 형식 | Description |
|---|---|---|
| entity |
경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다. |
|
| northEast |
string |
북동 위도, 경계 상자의 경도 좌표(쉼표로 구분된 부동 소수로) |
| southWest |
string |
남서 위도, 경계 상자의 경도 좌표(쉼표로 구분된 부동 소수로) |
Brand
POI와 연결된 브랜드
| Name | 형식 | Description |
|---|---|---|
| name |
string |
브랜드 이름 |
Classification
반환되는 POI에 대한 분류
| Name | 형식 | Description |
|---|---|---|
| code |
string |
코드 속성 |
| names |
이름 배열 |
ClassificationName
분류의 이름
| Name | 형식 | Description |
|---|---|---|
| name |
string |
Name 속성 |
| nameLocale |
string |
Name Locale 속성 |
DataSources
선택적 섹션입니다. 검색 다각형 API 가져오기 사용할 참조 ID입니다.
| Name | 형식 | Description |
|---|---|---|
| geometry |
결과의 기하학적 모양에 대한 정보입니다. == Geography 형식인 경우에만 존재합니다. |
Entity
경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다.
| 값 | Description |
|---|---|
| position |
위치 엔터티 |
EntryPoint
반환되는 POI의 진입점입니다.
| Name | 형식 | Description |
|---|---|---|
| position |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
|
| type |
진입점의 형식입니다. 값은 주 또는 부 수 있습니다. |
EntryPointType
진입점의 형식입니다. 값은 주 또는 부 수 있습니다.
| 값 | Description |
|---|---|
| main | |
| minor |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| info |
object |
추가 정보입니다. |
| type |
string |
추가 정보 유형입니다. |
ErrorDetail
오류 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| additionalInfo |
오류 추가 정보입니다. |
|
| code |
string |
오류 코드입니다. |
| details |
오류 세부 정보입니다. |
|
| message |
string |
오류 메시지입니다. |
| target |
string |
오류 대상입니다. |
ErrorResponse
오류 응답
| Name | 형식 | Description |
|---|---|---|
| error |
오류 개체입니다. |
GeographicEntityType
Geography 엔터티 형식입니다. entityType이 요청되어 사용 가능한 경우에만 표시됩니다.
| 값 | Description |
|---|---|
| Country |
국가/지역 이름 |
| CountrySubdivision |
주 또는 도 |
| CountrySecondarySubdivision |
군 |
| CountryTertiarySubdivision |
명명된 영역 |
| Municipality |
도시 / 마을 |
| MunicipalitySubdivision |
서브/슈퍼 시티 |
| Neighbourhood |
지역 |
| PostalCodeArea |
우편 번호 / 우편 번호 |
Geometry
결과의 기하학적 모양에 대한 정보입니다. == Geography 형식인 경우에만 존재합니다.
| Name | 형식 | Description |
|---|---|---|
| id |
string |
이 결과를 위해 기하 도형 정보를 가져오는 검색 다각형 API에 geometryId로 전달합니다. |
LatLongPairAbbreviated
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.
| Name | 형식 | Description |
|---|---|---|
| lat |
number (double) |
위도 속성 |
| lon |
number (double) |
경도 속성 |
MatchType
역방향 주소 검색 작업에 대한 일치 유형입니다.
| 값 | Description |
|---|---|
| AddressPoint | |
| HouseNumberRange | |
| Street |
OperatingHours
POI의 영업 시간(관심 지점).
| Name | 형식 | Description |
|---|---|---|
| mode |
string |
요청에 사용된 값: none 또는 "nextSevenDays" |
| timeRanges |
다음 7일 동안의 시간 범위 목록 |
OperatingHoursTime
날짜 및 시간을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| date |
string |
POI 표준 시간대의 현재 달력 날짜(예: "2019-02-07")를 나타냅니다. |
| hour |
integer |
시간은 POI의 현지 시간에 24시간 형식입니다. 가능한 값은 0 - 23입니다. |
| minute |
integer |
분은 POI의 현지 시간에 있습니다. 가능한 값은 0 - 59입니다. |
OperatingHoursTimeRange
하루의 여는 시간 범위
| Name | 형식 | Description |
|---|---|---|
| endTime |
지정된 POI를 닫을 때 다음 7일 범위의 지점이거나 범위 이전에 닫힌 경우 범위의 시작점입니다. |
|
| startTime |
지정된 POI를 열 때 다음 7일 범위의 지점이거나 범위 이전에 열린 경우 범위의 시작점입니다. |
PointOfInterest
이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| brands |
Brand[] |
브랜드 배열입니다. 반환되는 POI의 브랜드 이름입니다. |
| categories |
string[] |
범주 배열 |
| categorySet |
가장 구체적인 POI 범주 목록 |
|
| classifications |
분류 배열 |
|
| name |
string |
POI 속성의 이름 |
| openingHours |
POI의 영업 시간(관심 지점). |
|
| phone |
string |
전화 번호 속성 |
| url |
string |
웹 사이트 URL 속성 |
PointOfInterestCategorySet
POI 범주
| Name | 형식 | Description |
|---|---|---|
| id |
integer |
범주 ID |
QueryType
반환되는 쿼리 유형: NEARBY 또는 NON_NEAR.
중요: 이 특성은 폐기되었으며 답변에서 생략될 수 있습니다.
| 값 | Description |
|---|---|
| NEARBY |
수색은 특정 위도와 경도를 중심으로 반경이 정해진 곳에서 수행되었습니다. |
| NON_NEAR |
검색은 특정 위도 및 경도에 편향되지 않고 전역적으로 수행되었으며 정의된 반경이 없습니다. |
Response
쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 SearchAddressResult, 그렇지 않으면 ErrorResponse입니다.
| Name | 형식 | Description |
|---|---|---|
| error |
오류 개체입니다. |
|
| results |
검색 API 결과 목록입니다. |
|
| summary |
Search API 응답에 대한 요약 개체 |
ReverseSearchAddressBatchItem
검색 주소 역방향 Batch 서비스 호출에서 반환된 항목입니다.
| Name | 형식 | Description |
|---|---|---|
| response |
쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 SearchAddressReverseResponse, 그렇지 않으면 ErrorResponse입니다. |
|
| statusCode |
integer |
HTTP 요청 상태 코드입니다. |
ReverseSearchAddressBatchProcessResult
이 개체는 검색 주소 역방향 Batch 서비스 호출에서 반환됩니다.
| Name | 형식 | Description |
|---|---|---|
| batchItems |
일괄 처리 결과를 포함하는 배열입니다. |
|
| summary |
일괄 처리 요청에 대한 결과 요약 |
SearchAddressResultItem
Search API 응답에 대한 결과 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| address |
결과의 주소입니다. |
|
| addressRanges |
검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다. |
|
| dataSources |
선택적 섹션입니다. Get Search 다각형 API와 함께 사용할 기하 도형 ID를 참조합니다. |
|
| detourTime |
integer |
우회 시간(초)입니다. 경로 API를 따라 검색에 대한 호출에 대해서만 반환됩니다. |
| dist |
number (double) |
결과와 지오비아 위치 사이의 직선 거리(미터)입니다. |
| entityType |
Geography 엔터티 형식입니다. entityType이 요청되어 사용 가능한 경우에만 표시됩니다. |
|
| entryPoints |
EntryPoint의 배열입니다. 이들은 위치에서 사용할 수있는 입구의 유형을 설명합니다. 이 유형은 정문 또는 로비와 같은 정문의 경우 "main"이고 측면 및 뒷문의 경우 "부"일 수 있습니다. |
|
| id |
string |
Id 속성 |
| info |
string |
결과의 원래 데이터 원본에 대한 정보입니다. 지원 요청에 사용됩니다. |
| matchType |
일치 유형에 대한 정보입니다. 다음 중 하나입니다.
|
|
| poi |
이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다. |
|
| position |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
|
| score |
number (double) |
결과 집합 내의 값으로, 결과 간의 상대 일치 점수를 나타냅니다. x 값이 y 값의 2배인 경우 결과 x가 결과 y보다 두 배 더 관련성이 있다고 판단하는 데 사용할 수 있습니다. 값은 쿼리마다 다르며 하나의 결과 집합에 대한 상대 값으로만 사용됩니다. 중요: 이 특성은 폐기되었으며 답변에서 생략될 수 있습니다. |
| type |
다음 중 하나입니다.
|
|
| viewport |
뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다. |
SearchAddressResultType
다음 중 하나입니다.
- POI
- 거리
- 지리학
- 지점 주소
- 주소 범위
- 교차로
| 값 | Description |
|---|---|
| POI | |
| Street | |
| Geography | |
| Point Address | |
| Address Range | |
| Cross Street |
SearchSummary
Search API 응답에 대한 요약 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| fuzzyLevel |
integer |
결과를 제공하는 데 필요한 최대 유사 항목 수준입니다. |
| geoBias |
내부 검색 엔진이 지리 공간적 편향을 적용하여 결과 순위를 향상한 경우를 나타냅니다. 일부 메서드에서는 사용 가능한 경우 위도 및 lon 매개 변수를 설정하여 영향을 받을 수 있습니다. 다른 경우에는 순전히 내부입니다. |
|
| limit |
integer |
반환될 최대 응답 수 |
| numResults |
integer |
응답의 결과 수입니다. |
| offset |
integer |
전체 결과 집합 내에서 반환된 결과의 시작 오프셋입니다. |
| query |
string |
이러한 검색 결과를 생성하는 데 사용된 쿼리 매개 변수입니다. |
| queryTime |
integer |
쿼리를 확인하는 데 소요된 시간(밀리초)입니다. |
| queryType |
반환되는 쿼리 유형: NEARBY 또는 NON_NEAR. 중요: 이 특성은 폐기되었으며 답변에서 생략될 수 있습니다. |
|
| totalResults |
integer |
찾은 총 결과 수입니다. |
Summary
일괄 처리 요청에 대한 결과 요약
| Name | 형식 | Description |
|---|---|---|
| successfulRequests |
integer |
일괄 처리에서 성공한 요청 수 |
| totalRequests |
integer |
일괄 처리의 총 요청 수 |