다음을 통해 공유


Search - Get Geocoding

도로 주소 또는 장소 이름의 경도 및 위도 좌표를 가져오는 데 사용합니다.

Get Geocoding API는 검색되는 위치의 경도 및 위도 좌표를 반환하는 HTTP GET 요청입니다.

대부분의 경우 일반적인 지오코딩에만 관심이 있는 경우와 같이 전체 검색 서비스가 너무 많을 수 있습니다. 주소 조회에 대한 검색에만 액세스할 수도 있습니다. 지오코딩은 해당 주소 또는 부분 주소만으로 지오코딩 엔드포인트를 눌러 수행됩니다. 지오코딩 검색 인덱스가 거리 수준 데이터 위의 모든 항목에 대해 쿼리됩니다. POI(관심 지점 없음)가 반환되지 않습니다. 지오코더는 오타 및 불완전한 주소에 대해 매우 관대합니다. 또한 정확한 거리 주소 또는 거리 또는 교차로뿐만 아니라 도심, 카운티 및 주와 같은 높은 수준의 지역에서 모든 것을 처리합니다. 응답은 거리, 우편 번호, 지방 자치 단체 및 국가 / 지역 정보와 같은 자세한 주소 속성도 반환합니다.

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01
GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
api-version
query True

string

Azure Maps API의 버전 번호.

addressLine
query

string

지역 또는 우편 번호 속성에 지정된 대로 지역을 기준으로 하는 주소의 공식 거리 줄입니다. 이 요소의 일반적인 사용은 거리 주소 또는 공식 주소를 제공하는 것입니다.

쿼리가 지정된 경우 이 매개 변수를 사용하면 안 됩니다.

adminDistrict
query

string

WA와 같은 주소의 국가 세분화 부분입니다.

쿼리가 지정된 경우 이 매개 변수를 사용하면 안 됩니다.

adminDistrict2
query

string

킹과 같은 구조화된 주소의 카운티입니다.

쿼리가 지정된 경우 이 매개 변수를 사용하면 안 됩니다.

adminDistrict3
query

string

구조화된 주소의 명명된 영역입니다.

쿼리가 지정된 경우 이 매개 변수를 사용하면 안 됩니다.

bbox
query

number[]

경계 상자 개체로 정의된 지구의 사각형 영역입니다. 사각형의 측면은 경도 및 위도 값으로 정의됩니다. 이 매개 변수를 지정하면 위치 쿼리의 결과를 계산할 때 지리적 영역이 고려됩니다.

예: lon1,lat1,lon2,lat2

coordinates
query

number[]

경도 및 위도로 지정된 지구의 점입니다. 이 매개 변수를 지정하면 사용자의 위치가 고려되고 반환된 결과가 사용자와 더 관련이 있을 수 있습니다. 예: &좌표=lon,위도

countryRegion
query

string

ISO 3166-1 Alpha-2 지역/국가 코드에 대한 지오코딩 결과에 대한 신호(예: FR./

쿼리가 지정된 경우 이 매개 변수를 사용하면 안 됩니다.

locality
query

string

주소의 지역(예: 시애틀)입니다.

쿼리가 지정된 경우 이 매개 변수를 사용하면 안 됩니다.

postalCode
query

string

주소의 우편 번호 부분입니다.

쿼리가 지정된 경우 이 매개 변수를 사용하면 안 됩니다.

query
query

string

주소 또는 랜드마크 이름과 같은 위치에 대한 정보가 들어 있는 문자열입니다.

top
query

integer

int32

반환될 최대 응답 수입니다. 기본값: 5, 최소: 1 및 최대: 20.

view
query

string

ISO 3166-1 Alpha-2 지역/국가 코드를 나타내는 문자열입니다. 이렇게 하면 지정학적 분쟁이 있는 테두리와 레이블이 지정된 사용자 지역에 맞게 변경됩니다. 기본적으로 View 매개 변수는 요청에서 정의하지 않은 경우에도 "자동"으로 설정됩니다.

자세한 내용은 지원되는 보기를 참조하고 사용 가능한 보기를 확인하세요.

요청 헤더

Name 필수 형식 Description
Accept-Language

string

검색 결과를 반환해야 하는 언어입니다.

자세한 내용은 지원되는 언어를 참조하세요.

x-ms-client-id

string

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

응답

Name 형식 Description
200 OK

GeocodingResponse

정상

Media Types: "application/geo+json"

헤더

x-ms-request-id: string

Other Status Codes

ErrorResponse

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

Media Types: "application/geo+json"

보안

AADToken

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

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

참고

  • 이 보안 정의 에서는 헤더를 사용하여 애플리케이션이 x-ms-client-id 액세스를 요청하는 Azure Maps 리소스를 나타내야 합니다. 이는 Maps 관리 API에서 가져올 수 있습니다.
  • Authorization URL 은 Azure 퍼블릭 클라우드 인스턴스와 관련이 있습니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다.
  • Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면 에서 구성됩니다.
  • Azure Maps 웹 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, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스 를 만들 때 프로비전되는 공유 키입니다.

이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있는 권한이 부여됩니다. 즉, 이러한 키는 현재 발급된 계정의 마스터 키로 처리될 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 이 키를 안전하게 저장할 수 있는 Azure Maps REST API의 서버-서버 액세스를 사용하는 것이 좋습니다.

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

SAS Token

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

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

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

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

예제

Search detail address 15127 NE 24th Street, Redmond, WA
Search detail address 15127 NE 24th Street, Redmond, WA by addressLine
Search detail address 15127 NE 24th Street, Redmond, WA by query
Search landmark Empire State Building by query

Search detail address 15127 NE 24th Street, Redmond, WA

샘플 요청

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

샘플 응답

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

샘플 요청

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

샘플 응답

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

샘플 요청

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=15127 NE 24th Street Redmond WA

샘플 응답

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

샘플 요청

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=empire state building

샘플 응답

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

정의

Name Description
Address

결과의 주소

AdminDistricts

주소에 대한 국가 또는 지역의 세분화 이름입니다. 이 요소는 일반적으로 첫 번째 순서 관리 세분으로 처리되지만 경우에 따라 국가, 종속성 또는 지역의 두 번째, 세 번째 또는 네 번째 순서 세분화도 포함됩니다.

CalculationMethodEnum

지오코드 지점을 계산하는 데 사용된 메서드입니다.

ConfidenceEnum

지오코딩된 위치 결과가 일치한다는 신뢰도 수준입니다. 일치 코드와 함께 이 값을 사용하여 일치 항목에 대한 자세한 정보를 확인할 수 있습니다.

지오코딩된 위치의 신뢰도는 지정된 경우 지오코딩된 위치 및 사용자의 위치의 상대적 중요도를 비롯한 여러 요인을 기반으로 합니다.

CountryRegion
ErrorAdditionalInfo

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

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

오류 응답

FeatureCollectionEnum

FeatureCollection 개체의 형식은 FeatureCollection이어야 합니다.

FeaturesItem
FeatureTypeEnum

기능 유형은 기능이어야 합니다.

GeocodePoints

계산 방법 및 제안된 사용과 다른 지오코드 지점의 컬렉션입니다.

GeocodingResponse

이 개체는 성공적인 지오코딩 호출에서 반환됩니다.

GeoJsonPoint

유효한 GeoJSON Point 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

Intersection

결과의 주소입니다.

MatchCodesEnum

응답의 각 위치에 대한 지오코딩 수준을 나타내는 하나 이상의 일치 코드 값입니다.

예를 들어 및 의 일치 코드 GoodAmbiguous 가 있는 지오코딩된 위치는 위치 정보에 대해 둘 이상의 지오코드 위치를 찾았으며 지오코드 서비스에 일치하는 항목을 찾기 위한 검색 계층 구조가 없음을 의미합니다.

마찬가지로 및 의 AmbiguousUpHierarchy 일치 코드가 있는 지오코딩된 위치는 제공된 모든 위치 정보와 일치하는 지오코드 위치를 찾을 수 없음을 의미하므로 지오코드 서비스는 업 계층 구조를 검색하고 해당 수준에서 여러 일치 항목을 발견해야 했습니다. 및 AmbiguousUpHierarchy 결과의 예는 전체 주소 정보를 제공하는 경우이지만 geocode 서비스는 거리 주소에 대한 일치 항목을 찾을 수 없으며 대신 둘 이상의 RoadBlock 값에 대한 정보를 반환합니다.

가능한 값은 다음과 같습니다.

Good: 위치에 일치하는 항목이 하나만 있거나 반환된 모든 일치 항목이 강력한 일치 항목으로 간주됩니다. 예를 들어 뉴욕에 대한 쿼리는 몇 가지 양수 일치 항목을 반환합니다.

Ambiguous: 위치는 가능한 일치 항목 집합 중 하나입니다. 예를 들어 거리 주소 128 Main St.를 쿼리할 때 선택할 옵션을 결정하기에 충분한 정보가 없기 때문에 응답은 128 North Main St. 및 128 South Main St.에 대한 두 위치를 반환할 수 있습니다.

UpHierarchy: 위치는 지리적 계층 구조 위로의 이동을 나타냅니다. 이는 위치 요청에 대한 일치 항목을 찾을 수 없으므로 덜 정확한 결과가 반환되는 경우에 발생합니다. 예를 들어 요청된 주소에 대한 일치 항목을 찾을 수 없는 경우 RoadBlock 엔터티 형식의 UpHierarchy 일치 코드가 반환될 수 있습니다.

Properties
UsageTypeEnum

지오코드 지점에 가장 적합합니다. 각 지오코드 지점은 점, 점 또는 둘 다로 RouteDisplay 정의됩니다. 위치에 대한 경로를 만드는 경우 포인트를 사용합니다 Route . 지도에 위치를 표시하는 경우 포인트를 사용합니다 Display . 예를 들어 위치가 공원 Route 인 경우 포인트는 자동차로 입력할 수 있는 공원 입구를 지정할 수 있으며 Display , 포인트는 공원의 중심을 지정하는 점일 수 있습니다.

Address

결과의 주소

Name 형식 Description
addressLine

string

Street Name 및 Number를 포함하는 AddressLine

adminDistricts

AdminDistricts[]

주소에 대한 국가 또는 지역의 세분화 이름입니다. 이 요소는 일반적으로 첫 번째 순서 관리 세분으로 처리되지만 경우에 따라 국가, 종속성 또는 지역의 두 번째, 세 번째 또는 네 번째 순서 세분화도 포함됩니다.

countryRegion

CountryRegion

formattedAddress

string

서식이 지정된 Address 속성

intersection

Intersection

결과의 주소입니다.

locality

string

locality 속성

neighborhood

string

neighborhood 속성

postalCode

string

Postal Code 속성

AdminDistricts

주소에 대한 국가 또는 지역의 세분화 이름입니다. 이 요소는 일반적으로 첫 번째 순서 관리 세분으로 처리되지만 경우에 따라 국가, 종속성 또는 지역의 두 번째, 세 번째 또는 네 번째 순서 세분화도 포함됩니다.

Name 형식 Description
name

string

해당 adminDistrict 필드의 이름, adminDistrict[0]의 경우 이 이름은 워싱턴과 같은 주의 전체 이름이 될 수 있습니다. adminDistrict[1]의 경우 이 이름은 카운티의 전체 이름이 될 수 있습니다.

shortName

string

해당 adminDistrict 필드의 짧은 이름인 adminDistrict[0]의 경우 WA, adminDistrict[1]와 같은 주 이름이 짧을 수 있습니다. 이 이름은 카운티의 짧은 이름일 수 있습니다.

CalculationMethodEnum

지오코드 지점을 계산하는 데 사용된 메서드입니다.

Name 형식 Description
Interpolation

string

지오코드 지점은 보간을 사용하여 도로의 한 지점과 일치했습니다.

InterpolationOffset

string

지오코드 지점은 보간과 추가 오프셋을 사용하여 도로의 지점과 일치하여 지점을 도로 측면으로 이동시켰습니다.

Parcel

string

지오코드 지점이 소포의 중심과 일치했습니다.

Rooftop

string

지오코드 지점은 건물의 옥상과 일치했습니다.

ConfidenceEnum

지오코딩된 위치 결과가 일치한다는 신뢰도 수준입니다. 일치 코드와 함께 이 값을 사용하여 일치 항목에 대한 자세한 정보를 확인할 수 있습니다.

지오코딩된 위치의 신뢰도는 지정된 경우 지오코딩된 위치 및 사용자의 위치의 상대적 중요도를 비롯한 여러 요인을 기반으로 합니다.

Name 형식 Description
High

string

신뢰도가 로 High설정된 경우 하나 이상의 강력한 일치 항목이 발견되었습니다. 여러 High 신뢰도 일치 항목은 해당하는 경우 중요도별로 순위순으로 정렬됩니다. 예를 들어 랜드마크는 중요하지만 주소는 그렇지 않습니다.

요청에 위치 또는 뷰가 포함된 경우 순위가 적절하게 변경 될 수 있습니다. 예를 들어 "Paris"에 대한 위치 쿼리는 "Paris, France" 및 "Paris, TX"를 모두 자신 있는 것으로 High 반환합니다. "파리, 프랑스"는 사용자 위치가 사용자가 파리, TX 또는 지도 보기에서 사용자가 해당 영역에서 검색 중임을 나타내거나 매우 가깝다는 것을 나타내지 않는 한 항상 중요도 때문에 1위를 차지합니다.

Low

string

Medium

string

경우에 따라 반환된 일치 항목이 요청에 제공된 정보와 동일한 수준에 있지 않을 수 있습니다. 예를 들어 요청은 주소 정보를 지정할 수 있으며 지역 코드 서비스는 우편 번호와만 일치할 수 있습니다. 이 경우 지역 코드 서비스에 우편 번호가 데이터와 일치한다는 확신이 있는 경우 신뢰도가 로 Medium 설정되고 일치 코드가 모든 정보와 일치할 수 없으며 업 계층 구조를 검색해야 했음을 지정하도록 설정 UpHierarchy 됩니다.

쿼리의 위치 정보가 모호하고 위치의 순위를 지정하는 추가 정보(예: 사용자 위치 또는 위치의 상대적 중요도)가 없는 경우 신뢰도는 로 Medium설정됩니다. 예를 들어 "148th Ave, Bellevue"에 대한 위치 쿼리는 "148th Ave SE"와 "148th Ave NE"를 모두 자신 있는 상태로 Medium 반환할 수 있습니다.

쿼리의 위치 정보가 특정 위치를 지오코딩하기에 충분한 정보를 제공하지 않는 경우 덜 정확한 위치 값이 반환되고 신뢰도가 로 Medium설정될 수 있습니다. 예를 들어 주소가 제공되지만 집 번호에 대한 일치 항목을 찾을 수 없는 경우 Roadblock 엔터티 형식의 지오코드 결과가 반환될 수 있습니다.

CountryRegion

Name 형식 Description
ISO

string

국가/지역의 ISO

name

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 개체.

FeatureCollectionEnum

FeatureCollection 개체의 형식은 FeatureCollection이어야 합니다.

Name 형식 Description
FeatureCollection

string

FeaturesItem

Name 형식 Description
bbox

number[]

경계 상자. 사용된 프로젝션 - EPSG:3857. 자세한 내용은 RFC 7946 을 참조하세요.

geometry

GeoJsonPoint

유효한 GeoJSON Point 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

id

string

반환된 기능에 대한 ID

properties

Properties

type

FeatureTypeEnum

기능 유형은 기능이어야 합니다.

FeatureTypeEnum

기능 유형은 기능이어야 합니다.

Name 형식 Description
Feature

string

GeocodePoints

계산 방법 및 제안된 사용과 다른 지오코드 지점의 컬렉션입니다.

Name 형식 Description
calculationMethod

CalculationMethodEnum

지오코드 지점을 계산하는 데 사용된 메서드입니다.

geometry

GeoJsonPoint

유효한 GeoJSON Point 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

usageTypes

UsageTypeEnum[]

지오코드 지점에 가장 적합합니다. 각 지오코드 지점은 점, 점 또는 둘 다로 RouteDisplay 정의됩니다. 위치에 대한 경로를 만드는 경우 포인트를 사용합니다 Route . 지도에 위치를 표시하는 경우 포인트를 사용합니다 Display . 예를 들어 위치가 공원 Route 인 경우 포인트는 자동차로 입력할 수 있는 공원 입구를 지정할 수 있으며 Display , 포인트는 공원의 중심을 지정하는 점일 수 있습니다.

GeocodingResponse

이 개체는 성공적인 지오코딩 호출에서 반환됩니다.

Name 형식 Description
features

FeaturesItem[]

nextLink

string

는 반환된 기능의 다음 페이지에 대한 링크입니다. 마지막 페이지인 경우 이 필드가 없습니다.

type

FeatureCollectionEnum

FeatureCollection 개체의 형식은 FeatureCollection이어야 합니다.

GeoJsonPoint

유효한 GeoJSON Point 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

Name 형식 Description
bbox

number[]

경계 상자. 사용된 프로젝션 - EPSG:3857. 자세한 내용은 RFC 7946 을 참조하세요.

coordinates

number[]

Position 은 둘 이상의 요소가 있는 숫자 배열입니다. 처음 두 요소는 경도위도이며 정확히 그 순서로 표시됩니다. 고도/상승 은 선택적 세 번째 요소입니다. 자세한 내용은 RFC 7946 을 참조하세요.

type string:

Point

GeoJSON 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection 등 9가지 유효한 GeoJSON 개체 형식 중 하나여야 합니다.

Intersection

결과의 주소입니다.

Name 형식 Description
baseStreet

string

위치의 기본 거리입니다.

displayName

string

교차의 전체 이름입니다.

intersectionType

string

교집합 유형입니다.

secondaryStreet1

string

첫 번째 교차 거리.

secondaryStreet2

string

있는 경우 두 번째 교차 거리입니다.

MatchCodesEnum

응답의 각 위치에 대한 지오코딩 수준을 나타내는 하나 이상의 일치 코드 값입니다.

예를 들어 및 의 일치 코드 GoodAmbiguous 가 있는 지오코딩된 위치는 위치 정보에 대해 둘 이상의 지오코드 위치를 찾았으며 지오코드 서비스에 일치하는 항목을 찾기 위한 검색 계층 구조가 없음을 의미합니다.

마찬가지로 및 의 AmbiguousUpHierarchy 일치 코드가 있는 지오코딩된 위치는 제공된 모든 위치 정보와 일치하는 지오코드 위치를 찾을 수 없음을 의미하므로 지오코드 서비스는 업 계층 구조를 검색하고 해당 수준에서 여러 일치 항목을 발견해야 했습니다. 및 AmbiguousUpHierarchy 결과의 예는 전체 주소 정보를 제공하는 경우이지만 geocode 서비스는 거리 주소에 대한 일치 항목을 찾을 수 없으며 대신 둘 이상의 RoadBlock 값에 대한 정보를 반환합니다.

가능한 값은 다음과 같습니다.

Good: 위치에 일치하는 항목이 하나만 있거나 반환된 모든 일치 항목이 강력한 일치 항목으로 간주됩니다. 예를 들어 뉴욕에 대한 쿼리는 몇 가지 양수 일치 항목을 반환합니다.

Ambiguous: 위치는 가능한 일치 항목 집합 중 하나입니다. 예를 들어 거리 주소 128 Main St.를 쿼리할 때 선택할 옵션을 결정하기에 충분한 정보가 없기 때문에 응답은 128 North Main St. 및 128 South Main St.에 대한 두 위치를 반환할 수 있습니다.

UpHierarchy: 위치는 지리적 계층 구조 위로의 이동을 나타냅니다. 이는 위치 요청에 대한 일치 항목을 찾을 수 없으므로 덜 정확한 결과가 반환되는 경우에 발생합니다. 예를 들어 요청된 주소에 대한 일치 항목을 찾을 수 없는 경우 RoadBlock 엔터티 형식의 UpHierarchy 일치 코드가 반환될 수 있습니다.

Name 형식 Description
Ambiguous

string

Good

string

UpHierarchy

string

Properties

Name 형식 Description
address

Address

결과의 주소

confidence

ConfidenceEnum

지오코딩된 위치 결과가 일치한다는 신뢰도 수준입니다. 일치 코드와 함께 이 값을 사용하여 일치 항목에 대한 자세한 정보를 확인할 수 있습니다.

지오코딩된 위치의 신뢰도는 지정된 경우 지오코딩된 위치 및 사용자의 위치의 상대적 중요도를 비롯한 여러 요인을 기반으로 합니다.

geocodePoints

GeocodePoints[]

계산 방법 및 제안된 사용과 다른 지오코드 지점의 컬렉션입니다.

matchCodes

MatchCodesEnum[]

응답의 각 위치에 대한 지오코딩 수준을 나타내는 하나 이상의 일치 코드 값입니다.

예를 들어 및 의 일치 코드 GoodAmbiguous 가 있는 지오코딩된 위치는 위치 정보에 대해 둘 이상의 지오코드 위치를 찾았으며 지오코드 서비스에 일치하는 항목을 찾기 위한 검색 계층 구조가 없음을 의미합니다.

마찬가지로 및 의 AmbiguousUpHierarchy 일치 코드가 있는 지오코딩된 위치는 제공된 모든 위치 정보와 일치하는 지오코드 위치를 찾을 수 없음을 의미하므로 지오코드 서비스는 업 계층 구조를 검색하고 해당 수준에서 여러 일치 항목을 발견해야 했습니다. 및 AmbiguousUpHierarchy 결과의 예는 전체 주소 정보를 제공하는 경우이지만 geocode 서비스는 거리 주소에 대한 일치 항목을 찾을 수 없으며 대신 둘 이상의 RoadBlock 값에 대한 정보를 반환합니다.

가능한 값은 다음과 같습니다.

Good: 위치에 일치하는 항목이 하나만 있거나 반환된 모든 일치 항목이 강력한 일치 항목으로 간주됩니다. 예를 들어 뉴욕에 대한 쿼리는 몇 가지 양수 일치 항목을 반환합니다.

Ambiguous: 위치는 가능한 일치 항목 집합 중 하나입니다. 예를 들어 거리 주소 128 Main St.를 쿼리할 때 선택할 옵션을 결정하기에 충분한 정보가 없기 때문에 응답은 128 North Main St. 및 128 South Main St.에 대한 두 위치를 반환할 수 있습니다.

UpHierarchy: 위치는 지리적 계층 구조 위로의 이동을 나타냅니다. 이는 위치 요청에 대한 일치 항목을 찾을 수 없으므로 덜 정확한 결과가 반환되는 경우에 발생합니다. 예를 들어 요청된 주소에 대한 일치 항목을 찾을 수 없는 경우 RoadBlock 엔터티 형식의 UpHierarchy 일치 코드가 반환될 수 있습니다.

type

string

다음 중 하나:

  • 주소
  • 바리 케이트
  • RoadIntersection
  • 이웃 도시
  • PopulatedPlace
  • Postcode1
  • AdminDivision1
  • AdminDivision2
  • CountryRegion

UsageTypeEnum

지오코드 지점에 가장 적합합니다. 각 지오코드 지점은 점, 점 또는 둘 다로 RouteDisplay 정의됩니다. 위치에 대한 경로를 만드는 경우 포인트를 사용합니다 Route . 지도에 위치를 표시하는 경우 포인트를 사용합니다 Display . 예를 들어 위치가 공원 Route 인 경우 포인트는 자동차로 입력할 수 있는 공원 입구를 지정할 수 있으며 Display , 포인트는 공원의 중심을 지정하는 점일 수 있습니다.

Name 형식 Description
Display

string

Route

string