Search - Get Search Address Reverse

Service:

Maps

API Version:

1.0

Użyj polecenia , aby uzyskać informacje o adresie i lokalizacji ulicy ze współrzędnych szerokości i długości geograficznej.
Interfejs Get Search Address Reverse API to i żądanie HTTP GET , które zwraca adres ulicy lub lokalizację, gdy dana współrzędna szerokości i długości geograficznej.

Czasami trzeba przetłumaczyć współrzędną (na przykład 37.786505, -122.3862) na zrozumiały adres ulicy. Najczęściej jest to potrzebne w aplikacjach do śledzenia, gdzie otrzymujesz kanał GPS z urządzenia lub zasobu i chcesz wiedzieć, jaki adres, gdzie znajduje się współrzędna. Ten punkt końcowy zwróci informacje o adresie dla danej współrzędnej.

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}

With optional parameters:

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&entityType={entityType}&view={view}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.
query	query	True	number[]	Odpowiednie zapytanie określone jako ciąg rozdzielany przecinkami składające się z szerokości geograficznej, po której następuje długość geograficzna, np. "47.641268,-122.125679".
allowFreeformNewline	query		boolean	Format nowego wiersza w sformatowanych adresach. Jeśli wartość true, adres będzie zawierać nowe linie. W przypadku wartości false nowe linie zostaną przekonwertowane na przecinki.
entityType	query		GeographicEntityType	Określa poziom filtrowania wykonywanego w lokalizacjach geograficznych. Zawęża wyszukiwanie określonych typów jednostek geograficznych, np. zwraca tylko gminy. Wynikowa odpowiedź będzie zawierać identyfikator geografii, a także dopasowany typ jednostki. Jeśli podasz więcej niż jedną jednostkę jako listę rozdzielaną przecinkami, punkt końcowy zwróci "najmniejszą dostępną jednostkę". Zwrócony identyfikator geometrii może służyć do uzyskania geometrii tej lokalizacji geograficznej za pośrednictwem interfejsu API Get Search Polygon API. Podczas ustawiania właściwości entityType są ignorowane następujące parametry: Pozycji liczba returnRoadUse returnSpeedLimit roadUse returnMatchType
heading	query		integer	Kierunek kierunku pojazdu w stopniach, do podróży wzdłuż odcinka drogi. 0 to Północ, 90 to Wschód i tak dalej, wartości wahają się od -360 do 360. Precyzja może obejmować maksymalnie jedno miejsce dziesiętne
language	query		string	Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane języki .
number	query		string	Numer ulicy jako ciąg. Jeśli liczba jest wysyłana wraz z żądaniem, odpowiedź może zawierać bok ulicy (lewy/prawy), a także położenie przesunięcia dla tej liczby
radius	query		integer	Promień w metrach dla wyników, które mają być ograniczone do zdefiniowanego obszaru
returnMatchType	query		boolean	Dołącz informacje o typie dopasowania geokodera osiągniętego w odpowiedzi.
returnRoadUse	query		boolean	Boolean. Aby włączyć powrót drogi, użyj tablicy dla odwróconych geokodów na poziomie ulicy
returnSpeedLimit	query		boolean	Boolean. Aby umożliwić powrót limitu prędkości zaksięgowania
roadUse	query		RoadUseType[]	Aby ograniczyć odwrotne kody geograficzne do określonego typu użycia dróg. Tablica użycia dróg dla odwrotnych kodów geograficznych może być co najmniej jedna z funkcji LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet
view	query		LocalizedMapView	Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie prawidłowych map dla określonego kraju/regionu dla spornych geopolitycznie regionów. Różne kraje/regiony mają różne widoki takich regionów, a parametr Wyświetl umożliwia aplikacji zachowanie zgodności z widokiem wymaganym przez kraj/region, który będzie obsługiwać aplikacja. Domyślnie parametr Widok jest ustawiony na wartość "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania, kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki, zapoznaj się z tematem Obsługiwane 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ń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReverseSearchAddressResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. Po 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 Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego Azure Maps konta zasobu 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 Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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 w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps .
• Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra.
• Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
• Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
• Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz współużytkowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu Azure Maps interfejsów API REST, aby klucz mógł być bezpiecznie przechowywany.

Type: apiKey
In: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list sygnatur dostępu współdzielonego na zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny 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 SAS.

Type: apiKey
In: header

Przykłady

Searches addresses for coordinates 37.337,-121.89

Sample Request

HTTP

GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89

Sample Response

Status code:

200

{
  "summary": {
    "queryTime": 5,
    "numResults": 1
  },
  "addresses": [
    {
      "address": {
        "streetNumber": "31",
        "routeNumbers": [],
        "streetName": "N 2nd St",
        "streetNameAndNumber": "31 N 2nd St",
        "countryCode": "US",
        "countrySubdivisionCode": "CA",
        "countrySubdivisionName": "California",
        "municipality": "San Jose",
        "postalCode": "95113",
        "country": "United States of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "31 N 2nd St, San Jose CA 95113",
        "extendedPostalCode": "951131217"
      },
      "position": "37.337090,-121.889820"
    }
  ]
}

Definicje

Nazwa	Opis
Address	Adres wyniku
BoundingBoxCompassNotation	Pole ograniczenia lokalizacji.
Entity	Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GeographicEntityType	Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.
LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
LocalizedMapView	Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.
MatchType	Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.
QueryType	Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
ReverseSearchAddressResult	Ten obiekt jest zwracany z pomyślnego wywołania odwrotnego adresu Search
ReverseSearchAddressResultItem	Obiekt wyniku dla odpowiedzi odwrotnej adresu Search
RoadUseType	Opisuje możliwe zastosowania drogi.
SearchSummary	Obiekt podsumowania odpowiedzi interfejsu API Search.

Address

Adres wyniku

Nazwa	Typ	Opis
boundingBox	BoundingBoxCompassNotation	Pole ograniczenia lokalizacji.
buildingNumber	string	Numer budynku na ulicy. PRZESTARZAŁE użyj streetNumber zamiast tego.
country	string	nazwa kraju/regionu
countryCode	string	Kraj (Uwaga: jest to dwuliterowy kod, a nie nazwa kraju/regionu).
countryCodeISO3	string	Kod kraju ISO alfa-3
countrySecondarySubdivision	string	Powiat
countrySubdivision	string	Stan lub prowincja
countrySubdivisionCode	string	countrySubdivisionCode prefiks ( countryCode countryCode-countrySubdivisionCode ) i łącznik tworzy kod ISO 3166-2. Przykłady: TX dla Teksasu, SCT dla Szkocji i ON dla Ontario.
countrySubdivisionName	string	Pełna nazwa pierwszego poziomu hierarchii administracyjnej kraju/regionu. To pole jest wyświetlane tylko w przypadku, gdy countrySubdivision jest przedstawiany w skróconej formie. Obsługiwane tylko w przypadku Stanów Zjednoczonych, Kanady i Wielkiej Brytanii.
countryTertiarySubdivision	string	Nazwany obszar
crossStreet	string	Nazwa ulicy, która jest skrzyżowana.
extendedPostalCode	string	Rozszerzony kod pocztowy (dostępność zależy od regionu).
freeformAddress	string	Wiersz adresu sformatowany zgodnie z regułami formatowania kraju/regionu pochodzenia wyniku lub w przypadku kraju/regionu pełna nazwa kraju/regionu.
localName	string	Składnik adresu, który reprezentuje nazwę obszaru geograficznego lub lokalizacji, który grupuje wiele obiektów adresowalnych na potrzeby adresowania, bez jednostki administracyjnej. To pole służy do kompilowania freeformAddress właściwości . localName reprezentuje gminę pocztową. W zależności od lokalizacji localName jest powszechnie znaną nazwą miasta lub miasta. Dla powszechnie znanej nazwy miasta lub miasta użyj localName zamiast municipality.
municipality	string	Miasto /Miasto Uwaga: municipality reprezentuje gminę mieszkalną. W zależności od lokalizacji municipality wartość może się różnić od powszechnie znanej nazwy miasta lub miasta. W przypadku powszechnie znanej nazwy miasta lub miasta sugerowane jest, aby localName wartość była używana zamiast municipality wartości.
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Dzielnica jest geograficznie zlokalizowanym obszarem w mieście lub mieście z charakterystycznymi cechami i interakcjami społecznymi między mieszkańcami.
postalCode	string	Kod pocztowy/kod pocztowy
routeNumbers	string[]	Kody używane do jednoznacznej identyfikacji ulicy
street	string	Nazwa ulicy. PRZESTARZAŁE zamiast tego użyj streetName.
streetName	string	Nazwa ulicy.
streetNameAndNumber	string	Nazwa ulicy i numer.
streetNumber	string	Numer budynku na ulicy.

BoundingBoxCompassNotation

Pole ograniczenia lokalizacji.

Nazwa	Typ	Opis
entity	Entity	Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.
northEast	string	Szerokość geograficzna północno-wschodnia, współrzędna długości geograficznej pola ograniczenia jako rozdzielane przecinkami liczby zmiennoprzecinkowe
southWest	string	Szerokość geograficzna południowo-zachodnia,współrzędna długości geograficznej pola ograniczenia jako rozdzielane przecinkami liczby zmiennoprzecinkowe

Entity

Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.

Nazwa	Typ	Opis
position	string	Pozycja jednostki

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	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	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	ErrorDetail	Obiekt błędu.

GeographicEntityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.

Nazwa	Typ	Opis
Country	string	nazwa kraju/regionu
CountrySecondarySubdivision	string	Powiat
CountrySubdivision	string	Stan lub prowincja
CountryTertiarySubdivision	string	Nazwany obszar
Municipality	string	Miasto /Miasto
MunicipalitySubdivision	string	Sub / Super City
Neighbourhood	string	Sąsiedztwa
PostalCodeArea	string	Kod pocztowy/kod pocztowy

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

Nazwa	Typ	Opis
lat	number	Właściwość Szerokość geograficzna
lon	number	Właściwość Długość geograficzna

LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.

Nazwa	Typ	Opis
AE	string	Zjednoczone Emiraty Arabskie (widok arabski)
AR	string	Argentyna (widok argentyński)
Auto	string	Zwróć dane mapy na podstawie adresu IP żądania.
BH	string	Bahrajn (widok arabski)
IN	string	Indie (Widok indyjski)
IQ	string	Irak (widok arabski)
JO	string	Jordania (widok arabski)
KW	string	Kuwejt (widok arabski)
LB	string	Liban (widok arabski)
MA	string	Maroko (widok marokański)
OM	string	Oman (widok arabski)
PK	string	Pakistan (Widok pakistanu)
PS	string	Autonomia Palestyńska (widok arabski)
QA	string	Katar (widok arabski)
SA	string	Arabia Saudyjska (widok arabski)
SY	string	Syria (widok arabski)
Unified	string	Ujednolicony widok (inne)
YE	string	Jemen (widok arabski)

MatchType

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.

Nazwa	Typ	Opis
AddressPoint	string
HouseNumberRange	string
Street	string

QueryType

Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.

Nazwa	Typ	Opis
NEARBY	string	Search wykonano wokół określonej szerokości i długości geograficznej ze zdefiniowanym promieniem
NON_NEAR	string	Search wykonano globalnie bez uprzedzeń do określonej szerokości geograficznej i długości geograficznej oraz bez zdefiniowanego promienia

ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript
xml	string	Rozszerzalny język znaczników

ReverseSearchAddressResult

Ten obiekt jest zwracany z pomyślnego wywołania odwrotnego adresu Search

Nazwa	Typ	Opis
addresses	ReverseSearchAddressResultItem[]	Tablica adresów
summary	SearchSummary	Obiekt podsumowania dla odpowiedzi odwrotnej adresu Search

ReverseSearchAddressResultItem

Obiekt wyniku dla odpowiedzi odwrotnej adresu Search

Nazwa	Typ	Opis
address	Address	Adres wyniku
matchType	MatchType	Informacje o typie dopasowania. Jeden z: Punkt adresowy HouseNumberRange Ulica
position	string	Pozycja właściwości w postaci "{latitude},{długość geograficzna}"
roadUse	RoadUseType[]	Opisuje możliwe zastosowania drogi.

RoadUseType

Opisuje możliwe zastosowania drogi.

Nazwa	Typ	Opis
Arterial	string
LimitedAccess	string
LocalStreet	string
Ramp	string
Rotary	string
Terminal	string

SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API Search.

Nazwa	Typ	Opis
fuzzyLevel	integer	Maksymalny poziom rozmyty wymagany do udostępnienia wyników.
geoBias	LatLongPairAbbreviated	Wskazanie, kiedy wewnętrzna wyszukiwarka zastosowała stronniczość geoprzestrzenną, aby poprawić klasyfikację wyników. W niektórych metodach może to mieć wpływ, ustawiając parametry lat i lon, jeśli są dostępne. W innych przypadkach jest to wyłącznie wewnętrzne.
limit	integer	Maksymalna liczba odpowiedzi, które zostaną zwrócone
numResults	integer	Liczba wyników w odpowiedzi.
offset	integer	Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników.
query	string	Parametr zapytania, który został użyty do wygenerowania tych wyników wyszukiwania.
queryTime	integer	Czas spędzony na rozpoznawaniu zapytania w milisekundach.
queryType	QueryType	Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
totalResults	integer	Łączna liczba znalezionych wyników.