Search - Get Geocoding

Usługa:: Maps

Wersja interfejsu API:: 2026-01-01

Umożliwia uzyskanie współrzędnych długości i szerokości geograficznej ulicy, adresu lub nazwy miejsca.
Interfejs Get Geocoding API to żądanie HTTP GET , które zwraca współrzędne długości i szerokości geograficznej wyszukiwanej 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ę poprzez trafienie w punkt końcowy geokodowania z samym adresem lub częściowym adresem, o którym mowa. Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Żadne użyteczne miejsca (POI) nie zostaną zwrócone. Należy pamiętać, że geokoder jest bardzo odporny na literówki i niekompletne adresy. Poradzi sobie również ze wszystkim, od dokładnych adresów ulic lub ulic lub skrzyżowań, a także obszarów geograficznych wyższego poziomu, takich jak centra miast, hrabstwa i stany. Odpowiedź zwraca również szczegółowe właściwości adresu, takie jak ulica, kod pocztowy, gmina i informacje o kraju/regionie.

GET {endpoint}/geocode?api-version=2026-01-01

Z parametrami opcjonalnymi:

GET {endpoint}/geocode?api-version=2026-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
endpoint	path	True	string
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
addressLine	query		string	Oficjalna linia ulicy adresu względem obszaru, określona przez właściwości locality (postalCode). Typowym zastosowaniem tego elementu byłoby podanie adresu ulicy lub dowolnego oficjalnego adresu. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
adminDistrict	query		string	Część adresu dotycząca podziału na poszczególne kraje, na przykład WA. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
adminDistrict2	query		string	Hrabstwo dla adresu strukturalnego, na przykład King. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
adminDistrict3	query		string	Nazwany obszar 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ąta są definiowane przez wartości długości i szerokości geograficznej. Po określeniu tego parametru obszar geograficzny jest brany pod uwagę przy obliczaniu wyników kwerendy dotyczącej lokalizacji. 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[]	Punkt na Ziemi określony jako długość i szerokość geograficzna. Po określeniu tego parametru lokalizacja użytkownika jest brana pod uwagę, a zwrócone wyniki mogą być bardziej odpowiednie dla użytkownika. Przykład: współrzędne &=lon,lat
countryRegion	query		string	Sygnał dla wyniku geokodowania do kodu regionu/kraju ISO 3166-1 Alpha-2 , który jest określony, np. FR. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
locality	query		string	Część adresu dotycząca lokalizacji, na przykład Seattle. Ten parametr nie powinien być używany, `query` gdy parametr jest uwzględniony w żądaniu.
postalCode	query		string	Część adresu zawierająca kod pocztowy. 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 punktu orientacyjnego.
top	query		integer (int32) minimum: 1 maximum: 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
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 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.

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

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GeocodingResponse	Żądanie zakończyło się pomyślnie. Media Types: "application/geo+json", "application/json"
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Media Types: "application/geo+json", "application/json" Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

GeocodingResponse

Żądanie zakończyło się pomyślnie.

Media Types: "application/geo+json", "application/json"

Other Status Codes

Azure.Core.Foundations.ErrorResponse

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 podmiot usługowy może otrzymać dostęp poprzez wbudowaną rolę lub niestandardową rolę składającą się z jednego lub więcej uprawnień do Azure Maps API REST.\n\nAby zaimplementować scenariusze, zalecamy zapoznanie się z koncepcjami authentication concepts. Podsumowując, ta definicja bezpieczeństwa zapewnia rozwiązanie do modelowania aplikacji(-ów) za pomocą obiektów zdolnych do kontroli dostępu do określonych API i zakresów.\n\n#### Uwagi\n* Ta definicja bezpieczeństwa wymaga użycia nagłówka x-ms-client-id do wskazania, do którego Azure Maps zasobu aplikacja żąda dostępu. Można ją uzyskać z API zarządzania Maps.\n* \nAuthorization URL jest specyficzny dla instancji Azure chmury publicznej. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID. \n* \nKontrola dostępu oparta na rolach Azure jest konfigurowana z płaszczyzny zarządzania Azure za pośrednictwem Azure portalu, PowerShell, CLI, Azure SDKs lub API REST.\n* \nWykorzystanie Azure Maps Web SDK umożliwia konfigurację aplikacji dla wielu zastosowań.\n* Aby uzyskać więcej informacji o Platforma tożsamości Microsoft, zobacz przegląd Platforma tożsamości Microsoft przegląd.

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ółdzielony, który jest przydzielany podczas Tworzenia konta Azure Maps w portalu Azure lub za pomocą PowerShell, CLI, Azure SDKs lub REST API.\n\n Dzięki temu kluczowi każda aplikacja może uzyskać dostęp do wszystkich API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, na którym są wydawane.\n\n W przypadku aplikacji udostępnionych publicznie zalecamy stosowanie podejścia confidential client applications do dostępu do API REST Azure Maps i bezpiecznie przechowywać klucz.

Typ: apiKey
W: header

SAS Token

Jest to token podpisu współdzielonego dostępu tworzony na podstawie operacji List SAS na Azure Maps resource przez płaszczyznę zarządzania Azure za pomocą Azure portalu, PowerShell, CLI, Azure SDKs lub API REST.\n\n Dzięki temu tokenowi każda aplikacja jest autoryzowana do dostępu za pomocą Azure kontrola dostępu oparta na rolach oraz precyzyjna kontrola do terminu wygaśnięcia, tempa i regionu użycia danego tokena. Innymi słowy, token SAS może być używany do umożliwienia aplikacjom kontrolowania dostępu w sposób bezpieczniejszy niż klucz współdzielony.\n\n W przypadku aplikacji udostępnionych publicznie zalecamy skonfigurowanie konkretnej listy dozwolonych źródeł na zasobach konta Map , aby ograniczyć nadużycia renderowania i regularnie odnawiać Token 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 {endpoint}/geocode?api-version=2026-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 {endpoint}/geocode?api-version=2026-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 {endpoint}/geocode?api-version=2026-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 {endpoint}/geocode?api-version=2026-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
AddressAdminDistrictsItem	Nazwa poddziału w kraju lub regionie dla adresu.
AddressCountryRegion	Kraj lub region wraz z jego nazwą i kodem ISO.
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły 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.
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.
FeatureCollectionEnum	Określa typ `GeoJSON`. Jedynym obsługiwanym typem obiektu jest `FeatureCollection`. Aby uzyskać więcej informacji, zobacz RFC 7946.
FeaturesItem	Obiekt cechowy.
FeaturesItemProperties	Właściwości cechy.
FeatureTypeEnum	Typ funkcji musi mieć wartość Funkcja.
GeocodePointsItem	Punkt geokodowy.
GeocodingResponse	Ten obiekt jest zwracany z pomyślnego wywołania geokodowania
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.
GeoJsonPoint	Prawidłowy typ geometrii `GeoJSON Point`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
Intersection	Adres wyniku.
MatchCodesEnum	Enum reprezentujące kod meczu.
UsageTypeEnum	Enum reprezentujące typ użycia.

Address

Objekt

Adres wyniku

Nazwa	Typ	Opis
addressLine	string	AddressLine, który zawiera nazwę ulicy i numer
adminDistricts	AddressAdminDistrictsItem[]	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	AddressCountryRegion	Kraj lub region wraz z jego nazwą i kodem ISO.
formattedAddress	string	Właściwość Sformatowany adres
intersection	Intersection	Adres wyniku.
locality	string	Właściwość lokalna
neighborhood	string	Nieruchomość w sąsiedztwie
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

AddressAdminDistrictsItem

Objekt

Nazwa poddziału w kraju lub regionie dla adresu.

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

AddressCountryRegion

Objekt

Kraj lub region wraz z jego nazwą i kodem ISO.

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

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.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

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

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	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

CalculationMethodEnum

Wyliczenie

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

Wyliczenie

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

FeatureCollectionEnum

Wyliczenie

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest FeatureCollection. Aby uzyskać więcej informacji, zobacz RFC 7946.

Wartość	Opis
FeatureCollection	Określa typ obiektu `GeoJSONFeatureCollection`.

FeaturesItem

Objekt

Obiekt cechowy.

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	FeaturesItemProperties	Właściwości cechy.
type	FeatureTypeEnum	Typ funkcji musi mieć wartość Funkcja.

FeaturesItemProperties

Objekt

Właściwości cechy.

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	GeocodePointsItem[]	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 * RoadBlock * RoadIntersection * Neighborhood * PopulatedPlace * Kod pocztowy 1 * AdminDivision1 * AdminDivision2 * CountryRegion

FeatureTypeEnum

Wyliczenie

Typ funkcji musi mieć wartość Funkcja.

Wartość	Opis
Feature	Określa typ obiektu funkcji `GeoJSON`.

GeocodePointsItem

Objekt

Punkt geokodowy.

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[]	Z zapytania powrócił szereg cech.
nextLink	string	Jest to link do następnej strony zwróconych funkcji. Jeśli jest to ostatnia strona, nie ma tego pola.
type	FeatureCollectionEnum	Określa typ `GeoJSON`. Jedynym obsługiwanym typem obiektu jest `FeatureCollection`. Aby uzyskać więcej informacji, zobacz RFC 7946.

GeoJsonObjectType

Wyliczenie

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	`GeoJSON Point` geometrii.
MultiPoint	`GeoJSON MultiPoint` geometrii.
LineString	`GeoJSON LineString` geometrii.
MultiLineString	`GeoJSON MultiLineString` geometrii.
Polygon	`GeoJSON Polygon` geometrii.
MultiPolygon	`GeoJSON MultiPolygon` geometrii.
GeometryCollection	`GeoJSON GeometryCollection` geometrii.
Feature	`GeoJSON Feature` obiekt.
FeatureCollection	`GeoJSON FeatureCollection` obiekt.

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

Wyliczenie

Enum reprezentujące kod meczu.

Wartość	Opis
Good	Dobrze
Ambiguous	Dwuznaczny
UpHierarchy	UpHierarchy

UsageTypeEnum

Wyliczenie

Enum reprezentujące typ użycia.

Wartość	Opis
Display	Display
Route	Marszruta

Udostępnij za pośrednictwem

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

AddressAdminDistrictsItem

AddressCountryRegion

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CalculationMethodEnum

ConfidenceEnum

FeatureCollectionEnum

FeaturesItem

FeaturesItemProperties

FeatureTypeEnum

GeocodePointsItem

GeocodingResponse

GeoJsonObjectType

GeoJsonPoint

Intersection

MatchCodesEnum

UsageTypeEnum