Search - Get Search Address Structured
를 사용하여 거리 주소의 위도 및 경도 좌표를 비정형 또는 쿼리 입력 형식으로 가져옵니다.
Get Search Address Structured
(구조적 주소 지오코딩) API는 비정형 또는 쿼리 입력 형식으로 거리 주소의 위도 및 경도 좌표를 반환하는 HTTP GET
요청입니다.
지오코딩 검색 인덱스가 거리 수준 데이터 위의 모든 항목에 대해 쿼리됩니다. POI는 반환되지 않습니다. 지오코더는 오타 및 불완전한 주소를 매우 관대합니다. 또한 정확한 거리 주소 또는 거리 또는 교차로뿐만 아니라 도심, 카운티, 주 등과 같은 높은 수준의 지역에서 모든 것을 처리합니다.
GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&countryCode={countryCode}
GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&language={language}&countryCode={countryCode}&limit={limit}&ofs={ofs}&streetNumber={streetNumber}&streetName={streetName}&crossStreet={crossStreet}&municipality={municipality}&municipalitySubdivision={municipalitySubdivision}&countryTertiarySubdivision={countryTertiarySubdivision}&countrySecondarySubdivision={countrySecondarySubdivision}&countrySubdivision={countrySubdivision}&postalCode={postalCode}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
format
|
path | True |
원하는 응답 형식입니다. 값은 json 또는 xml일 수 있습니다. |
|
api-version
|
query | True |
string |
Azure Maps API의 버전 번호. |
country
|
query | True |
string |
주소의 2자 또는 3자 ISO3166-1 국가/지역 코드 부분입니다. 예: 미국 |
country
|
query |
string |
구조화된 주소의 국가/지역 |
|
country
|
query |
string |
주소의 국가/지역 세분화 부분 |
|
country
|
query |
string |
구조화된 주소의 명명된 영역 |
|
cross
|
query |
string |
구조화된 주소의 교차 거리 이름 |
|
entity
|
query |
지역에서 수행되는 필터링 수준을 지정합니다. 지정된 지리 엔터티 형식에 대한 검색 범위를 좁힐 수 있습니다( 예: 지방 자치 단체만 반환). 결과 응답에는 일치하는 엔터티 형식뿐만 아니라 지리 ID도 포함됩니다. 둘 이상의 엔터티를 쉼표로 구분된 목록으로 제공하는 경우 엔드포인트는 '사용 가능한 가장 작은 엔터티'를 반환합니다. 반환된 기하 도형 ID는 Get Search Polygon API를 통해 해당 지리의 기하 도형을 가져오는 데 사용할 수 있습니다. entityType이 설정되면 다음 매개 변수가 무시됩니다.
|
||
extended
|
query |
확장된 우편 번호를 결과에 포함해야 하는 인덱스입니다. 사용 가능한 인덱스는 다음과 같습니다. Addr = 주소 범위 지리적 = 지리 PAD = 지점 주소 POI = 관심 지점 Str = Streets XStr = 교차로(교차로) 값은 인덱스 형식의 쉼표로 구분된 목록이거나 인덱스가 없는 경우 없음 이어야 합니다. 기본적으로 확장 우편 번호는 Geo를 제외한 모든 인덱스에 포함됩니다. 지리적 위치의 확장 우편 번호 목록은 매우 길 수 있으므로 필요할 때 명시적으로 요청해야 합니다. 사용 예: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 확장 우편 번호는 주소의 extendedPostalCode 속성으로 반환됩니다. 가용성은 지역에 따라 다릅니다. |
||
language
|
query |
string |
검색 결과를 반환해야 하는 언어입니다. 대/소문자를 구분하지 않는 지원되는 IETF 언어 태그 중 하나여야 합니다. 특정 필드에 대해 지정된 언어의 데이터를 사용할 수 없는 경우 기본 언어가 사용됩니다. 자세한 내용은 지원되는 언어를 참조하세요. |
|
limit
|
query |
integer |
반환될 최대 응답 수입니다. 기본값: 10, 최소: 1 및 최대: 100 |
|
municipality
|
query |
string |
주소의 지방자치단체 부분 |
|
municipality
|
query |
string |
구조화된 주소에 대한 지방 자치 단체 세분화(하위/슈퍼 도시) |
|
ofs
|
query |
integer |
전체 결과 집합 내에서 반환된 결과의 시작 오프셋입니다. Default: 0 |
|
postal
|
query |
string |
주소의 우편 번호 부분입니다. |
|
street
|
query |
string |
주소의 거리 이름 부분입니다. |
|
street
|
query |
string |
주소의 거리 번호 부분 |
|
view
|
query |
View 매개 변수("사용자 지역" 매개 변수라고도 함)를 사용하면 지정학적으로 분쟁이 있는 지역의 특정 국가/지역에 대한 올바른 맵을 표시할 수 있습니다. 국가/지역에 따라 이러한 지역에 대한 보기가 다르며 View 매개 변수를 사용하면 애플리케이션이 서비스할 국가/지역에 필요한 보기를 애플리케이션이 준수할 수 있습니다. 기본적으로 View 매개 변수는 요청에 정의하지 않은 경우에도 "Unified"로 설정됩니다. 사용자의 위치를 확인한 다음 해당 위치에 대해 View 매개 변수를 올바르게 설정하는 것은 사용자의 책임입니다. 또는 요청의 IP 주소를 기반으로 맵 데이터를 반환하는 'View=Auto'를 설정하는 옵션이 있습니다. Azure Maps View 매개 변수는 지도, 이미지 및 기타 데이터 및 Azure Maps 통해 액세스할 수 있는 권한이 있는 타사 콘텐츠가 제공되는 국가/지역의 매핑과 관련된 법률을 포함하여 해당 법률을 준수하는 데 사용해야 합니다. 예: view=IN. 자세한 내용은 지원되는 보기를 참조하고 사용 가능한 보기를 확인하세요. |
요청 헤더
Name | 필수 | 형식 | Description |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정의 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps Microsoft Entra ID 보안을 사용하려면 다음 문서를 참조하세요. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
정상 |
|
Other Status Codes |
예기치 않은 오류가 발생했습니다. |
보안
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
예제
Search address in Redmond, WA in structured form
샘플 요청
GET https://atlas.microsoft.com/search/address/structured/json?api-version=1.0&countryCode=US&streetNumber=15127&streetName=NE%2024th%20Street&municipality=Redmond&postalCode=98052
샘플 응답
{
"summary": {
"query": "15127 98052 ne redmond wa",
"queryType": "NON_NEAR",
"queryTime": 57,
"numResults": 1,
"offset": 0,
"totalResults": 34,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.30129317913035,
"lon": -120.88247999999997
}
},
"results": [
{
"type": "Point Address",
"id": "US/PAD/p0/37974392",
"score": 8.074,
"dist": 101274.64693865852,
"address": {
"streetNumber": "15127",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525544",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "15127 NE 24th St, Redmond, WA 98052",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6308,
"lon": -122.1385
},
"viewport": {
"topLeftPoint": {
"lat": 47.6317,
"lon": -122.13983
},
"btmRightPoint": {
"lat": 47.6299,
"lon": -122.13717
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6315,
"lon": -122.13852
}
}
]
}
]
}
정의
Name | Description |
---|---|
Address |
결과의 주소 |
Address |
검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다. |
Bounding |
뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다. |
Bounding |
위치의 경계 상자입니다. |
Brand |
POI와 연결된 브랜드 |
Classification |
반환되는 POI에 대한 분류 |
Classification |
분류의 이름 |
Data |
선택 단원. Search 다각형 API 가져오기와 함께 사용할 참조 ID입니다. |
Entity |
경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다. |
Entry |
반환되는 POI의 진입점입니다. |
Entry |
진입점의 형식입니다. 값은 기본 또는 부 값일 수 있습니다. |
Error |
리소스 관리 오류 추가 정보입니다. |
Error |
오류 세부 정보입니다. |
Error |
오류 응답 |
Geographic |
Geography 엔터티 형식입니다. entityType이 요청되고 사용할 수 있는 경우에만 표시됩니다. |
Geometry |
결과의 기하학적 모양에 대한 정보입니다. == Geography를 입력하는 경우에만 존재합니다. |
Lat |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
Localized |
View 매개 변수("사용자 지역" 매개 변수라고도 함)를 사용하면 지정학적으로 분쟁이 있는 지역의 특정 국가/지역에 대한 올바른 맵을 표시할 수 있습니다. 국가/지역에 따라 해당 지역에 대한 보기가 다르며 View 매개 변수를 사용하면 애플리케이션이 서비스할 국가/지역에 필요한 보기를 애플리케이션이 준수할 수 있습니다. 기본적으로 View 매개 변수는 요청에 정의하지 않은 경우에도 "Unified"로 설정됩니다. 사용자의 위치를 확인한 다음 해당 위치에 대해 View 매개 변수를 올바르게 설정하는 것은 사용자의 책임입니다. 또는 요청의 IP 주소를 기반으로 맵 데이터를 반환하는 'View=Auto'를 설정하는 옵션이 있습니다. Azure Maps View 매개 변수는 지도, 이미지 및 기타 데이터 및 Azure Maps 통해 액세스할 권한이 있는 타사 콘텐츠가 제공되는 국가/지역의 매핑과 관련된 법률을 포함하여 관련 법률을 준수하는 데 사용해야 합니다. 예: view=IN. 자세한 내용은 지원되는 보기를 참조하고 사용 가능한 보기를 확인하세요. |
Match |
역방향 주소 검색 작업에 대한 일치 유형입니다. |
Operating |
POI의 영업 시간(관심 지점). |
Operating |
날짜 및 시간을 나타냅니다. |
Operating |
하루 동안의 여는 시간 범위 |
Point |
이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다. |
Point |
POI 범주 |
Query |
반환되는 쿼리 유형: NEARBY 또는 NON_NEAR. |
Response |
원하는 응답 형식입니다. 값은 json 또는 xml일 수 있습니다. |
Search |
이 개체는 성공적인 Search 호출에서 반환됩니다. |
Search |
Search API 응답에 대한 결과 개체입니다. |
Search |
다음 중 하나:
|
Search |
확장 우편 번호를 결과에 포함해야 하는 인덱스입니다. 사용 가능한 인덱스는 다음과 같습니다. Addr = 주소 범위 지역 = 지리 PAD = 지점 주소 POI = 관심 지점 Str = Streets XStr = 교차로(교차로) 값은 인덱스 형식의 쉼표로 구분된 목록이거나 인덱스가 없는 경우 없음 이어야 합니다. 기본적으로 확장 우편 번호는 Geo를 제외한 모든 인덱스에 포함됩니다. 지역에 대한 확장 우편 번호 목록은 매우 길 수 있으므로 필요할 때 명시적으로 요청해야 합니다. 사용 예: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 확장 우편 번호는 주소의 extendedPostalCode 속성으로 반환됩니다. 가용성은 지역에 따라 다릅니다. |
Search |
Search API 응답에 대한 요약 개체입니다. |
Address
결과의 주소
Name | 형식 | Description |
---|---|---|
boundingBox |
위치의 경계 상자입니다. |
|
buildingNumber |
string |
거리의 건물 번호입니다. 사용되지 않습니다. 대신 streetNumber를 사용합니다. |
country |
string |
국가/지역 이름 |
countryCode |
string |
국가(참고: 국가/지역 이름이 아닌 두 글자 코드입니다.) |
countryCodeISO3 |
string |
ISO alpha-3 국가 코드 |
countrySecondarySubdivision |
string |
국가 |
countrySubdivision |
string |
시/도 |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
국가/지역 관리 계층 구조의 첫 번째 수준의 전체 이름입니다. 이 필드는 countrySubdivision이 약식 형식으로 표시되는 경우에만 나타납니다. 미국, 캐나다 및 영국에서만 지원됩니다. |
countryTertiarySubdivision |
string |
명명된 영역 |
crossStreet |
string |
교차되는 거리의 이름입니다. |
extendedPostalCode |
string |
확장된 우편 번호(가용성은 지역에 따라 다발성). |
freeformAddress |
string |
결과 국가/원본 지역의 서식 규칙에 따라 또는 국가/지역의 경우 전체 국가/지역 이름에 따라 서식이 지정된 주소 줄입니다. |
localName |
string |
관리 단위가 아닌 주소 지정을 위해 여러 주소 지정 가능한 개체를 그룹화한 지리적 영역 또는 지역 이름을 나타내는 주소 구성 요소입니다. 이 필드는 속성을 빌드 |
municipality |
string |
시티 /타운 |
municipalitySubdivision |
string |
서브/슈퍼 시티 |
neighbourhood |
string |
이웃은 독특한 특성과 주민 간의 사회적 상호 작용을 가진 도시 또는 마을 내에서 지리적으로 지역화 된 지역입니다. |
postalCode |
string |
우편 번호/우편 번호 |
routeNumbers |
string[] |
거리를 명확하게 식별하는 데 사용되는 코드 |
street |
string |
거리 이름입니다. 사용되지 않습니다. 대신 streetName을 사용합니다. |
streetName |
string |
거리 이름입니다. |
streetNameAndNumber |
string |
거리 이름 및 번호입니다. |
streetNumber |
string |
거리의 건물 번호입니다. |
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 |
Code 속성 |
names |
이름 배열 |
ClassificationName
분류의 이름
Name | 형식 | Description |
---|---|---|
name |
string |
Name 속성 |
nameLocale |
string |
Name Locale 속성 |
DataSources
선택 단원. Search 다각형 API 가져오기와 함께 사용할 참조 ID입니다.
Name | 형식 | Description |
---|---|---|
geometry |
결과의 기하 도형에 대한 정보입니다. == Geography 형식인 경우에만 존재합니다. |
Entity
경계 상자의 엔터티 형식 원본입니다. 역방향 지오코딩의 경우 항상 위치와 같습니다.
Name | 형식 | Description |
---|---|---|
position |
string |
위치 엔터티 |
EntryPoint
반환되는 POI의 진입점입니다.
Name | 형식 | Description |
---|---|---|
position |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
|
type |
진입점 유형입니다. 값은 기본 또는 부일 수 있습니다. |
EntryPointType
진입점의 형식입니다. 값은 기본 또는 부 값일 수 있습니다.
Name | 형식 | Description |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보입니다.
Name | 형식 | Description |
---|---|---|
info |
object |
추가 정보입니다. |
type |
string |
추가 정보 유형입니다. |
ErrorDetail
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
additionalInfo |
오류 추가 정보입니다. |
|
code |
string |
오류 코드입니다. |
details |
오류 세부 정보입니다. |
|
message |
string |
오류 메시지입니다. |
target |
string |
오류 대상입니다. |
ErrorResponse
오류 응답
Name | 형식 | Description |
---|---|---|
error |
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로 전달합니다. |
LatLongPairAbbreviated
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.
Name | 형식 | Description |
---|---|---|
lat |
number |
위도 속성 |
lon |
number |
경도 속성 |
LocalizedMapView
View 매개 변수("사용자 지역" 매개 변수라고도 함)를 사용하면 지정학적으로 분쟁이 있는 지역의 특정 국가/지역에 대한 올바른 맵을 표시할 수 있습니다. 국가/지역에 따라 해당 지역에 대한 보기가 다르며 View 매개 변수를 사용하면 애플리케이션이 서비스할 국가/지역에 필요한 보기를 애플리케이션이 준수할 수 있습니다. 기본적으로 View 매개 변수는 요청에 정의하지 않은 경우에도 "Unified"로 설정됩니다. 사용자의 위치를 확인한 다음 해당 위치에 대해 View 매개 변수를 올바르게 설정하는 것은 사용자의 책임입니다. 또는 요청의 IP 주소를 기반으로 맵 데이터를 반환하는 'View=Auto'를 설정하는 옵션이 있습니다. Azure Maps View 매개 변수는 지도, 이미지 및 기타 데이터 및 Azure Maps 통해 액세스할 권한이 있는 타사 콘텐츠가 제공되는 국가/지역의 매핑과 관련된 법률을 포함하여 관련 법률을 준수하는 데 사용해야 합니다. 예: view=IN.
자세한 내용은 지원되는 보기를 참조하고 사용 가능한 보기를 확인하세요.
Name | 형식 | Description |
---|---|---|
AE |
string |
아랍에미리트(아랍어 보기) |
AR |
string |
아르헨티나(아르헨티나어 보기) |
Auto |
string |
요청의 IP 주소를 기준으로 지도 데이터를 반환합니다. |
BH |
string |
바레인(아랍어 보기) |
IN |
string |
인도(인도어 보기) |
IQ |
string |
이라크(아랍어 보기) |
JO |
string |
요르단(아랍어 보기) |
KW |
string |
쿠웨이트(아랍어 보기) |
LB |
string |
레바논(아랍어 보기) |
MA |
string |
모로코(모로코어 보기) |
OM |
string |
오만(아랍어 보기) |
PK |
string |
파키스탄(파키스탄어 보기) |
PS |
string |
팔레스타인 자치 정부(아랍어 보기) |
QA |
string |
카타르(아랍어 보기) |
SA |
string |
사우디아라비아(아랍어 보기) |
SY |
string |
시리아(아랍어 보기) |
Unified |
string |
통합 보기(기타) |
YE |
string |
예멘(아랍어 보기) |
MatchType
역방향 주소 검색 작업에 대한 일치 유형입니다.
Name | 형식 | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
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.
Name | 형식 | Description |
---|---|---|
NEARBY |
string |
Search 정의된 반경을 사용하여 특정 위도 및 경도 주위에 수행되었습니다. |
NON_NEAR |
string |
Search 특정 위도 및 경도에 편향되지 않고 정의된 반경 없이 전역적으로 수행되었습니다. |
ResponseFormat
원하는 응답 형식입니다. 값은 json 또는 xml일 수 있습니다.
Name | 형식 | Description |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
이 개체는 성공적인 Search 호출에서 반환됩니다.
Name | 형식 | Description |
---|---|---|
results |
Search API 결과 목록입니다. |
|
summary |
Search API 응답에 대한 요약 개체 |
SearchAddressResultItem
Search API 응답에 대한 결과 개체입니다.
Name | 형식 | Description |
---|---|---|
address |
결과의 주소 |
|
addressRanges |
검색 결과에 대한 거리 양쪽의 주소 범위를 설명합니다. 주소 범위의 시작 및 끝 위치에 대한 좌표가 포함됩니다. |
|
dataSources |
선택 단원. Get Search Polygon API에 사용할 기하 도형 ID를 참조합니다. |
|
detourTime |
integer |
우회 시간(초)입니다. 경로 API를 따라 Search 호출에 대해서만 반환됩니다. |
dist |
number |
결과와 지오비아 위치 사이의 직선 거리(미터)입니다. |
entityType |
Geography 엔터티 형식입니다. entityType이 요청되고 사용할 수 있는 경우에만 표시됩니다. |
|
entryPoints |
EntryPoint의 배열입니다. 이들은 위치에서 사용할 수있는 입구의 유형을 설명합니다. 형식은 현관이나 로비와 같은 기본 입구의 경우 "기본"이고 측면 및 뒷문의 경우 "부"일 수 있습니다. |
|
id |
string |
Id 속성 |
info |
string |
결과의 원래 데이터 원본에 대한 정보입니다. 지원 요청에 사용됩니다. |
matchType |
일치 유형에 대한 정보입니다. 다음 중 하나:
|
|
poi |
이름, 전화, URL 주소 및 분류와 같은 정보를 포함하여 반환된 POI의 세부 정보입니다. |
|
position |
짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다. |
|
score |
number |
결과 집합 내의 값으로, 결과 간의 상대적 일치 점수를 나타냅니다. x 값이 y 값의 2배인 경우 결과 x가 결과 y보다 두 배 더 관련성이 높은지 확인하는 데 사용할 수 있습니다. 값은 쿼리마다 다르며 하나의 결과 집합에 대한 상대 값으로만 사용됩니다. |
type |
다음 중 하나:
|
|
viewport |
뷰포트의 왼쪽 위와 오른쪽 아래 좌표로 표시되는 결과를 포함하는 뷰포트입니다. |
SearchAddressResultType
다음 중 하나:
- 지점
- Street
- Geography
- 지점 주소
- 주소 범위
- 교차로
Name | 형식 | Description |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchIndexes
확장 우편 번호를 결과에 포함해야 하는 인덱스입니다.
사용 가능한 인덱스는 다음과 같습니다.
Addr = 주소 범위
지역 = 지리
PAD = 지점 주소
POI = 관심 지점
Str = Streets
XStr = 교차로(교차로)
값은 인덱스 형식의 쉼표로 구분된 목록이거나 인덱스가 없는 경우 없음 이어야 합니다.
기본적으로 확장 우편 번호는 Geo를 제외한 모든 인덱스에 포함됩니다. 지역에 대한 확장 우편 번호 목록은 매우 길 수 있으므로 필요할 때 명시적으로 요청해야 합니다.
사용 예:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
확장 우편 번호는 주소의 extendedPostalCode 속성으로 반환됩니다. 가용성은 지역에 따라 다릅니다.
Name | 형식 | Description |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
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 |
찾은 총 결과 수입니다. |