Search - Get Search Address

  • Odwołanie
Service:
Maps
API Version:
1.0

Służy do uzyskiwania współrzędnych szerokości i długości geograficznej adresu ulicznego w formacie wejściowym bez struktury lub zapytania.

Interfejs Get Search Address API to żądanie HTTP GET zwraca współrzędne szerokości i długości geograficznej po przekazaniu adresu ulicznego lub nazwy 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. Search można również uzyskać dostęp do wyszukiwania adresów wyłącznie. Geokodowanie jest wykonywane przez trafienie punktu końcowego kodu geograficznego tylko z adresem lub częściowym adresem. 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}
With optional parameters: 
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 Azure Maps.
query
 query True

string

Adres do wyszukania (np. "1 sposób firmy Microsoft, Redmond, WA"), musi być prawidłowo zakodowany pod adresem URL.
btmRight
 query

string

Prawa dolna pozycja pola ograniczenia. Np. 37.553,-122.453
countrySet
 query

string[]

Ciąg rozdzielony przecinkami 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 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 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.
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. Gdy 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

Maksymalna liczba odpowiedzi, które zostaną zwrócone. Wartość domyślna: 10, minimalna: 1 i maksymalna: 100
lon
 query

number

double

Długość geograficzna, w której wyniki powinny być stronnicze. Np. -121.89
ofs
 query

integer

Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Ustawienie domyślne: 0
radius
 query

integer

Promień w metrach do 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

Boolean. Jeśli flaga typeahead jest ustawiona, 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 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 protokołu OAuth 2.0 Microsoft Entra. 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 Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów 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 Azure Maps interfejsów API REST.

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łówkax-ms-client-id, aby wskazać, do którego zasobu 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 Tożsamość Microsoft Entra.
  • Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
  • Użycie Azure Maps zestawu Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach 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ólny aprowizowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany 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 do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Type: apiKey
In: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem 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.

Type: apiKey
In: header

Przykłady

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

Sample Request

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

Sample Response

Status code:
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

Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku.
BoundingBoxCompassNotation

Pole ograniczenia lokalizacji.
Brand

Marka skojarzona z interfejsem POI
Classification

Klasyfikacja zwracanego interfejsu poi
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 położenie.
EntryPoint

Punkt wejścia zwracanego interfejsu poI.
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 zażądano parametru entityType i jest dostępny.
Geometry

Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geografia.
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 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 .
MatchType

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.
OperatingHours

Godziny otwarcia punktu zakupu (punkty orientacyjne).
OperatingHoursTime

Reprezentuje datę i godzinę
OperatingHoursTimeRange

Otwarty zakres czasu dla dnia
PointOfInterest

Szczegóły zwróconego interfejsu poI, 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ń Search.
SearchAddressResultItem

Wynik obiektu odpowiedzi interfejsu API Search.
SearchAddressResultType

Jeden z:

  • UM
  • Ulica
  • Lokalizacja geograficzna
  • 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:

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.
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 prezentowana w skróconej formie. Obsługiwane tylko dla 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ść jest zależna 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, który reprezentuje nazwę obszaru geograficznego lub lokalizacji, który grupuje wiele obiektów adresowalnych do celów 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 należy użyć 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.

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.

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

Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku.

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

Pole ograniczenia lokalizacji.

Nazwa Typ Opis
entity

Entity

Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe położenie.
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

Marka skojarzona z interfejsem POI

Nazwa Typ Opis
name

string

Nazwa marki

Classification

Klasyfikacja zwracanego interfejsu poi

Nazwa Typ Opis
code

string

Właściwość Code
names

ClassificationName[]

Tablica nazw

ClassificationName

Nazwa klasyfikacji

Nazwa Typ Opis
name

string

Name — Właściwość
nameLocale

string

Nazwa właściwości Ustawienia regionalne

DataSources

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 == Geografia.

Entity

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

Nazwa Typ Opis
position

string

Pozycja jednostki

EntryPoint

Punkt wejścia zwracanego interfejsu poI.

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

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

Nazwa Typ Opis
main

string

minor

string

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

GeographicEntityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy zażądano parametru entityType i jest dostępny.

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

Geometry

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

Nazwa Typ Opis
id

string

Przekaż ten identyfikator geometryId do interfejsu API get Search Polygon, aby pobrać informacje o geometrii dla tego wyniku.

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

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 (Pakistani View)
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

OperatingHours

Godziny otwarcia punktu zakupu (punkty orientacyjne).

Nazwa Typ Opis
mode

string

Wartość używana w żądaniu: none lub "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

Lista zakresów czasu dla następnych 7 dni

OperatingHoursTime

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 interfejsu użytkownika; możliwe wartości to 0–59.

OperatingHoursTimeRange

Otwarty zakres czasu dla dnia

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 od otwarcia danego punktu zakupu lub początku zakresu, jeśli został otwarty przed zakresem.

PointOfInterest

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

Nazwa Typ Opis
brands

Brand[]

Tablica marek. Nazwa marki dla zwracanego interfejsu POI.
categories

string[]

Tablica kategorii
categorySet

PointOfInterestCategorySet[]

Lista najbardziej specyficznych kategorii poI
classifications

Classification[]

Tablica klasyfikacji
name

string

Nazwa właściwości POI
openingHours

OperatingHours

Godziny otwarcia punktu zakupu (punkty orientacyjne).
phone

string

Właściwość numeru telefonu
url

string

Właściwość adresu URL witryny internetowej

PointOfInterestCategorySet

Kategoria poi

Nazwa Typ Opis
id

integer

Identyfikator kategorii

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

The Extensible Markup Language

SearchAddressResult

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

Wynik obiektu 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ątkowych i końcowych zakresu adresów.
dataSources

DataSources

Sekcja opcjonalna. Identyfikator geometrii odwołania do użycia z interfejsem API Get Search Polygon.
detourTime

integer

Czas objazdu w sekundach. Zwrócono tylko wywołania interfejsu API Search Wzdłuż trasy.
dist

number

Odległość linii prostej między wynikiem a lokalizacją geobiazy w metrach.
entityType

GeographicEntityType

Typ jednostki Geografia. Występuje 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:

  • Punkt adresowy
  • HouseNumberRange
  • Ulica
poi

PointOfInterest

Szczegóły zwróconego interfejsu 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

Wartość w zestawie wyników wskazująca względny wynik dopasowania między wynikami. Można użyć tej funkcji, aby określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x jest 2x wartością 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
  • Ulica krzyżowa
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

Jeden z:

  • UM
  • Ulica
  • Lokalizacja geograficzna
  • Adres punktu
  • Zakres adresów
  • Cross Street
Nazwa Typ Opis
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

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.

Nazwa Typ Opis
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API Search.

Nazwa Typ Opis
fuzzyLevel

integer

Maksymalny poziom rozmyty 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 rozpoznawaniu zapytania w milisekundach.
queryType

QueryType

Zwracany typ zapytania: NEARBY lub NON_NEAR.
totalResults

integer

Łączna liczba znalezionych wyników.