Search - Post Search Address Reverse Batch Sync

참조

서비스:: Maps

API 버전:: 1.0

단일 동기 요청에서 Search Address API에 쿼리 일괄 처리를 보내는 데 사용합니다.
Get Search Address Batch API는 단일 동기 API 호출에서 Search Address API에 쿼리 일괄 처리를 보내는 HTTP GET 요청입니다. Search Address Reverse Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 10,000 개의 쿼리를 일괄 처리하고 최대 100 개의 쿼리를 API를 동기화할 수 있습니다.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 동기 API는 요청이 60초보다 오래 걸리는 경우 시간 제한 오류(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 Search 주소 역방향 일괄 처리 POST 요청을 보냅니다.

POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}

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

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

HTTP Error - Batch 요청을 처리하는 동안 오류가 발생했습니다. 이는 또는 다른 Error 상태 코드일 400 Bad Request 수 있습니다.
일괄 처리 요청이 성공적으로 수락된 경우 응답의 Location 헤더에는 일괄 처리 요청의 결과를 다운로드하는 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

클라이언트는 GET 3단계에서 가져온 다운로드 URL 에 대한 요청을 실행하여 일괄 처리 결과를 다운로드합니다.

Batch 요청에 대한 POST 본문

검색 주소 역방향 쿼리를 보내려면 요청 본문에 배열 json 형식이 batchItems 포함되고 Content-Type 헤더가 로 설정application/json되는 요청을 사용합니다POST. 다음은 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 개의 쿼리를 일괄 처리하고 API를 최대 100 개의 쿼리와 동기화할 수 있으며 일괄 처리에는 쿼리가 1 개 이상 포함되어야 합니다.

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

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

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

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

클라이언트는 다운로드 URL을 GET 사용하여 요청을 보냅니다.
서버는 다음 중 하나로 응답합니다.

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

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

일괄 처리 응답 모델

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

SearchAddressReverseResponse - 쿼리가 성공적으로 완료된 경우
Error - 쿼리가 실패한 경우 응답에는 이 경우 및 message 가 포함 code 됩니다.

다음은 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."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/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	ReverseSearchAddressBatchProcessResult	정상
Other Status Codes	ErrorResponse	시간 제한: API에 정의된 최대 시간보다 요청을 완료하는 데 시간이 더 오래 걸렸습니다.
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를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.
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에 액세스할 수 있습니다. 즉, 이 키는 발급된 계정에서 master 키로 사용할 수 있습니다.

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

형식: apiKey
In(다음 안에): query

SAS Token

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

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

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

형식: apiKey
In(다음 안에): header

예제

A Reverse Geocoding Batch API Sync call containing 5 Reverse Geocoding API queries

샘플 요청

HTTP

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=48.858561,2.294911"
    },
    {
      "query": "?query=47.639765,-122.127896&radius=5000&limit=2"
    },
    {
      "query": "?query=47.621028,-122.348170"
    }
  ]
}

샘플 응답

상태 코드:: 200

{
  "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"
          }
        ]
      }
    }
  ]
}

상태 코드:: 408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

정의

Name	Description
Address	결과의 주소
AddressRanges	검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다.
BatchRequest	이 형식은 Batch 서비스에 대한 요청 본문을 나타냅니다.
BatchRequestItem	Batch 요청 개체
BoundingBox	뷰포트의 왼쪽 위 및 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다.
BoundingBoxCompassNotation	위치의 경계 상자입니다.
Brand	POI와 연결된 브랜드
Classification	반환되는 POI에 대한 분류
ClassificationName	분류의 이름
DataSources	선택 단원. Get Search Polygon API에 사용할 참조 ID입니다.
Entity	경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다.
EntryPoint	반환되는 POI의 진입점입니다.
EntryPointType	진입점의 형식입니다. 값은 기본 또는 부 값일 수 있습니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
GeographicEntityType	Geography 엔터티 형식입니다. entityType이 요청되고 사용할 수 있는 경우에만 표시됩니다.
Geometry	결과의 기하학적 모양에 대한 정보입니다. == Geography를 입력하는 경우에만 존재합니다.
JsonFormat	원하는 응답 형식입니다. `json` 형식만 지원됩니다.
LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.
MatchType	역방향 주소 검색 작업에 대한 일치 유형입니다.
OperatingHours	POI의 영업 시간(관심 지점).
OperatingHoursTime	날짜 및 시간을 나타냅니다.
OperatingHoursTimeRange	하루 동안의 여는 시간 범위
PointOfInterest	이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다.
PointOfInterestCategorySet	POI 범주
QueryType	반환되는 쿼리 유형: NEARBY 또는 NON_NEAR.
Response	쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 SearchAddressResult, 그렇지 않으면 ErrorResponse입니다.
ReverseSearchAddressBatchItem	Search 주소 역방향 일괄 처리 서비스 호출에서 반환된 항목입니다.
ReverseSearchAddressBatchProcessResult	이 개체는 주소 역방향 일괄 처리 서비스 호출에 성공한 Search 반환됩니다.
SearchAddressResultItem	Search API 응답에 대한 결과 개체입니다.
SearchAddressResultType	다음 중 하나: 지점 Street Geography 지점 주소 주소 범위 교차로
SearchSummary	Search API 응답에 대한 요약 개체입니다.
Summary	일괄 처리 요청에 대한 결과 요약

Address

결과의 주소

Name	형식	Description
boundingBox	BoundingBoxCompassNotation	위치의 경계 상자입니다.
buildingNumber	string	거리의 건물 번호입니다. 사용되지 않습니다. 대신 streetNumber를 사용합니다.
country	string	국가/지역 이름
countryCode	string	국가(참고: 국가/지역 이름이 아닌 두 글자 코드입니다.)
countryCodeISO3	string	ISO alpha-3 국가 코드
countrySecondarySubdivision	string	국가
countrySubdivision	string	시/도
countrySubdivisionCode	string	`countrySubdivisionCode` 접두사 `countryCode` ( countryCode-countrySubdivisionCode) 및 하이픈은 ISO 3166-2 코드를 형성합니다. 예: 텍사스의 경우 TX, 스코틀랜드의 경우 SCT, 온타리오의 경우 ON입니다.
countrySubdivisionName	string	국가/지역 관리 계층 구조의 첫 번째 수준의 전체 이름입니다. 이 필드는 countrySubdivision이 축약된 형식으로 표시되는 경우에만 나타납니다. 미국, 캐나다 및 영국에서만 지원됩니다.
countryTertiarySubdivision	string	명명된 영역
crossStreet	string	교차되는 거리의 이름입니다.
extendedPostalCode	string	확장된 우편 번호(가용성은 지역에 따라 다됨).
freeformAddress	string	결과 국가/원본 지역의 서식 규칙에 따라 또는 국가/지역의 경우 전체 국가/지역 이름에 따라 서식이 지정된 주소 줄입니다.
localName	string	관리 단위가 아닌 주소 지정이 가능한 여러 개체를 주소 지정 가능한 개체로 그룹화한 지리적 영역 또는 지역 이름을 나타내는 주소 구성 요소입니다. 이 필드는 속성을 빌드 `freeformAddress` 하는 데 사용됩니다. `localName` 는 우편 지방 자치 단체를 나타냅니다. 위치에 `localName` 따라 은 도시 또는 마을의 일반적으로 알려진 이름입니다. 도시 또는 마을의 일반적으로 알려진 이름에 대 한 대신 사용 `localName` 합니다 `municipality`.
municipality	string	시티 /타운 참고: `municipality` 주거용 지방자치단체를 나타냅니다. 위치에 따라 값은 `municipality` 일반적으로 알려진 도시 또는 도시의 이름과 다를 수 있습니다. 도시 또는 도시의 일반적으로 알려진 이름의 경우 값 대신 `municipality` 값을 사용하는 것이 `localName` 좋습니다.
municipalitySubdivision	string	서브/슈퍼 시티
neighbourhood	string	이웃은 독특한 특성과 주민 간의 사회적 상호 작용을 가진 도시 또는 마을 내에서 지리적으로 지역화 된 지역입니다.
postalCode	string	우편 번호/우편 번호
routeNumbers	string[]	거리를 명확하게 식별하는 데 사용되는 코드
street	string	거리 이름입니다. 사용되지 않습니다. 대신 streetName을 사용합니다.
streetName	string	거리 이름입니다.
streetNameAndNumber	string	거리 이름 및 번호입니다.
streetNumber	string	거리의 건물 번호입니다.

AddressRanges

검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다.

Name	형식	Description
from	LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.
rangeLeft	string	거리 왼쪽의 주소 범위입니다.
rangeRight	string	거리 오른쪽의 주소 범위입니다.
to	LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

BatchRequest

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

Name	형식	Description
batchItems	BatchRequestItem[]	처리할 쿼리 목록입니다.

BatchRequestItem

Batch 요청 개체

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

BoundingBox

뷰포트의 왼쪽 위 및 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다.

Name	형식	Description
btmRightPoint	LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.
topLeftPoint	LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

BoundingBoxCompassNotation

위치의 경계 상자입니다.

Name	형식	Description
entity	Entity	경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다.
northEast	string	북동 위도, 경계 상자의 경도 좌표(쉼표로 구분된 부동 소수)입니다.
southWest	string	남서 위도, 경계 상자의 경도 좌표(쉼표로 구분된 부동 소수)입니다.

Brand

POI와 연결된 브랜드

Name	형식	Description
name	string	브랜드 이름

Classification

반환되는 POI에 대한 분류

Name	형식	Description
code	string	Code 속성
names	ClassificationName[]	이름 배열

ClassificationName

분류의 이름

Name	형식	Description
name	string	Name 속성
nameLocale	string	Name Locale 속성

DataSources

선택 단원. Get Search Polygon API에 사용할 참조 ID입니다.

Name	형식	Description
geometry	Geometry	결과의 기하학적 모양에 대한 정보입니다. == Geography를 입력하는 경우에만 존재합니다.

Entity

경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다.

Name	형식	Description
position	string	위치 엔터티

EntryPoint

반환되는 POI의 진입점입니다.

Name	형식	Description
position	LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.
type	EntryPointType	진입점의 형식입니다. 값은 기본 또는 부 값일 수 있습니다.

EntryPointType

진입점의 형식입니다. 값은 기본 또는 부 값일 수 있습니다.

Name	형식	Description
main	string
minor	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 개체.

GeographicEntityType

Geography 엔터티 형식입니다. entityType이 요청되고 사용할 수 있는 경우에만 표시됩니다.

Name	형식	Description
Country	string	국가/지역 이름
CountrySecondarySubdivision	string	국가
CountrySubdivision	string	시/도
CountryTertiarySubdivision	string	명명된 영역
Municipality	string	시티 /타운
MunicipalitySubdivision	string	서브/슈퍼 시티
Neighbourhood	string	이웃
PostalCodeArea	string	우편 번호/우편 번호

Geometry

결과의 기하학적 모양에 대한 정보입니다. == Geography를 입력하는 경우에만 존재합니다.

Name	형식	Description
id	string	이 결과를 위한 기하 도형 정보를 가져오려면 get Search Polygon API에 geometryId로 전달합니다.

JsonFormat

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

Name	형식	Description
json	string	JavaScript 개체 표기법 데이터 교환 형식

LatLongPairAbbreviated

짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

Name	형식	Description
lat	number	위도 속성
lon	number	경도 속성

MatchType

역방향 주소 검색 작업에 대한 일치 유형입니다.

Name	형식	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

POI의 영업 시간(관심 지점).

Name	형식	Description
mode	string	요청에 사용된 값: none 또는 "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	다음 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	OperatingHoursTime	지정된 POI가 닫혀 있는 다음 7일 범위의 점 또는 범위 이전에 닫힌 경우 범위의 시작입니다.
startTime	OperatingHoursTime	지정된 POI를 열 때 다음 7일 범위의 점 또는 범위 이전에 열린 경우 범위의 시작점입니다.

PointOfInterest

이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다.

Name	형식	Description
brands	Brand[]	브랜드 배열. 반환되는 POI에 대한 브랜드의 이름입니다.
categories	string[]	범주 배열
categorySet	PointOfInterestCategorySet[]	가장 구체적인 POI 범주 목록
classifications	Classification[]	분류 배열
name	string	POI 속성의 이름
openingHours	OperatingHours	POI의 영업 시간(관심 지점).
phone	string	전화 번호 속성
url	string	웹 사이트 URL 속성

PointOfInterestCategorySet

POI 범주

Name	형식	Description
id	integer	범주 ID입니다.

QueryType

반환되는 쿼리 유형: NEARBY 또는 NON_NEAR.

Name	형식	Description
NEARBY	string	Search 정의된 반경을 사용하여 특정 위도 및 경도 주위에 수행되었습니다.
NON_NEAR	string	Search 특정 위도 및 경도에 편향되지 않고 정의된 반경 없이 전역적으로 수행되었습니다.

Response

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

Name	형식	Description
error	ErrorDetail	Error 개체.
results	SearchAddressResultItem[]	Search API 결과 목록입니다.
summary	SearchSummary	Search API 응답에 대한 요약 개체

ReverseSearchAddressBatchItem

Search 주소 역방향 일괄 처리 서비스 호출에서 반환된 항목입니다.

Name	형식	Description
response	Response	쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 SearchAddressReverseResponse, 그렇지 않으면 ErrorResponse입니다.
statusCode	integer	HTTP 요청 상태 코드.

ReverseSearchAddressBatchProcessResult

이 개체는 주소 역방향 일괄 처리 서비스 호출에 성공한 Search 반환됩니다.

Name	형식	Description
batchItems	ReverseSearchAddressBatchItem[]	일괄 처리 결과를 포함하는 배열입니다.
summary	Summary	일괄 처리 요청에 대한 결과 요약

SearchAddressResultItem

Search API 응답에 대한 결과 개체입니다.

Name	형식	Description
address	Address	결과의 주소
addressRanges	AddressRanges	검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다.
dataSources	DataSources	선택 단원. Get Search Polygon API에 사용할 기하 도형 ID를 참조합니다.
detourTime	integer	우회 시간(초)입니다. 경로 API를 따라 Search 호출에 대해서만 반환됩니다.
dist	number	결과와 지오비아 위치 사이의 직선 거리(미터)입니다.
entityType	GeographicEntityType	Geography 엔터티 형식입니다. entityType이 요청되고 사용할 수 있는 경우에만 표시됩니다.
entryPoints	EntryPoint[]	EntryPoint의 배열입니다. 이들은 위치에서 사용할 수있는 입구의 유형을 설명합니다. 형식은 현관이나 로비와 같은 기본 입구의 경우 "기본"이고 측면 및 뒷문의 경우 "부"일 수 있습니다.
id	string	Id 속성
info	string	결과의 원래 데이터 원본에 대한 정보입니다. 지원 요청에 사용됩니다.
matchType	MatchType	일치 유형에 대한 정보입니다. 다음 중 하나: AddressPoint HouseNumberRange Street
poi	PointOfInterest	이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다.
position	LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.
score	number	결과 집합 내의 값으로, 결과 간의 상대적 일치 점수를 나타냅니다. x 값이 y 값의 2배인 경우 결과 x가 결과 y보다 두 배 더 관련성이 높은지 확인하는 데 사용할 수 있습니다. 값은 쿼리마다 다르며 하나의 결과 집합에 대한 상대 값으로만 사용됩니다.
type	SearchAddressResultType	다음 중 하나: 지점 Street Geography 지점 주소 주소 범위 교차로
viewport	BoundingBox	뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다.

SearchAddressResultType

다음 중 하나:

지점
Street
Geography
지점 주소
주소 범위
교차로

Name	형식	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Search API 응답에 대한 요약 개체입니다.

Name	형식	Description
fuzzyLevel	integer	결과를 제공하는 데 필요한 최대 유사 항목 수준입니다.
geoBias	LatLongPairAbbreviated	내부 검색 엔진이 결과의 순위를 개선하기 위해 지리 공간적 편향을 적용한 경우를 나타냅니다. 일부 메서드에서는 사용 가능한 경우 위도 및 lon 매개 변수를 설정하여 영향을 받을 수 있습니다. 다른 경우에는 순전히 내부입니다.
limit	integer	반환될 최대 응답 수
numResults	integer	응답의 결과 수입니다.
offset	integer	전체 결과 집합 내에서 반환된 결과의 시작 오프셋입니다.
query	string	이러한 검색 결과를 생성하는 데 사용된 쿼리 매개 변수입니다.
queryTime	integer	쿼리를 확인하는 데 소요된 시간(밀리초)입니다.
queryType	QueryType	반환되는 쿼리 유형: NEARBY 또는 NON_NEAR.
totalResults	integer	찾은 총 결과 수입니다.

Summary

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

Name	형식	Description
successfulRequests	integer	일괄 처리에서 성공한 요청 수
totalRequests	integer	일괄 처리의 총 요청 수

다음을 통해 공유