Search - Get Search Address Structured

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Służy do pobierania współrzędnych szerokości i długości geograficznej adresu ulicy w formacie wejściowym bez struktury lub zapytania.
Get Search Address Structured Interfejs API (Geokodowanie adresów strukturalnych) to żądanie HTTPGET, które zwraca współrzędne szerokości i długości geograficznej adresu ulicy w formacie wejściowym bez struktury lub zapytania.

Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Nie zostaną zwrócone żadne interfejsy POI. Należy pamiętać, że geokoder jest bardzo odporny na literówki i niekompletne adresy. Będzie również obsługiwać wszystko, od dokładnych adresów ulicznych lub ulic lub skrzyżowania, a także lokalizacji geograficznych wyższego poziomu, takich jak centra miast, powiaty, stany itp.

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

Z parametrami opcjonalnymi:

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}

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.
countryCode	query	True	string	Część kodu kraju/regionu o numerze 2 lub 3 ISO3166-1 . Np. Stany Zjednoczone.
countrySecondarySubdivision	query		string	Kraj/region dla adresu ustrukturyzowanego
countrySubdivision	query		string	Część adresu w poddziałie kraju/regionu
countryTertiarySubdivision	query		string	Nazwany obszar dla adresu strukturalnego
crossStreet	query		string	Nazwa ulicy krzyżowej dla adresu ze strukturą
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
extendedPostalCodesFor	query		SearchIndexes[]	Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach. Dostępne indeksy to: Addr = zakresy adresów Geo = Geographies PAD = adresy punktów PoI = punkty orientacyjne Str = ulice XStr = Skrzyżowania (skrzyżowania) Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub brakiem indeksów. Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane. Przykłady użycia: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.
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 .
limit	query		integer minimum: 1 maximum: 100	Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100
municipality	query		string	Część adresu w gminie
municipalitySubdivision	query		string	Poddział gminy (podmiejza/miasto) dla adresu strukturalnego
ofs	query		integer minimum: 0 maximum: 1900	Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Ustawienie domyślne: 0
postalCode	query		string	Część kodu pocztowego adresu
streetName	query		string	Część adresu z nazwą ulicy
streetNumber	query		string	Część numeru ulicy adresu
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	SearchAddressResult	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.

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ół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.

Typ: apiKey
W: 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.

Typ: apiKey
W: header

Przykłady

Search address in Redmond, WA in structured form

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
Address	Adres wyniku
AddressRanges	Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowej i końcowej zakresu adresów.
BoundingBox	Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.
BoundingBoxCompassNotation	Pole ograniczenia lokalizacji.
Brand	Marka skojarzona z interfejsem POI
Classification	Klasyfikacja zwracanego interfejsu użytkownika
ClassificationName	Nazwa klasyfikacji
DataSources	Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon.
Entity	Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.
EntryPoint	Punkt wejścia dla zwracanego punktu weryfikacji koncepcji.
EntryPointType	Typ punktu wejścia. Wartość może być główna lub pomocnicza.
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.
Geometry	Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.
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.
OperatingHours	Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).
OperatingHoursTime	Reprezentuje datę i godzinę
OperatingHoursTimeRange	Zakres czasu otwierania na dzień
PointOfInterest	Szczegóły zwróconego interfejsu użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
PointOfInterestCategorySet	Kategoria poi
QueryType	Zwracany typ zapytania: NEARBY lub NON_NEAR.
ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
SearchAddressResult	Ten obiekt jest zwracany z pomyślnych wywołań Search.
SearchAddressResultItem	Obiekt wyniku odpowiedzi interfejsu API Search.
SearchAddressResultType	Jeden z: UM Ulica Lokalizacja geograficzna Adres punktu Zakres adresów Ulica krzyżowa
SearchIndexes	Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach. Dostępne indeksy to: Addr = zakresy adresów Geo = Geografie PAD = adresy punktów POI = punkty orientacyjne Str = ulice XStr = Cross Streets (skrzyżowania) Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub Brak dla żadnych indeksów. Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane. Przykłady użycia: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.
SearchSummary	Obiekt podsumowania odpowiedzi interfejsu API Search.

Address

Objekt

Adres wyniku

Nazwa	Typ	Opis
boundingBox	BoundingBoxCompassNotation	Pole ograniczenia lokalizacji.
buildingNumber	string	Numer budynku na ulicy. PRZESTARZAŁE, zamiast tego użyj streetNumber.
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 przekraczana.
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ę mieszkaniową. W zależności od lokalizacji `municipality` wartość może różnić się od powszechnie znanej nazwy miasta lub miasta. W przypadku powszechnie znanej nazwy miasta lub miasta zaleca się, aby `localName` wartość była używana zamiast `municipality` wartości.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Sąsiedztwo to geograficznie zlokalizowany obszar w mieście lub mieście o charakterystycznych cechach i interakcjach społecznych 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 nazwy streetName.
streetName	string	Nazwa ulicy.
streetNameAndNumber	string	Nazwa i numer ulicy.
streetNumber	string	Numer budynku na ulicy.

AddressRanges

Objekt

Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowej i końcowej zakresu adresów.

Nazwa	Typ	Opis
from	LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
rangeLeft	string	Zakres adresów po lewej stronie ulicy.
rangeRight	string	Zakres adresów po prawej stronie ulicy.
to	LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

BoundingBox

Objekt

Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.

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

BoundingBoxCompassNotation

Objekt

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

Brand

Objekt

Marka skojarzona z interfejsem POI

Nazwa	Typ	Opis
name	string	Nazwa marki

Classification

Objekt

Klasyfikacja zwracanego interfejsu użytkownika

Nazwa	Typ	Opis
code	string	Właściwość Code
names	ClassificationName[]	Tablica nazw

ClassificationName

Objekt

Nazwa klasyfikacji

Nazwa	Typ	Opis
name	string	Name — Właściwość
nameLocale	string	Nazwa właściwości ustawień regionalnych

DataSources

Objekt

Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon.

Nazwa	Typ	Opis
geometry	Geometry	Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.

Entity

Wyliczanie

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

Wartość	Opis
position	Pozycja jednostki

EntryPoint

Objekt

Punkt wejścia dla zwracanego punktu weryfikacji koncepcji.

Nazwa	Typ	Opis
position	LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
type	EntryPointType	Typ punktu wejścia. Wartość może być główna lub pomocnicza.

EntryPointType

Wyliczanie

Typ punktu wejścia. Wartość może być główna lub pomocnicza.

Wartość	Opis
main
minor

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

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

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GeographicEntityType

Wyliczanie

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

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

Geometry

Objekt

Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.

Nazwa	Typ	Opis
id	string	Przekaż go jako geometryId do interfejsu API Get Search Polygon, aby pobrać informacje o geometrii dla tego wyniku.

LatLongPairAbbreviated

Objekt

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

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

LocalizedMapView

Wyliczanie

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.

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

MatchType

Wyliczanie

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.

Wartość	Opis
AddressPoint
HouseNumberRange
Street

OperatingHours

Objekt

Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).

Nazwa	Typ	Opis
mode	string	Wartość używana w żądaniu: brak lub "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista zakresów czasu dla następnych 7 dni

OperatingHoursTime

Objekt

Reprezentuje datę i godzinę

Nazwa	Typ	Opis
date	string	Reprezentuje bieżącą datę kalendarza w strefie czasowej POI, np. "2019-02-07".
hour	integer	Godziny są w formacie 24 godziny w czasie lokalnym weryfikacji koncepcji; możliwe wartości to 0–23.
minute	integer	Minuty są w czasie lokalnym weryfikacji koncepcji; możliwe wartości to 0–59.

OperatingHoursTimeRange

Objekt

Zakres czasu otwierania na dzień

Nazwa	Typ	Opis
endTime	OperatingHoursTime	Punkt w ciągu najbliższych 7 dni od momentu zamknięcia danego interfejsu wiersza polecenia lub początku zakresu, jeśli został zamknięty przed zakresem.
startTime	OperatingHoursTime	Punkt w ciągu najbliższych 7 dni od otwarcia danego interfejsu wiersza polecenia lub początku zakresu, jeśli został otwarty przed zakresem.

PointOfInterest

Objekt

Szczegóły zwróconego interfejsu użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.

Nazwa	Typ	Opis
brands	Brand[]	Tablica marek. Nazwa marki zwracanej przez weryfikację koncepcji.
categories	string[]	Tablica kategorii
categorySet	PointOfInterestCategorySet[]	Lista najbardziej określonych kategorii poi
classifications	Classification[]	Tablica klasyfikacji
name	string	Nazwa właściwości POI
openingHours	OperatingHours	Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).
phone	string	Właściwość numeru telefonu
url	string	Właściwość adresu URL witryny sieci Web

PointOfInterestCategorySet

Objekt

Kategoria poi

Nazwa	Typ	Opis
id	integer	Identyfikator kategorii

QueryType

Wyliczanie

Zwracany typ zapytania: NEARBY lub NON_NEAR.

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

ResponseFormat

Wyliczanie

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

Wartość	Opis
json	Format wymiany danych notacji obiektów JavaScript
xml	Rozszerzalny język znaczników

SearchAddressResult

Objekt

Ten obiekt jest zwracany z pomyślnych wywołań Search.

Nazwa	Typ	Opis
results	SearchAddressResultItem[]	Lista wyników interfejsu API Search.
summary	SearchSummary	Obiekt podsumowania odpowiedzi interfejsu API Search

SearchAddressResultItem

Objekt

Obiekt wyniku odpowiedzi interfejsu API Search.

Nazwa	Typ	Opis
address	Address	Adres wyniku
addressRanges	AddressRanges	Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowej i końcowej zakresu adresów.
dataSources	DataSources	Sekcja opcjonalna. Dokumentacja identyfikatora geometrii do użycia z interfejsem API Get Search Polygon.
detourTime	integer	Czas objazdu w sekundach. Zwracane tylko w przypadku wywołań interfejsu API Search Wzdłuż trasy.
dist	number (double)	Odległość linii prostej między lokalizacją wyniku a geobiasami w metrach.
entityType	GeographicEntityType	Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.
entryPoints	EntryPoint[]	Tablica punktów wejścia. Opisują one typy wejść dostępnych w lokalizacji. Typ może być "główny" dla głównych wejść, takich jak drzwi wejściowe, lub hol, i "drobne", dla drzwi bocznych i tylnych.
id	string	Właściwość Id
info	string	Informacje o oryginalnym źródle danych wyniku. Służy do obsługi żądań pomocy technicznej.
matchType	MatchType	Informacje o typie dopasowania. Jeden z: Punkt adresu HouseNumberRange Ulica
poi	PointOfInterest	Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
position	LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
score	number (double)	Wartość w zestawie wyników wskazująca względny wynik dopasowania między wynikami. Można to użyć, aby określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x wynosi 2x wartość y. Wartości różnią się między zapytaniami i są przeznaczone tylko jako wartość względna dla jednego zestawu wyników.
type	SearchAddressResultType	Jeden z: UM Ulica Lokalizacja geograficzna Adres punktu Zakres adresów Cross Street
viewport	BoundingBox	Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku.

SearchAddressResultType

Wyliczanie

Jeden z:

UM
Ulica
Lokalizacja geograficzna
Adres punktu
Zakres adresów
Ulica krzyżowa

Wartość	Opis
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Wyliczanie

Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach.

Dostępne indeksy to:

Addr = zakresy adresów

Geo = Geografie

PAD = adresy punktów

POI = punkty orientacyjne

Str = ulice

XStr = Cross Streets (skrzyżowania)

Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub Brak dla żadnych indeksów.

Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane.

Przykłady użycia:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.

Wartość	Opis
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Objekt

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.

Udostępnij za pośrednictwem

Search - Get Search Address Structured

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Zakresy

subscription-key

SAS Token

Przykłady

Search address in Redmond, WA in structured form

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchSummary

Dodatkowe zasoby