Search - Get Reverse Geocoding
Użyj polecenia , aby uzyskać informacje o adresie i lokalizacji z współrzędnych długości i szerokości geograficznej.
Interfejs Get Reverse Geocoding
API to żądanie HTTP GET
używane do tłumaczenia współrzędnych (na przykład 37.786505, -122.3862) na zrozumiały dla człowieka adres ulicy. Przydatne w śledzeniu aplikacji, w których otrzymujesz kanał informacyjny GPS z urządzenia lub zasobu i chcesz znać adres skojarzony ze współrzędnymi. Ten punkt końcowy zwróci informacje o adresie dla danej współrzędnej.
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
api-version
|
query | True |
string |
Numer wersji interfejsu API usługi Azure Maps. |
coordinates
|
query | True |
number[] |
Współrzędne lokalizacji, w której chcesz odwrócić kod geograficzny. Przykład: &współrzędne=lon,lat |
result
|
query |
Określ typy jednostek, które mają być w odpowiedzi. Zostaną zwrócone tylko określone typy. Jeśli nie można zamapować punktu na określone typy jednostek, w odpowiedzi nie są zwracane żadne informacje o lokalizacji. Wartość domyślna to wszystkie możliwe jednostki. Rozdzielona przecinkami lista typów jednostek wybranych z następujących opcji.
Te typy jednostek są uporządkowane od najbardziej określonej jednostki do najmniej określonej jednostki. Gdy znaleziono jednostki o więcej niż jednym typie, zwracana jest tylko najbardziej konkretna jednostka. Jeśli na przykład określisz wartość Address (Adres) i AdminDistrict1 jako typy jednostek i jednostki zostały znalezione dla obu typów, w odpowiedzi zostaną zwrócone tylko informacje o jednostce Adres. |
||
view
|
query |
string |
Ciąg reprezentujący kod regionu/kraju ISO 3166-1 Alpha-2. Spowoduje to zmianę granic i etykiet geopolitycznych w celu dostosowania ich do określonego regionu użytkownika. Domyślnie parametr Widok jest ustawiony na wartość "Auto", nawet jeśli nie zdefiniowano go w żądaniu. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki. |
Nagłówek żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
x-ms-client-id |
string |
Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń usługi Azure AD. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń usługi Azure AD w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki. |
|
Accept-Language |
string |
Język, w którym powinny być zwracane wyniki wyszukiwania. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki . |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Wystąpił nieoczekiwany błąd. Media Types: "application/geo+json" |
Zabezpieczenia
AADToken
Są to przepływy protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.
Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Uwaga
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-id
, aby wskazać, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami. - Element
Authorization URL
jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów entra firmy Microsoft. - Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
- Użycie zestawu Sdk sieci Web usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenia zasobu usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Przy użyciu tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.
W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu serwera do serwera interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.
Typ:
apiKey
W:
header
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.
Typ:
apiKey
W:
header
Przykłady
Search point -122.138681, 47.630358
Przykładowe żądanie
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates=-122.138681,47.630358
Przykładowa odpowiedź
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
]
}
]
}
Definicje
Nazwa | Opis |
---|---|
Address |
Adres wyniku |
Admin |
Nazwa podsieci w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako pierwsza kolejność podziału administracyjnego, ale w niektórych przypadkach zawiera on również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie. |
Calculation |
Metoda, która została użyta do obliczenia punktu kodu geograficznego. |
Confidence |
Poziom pewności, że wynik lokalizacji geokodowanej jest zgodny. Użyj tej wartości z kodem dopasowania, aby określić więcej pełnych informacji o dopasowaniu. Pewność lokalizacji geokodowanej opiera się na wielu czynnikach, w tym względnej ważności lokalizacji geokodowanej i lokalizacji użytkownika, jeśli zostanie określony. |
Country |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Feature |
Typ obiektu FeatureCollection musi być FeatureCollection. |
Features |
|
Feature |
Typ funkcji musi mieć wartość Funkcja. |
Geocode |
Kolekcja punktów kodu geograficznego, które różnią się sposobem ich obliczania i sugerowanym użyciem. |
Geocoding |
Ten obiekt jest zwracany z pomyślnego wywołania geokodowania |
Geo |
Prawidłowy |
Intersection |
Adres wyniku. |
Match |
Co najmniej jedna zgodna wartość kodu reprezentująca poziom geokodowania dla każdej lokalizacji w odpowiedzi. Na przykład lokalizacja geokodowana z kodami Podobnie lokalizacja geokodowana z kodami Możliwe wartości są następujące:
|
Properties | |
Reverse |
Określ typy jednostek, które mają być w odpowiedzi. Zostaną zwrócone tylko określone typy. Jeśli nie można zamapować punktu na określone typy jednostek, w odpowiedzi nie są zwracane żadne informacje o lokalizacji. Wartość domyślna to wszystkie możliwe jednostki. Rozdzielona przecinkami lista typów jednostek wybranych z następujących opcji.
Te typy jednostek są uporządkowane od najbardziej konkretnej jednostki do najmniej konkretnej jednostki. Gdy znaleziono jednostki o więcej niż jednym typie, zwracana jest tylko najbardziej konkretna jednostka. Jeśli na przykład określisz wartości Address i AdminDistrict1 jako typy jednostek i jednostki dla obu typów, w odpowiedzi zostanie zwrócona tylko informacja o jednostce Adres. |
Usage |
Najlepsze zastosowanie dla punktu kodu geograficznego.
Każdy punkt kodu geograficznego |
Address
Adres wyniku
Nazwa | Typ | Opis |
---|---|---|
addressLine |
string |
AddressLine, która zawiera nazwę ulicy i numer |
adminDistricts |
Nazwa podsieci w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako pierwsza kolejność podziału administracyjnego, ale w niektórych przypadkach zawiera on również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie. |
|
countryRegion | ||
formattedAddress |
string |
Sformatowana właściwość Address |
intersection |
Adres wyniku. |
|
locality |
string |
właściwość locality |
neighborhood |
string |
nieruchomość w sąsiedztwie |
postalCode |
string |
Właściwość Kod pocztowy |
AdminDistricts
Nazwa podsieci w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako pierwsza kolejność podziału administracyjnego, ale w niektórych przypadkach zawiera on również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa odpowiedniego pola adminDistrict, Dla adminDistrict[0], może to być pełna nazwa stanu, takiego jak Waszyngton, For adminDistrict[1], może to być pełna nazwa powiatu |
shortName |
string |
Krótka nazwa odpowiedniego pola adminDistrict, Dla adminDistrict[0], może to być krótka nazwa stanu, takiego jak WA, For adminDistrict[1], może to być krótka nazwa powiatu |
CalculationMethodEnum
Metoda, która została użyta do obliczenia punktu kodu geograficznego.
Nazwa | Typ | Opis |
---|---|---|
Interpolation |
string |
Punkt kodu geograficznego został dopasowany do punktu na drodze przy użyciu interpolacji. |
InterpolationOffset |
string |
Punkt kodu geograficznego został dopasowany do punktu na drodze przy użyciu interpolacji z dodatkowym przesunięciem, aby przesunąć punkt na stronę ulicy. |
Parcel |
string |
Punkt kodu geograficznego został dopasowany do środka paczki. |
Rooftop |
string |
Punkt kodu geograficznego został dopasowany do dachu budynku. |
ConfidenceEnum
Poziom pewności, że wynik lokalizacji geokodowanej jest zgodny. Użyj tej wartości z kodem dopasowania, aby określić więcej pełnych informacji o dopasowaniu.
Pewność lokalizacji geokodowanej opiera się na wielu czynnikach, w tym względnej ważności lokalizacji geokodowanej i lokalizacji użytkownika, jeśli zostanie określony.
Nazwa | Typ | Opis |
---|---|---|
High |
string |
Jeśli pewność siebie jest ustawiona na Jeśli żądanie zawiera lokalizację lub widok, klasyfikacja może zostać odpowiednio zmieniona. Na przykład zapytanie o lokalizację dla "Paryż" zwraca wartość "Paris, France" i "Paris, TX" z ufnością |
Low |
string |
|
Medium |
string |
W niektórych sytuacjach zwrócone dopasowanie może nie być na tym samym poziomie, co informacje podane w żądaniu. Na przykład żądanie może określać informacje o adresie, a usługa geokodu może być w stanie dopasować kod pocztowy. W takim przypadku jeśli usługa geokodowania ma pewność, że kod pocztowy jest zgodny z danymi, ustawiono pewność Jeśli informacje o lokalizacji w zapytaniu są niejednoznaczne i nie ma dodatkowych informacji dotyczących klasyfikacji lokalizacji (takich jak lokalizacja użytkownika lub względna ważność lokalizacji), pewność jest ustawiona na Jeśli informacje o lokalizacji w zapytaniu nie udostępniają wystarczającej ilości informacji do geokodowania określonej lokalizacji, może zostać zwrócona mniej dokładna wartość lokalizacji i ustawiono pewność na |
CountryRegion
Nazwa | Typ | Opis |
---|---|---|
ISO |
string |
ISO kraju/regionu |
name |
string |
nazwa kraju/regionu |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt error. |
FeatureCollectionEnum
Typ obiektu FeatureCollection musi być FeatureCollection.
Nazwa | Typ | Opis |
---|---|---|
FeatureCollection |
string |
FeaturesItem
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
geometry |
Prawidłowy |
|
id |
string |
Identyfikator funkcji zwróconej |
properties | ||
type |
Typ funkcji musi mieć wartość Funkcja. |
FeatureTypeEnum
Typ funkcji musi mieć wartość Funkcja.
Nazwa | Typ | Opis |
---|---|---|
Feature |
string |
GeocodePoints
Kolekcja punktów kodu geograficznego, które różnią się sposobem ich obliczania i sugerowanym użyciem.
Nazwa | Typ | Opis |
---|---|---|
calculationMethod |
Metoda, która została użyta do obliczenia punktu kodu geograficznego. |
|
geometry |
Prawidłowy |
|
usageTypes |
Najlepsze zastosowanie dla punktu kodu geograficznego.
Każdy punkt kodu geograficznego |
GeocodingResponse
Ten obiekt jest zwracany z pomyślnego wywołania geokodowania
Nazwa | Typ | Opis |
---|---|---|
features | ||
nextLink |
string |
To link do następnej strony zwróconych funkcji. Jeśli jest to ostatnia strona, nie ma tego pola. |
type |
Typ obiektu FeatureCollection musi być FeatureCollection. |
GeoJsonPoint
Prawidłowy GeoJSON Point
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
coordinates |
number[] |
A |
type |
string:
Point |
Określa |
Intersection
Adres wyniku.
Nazwa | Typ | Opis |
---|---|---|
baseStreet |
string |
Główna ulica dla lokalizacji. |
displayName |
string |
Pełna nazwa skrzyżowania. |
intersectionType |
string |
Typ skrzyżowania. |
secondaryStreet1 |
string |
Pierwsza przecinając ulicę. |
secondaryStreet2 |
string |
Jeśli istnieje, druga przecinając ulicę. |
MatchCodesEnum
Co najmniej jedna zgodna wartość kodu reprezentująca poziom geokodowania dla każdej lokalizacji w odpowiedzi.
Na przykład lokalizacja geokodowana z kodami Good
dopasowania i Ambiguous
oznacza, że odnaleziono więcej niż jedną lokalizację geokodu dla informacji o lokalizacji i że usługa geokodowania nie ma hierarchii wyszukiwania w górę, aby znaleźć dopasowanie.
Podobnie lokalizacja geokodowana z kodami Ambiguous
dopasowania i UpHierarchy
oznacza, że nie można odnaleźć lokalizacji geokodu pasujących do wszystkich podanych informacji o lokalizacji, więc usługa geokodowania musiała przeszukiwać hierarchię i znajdować wiele dopasowań na tym poziomie. Przykładem elementu Ambiguous
i UpHierarchy
jest podanie pełnych informacji o adresie, ale usługa geokodu nie może zlokalizować dopasowania dla adresu ulicznego i zamiast tego zwraca informacje dla więcej niż jednej wartości roadblock.
Możliwe wartości są następujące:
Good
: Lokalizacja ma tylko jedno dopasowanie lub wszystkie zwrócone mecze są uznawane za silne mecze. Na przykład zapytanie dla Nowego Jorku zwraca kilka dobrych dopasowań.
Ambiguous
: Lokalizacja jest jednym z zestawów możliwych dopasowań. Na przykład podczas wykonywania zapytania o adres ulicy 128 Main St., odpowiedź może zwrócić dwie lokalizacje dla 128 North Main St. i 128 South Main St. ponieważ nie ma wystarczającej ilości informacji, aby określić, która opcja ma zostać wybrana.
UpHierarchy
: Lokalizacja reprezentuje przeniesienie w górę hierarchii geograficznej. Dzieje się tak, gdy nie znaleziono dopasowania żądania lokalizacji, dlatego zwracany jest mniej precyzyjny wynik. Jeśli na przykład nie można odnaleźć dopasowania żądanego adresu, może zostać zwrócony kod dopasowania typu UpHierarchy
jednostki RoadBlock.
Nazwa | Typ | Opis |
---|---|---|
Ambiguous |
string |
|
Good |
string |
|
UpHierarchy |
string |
Properties
Nazwa | Typ | Opis |
---|---|---|
address |
Adres wyniku |
|
confidence |
Poziom pewności, że wynik lokalizacji geokodowanej jest zgodny. Użyj tej wartości z kodem dopasowania, aby określić więcej pełnych informacji o dopasowaniu. Pewność lokalizacji geokodowanej opiera się na wielu czynnikach, w tym względnej ważności lokalizacji geokodowanej i lokalizacji użytkownika, jeśli zostanie określony. |
|
geocodePoints |
Kolekcja punktów geokodu, które różnią się sposobem ich obliczania i sugerowanym użyciem. |
|
matchCodes |
Co najmniej jedna zgodna wartość kodu reprezentująca poziom geokodowania dla każdej lokalizacji w odpowiedzi. Na przykład lokalizacja geokodowana z kodami Podobnie lokalizacja geokodowana z kodami Możliwe wartości są następujące:
|
|
type |
string |
Jeden z:
|
ReverseGeocodingResultTypeEnum
Określ typy jednostek, które mają być w odpowiedzi. Zostaną zwrócone tylko określone typy. Jeśli nie można zamapować punktu na określone typy jednostek, w odpowiedzi nie są zwracane żadne informacje o lokalizacji. Wartość domyślna to wszystkie możliwe jednostki. Rozdzielona przecinkami lista typów jednostek wybranych z następujących opcji.
- Adres
- Sąsiedztwo
- Zapełnione miejsce
- Kod pocztowy 1
- AdminDivision1
- AdminDivision2
- CountryRegion
Te typy jednostek są uporządkowane od najbardziej konkretnej jednostki do najmniej konkretnej jednostki. Gdy znaleziono jednostki o więcej niż jednym typie, zwracana jest tylko najbardziej konkretna jednostka. Jeśli na przykład określisz wartości Address i AdminDistrict1 jako typy jednostek i jednostki dla obu typów, w odpowiedzi zostanie zwrócona tylko informacja o jednostce Adres.
Nazwa | Typ | Opis |
---|---|---|
Address |
string |
|
AdminDivision1 |
string |
|
AdminDivision2 |
string |
|
CountryRegion |
string |
|
Neighborhood |
string |
|
PopulatedPlace |
string |
|
Postcode1 |
string |
UsageTypeEnum
Najlepsze zastosowanie dla punktu kodu geograficznego.
Każdy punkt kodu geograficznego Route
jest definiowany jako punkt, Display
punkt lub oba.
Użyj Route
punktów, jeśli tworzysz trasę do lokalizacji. Użyj Display
punktów, jeśli wyświetlasz lokalizację na mapie. Na przykład jeśli lokalizacja jest parkiem, punkt może określić wejście do parku, Route
w którym można wejść z samochodem, a Display
punkt może być punktem określającym centrum parku.
Nazwa | Typ | Opis |
---|---|---|
Display |
string |
|
Route |
string |