Search - Get Geocoding

Usługa:: Maps

Wersja interfejsu API:: 2025-01-01

Umożliwia uzyskanie współrzędnych długości i szerokości geograficznej ulicy, adresu lub nazwy miejsca.

Interfejs API Get Geocoding to żądanie GET HTTP, które zwraca współrzędne długości i szerokości geograficznej przeszukiwanej lokalizacji.

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 trafienie punktu końcowego geokodowania tylko do adresu lub adresu częściowego. Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Nie zostanie zwrócony żaden punkt orientacyjny (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 i stany. Odpowiedź zwraca również szczegółowe właściwości adresu, takie jak ulica, kod pocztowy, gminy i informacje o kraju/regionie.

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
addressLine	query		string	Oficjalna linia ulicy adresu względem obszaru, określona przez lokalizację lub postalCode, właściwości. Typowym zastosowaniem tego elementu jest podanie adresu ulicznego lub dowolnego oficjalnego adresu. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
adminDistrict	query		string	Część adresu, na przykład WA, podział kraju. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
adminDistrict2	query		string	Hrabstwo dla adresu ustrukturyzowanego, takiego jak King. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
adminDistrict3	query		string	Nazwany obszar dla adresu strukturalnego. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
bbox	query		number[]	Prostokątny obszar na ziemi zdefiniowany jako obiekt pola ograniczenia. Boki prostokątów są definiowane według długości geograficznej i wartości szerokości geograficznej. Po określeniu tego parametru obszar geograficzny jest brany pod uwagę podczas obliczania wyników zapytania lokalizacji. Przykład: lon1,lat1,lon2,lat2
coordinates	query		number[]	Punkt na ziemi określony jako długość geograficzna i szerokość geograficzna. Po określeniu tego parametru lokalizacja użytkownika jest uwzględniana, a zwrócone wyniki mogą być bardziej istotne dla użytkownika. Przykład: współrzędne &=lon,lat
countryRegion	query		string	Sygnał dla wyniku geokodowania do ISO 3166-1 Alfa-2 region/kod kraju określony np. FR./ Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
locality	query		string	Część adresu w lokalizacji, taka jak Seattle. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
postalCode	query		string	Część kodu pocztowego adresu. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
query	query		string	Ciąg zawierający informacje o lokalizacji, takie jak adres lub nazwa charakterystycznego elementu.
top	query		integer (int32) minimum: 1 maximum: 20	Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 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
Accept-Language		string	Język, w którym powinny być zwracane wyniki wyszukiwania. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki.
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń usługi Azure AD. 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 uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps.

Nazwa

Wymagane

Typ

Opis

Accept-Language

string

Język, w którym powinny być zwracane wyniki wyszukiwania.

Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki.

x-ms-client-id

string

Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń usługi Azure AD. 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 uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GeocodingResponse	OK Media Types: "application/geo+json" Nagłówki x-ms-request-id: string
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd. Media Types: "application/geo+json"

Nazwa

Typ

Opis

200 OK

GeocodingResponse

Media Types: "application/geo+json"

Nagłówki

x-ms-request-id: string

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Media Types: "application/geo+json"

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 / Notatka

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 usługami 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 tworzenia zasobów 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 SDK platformy Azure lub interfejsów API REST.

Za pomocą tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu serwer-serwer interfejsów API REST usługi Azure Maps, w których ten klucz może 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

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

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Search detail address 15127 NE 24th Street, Redmond, WA by query

Search landmark Empire State Building by query

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

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

Przykładowa odpowiedź

Kod stanu:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

Przykładowa odpowiedź

Kod stanu:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=15127 NE 24th Street Redmond WA

Przykładowa odpowiedź

Kod stanu:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=empire state building

Przykładowa odpowiedź

Kod stanu:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

Definicje

Nazwa	Opis
Address	Adres wyniku
AdminDistricts	Nazwa poddziału w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako podsieć administracyjna pierwszego zamówienia, ale w niektórych przypadkach zawiera również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie.
CalculationMethodEnum	Metoda, która została użyta do obliczenia punktu kodu geograficznego.
ConfidenceEnum	Poziom pewności, że wynik geokodowanej lokalizacji jest zgodny. Użyj tej wartości z kodem dopasowania, aby określić więcej pełnych informacji o dopasowaniu. Pewność lokalizacji zakodowanej geograficznie opiera się na wielu czynnikach, w tym względnym znaczeniu lokalizacji zakodowanej geograficznie i lokalizacji użytkownika, jeśli zostanie określona.
CountryRegion
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
FeatureCollectionEnum	Typ obiektu FeatureCollection musi mieć wartość FeatureCollection.
FeaturesItem
FeatureTypeEnum	Typ funkcji musi mieć wartość Funkcja.
GeocodePoints	Kolekcja punktów kodu geograficznego, które różnią się sposobem ich obliczania i sugerowanym użyciem.
GeocodingResponse	Ten obiekt jest zwracany z pomyślnego wywołania geokodowania
GeoJsonPoint	Prawidłowy typ geometrii `GeoJSON Point`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
Intersection	Adres wyniku.
MatchCodesEnum	Co najmniej jedna zgodna wartość kodu reprezentująca poziom geokodowania dla każdej lokalizacji w odpowiedzi. Na przykład lokalizacja geokodowana z kodami dopasowania `Good` i `Ambiguous` oznacza, że dla informacji o lokalizacji odnaleziono więcej niż jedną lokalizację kodu geograficznego i że usługa geokodu nie ma wyszukiwania w hierarchii w celu znalezienia dopasowania. Podobnie lokalizacja geokodowana z kodami dopasowania `Ambiguous` i `UpHierarchy` oznacza, że nie można odnaleźć lokalizacji kodu geograficznego pasujących do wszystkich podanych informacji o lokalizacji, więc usługa geokodu musiała przeszukiwać hierarchię i znajdować wiele dopasowań na tym poziomie. Przykładem `Ambiguous` i `UpHierarchy` wyniku jest podanie pełnych informacji o adresie, ale usługa geokodowania nie może zlokalizować dopasowania dla adresu ulicznego i zamiast tego zwraca informacje dla więcej niż jednej wartości RoadBlock. Możliwe wartości to: `Good`: lokalizacja ma tylko jedno dopasowanie lub wszystkie zwrócone dopasowania są uznawane za silne dopasowania. Na przykład zapytanie dla Nowego Jorku zwraca kilka dobrych dopasowań. `Ambiguous`: lokalizacja jest jednym z zestawów możliwych dopasowań. Na przykład podczas wykonywania zapytania o adres ulicy 128 Main St., odpowiedź może zwrócić dwie lokalizacje dla 128 North Main St. i 128 South Main St. ponieważ nie ma wystarczającej ilości informacji, aby określić, którą opcję wybrać. `UpHierarchy`: lokalizacja reprezentuje przejście w górę hierarchii geograficznej. Dzieje się tak, gdy nie znaleziono dopasowania żądania lokalizacji, dlatego zwracany jest mniej dokładny wynik. Jeśli na przykład nie można odnaleźć dopasowania żądanego adresu, może zostać zwrócony kod dopasowania `UpHierarchy` z typem jednostki RoadBlock.
Properties
UsageTypeEnum	Najlepsze zastosowanie dla punktu kodu geograficznego. Każdy punkt kodu geograficznego jest definiowany jako punkt `Route`, punkt `Display` lub oba te elementy. Użyj `Route` punktów, jeśli tworzysz trasę do lokalizacji. Użyj `Display` punktów, jeśli wyświetlasz lokalizację na mapie. Na przykład jeśli lokalizacja jest parkiem, punkt `Route` może określić wejście do parku, w którym można wejść z samochodem, a punkt `Display` może być punktem określającym centrum parku.

Address

Objekt

Adres wyniku

Nazwa	Typ	Opis
addressLine	string	AddressLine, która zawiera nazwę ulicy i numer
adminDistricts	AdminDistricts[]	Nazwa poddziału w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako podsieć administracyjna pierwszego zamówienia, ale w niektórych przypadkach zawiera również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie.
countryRegion	CountryRegion
formattedAddress	string	Sformatowana właściwość Address
intersection	Intersection	Adres wyniku.
locality	string	właściwość locality
neighborhood	string	nieruchomość sąsiedztwa
postalCode	string	Właściwość Kod pocztowy
streetName	string	Nazwa ulicy z formattedAddress
streetNumber	string	Numer na ulicy, jeśli jest dostępny, from formattedAddress

AdminDistricts

Objekt

Nazwa poddziału w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako podsieć administracyjna pierwszego zamówienia, ale w niektórych przypadkach zawiera również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie.

Nazwa	Typ	Opis
name	string	Nazwa odpowiedniego pola adminDistrict, For adminDistrict[0], może to być pełna nazwa stanu, takiego jak Washington, For adminDistrict[1], może to być pełna nazwa powiatu
shortName	string	Krótka nazwa odpowiedniego pola adminDistrict, For adminDistrict[0], może to być krótka nazwa stanu, takiego jak WA, For adminDistrict[1], może to być krótka nazwa hrabstwa

CalculationMethodEnum

Wyliczanie

Metoda, która została użyta do obliczenia punktu kodu geograficznego.

Wartość	Opis
Interpolation	Punkt geokodowy został dopasowany do punktu na drodze za pomocą interpolacji.
InterpolationOffset	Punkt geokodowy został dopasowany do punktu na drodze za pomocą interpolacji z dodatkowym przesunięciem w celu przesunięcia punktu na bok ulicy.
Parcel	Punkt geokodowania został dopasowany do środka działki.
Rooftop	Punkt geokodowy został dopasowany do dachu budynku.

ConfidenceEnum

Wyliczanie

Poziom pewności, że wynik geokodowanej lokalizacji jest zgodny. Użyj tej wartości z kodem dopasowania, aby określić więcej pełnych informacji o dopasowaniu.

Pewność lokalizacji zakodowanej geograficznie opiera się na wielu czynnikach, w tym względnym znaczeniu lokalizacji zakodowanej geograficznie i lokalizacji użytkownika, jeśli zostanie określona.

Wartość Opis

High

Wartość	Opis
High	Jeśli poziom ufności jest ustawiony na `High`, znaleziono co najmniej jedno silne dopasowanie. Wiele `High` dopasowań ufności jest sortowanych w kolejności uszeregowanej według ważności, jeśli ma to zastosowanie. Na przykład punkty orientacyjne mają znaczenie, ale adresy nie. Jeśli żądanie zawiera lokalizację lub widok, klasyfikacja może się odpowiednio zmienić. Na przykład zapytanie o lokalizację "Paryż" zwraca z pewnością "Paryż, Francja" i "Paryż, Teksas".`High` "Paryż, Francja" jest zawsze umieszczana na pierwszym miejscu ze względu na ważność, chyba że lokalizacja użytkownika wskazuje, że użytkownik znajduje się w Paryżu w Teksasie lub bardzo blisko niego, lub widok mapy wskazuje, że użytkownik wyszukuje w tym obszarze.
Medium	W niektórych sytuacjach zwrócone dopasowanie może nie być na tym samym poziomie, co informacje podane w żądaniu. Na przykład żądanie może zawierać informacje adresowe, a usługa geokodowania może być w stanie dopasować tylko kod pocztowy. W takim przypadku, jeśli usługa geokodowania ma pewność, że kod pocztowy jest zgodny z danymi, ufność jest ustawiana na `Medium` wartość i kod dopasowania jest ustawiany na `UpHierarchy` określenie, że nie może pasować do wszystkich informacji i musi przeszukiwać w hierarchii. Jeśli informacje o lokalizacji w zapytaniu są niejednoznaczne i nie ma dodatkowych informacji umożliwiających uszeregowanie lokalizacji (takich jak lokalizacja użytkownika lub względna ważność lokalizacji), ufność jest ustawiana na `Medium`. Na przykład kwerenda lokalizacji "148th Ave, Bellevue" może z `Medium` pewnością zwrócić wartości "148th Ave SE" i "148th Ave NE". Jeśli informacje o lokalizacji w zapytaniu nie zawierają wystarczających informacji do geokodowania określonej lokalizacji, może zostać zwrócona mniej dokładna wartość lokalizacji, a ufność zostanie ustawiona na `Medium`. Jeśli na przykład zostanie podany adres, ale nie zostanie znalezione pasujące dopasowanie do numeru domu, może zostać zwrócony wynik geokodowania z typem jednostki Reklama samodzielna.
Low

Jeśli poziom ufności jest ustawiony na High, znaleziono co najmniej jedno silne dopasowanie. Wiele High dopasowań ufności jest sortowanych w kolejności uszeregowanej według ważności, jeśli ma to zastosowanie. Na przykład punkty orientacyjne mają znaczenie, ale adresy nie.

Jeśli żądanie zawiera lokalizację lub widok, klasyfikacja może się odpowiednio zmienić. Na przykład zapytanie o lokalizację "Paryż" zwraca z pewnością "Paryż, Francja" i "Paryż, Teksas".High "Paryż, Francja" jest zawsze umieszczana na pierwszym miejscu ze względu na ważność, chyba że lokalizacja użytkownika wskazuje, że użytkownik znajduje się w Paryżu w Teksasie lub bardzo blisko niego, lub widok mapy wskazuje, że użytkownik wyszukuje w tym obszarze.

Medium

W niektórych sytuacjach zwrócone dopasowanie może nie być na tym samym poziomie, co informacje podane w żądaniu. Na przykład żądanie może zawierać informacje adresowe, a usługa geokodowania może być w stanie dopasować tylko kod pocztowy. W takim przypadku, jeśli usługa geokodowania ma pewność, że kod pocztowy jest zgodny z danymi, ufność jest ustawiana na Medium wartość i kod dopasowania jest ustawiany na UpHierarchy określenie, że nie może pasować do wszystkich informacji i musi przeszukiwać w hierarchii.

Jeśli informacje o lokalizacji w zapytaniu są niejednoznaczne i nie ma dodatkowych informacji umożliwiających uszeregowanie lokalizacji (takich jak lokalizacja użytkownika lub względna ważność lokalizacji), ufność jest ustawiana na Medium. Na przykład kwerenda lokalizacji "148th Ave, Bellevue" może z Medium pewnością zwrócić wartości "148th Ave SE" i "148th Ave NE".

Jeśli informacje o lokalizacji w zapytaniu nie zawierają wystarczających informacji do geokodowania określonej lokalizacji, może zostać zwrócona mniej dokładna wartość lokalizacji, a ufność zostanie ustawiona na Medium. Jeśli na przykład zostanie podany adres, ale nie zostanie znalezione pasujące dopasowanie do numeru domu, może zostać zwrócony wynik geokodowania z typem jednostki Reklama samodzielna.

Low

CountryRegion

Objekt

Nazwa	Typ	Opis
ISO	string	ISO kraju/regionu
name	string	nazwa kraju/regionu

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.

FeatureCollectionEnum

Wyliczanie

Typ obiektu FeatureCollection musi mieć wartość FeatureCollection.

Wartość	Opis
FeatureCollection

FeaturesItem

Objekt

Nazwa	Typ	Opis
bbox	number[] (double)	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
geometry	GeoJsonPoint	Prawidłowy typ geometrii `GeoJSON Point`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
id	string	Identyfikator zwracanej funkcji
properties	Properties
type	FeatureTypeEnum	Typ funkcji musi mieć wartość Funkcja.

FeatureTypeEnum

Wyliczanie

Typ funkcji musi mieć wartość Funkcja.

Wartość	Opis
Feature

GeocodePoints

Objekt

Kolekcja punktów kodu geograficznego, które różnią się sposobem ich obliczania i sugerowanym użyciem.

Nazwa	Typ	Opis
calculationMethod	CalculationMethodEnum	Metoda, która została użyta do obliczenia punktu kodu geograficznego.
geometry	GeoJsonPoint	Prawidłowy typ geometrii `GeoJSON Point`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
usageTypes	UsageTypeEnum[]	Najlepsze zastosowanie dla punktu kodu geograficznego. Każdy punkt kodu geograficznego jest definiowany jako punkt `Route`, punkt `Display` lub oba te elementy. Użyj `Route` punktów, jeśli tworzysz trasę do lokalizacji. Użyj `Display` punktów, jeśli wyświetlasz lokalizację na mapie. Na przykład jeśli lokalizacja jest parkiem, punkt `Route` może określić wejście do parku, w którym można wejść z samochodem, a punkt `Display` może być punktem określającym centrum parku.

GeocodingResponse

Objekt

Ten obiekt jest zwracany z pomyślnego wywołania geokodowania

Nazwa	Typ	Opis
features	FeaturesItem[]
nextLink	string	Jest to link do następnej strony zwróconych funkcji. Jeśli jest to ostatnia strona, nie ma tego pola.
type	FeatureCollectionEnum	Typ obiektu FeatureCollection musi mieć wartość FeatureCollection.

GeoJsonPoint

Objekt

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)	`Position` to tablica liczb z co najmniej dwoma elementami. Dwa pierwsze elementy to długości geograficznej i szerokości geograficznej, dokładnie w tej kolejności. wysokości/wysokości jest opcjonalnym trzecim elementem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
type	string: Point	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.

Intersection

Objekt

Adres wyniku.

Nazwa	Typ	Opis
baseStreet	string	Główna ulica dla lokalizacji.
displayName	string	Pełna nazwa skrzyżowania.
intersectionType	string	Typ skrzyżowania.
secondaryStreet1	string	Pierwsza przecinając ulicę.
secondaryStreet2	string	Jeśli istnieje, druga przecinając ulicę.

MatchCodesEnum

Wyliczanie

Co najmniej jedna zgodna wartość kodu reprezentująca poziom geokodowania dla każdej lokalizacji w odpowiedzi.

Na przykład lokalizacja geokodowana z kodami dopasowania Good i Ambiguous oznacza, że dla informacji o lokalizacji odnaleziono więcej niż jedną lokalizację kodu geograficznego i że usługa geokodu nie ma wyszukiwania w hierarchii w celu znalezienia dopasowania.

Podobnie lokalizacja geokodowana z kodami dopasowania Ambiguous i UpHierarchy oznacza, że nie można odnaleźć lokalizacji kodu geograficznego pasujących do wszystkich podanych informacji o lokalizacji, więc usługa geokodu musiała przeszukiwać hierarchię i znajdować wiele dopasowań na tym poziomie. Przykładem Ambiguous i UpHierarchy wyniku jest podanie pełnych informacji o adresie, ale usługa geokodowania nie może zlokalizować dopasowania dla adresu ulicznego i zamiast tego zwraca informacje dla więcej niż jednej wartości RoadBlock.

Możliwe wartości to:

Good: lokalizacja ma tylko jedno dopasowanie lub wszystkie zwrócone dopasowania są uznawane za silne dopasowania. Na przykład zapytanie dla Nowego Jorku zwraca kilka dobrych dopasowań.

Ambiguous: lokalizacja jest jednym z zestawów możliwych dopasowań. Na przykład podczas wykonywania zapytania o adres ulicy 128 Main St., odpowiedź może zwrócić dwie lokalizacje dla 128 North Main St. i 128 South Main St. ponieważ nie ma wystarczającej ilości informacji, aby określić, którą opcję wybrać.

UpHierarchy: lokalizacja reprezentuje przejście w górę hierarchii geograficznej. Dzieje się tak, gdy nie znaleziono dopasowania żądania lokalizacji, dlatego zwracany jest mniej dokładny wynik. Jeśli na przykład nie można odnaleźć dopasowania żądanego adresu, może zostać zwrócony kod dopasowania UpHierarchy z typem jednostki RoadBlock.

Wartość	Opis
Good
Ambiguous
UpHierarchy

Properties

Objekt

Nazwa	Typ	Opis
address	Address	Adres wyniku
confidence	ConfidenceEnum	Poziom pewności, że wynik geokodowanej lokalizacji jest zgodny. Użyj tej wartości z kodem dopasowania, aby określić więcej pełnych informacji o dopasowaniu. Pewność lokalizacji zakodowanej geograficznie opiera się na wielu czynnikach, w tym względnym znaczeniu lokalizacji zakodowanej geograficznie i lokalizacji użytkownika, jeśli zostanie określona.
geocodePoints	GeocodePoints[]	Kolekcja punktów kodu geograficznego, które różnią się sposobem ich obliczania i sugerowanym użyciem.
matchCodes	MatchCodesEnum[]	Co najmniej jedna zgodna wartość kodu reprezentująca poziom geokodowania dla każdej lokalizacji w odpowiedzi. Na przykład lokalizacja geokodowana z kodami dopasowania `Good` i `Ambiguous` oznacza, że dla informacji o lokalizacji odnaleziono więcej niż jedną lokalizację kodu geograficznego i że usługa geokodu nie ma wyszukiwania w hierarchii w celu znalezienia dopasowania. Podobnie lokalizacja geokodowana z kodami dopasowania `Ambiguous` i `UpHierarchy` oznacza, że nie można odnaleźć lokalizacji kodu geograficznego pasujących do wszystkich podanych informacji o lokalizacji, więc usługa geokodu musiała przeszukiwać hierarchię i znajdować wiele dopasowań na tym poziomie. Przykładem `Ambiguous` i `UpHierarchy` wyniku jest podanie pełnych informacji o adresie, ale usługa geokodowania nie może zlokalizować dopasowania dla adresu ulicznego i zamiast tego zwraca informacje dla więcej niż jednej wartości RoadBlock. Możliwe wartości to: `Good`: lokalizacja ma tylko jedno dopasowanie lub wszystkie zwrócone dopasowania są uznawane za silne dopasowania. Na przykład zapytanie dla Nowego Jorku zwraca kilka dobrych dopasowań. `Ambiguous`: lokalizacja jest jednym z zestawów możliwych dopasowań. Na przykład podczas wykonywania zapytania o adres ulicy 128 Main St., odpowiedź może zwrócić dwie lokalizacje dla 128 North Main St. i 128 South Main St. ponieważ nie ma wystarczającej ilości informacji, aby określić, którą opcję wybrać. `UpHierarchy`: lokalizacja reprezentuje przejście w górę hierarchii geograficznej. Dzieje się tak, gdy nie znaleziono dopasowania żądania lokalizacji, dlatego zwracany jest mniej dokładny wynik. Jeśli na przykład nie można odnaleźć dopasowania żądanego adresu, może zostać zwrócony kod dopasowania `UpHierarchy` z typem jednostki RoadBlock.
type	string	Jeden z: Adres Blokada RoadIntersection Sąsiedztwo Zapełnione miejsce Kod pocztowy1 AdminDivision1 AdminDivision2 Kraj/Region

UsageTypeEnum

Wyliczanie

Najlepsze zastosowanie dla punktu kodu geograficznego. Każdy punkt kodu geograficznego jest definiowany jako punkt Route, punkt Display lub oba te elementy. Użyj Route punktów, jeśli tworzysz trasę do lokalizacji. Użyj Display punktów, jeśli wyświetlasz lokalizację na mapie. Na przykład jeśli lokalizacja jest parkiem, punkt Route może określić wejście do parku, w którym można wejść z samochodem, a punkt Display może być punktem określającym centrum parku.

Wartość	Opis
Display
Route

Udostępnij przez

Search - Get Geocoding

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Zakresy

subscription-key

SAS Token

Przykłady

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

Przykładowe żądanie

Przykładowa odpowiedź

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Przykładowe żądanie

Przykładowa odpowiedź

Search detail address 15127 NE 24th Street, Redmond, WA by query

Przykładowe żądanie

Przykładowa odpowiedź

Search landmark Empire State Building by query

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingResponse

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

UsageTypeEnum