Search - Get Search Address

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.

Interfejs API Get Search Address to żądanie GET HTTP zwraca współrzędne szerokości i długości geograficznej po przekazaniu w adresie ulicy lub nazwie miejsca jako kryteriów wyszukiwania.

W wielu przypadkach kompletna usługa wyszukiwania może być zbyt duża, na przykład jeśli interesuje Cię tylko tradycyjne geokodowanie. Dostęp do wyszukiwania adresów można również uzyskać w trybie wyłącznym. Geokodowanie odbywa się przez naciśnięcie punktu końcowego kodu geograficznego tylko przy użyciu adresu lub adresu częściowego. 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 miasta, powiaty, stany itp.

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

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&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 usługi Azure Maps.
query	query	True	string	Adres do wyszukania (np. "1 microsoft way, Redmond, WA"), musi być prawidłowo zakodowany adres URL.
btmRight	query		string	Prawe dolne położenie pola ograniczenia. Np. 37.553,-122.453
countrySet	query		string[]	Rozdzielony przecinkami ciąg kodów kraju/regionu, np. FR,ES. Spowoduje to ograniczenie wyszukiwania do określonych krajów/regionów
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 uzyskiwania geometrii tej lokalizacji geograficznej za pomocą interfejsu API Uzyskiwanie wielokąta wyszukiwania. Następujące parametry są ignorowane, gdy parametr entityType jest ustawiony: nagłówek 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: dodatku = zakresy adresów Geo = Geographies PAD = adresy punktów POI = punkty orientacyjne Str = Ulice XStr = Cross Streets (skrzyżowania) Wartość powinna być rozdzielona przecinkami lista 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 muszą być jawnie żądane w razie potrzeby. 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, zobacz Obsługiwane języki.
lat	query		number (double)	Szerokość geograficzna, w której wyniki powinny być stronnicze. Np. 37.337
limit	query		integer minimum: 1 maximum: 100	Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100
lon	query		number (double)	Długość geograficzna, w której wyniki powinny być stronnicze. Np. -121.89
ofs	query		integer minimum: 0 maximum: 1900	Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Wartość domyślna: 0
radius	query		integer	Promień w metrach dla wyników, które mają być ograniczone do zdefiniowanego obszaru
topLeft	query		string	Lewa górna pozycja pola ograniczenia. Np. 37.553,-122.453
typeahead	query		boolean	Boolowski. Jeśli ustawiono flagę typeahead, zapytanie zostanie zinterpretowane jako dane wejściowe częściowe, a wyszukiwanie przejdzie w tryb predykcyjny
view	query		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 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 usłudze 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 usługi Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić 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ń Microsoft Entra ID. 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ń identyfikatora Entra firmy Microsoft 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 dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą 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 koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera 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 usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania Maps.
• Authorization URL jest specyficzna 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 na podstawie 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 Web SDK 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 Microsoft identity platform overview.

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 tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu 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 poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, 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 SAS na 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 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 i 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 zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

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

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Przykładowa odpowiedź

Kod stanu:

200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "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 980525544",
        "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ątkowych i końcowych 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 API.
Entity	Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.
EntryPoint	Punkt wejścia zwracanego interfejsu użytkownika.
EntryPointType	Typ punktu wejścia. Wartość może być głównym lub pomocniczym.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GeographicEntityType	Typ jednostki Geografia. Prezentuj tylko wtedy, gdy zażądano parametru entityType i jest dostępny.
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 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 usłudze 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 usługi Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki.
MatchType	Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.
OperatingHours	Godziny otwarcia poi (punkty orientacyjne).
OperatingHoursTime	Reprezentuje datę i godzinę
OperatingHoursTimeRange	Zakres czasu otwarcia na dzień
PointOfInterest	Szczegółowe informacje o zwracanym interfejsie użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
PointOfInterestCategorySet	Kategoria poi
QueryType	Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
SearchAddressResult	Ten obiekt jest zwracany z pomyślnych wywołań wyszukiwania.
SearchAddressResultItem	Wynik obiektu odpowiedzi interfejsu API wyszukiwania.
SearchAddressResultType	Jeden z: Punkt Zainteresowania (PZ) Ulica Geografia Adres punktu Zakres adresów Cross Street
SearchIndexes	Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach. Dostępne indeksy to: dodatku = zakresy adresów Geo = Geographies PAD = adresy punktów POI = punkty orientacyjne Str = Ulice XStr = Cross Streets (skrzyżowania) Wartość powinna być rozdzielona przecinkami lista 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 muszą być jawnie żądane w razie potrzeby. 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 wyszukiwania.

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 prefiksowany przez 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 prezentowany 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 wynikowego pochodzenia lub w przypadku kraju/regionu pełna nazwa kraju/regionu.
localName	string	Składnik adresu reprezentujący nazwę obszaru geograficznego lub lokalności, który grupuje wiele obiektów adresowalnych na potrzeby adresowania, bez jednostki administracyjnej. To pole służy do kompilowania właściwości freeformAddress. localName reprezentuje gminę pocztową. W zależności od lokalizacji localName jest powszechnie znaną nazwą miasta lub miasta. W przypadku powszechnie znanej nazwy miasta lub miasta należy użyć localName zamiast municipality.
municipality	string	Miasto/ Miasto Uwaga: municipality reprezentuje gminę mieszkalną. W zależności od lokalizacji wartość municipality może różnić się od powszechnie znanej nazwy miasta lub miasta. W przypadku powszechnie znanej nazwy miasta lub miasta zaleca się, aby wartość localName była używana zamiast wartości municipality.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Sąsiedztwo to geograficznie zlokalizowany obszar 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.

AddressRanges

Objekt

Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowych i końcowych 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 geograficzna pola ograniczenia jako rozdzielane przecinkami zmiennoprzecinkowe
southWest	string	Szerokość geograficzna południowo-zachodnia,współrzędna geograficzna pola ograniczenia jako rozdzielane przecinkami 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ść kodu
names	ClassificationName[]	Tablica nazw

ClassificationName

Objekt

Nazwa klasyfikacji

Nazwa	Typ	Opis
name	string	Właściwość Nazwa
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 API.

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 zwracanego interfejsu użytkownika.

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łównym lub pomocniczym.

EntryPointType

Wyliczanie

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

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. Prezentuj tylko wtedy, gdy zażądano parametru entityType i jest dostępny.

Wartość	Opis
Country	nazwa kraju/regionu
CountrySecondarySubdivision	Powiat
CountrySubdivision	Stan lub prowincja
CountryTertiarySubdivision	Nazwany obszar
Municipality	Miasto/ Miasto
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Sąsiedztwo
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 geometryczne 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 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 usłudze 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 usługi Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić 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 (Pakistani View)
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 poi (punkty orientacyjne).

Nazwa	Typ	Opis
mode	string	Wartość użyta 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 poi; możliwe wartości to 0–23.
minute	integer	Minuty są w czasie lokalnym poi; możliwe wartości to 0–59.

OperatingHoursTimeRange

Objekt

Zakres czasu otwarcia na dzień

Nazwa	Typ	Opis
endTime	OperatingHoursTime	Punkt w ciągu najbliższych 7 dni, gdy dany poI jest zamykany, lub początek zakresu, jeśli został zamknięty przed zakresem.
startTime	OperatingHoursTime	Punkt w ciągu najbliższych 7 dni, gdy dany poI jest otwierany, lub początek zakresu, jeśli został otwarty przed zakresem.

PointOfInterest

Objekt

Szczegółowe informacje o zwracanym interfejsie użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.

Nazwa	Typ	Opis
brands	Brand[]	Tablica marek. Nazwa marki zwracanej przez interfejs użytkownika.
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 poi (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: W POBLIŻU lub NON_NEAR.

Wartość	Opis
NEARBY	Wyszukiwanie zostało wykonane wokół określonej szerokości geograficznej i długości geograficznej ze zdefiniowanym promieniem
NON_NEAR	Wyszukiwanie zostało wykonane globalnie, bez stronniczo do określonej szerokości geograficznej i długości geograficznej i 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	rozszerzalnego języka znaczników

SearchAddressResult

Objekt

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

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

SearchAddressResultItem

Objekt

Wynik obiektu odpowiedzi interfejsu API wyszukiwania.

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ątkowych i końcowych zakresu adresów.
dataSources	DataSources	Sekcja opcjonalna. Identyfikator geometrii do użycia z interfejsem API Get Search Polygon API.
detourTime	integer	Czas objazdu w sekundach. Zwracane tylko dla wywołań interfejsu API wyszukiwania wzdłuż trasy.
dist	number (double)	Odległość linii prostej między wynikiem a lokalizacją geobiazy w metrach.
entityType	GeographicEntityType	Typ jednostki Geografia. Prezentuj tylko wtedy, gdy zażądano parametru entityType i jest dostępny.
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: AdresPoint HouseNumberRange Ulica
poi	PointOfInterest	Szczegółowe informacje o zwracanym interfejsie użytkownika, 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. Za pomocą tej opcji można określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x to 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: Punkt Zainteresowania (PZ) Ulica Geografia Adres punktu Zakres adresów Cross Street
viewport	BoundingBox	Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.

SearchAddressResultType

Wyliczanie

Jeden z:

• Punkt Zainteresowania (PZ)
• Ulica
• Geografia
• Adres punktu
• Zakres adresów
• Cross Street

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

SearchIndexes

Wyliczanie

Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach.

Dostępne indeksy to:

dodatku = zakresy adresów

Geo = Geographies

PAD = adresy punktów

POI = punkty orientacyjne

Str = Ulice

XStr = Cross Streets (skrzyżowania)

Wartość powinna być rozdzielona przecinkami lista 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 muszą być jawnie żądane w razie potrzeby.

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 wyszukiwania.

Nazwa	Typ	Opis
fuzzyLevel	integer	Maksymalny poziom rozmyte wymagany do dostarczenia 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 na ustawienie parametrów 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 rozwiązywaniu zapytania w milisekundach.
queryType	QueryType	Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
totalResults	integer	Całkowita liczba znalezionych wyników.