Search - Get Geocode Autocomplete
Umożliwia pobranie listy rankingowej sugerowanych encji na podstawie lokalizacji użytkownika i częściowego zapytania.
Dla żądania z lokalizacją użytkownika oraz częściowego zapytania służącego jako prefiks pełnego ciągu zapytania (zwanego prefiksem zapytania), API Azure Maps Autocomplete zwraca listę sugerowanych bytów, których użytkownik najprawdopodobniej szuka. Podmioty te są uszeregowane od najbardziej do najmniej prawdopodobnych.
GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}
GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}&coordinates={coordinates}&bbox={bbox}&top={top}&resultTypeGroups={resultTypeGroups}&resultTypes={resultTypes}&view={view}&countryRegion={countryRegion}
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Nazwa hosta usługi Azure Maps. Użyj |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
|
query
|
query | True |
string |
To jest wymagane. Prefiks zapytania użytkownika. Przykład: "1 Micro" lub "Muir Woods". |
|
bbox
|
query |
number[] |
Wymagane, gdy Przykład: lon1,lat1,lon2,lat2. Minimalny rozmiar: około 0,00001 stopnia (~0,01 metra). Maksymalny rozmiar: do pełnego globalnego zasięgu (od -180,-90 do 180,90) |
|
|
coordinates
|
query |
number[] |
Wymagane, gdy
Nuta: |
|
|
country
|
query |
string |
Sygnał dla wyniku autouzupełniania do kodu regionu/kraju ISO 3166-1 Alpha-2 , który jest określony, np. FR. Zostaną zwrócone tylko wyniki w określonym kraju/regionie. |
|
|
result
|
query |
Rozdzielona przecinkami lista zwracanych grup typów jednostek. Możliwe wartości to
|
||
|
result
|
query |
Rozdzielona przecinkami lista zwracanych typów jednostek. Gdy grupa typów jest ustawiona na Adres, obsługiwane typy to:
Wszystkie inne typy należą do grupy Typ miejsca. Mogą to być jednostki, takie jak AdminDivision1, Neighborhood, PopulatedPlace i inne. Wartość domyślna to wszystkie możliwe typy jednostek. |
||
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
Maksymalna liczba odpowiedzi, które zostaną zwrócone. Domyślnie: 5, minimum: 1 i maksimum: 20. |
|
|
view
|
query |
string |
Ciąg reprezentujący kod ISO 3166-1 Alfa-2 w regionie/kraju. Spowoduje to zmianę spornych geopolitycznych granic i etykiet w celu dopasowania ich do określonego regionu użytkownika. Domyślnie parametr Widok jest ustawiony na wartość "Auto", nawet jeśli nie zdefiniowano go w żądaniu. Aby uzyskać szczegółowe informacje, 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 bezpieczeństwa Azure AD. Reprezentuje unikalny identyfikator dla konta Azure Maps i można go pobrać z API konta Azure Maps management plane. Więcej informacji na temat korzystania z Microsoft Entra ID zabezpieczeń w Azure Maps można znaleźć w Manage authentication in Azure Maps. |
|
| Accept-Language |
string |
Język, w którym powinny być zwracane wyniki wyszukiwania. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zakończyło się pomyślnie. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. Media Types: "application/geo+json", "application/json" Nagłówki x-ms-error-code: string |
Zabezpieczenia
AadToken
Są to przepływy Microsoft Entra OAuth 2.0. W połączeniu z Azure zarządzaniem dostępem opartym na rolach może być używany do kontroli dostępu do Azure Maps API REST. Kontrola dostępu oparta na rolach Azure służy do wyznaczania dostępu do jednego lub więcej kont zasobów lub podzasobów Azure Maps. 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 / Notatka
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps. -
Authorization URLjest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID. - 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 Platforma tożsamości Microsoft overview.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| 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:
header
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
Autocomplete API call to search for '1 Microsoft'
Przykładowe żądanie
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft&coordinates=-122.136833,47.642282
Przykładowa odpowiedź
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"streetNumber": "1",
"streetName": "Microsoft Way",
"addressLine": "1 Microsoft Way",
"formattedAddress": "1 Microsoft Way, Redmond, WA 98052, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"streetNumber": "1",
"streetName": "Microsoft West Campus Rd",
"addressLine": "1 Microsoft West Campus Rd",
"formattedAddress": "1 Microsoft West Campus Rd, Redmond, WA, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Charlotte",
"adminDistricts": [
{
"name": "North Carolina",
"shortName": "NC"
},
{
"name": "Mecklenburg"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"streetNumber": "1",
"streetName": "Microsoft Way",
"addressLine": "1 Microsoft Way",
"formattedAddress": "1 Microsoft Way, Charlotte, NC, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Reading",
"adminDistricts": [
{
"name": "England"
},
{
"name": "Reading"
}
],
"countryRegion": {
"ISO": "GB",
"name": "United Kingdom"
},
"streetNumber": "1",
"streetName": "Microsoft Campus",
"addressLine": "1 Microsoft Campus",
"formattedAddress": "1 Microsoft Campus, Earley, Reading, England, United Kingdom"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Sonning",
"adminDistricts": [
{
"name": "England"
},
{
"name": "Reading"
}
],
"countryRegion": {
"ISO": "GB",
"name": "United Kingdom"
},
"streetNumber": "1",
"streetName": "Microsoft Campus",
"addressLine": "1 Microsoft Campus",
"formattedAddress": "1 Microsoft Campus, Sonning, England, United Kingdom"
}
}
}
]
}
Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result
Przykładowe żądanie
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft Way, Redmond&coordinates=-113.301894,49.201888&resultTypeGroups=Place&resultTypes=RoadBlock
Przykładowa odpowiedź
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": []
}
Autocomplete API call to search for '15010 NE 36th St WA'
Przykładowe żądanie
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=15010 NE 36th St WA&coordinates=-122.13704445129011,47.642303642565686&top=5
Przykładowa odpowiedź
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Redmond, WA 98052, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Bellevue",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98007",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Bellevue, WA 98007, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Sammamish",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98074",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Sammamish, WA 98074, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Yarrow Point",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98004",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Yarrow Point, WA 98004, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Seattle",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98105",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Seattle, WA 98105, United States"
}
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups
Przykładowe żądanie
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place&resultTypes=Park,PopulatedPlace
Przykładowa odpowiedź
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "PopulatedPlace",
"address": {
"locality": "Muir Woods",
"adminDistricts": [
{
"name": "Georgia"
},
{
"name": "Fulton County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "30349",
"formattedAddress": "Muir Woods, Georgia 30349, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Park"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes
Przykładowe żądanie
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park
Przykładowa odpowiedź
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Monument"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups
Przykładowe żądanie
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place
Przykładowa odpowiedź
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Forest",
"address": {
"adminDistricts": [
{
"name": "Wisconsin"
},
{
"name": "Dane County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "Wisconsin"
},
"name": "Muir Woods"
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "PopulatedPlace",
"address": {
"locality": "Muir Woods",
"adminDistricts": [
{
"name": "Georgia"
},
{
"name": "Fulton County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "30349",
"formattedAddress": "Muir Woods, Georgia 30349, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Monument"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups
Przykładowe żądanie
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address&resultTypes=RoadBlock
Przykładowa odpowiedź
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"streetName": "Muir St",
"addressLine": " Muir St",
"locality": "Grosse Pointe Farms",
"adminDistricts": [
{
"name": "Michigan"
},
{
"name": "Wayne County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "48236",
"formattedAddress": "Muir St, Grosse Pointe Farms, Michigan 48236, United States"
}
}
}
]
}
Definicje
| Nazwa | Opis |
|---|---|
| Address |
Adres geokodowanej lub automatycznie uzupełniającej lokalizacji, podzielonej na pola strukturalne.
Rzadkość jest normalna: wypełniane są tylko pola dostarczane przez rozdzieloną jednostkę. Na przykład |
|
Address |
Podział administracyjny, który zawiera adres. Na przykład stan, prowincja lub hrabstwo. Zwracany jako jeden element w tablicy nadrzędnej |
|
Address |
Kraj lub region, który zawiera adres, oznaczony nazwą wyświetlaną oraz kodem kraju ISO 3166-1 Alpha-2. W odpowiedzi można pominąć każde z tych pól. |
|
Autocomplete |
Pojedynczy element w tablicy |
|
Autocomplete |
Ładunek |
|
Autocomplete |
Udana jednostka odpowiedzi zwrócona przez |
|
Autocomplete |
Klasyfikacja sugestii autouzupełniających |
|
Autocomplete |
Gruba klasyfikacja sugestii autouzupełniającej na jedną z dwóch grup. Używane zarówno |
|
Azure. |
Obiekt błędu. |
|
Azure. |
Odpowiedź zawierająca szczegóły błędu. |
|
Azure. |
Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Feature |
Typ |
|
Feature |
Typ obiektu |
|
Geo |
Określa typ |
|
Geo |
Prawidłowy typ geometrii |
| Intersection |
Szczegóły skrzyżowania dla adresu rozstrzygniętego jako skrzyżowanie drogowe — narożnik, na którym spotykają się dwie lub więcej nazwanych ulic. Wypełnia się tylko wtedy, gdy rozwiązana jednostka jest ; |
Address
Adres geokodowanej lub automatycznie uzupełniającej lokalizacji, podzielonej na pola strukturalne.
Rzadkość jest normalna: wypełniane są tylko pola dostarczane przez rozdzieloną jednostkę. Na przykład streetName i pojawiają się streetNumber tylko dla adresów na poziomie ulicy i intersection pojawiają się tylko dla wyników skrzyżowań drogowych.
| Nazwa | Typ | Opis |
|---|---|---|
| addressLine |
string |
Pierwsza linia adresu, zazwyczaj nazwa i numer ulicy. Na przykład |
| adminDistricts |
Podziały administracyjne, które zawierają adres, uporządkowane od najgrubszego do najsubtelniejszego. Pierwszy wpis to zazwyczaj podział pierwszego rzędu (np. stan USA lub prowincja Kanada); kolejne wpisy obejmują drobniejsze podziały, gdzie kraj, jednostka zależna lub region je definiują (np. hrabstwo o indeksie 1). |
|
| countryRegion |
Kraj lub region, który zawiera adres, wraz z nazwą wyświetlaną oraz kodem kraju ISO 3166-1 Alpha-2. |
|
| formattedAddress |
string |
Pełny adres był renderowany jako pojedynczy, czytelny dla człowieka ciąg znaków, z komponentami połączonymi zgodnie z konwencjami kraju lub regionu adresu. Przykład: |
| intersection |
Szczegóły przecinających się ulic dla adresu, które pojawiają się, gdy rozwiązaną jednostką jest a |
|
| locality |
string |
Lokalizacja, do której należy, zwykle miasto, miasteczko lub wieś. Na przykład: |
| neighborhood |
string |
Nazwana dzielnica w obrębie lokalnej społeczności, gdy zostanie zidentyfikowana. |
| postalCode |
string |
Kod pocztowy adresu, kiedy jest definiowany. Przykład: |
| streetName |
string |
Komponent nazwy ulicy w adresie, gdy rozwiązany podmiot jest adresem na poziomie ulicy. Przykład: |
| streetNumber |
string |
Numer domu lub budynku na ulicy, gdy rozwiązany podmiot to adres na poziomie ulicy. Przykład: |
AddressAdminDistrictsItem
Podział administracyjny, który zawiera adres. Na przykład stan, prowincja lub hrabstwo. Zwracany jako jeden element w tablicy nadrzędnej Address.adminDistricts , gdzie wpisy są uporządkowane od najgrubszego do najcieńszego.
| Nazwa | Typ | Opis |
|---|---|---|
| name |
string |
Pełna nazwa osiedla. Na przykład |
| shortName |
string |
Krótka lub skrócona forma nazwy podziału, gdy jest ona definiowana. Na przykład |
AddressCountryRegion
Kraj lub region, który zawiera adres, oznaczony nazwą wyświetlaną oraz kodem kraju ISO 3166-1 Alpha-2. W odpowiedzi można pominąć każde z tych pól.
| Nazwa | Typ | Opis |
|---|---|---|
| ISO |
string |
Kod kraju ISO 3166-1 Alpha-2 dla kraju lub regionu. Na przykład |
| name |
string |
Nazwa wyświetlania kraju lub regionu. Na przykład |
AutocompleteFeature
Pojedynczy element w tablicy features , AutocompleteResponsezgodny z kształtem obiektu GeoJSON Feature .
Reprezentuje jedną sugestię autouzupełniania: klasyfikacja (type, typeGroup), przeanalizowany adres oraz opcjonalna nazwa miejsca są dostępne przez properties, z reprezentatywną współrzędną , kiedy geometry jest dostępna.
| Nazwa | Typ | Opis |
|---|---|---|
| geometry |
Współrzędna sugestii autouzupełniania jako , |
|
| properties |
Dane strukturalne dotyczące sugestii autouzupełniania, w tym jej klasyfikacja, przeanalizowany adres oraz (w przypadku |
|
| type |
Typ |
AutocompleteProperties
Ładunek properties .AutocompleteFeature Zawiera klasyfikację wyniku (typeGroup, type), jego przeanalizowany adres oraz (dla wielu Placewyników typu -typ) osobną nazwę wyświetlaną.
| Nazwa | Typ | Opis |
|---|---|---|
| address |
Adres wyniku autouzupełniania, rozłożony na pola strukturalne.
|
|
| name |
string |
Nazwa wyświetlana sugerowanego miejsca. Wypełniane dla |
| type |
Konkretny rodzaj bytu, do którego wynik się rozwiązuje. Na przykład adres, zamieszkane miejsce, park lub punkt orientacyjny. Zobacz |
|
| typeGroup |
Szeroka klasyfikacja rezultatu to albo adres, albo nazwane miejsce. Zobacz |
AutocompleteResponse
Udana jednostka odpowiedzi zwrócona przez Get Autocomplete. Zakodowane jako tablica zawierająca GeoJSON FeatureCollectionfeatures jeden na Feature sugestię autouzupełniania, uszeregowane od najbardziej do najmniej prawdopodobnego.
| Nazwa | Typ | Opis |
|---|---|---|
| features |
Tablica obiektów |
|
| nextLink |
string |
Zawiera adres URL do pobrania następnej strony z wynikami, jeśli odpowiedź jest paginowana. Jest to przydatne, gdy odpowiedź jest zbyt duża, by zwrócić ją w jednym połączeniu, co pozwala użytkownikom przejrzeć wiele stron z wynikami. |
| type |
Typ obiektu |
AutocompleteResultTypeEnum
Klasyfikacja sugestii autouzupełniających Get Autocomplete używanych zarówno jako filtr wejściowy (za pomocą parametru resultTypes zapytania), jak i jako etykieta wyjściowa (za pomocą type pola na każdym ).AutocompleteProperties Członkowie definiują taksonomię w stylu gazeterowym, obejmującą adresy, odcinki dróg, regiony administracyjne, miejsca zamieszkane, cechy przyrody oraz punkty warte odwiedzenia. Taksonomia ta dzieli się na dwie szersze grupy AutocompleteResultTypeGroupsEnum: , Addressobejmujące adresy i odcinki dróg; oraz Place, które obejmują wszystkie pozostałe typy wyników.
| Wartość | Opis |
|---|---|
| Address |
Konkretny adres. |
| AdminDivision1 |
Pierwszy poziom administracyjny w kraju/regionie, na przykład w stanie lub prowincji. |
| AdminDivision2 |
Drugi poziom administracyjny w kraju/regionie, na przykład w hrabstwie. |
| AdminDivision3 |
Trzeci poziom administracyjny w kraju/regionie, taki jak dystrykt, parafia lub gmina. |
| AdministrativeBuilding |
Budynek, w którym mieści się urzędy rządowe lub funkcje administracyjne publiczne. |
| Airport |
Obiekt, w którym samoloty regularnie startują i lądują, z udogodnieniami dla pasażerów i ładunków. |
| AirportTerminal |
Budynek terminalu pasażerskiego na lotnisku. |
| AmusementPark |
Obiekt rozrywkowy z atrakcjami, grami i atrakcjami tematycznymi. |
| AncientSite |
Miejsce, gdzie zachowane są pozostałości archeologiczne lub artefakty kulturowe starożytnej cywilizacji. |
| Aquarium |
Publiczny obiekt, w którym prezentowane są i badane rośliny wodne i zwierzęta. |
| Archipelago |
Grupa lub łańcuch wysp. |
| Basin |
Naturalna zagłębienie powierzchni terenu, często otoczone wyższym terenem. |
| Battlefield |
Miejsce historycznie istotnej bitwy lądowej. |
| Bay |
Zbiornik wodny częściowo otoczony lądem, mniejszy niż zatoka i większy niż zatoczka. |
| Beach |
Brzeg piasku, kamyków lub innych nieskonsolidowanych osadów wzdłuż zbiornika wodnego. |
| Bridge |
Konstrukcja przenosząca drogę, kolej lub ścieżkę przez przeszkodę, taką jak rzeka, dolina lub inna droga. |
| BusinessStructure |
Budynek używany do ogólnych działań biznesowych lub komercyjnych, który nie pasuje do bardziej konkretnej kategorii. |
| Camp |
Miejsce z schronieniami lub obiektami tymczasowymi do zamieszkania, takie jak pole namiotowe lub sezonowe osiedle. |
| Canal |
Sztuczny ciek wodny wykorzystywany do transportu, nawadniania lub odprowadzania wody. |
| Casino |
Obiekt wykorzystywany do hazardu i gier losowych. |
| Castle |
Historycznie ufortyfikowany budynek lub kompleks budynków, zwykle związany z rezydencją szlachecką lub królewską. |
| Cave |
Naturalna podziemna komora lub przejście uformowane w skale. |
| Cemetery |
Miejsce pochówku lub cmentarz. |
| Channel |
Żeglowny kanał między dwoma zbiornikami lądowymi lub główny przepływ większego zbiornika wodnego. |
| Church |
Budynek wykorzystywany do publicznych chrześcijańskich nabożeństw. |
| Cliff |
Wysoka, stroma ściana skalna lub ziemi, często z widokiem na wybrzeże lub dolinę. |
| Coast |
Nazwany fragment ziemi graniczący z morzem. |
| CommunityCenter |
Obiekt organizujący zajęcia społeczne, spotkania i usługi społeczne. |
| Continent |
Jeden z największych lądów Ziemi. |
| CountryRegion |
Kraj lub region. |
| Crater |
Okrągłe zagłębienie powstałe w wyniku aktywności wulkanicznej lub uderzenia meteorytu. |
| CulturalRegion |
Obszar wyróżniający się wspólnymi cechami kulturowymi, takimi jak język, pochodzenie etniczne czy dziedzictwo. |
| Dam |
Bariera zbudowana na strumieniu lub rzece, aby zatrzymać wodę. |
| Delta |
Forma terenu z osadów aluwialnych powstała tam, gdzie rzeka łączy się z większym zbiornikiem wodnym. |
| Desert |
Duży, suchy region z rzadką roślinnością spowodowaną ograniczonymi opadami. |
| DrainageBasin |
Obszar ziemi odwadnianej przez system rzeczny i jego dopływy. |
| Dune |
Kopca lub grzbiet piasku rozwiewanego przez wiatr. |
| FacilityStructure |
Obiekt, w którym znajduje się specjalistyczny obiekt, taki jak zakład użyteczności publicznej lub instalacja usługowa. |
| FerryTerminal |
Obiekt, w którym pasażerowie i pojazdy wsiadają i wysiadają z promów. |
| FinancialStructure |
Budynek, w którym mieści się bank, unia kredytowa lub inna instytucja usług finansowych. |
| FireStation |
Budynek, w którym mieści się strażacy, sprzęt oraz pojazdy ratunkowe. |
| Forest |
Duży obszar ziemi zdominowany przez drzewa. |
| Fort |
Obronna konstrukcja wojskowa lub wały ziemne. |
| Garden |
Uprawa do ekspozycji roślin ozdobnych lub naukowo wyselekcjonowanych. |
| Geyser |
Gorące źródło, które okresowo wybucha strumieniami wody i pary. |
| Glacier |
Trwała masa lodu, która porusza się powoli pod własnym ciężarem. |
| GolfCourse |
Pole przeznaczone do gry w golfa. |
| GreaterPopulatedPlace |
Obszar metropolitalny lub aglomeracja, która obejmuje i wykracza poza zaludnione miejsce. |
| HigherEducationFacility |
Uczelnia, uniwersytet lub podobna instytucja edukacji wyższej. |
| HistoricalSite |
Miejsce o znaczeniu historycznym, często zachowane jako miejsce dziedzictwa kulturowego. |
| Hospital |
Placówka medyczna świadcząca opiekę stacjonarną i ambulatoryjną. |
| HotSpring |
Naturalne źródło, w którym na powierzchni wypływa geotermalnie podgrzana woda gruntowa. |
| Ice |
Naturalna masa lub powierzchniowa warstwa zamarzniętej wody pokrywająca ląd lub wodę. |
| IndigenousPeoplesReserve |
Terytorium uznane za ojczyznę rdzennych mieszkańców lub społeczności. |
| IndustrialStructure |
Budynek lub instalacja wykorzystywana do produkcji, produkcji lub innych operacji przemysłowych. |
| Island |
Masa lądowa otoczona wodą, mniejsza niż kontynent. |
| Isthmus |
Wąski pas ziemi łączący dwie większe masy lądowe i oddzielający dwa zbiorniki wodne. |
| Lake |
Śródlądowy zbiornik stojącej wody otoczony lądem. |
| LandArea |
Nazwany region lądowy, który nie pasuje do bardziej konkretnej kategorii geograficznej. |
| Landform |
Naturalna cecha lądowa, która nie pasuje do bardziej konkretnej kategorii, takiej jak |
| LandmarkBuilding |
To godny uwagi budynek o znaczeniu architektonicznym, kulturowym lub historycznym, który stanowi rozpoznawalny punkt orientacyjny. |
| Library |
Budynek, w którym znajduje się kolekcja książek i innych materiałów dostępnych do użytku publicznego. |
| Lighthouse |
Struktura przybrzeżna lub portowa z lampką nawigacyjną do prowadzenia statków. |
| Marina |
Obiekt portowy zapewniający cumowania i usługi dla małych łodzi i jachtów. |
| Market |
Miejsce, gdzie towary są kupowane i sprzedawane, zazwyczaj w sklepie detalicznym. |
| MedicalStructure |
Budynek wykorzystywany do usług medycznych lub związanych z opieką zdrowotną innych niż |
| MetroStation |
Stacja na linii metra, podziemnej lub innym miejskim systemie szybkiej kolei. |
| MilitaryBase |
Instalacja obsługiwana przez siły zbrojne do celów szkoleniowych, zaopatrzeniowych lub operacyjnych. |
| Mission |
Kompleks prowadzony przez grupę religijną, aby świadczyć usługi społeczne i szerzyć wiarę. |
| Monument |
Struktura pamiątkowa lub pomnik wzniesiony na cześć osoby, wydarzenia lub idei. |
| Mosque |
Budynek wykorzystywany do publicznego kultu islamskiego. |
| Mountain |
Forma terenu, która znacznie wznosi się ponad otoczenie, zazwyczaj o stromych zboczach i wyraźnie określonym szczycie. |
| MountainRange |
Połączony ciąg gór tworzący ciągły łańcuch górski. |
| MultiModalStation |
Stacja obsługująca różne środki transportu, takie jak łączona kolej, autobus czy metro. |
| Museum |
Obiekt, w którym przechowywane i eksponowane są obiekty o znaczeniu artystycznym, naukowym lub historycznym. |
| NauticalStructure |
Struktura związana z działalnością morską lub morską, taka jak molo, dok lub boja. |
| Neighborhood |
Lokalnie uznany obszar w obrębie zamieszkanego miejsca, często z nieformalnymi lub kulturowo określonymi granicami. |
| Oasis |
Żyzny teren na pustyni podtrzymywany przez naturalne źródło wody. |
| ObservationPoint |
Punkt widokowy lub punkt widokowy z malowniczymi widokami na okolicę. |
| Ocean |
Jeden z głównych podziałów globalnego oceanu Ziemi. |
| OfficeBuilding |
Budynek wykorzystywany głównie jako przestrzeń biurowa lub administracyjna. |
| Other |
Sugestia, która nie pasuje do żadnego innego zdefiniowanego typu. |
| Park |
Obszar utrzymywany pod rekreację publiczną lub malownicze przyjemności. |
| ParkingStructure |
Wielopoziomowa konstrukcja przeznaczona do parkowania pojazdów. |
| Pass |
Żeglowna trasa przez lub nad pasmem górskim lub podobną przeszkodą. |
| Peninsula |
Masa lądowa wystająca w zbiornik wodny i niemal nią otoczona. |
| Plain |
Rozległy obszar stosunkowo płaskiego lub łagodnie falującego terenu. |
| Planet |
Ciało niebieskie krążące wokół gwiazdy, zwykle używane do przedstawienia Ziemi jako źródła hierarchii geograficznej. |
| Plateau |
Podwyższony obszar stosunkowo płaskiego terenu ze stromymi zboczami po jednej lub kilku stronach. |
| Playground |
Teren rekreacyjny przystosowany do zabawy dzieci. |
| PlayingField |
Otwarta przestrzeń wykorzystywana do uprawiania zorganizowanych dyscyplin sportowych. |
| Pole |
Biegun geograficzny, taki jak biegun północny lub południowy. |
| PoliticalUnit |
Samorządny podmiot polityczny, taki jak niezależne lub zależne państwo lub terytorium. |
| PopulatedPlace |
Skoncentrowany obszar osadnictwa ludzkiego, taki jak miasto, miasteczko lub wieś. |
| Port |
Obiekt morski z terminalami do załadunku i rozładunku ładunków lub pasażerów na wodzie. |
| Postcode1 |
Najmniejsza kategoria kodu pocztowego, na przykład kod pocztowy. |
| Promontory |
Wyraźna podniesiona forma terenu wystająca na nizinę lub zbiornik wodny (aqua). |
| RaceTrack |
Tor lub trasa przeznaczona dla pojazdów wyścigowych, zwierząt lub sportowców. |
| RailwayStation |
Obiekt, w którym pasażerowie wsiadają i wysiadają z pociągów. |
| Reef |
Zanurzony lub częściowo zanurzony grzbiet skalny, piaskowy lub koralowy w pobliżu powierzchni wody. |
| ReligiousStructure |
Budynek używany do kultu lub praktyki religijnej, który nie pasuje do bardziej konkretnej kategorii, takiej jak |
| Reserve |
Chroniony obszar ziemi przeznaczony na ochronę przyrody, dziką faunę lub inne ograniczone zagospodarowanie. |
| ResidentialStructure |
Budynek wykorzystywany głównie jako miejsce zamieszkania ludzi, taki jak mieszkanie lub kompleks mieszkaniowy. |
| River |
Naturalny ciek wodny płynący na niższe poziomy, zazwyczaj w kierunku morza, jeziora lub innej rzeki. |
| RoadBlock |
Odcinek ulicy bez konkretnego numeru domu, zwracany, gdy usługa geokodowania nie może znaleźć dokładnego numeru domu dla zapytania. Pomimo nazwy, ta wartość nie oznacza fizycznego zamknięcia drogi. |
| Ruin |
Zniszczona lub zniweczona konstrukcja, która nie pełni już swojej pierwotnej funkcji. |
| ScientificResearchBase |
Obiekt wykorzystywany jako baza badań naukowych, często w odległych lub ekstremalnych warunkach. |
| Sea |
Duży zbiornik słonej wody częściowo otoczony lądem, mniejszy niż ocean. |
| SeaplaneLandingArea |
Obszar wody przeznaczony dla wodnosamolotów do startu i lądowania. |
| Shrine |
Budowla lub miejsce, które upamiętnia osobę lub upamiętnia święte wydarzenie czy koncepcję. |
| SkiArea |
Powstał teren rekreacyjny przeznaczony do narciarstwa i innych sportów zimowych. |
| Spring |
Naturalne źródło, z którego woda gruntowa płynie z powierzchni ziemi. |
| Stadium |
Duży obiekt z wielopoziomowymi miejscami siedzenia przeznaczonymi dla sportów lub wydarzeń dla widzów. |
| StatisticalDistrict |
Region określony na cele statystyczne lub spisowe, taki jak metropolitalny obszar statystyczny lub obszar spisowy. |
| Temple |
Budynek poświęcony kultowi religijnemu. |
| Theater |
Miejsce do prezentacji sztuk teatralnych, filmowych lub innych występów na żywo bądź nagranych. |
| TouristRailway |
Malownicza lub zabytkowa kolej działała głównie dla turystyki, a nie regularnego transportu publicznego. |
| TouristStructure |
Budynek służący turystom, taki jak centrum dla odwiedzających lub biuro informacji turystycznej. |
| Trailhead |
Punkt startowy szlaku turystycznego, rowerowego lub rekreacyjnego. |
| TransportationStructure |
Struktura wspierająca infrastrukturę transportową, taką jak punkt poboru opłat, stacja wagi czy wiata dla transportu. |
| Tunnel |
Podziemny lub podwodny korytarz przeznaczony dla transportu drogowego, kolejowego lub pieszego. |
| Valley |
Wydłużony, nisko położony teren pomiędzy wzgórzami lub górami, często zawierający ciek wodociągowy. |
| Volcano |
Góra lub wzgórze powstałe w wyniku aktywności wulkanicznej, zazwyczaj z kraterem na szczycie. |
| Walkway |
Ścieżka lub asfaltowa powierzchnia przeznaczona do użytku pieszego. |
| Wall |
Zbudowana bariera tworząca ciągłą pionową granicę, często wykorzystywana do obrony, separacji lub upamiętniania. |
| Waterfall |
Miejsce, gdzie strumień lub rzeka opada pionowo lub stromo. |
| WaterFeature |
Zbiornik wodny, który nie mieści się w bardziej konkretnej kategorii, takiej jak |
| Wetland |
Obszar ziemi nasycony wodą i wspierający roślinność wodną, taki jak bagna lub bagna. |
| Winery |
Zakład, w którym produkuje się wino, często oferowane do degustacji lub sprzedaży. |
| Zoo |
Placówka, w której trzymane są dzikie zwierzęta na publiczne wystawy i badania. |
AutocompleteResultTypeGroupsEnum
Gruba klasyfikacja sugestii autouzupełniającej na jedną z dwóch grup. Używane zarówno Get Autocomplete jako filtr wejściowy przez resultTypeGroups parametr zapytania (ograniczający, jakie rodzaje sugestii są zwracane), jak i jako klasyfikator wyjściowy przez typeGroup pole na każdym z nich AutocompleteProperties (identyfikując, do której grupy należy zwrócona sugestia). Grupa obejmuje Address poszczególne adresy i odcinki ulic; obejmuje Place wszystkie inne typy podmiotów (regiony administracyjne, miejsca zamieszkane, cechy przyrodnicze oraz punkty zainteresowania).
| Wartość | Opis |
|---|---|
| Address |
Sugestie dotyczące konkretnego adresu lub odcinka drogi. |
| Place |
Sugestie dotyczące nazwanych miejsc, w tym regionów administracyjnych, zaludnionych, dzielnic, cech przyrodniczych i punktów zainteresowania. Przykłady obejmują |
Azure.Core.Foundations.Error
Obiekt błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
| details |
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu. |
|
| innererror |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
| message |
string |
Czytelna dla człowieka reprezentacja błędu. |
| target |
string |
Element docelowy błędu. |
Azure.Core.Foundations.ErrorResponse
Odpowiedź zawierająca szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
Azure.Core.Foundations.InnerError
Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
| innererror |
Błąd wewnętrzny. |
FeatureCollectionEnum
Typ GeoJSON obiektu używany u podstawy udanych odpowiedzi z operacji geokodowania do przodu, geokodowania odwrotnego oraz autouzupełniania (w tym ich wariantów wsadowych). Jedyną wartością FeatureCollectionjest , zgodnie z definicją RFC 7946.
Get Polygon jest jedynym wyjątkiem: jego pierwiastek odpowiedzi to GeoJSON Feature, zobacz FeatureTypeEnum.
| Wartość | Opis |
|---|---|
| FeatureCollection |
Typ |
FeatureTypeEnum
Typ obiektu GeoJSON dla Feature obiektów. Oznacza każdy wpis wewnątrz tablicy featuresFeatureCollection odpowiedzi (geokodowanie, geokodowanie odwrotne, autouzupełnianie) i pojawia się u podstawy Get Polygon odpowiedzi. Jedyną wartością Featurejest , zgodnie z definicją RFC 7946.
| Wartość | Opis |
|---|---|
| Feature |
Typ |
GeoJsonObjectType
Określa typ GeoJSON. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.
| Wartość | Opis |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| bbox |
number[] (double) |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946. |
| coordinates |
number[] (double) |
|
| type |
string:
Point |
Określa typ |
Intersection
Szczegóły skrzyżowania dla adresu rozstrzygniętego jako skrzyżowanie drogowe — narożnik, na którym spotykają się dwie lub więcej nazwanych ulic. Wypełnia się tylko wtedy, gdy rozwiązana jednostka jest ; RoadIntersectionrodzic Address.intersection jest pomijany.
| Nazwa | Typ | Opis |
|---|---|---|
| baseStreet |
string |
Główna ulica skrzyżowania — zazwyczaj ta, do której odnosi się numer adresu. |
| displayName |
string |
Czytelna dla człowieka nazwa skrzyżowania łączącego ulice poprzeczne, takie jak |
| intersectionType |
string |
Krótka etykieta opisująca kształt przecięcia. Na przykład rozróżnienie skrzyżowania na poziomie od przejazdu bez poziomu, takiego jak most czy wiadukt. |
| secondaryStreet1 |
string |
Pierwsza ulica krzyżowa, która spotyka |
| secondaryStreet2 |
string |
Druga ulica przerzeczna na skrzyżowaniu, gdy ktoś jest obecny. Zaludnione tylko na skrzyżowaniach trzech lub więcej ulic. |