Search - Get Geocoding

Usługa:

Maps

Wersja interfejsu API:

2023-06-01

Służy do uzyskiwania współrzędnych długości i szerokości geograficznej adresu ulicy lub nazwy miejsca.

Interfejs Get Geocoding API to żądanie HTTP GET , które zwraca współrzędne długości geograficznej 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ć wyłącznie. Geokodowanie jest wykonywane przez uderzenie punktu końcowego geokodowania tylko za pomocą adresu lub częściowego adresu. 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 adresów, takie jak ulica, kod pocztowy, gmina i informacje o kraju/regionie.

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

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/geocode?api-version=2023-06-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ślonego przez lokalizację lub kod pocztowy, właściwości. Typowym zastosowaniem tego elementu jest podanie adresu ulicznego lub dowolnego oficjalnego adresu. Jeśli podano zapytanie, nie należy używać tego parametru.
adminDistrict	query		string	Część adresu podziału kraju, taka jak WA. Jeśli podano zapytanie, nie należy używać tego parametru.
adminDistrict2	query		string	Powiat dla adresu ustrukturyzowanego, takiego jak King. Jeśli podano zapytanie, nie należy używać tego parametru.
adminDistrict3	query		string	Nazwany obszar dla adresu strukturalnego. Jeśli podano zapytanie, nie należy używać tego parametru.
bbox	query		number[]	Prostokątny obszar na ziemi zdefiniowany jako obiekt pola ograniczenia. Boki prostokątów są definiowane według wartości długości geograficznej i szerokości geograficznej. Po określeniu tego parametru obszar geograficzny jest uwzględniany podczas przetwarzania 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 kodu ISO 3166-1 Alfa-2 regionu/kraju , który jest określony, np. FR./ Jeśli podano zapytanie, nie należy używać tego parametru.
locality	query		string	Część adresu lokalnego, taka jak Seattle. Jeśli podano zapytanie, nie należy używać tego parametru.
postalCode	query		string	Część kodu pocztowego adresu. Jeśli podano zapytanie, nie należy używać tego parametru.
query	query		string	Ciąg zawierający informacje o lokalizacji, takie jak adres lub nazwa charakterystyczna.
top	query		integer int32	Maksymalna liczba odpowiedzi, które zostaną zwrócone. Wartość domyślna: 5, minimalna: 1 i maksymalna: 20.
view	query		string	Ciąg reprezentujący kod regionu/kraju ISO 3166-1 Alpha-2. Spowoduje to zmianę granic i etykiet geopolitycznych w celu dostosowania 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, zapoznaj się z tematem Obsługiwane widoki i zobacz 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 użyć zabezpieczeń usługi Azure AD w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

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"

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwaga

• Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id , aby wskazać, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.
• Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów entra firmy Microsoft.
• Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z poziomu 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 Sdk sieci Web 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 Omówienie platformy tożsamości firmy Microsoft.

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

Przy użyciu 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 serwera do serwera 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 listy sygnatur dostępu współdzielonego w 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 SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

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=2023-06-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",
          "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=2023-06-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",
          "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=2023-06-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",
          "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=2023-06-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 podsieci w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako pierwsza kolejność podziału administracyjnego, ale w niektórych przypadkach zawiera on 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 lokalizacji geokodowanej jest zgodny. Użyj tej wartości z kodem dopasowania, aby określić więcej pełnych informacji o dopasowaniu. Pewność lokalizacji geokodowanej opiera się na wielu czynnikach, w tym względnej ważności lokalizacji geokodowanej i lokalizacji użytkownika, jeśli zostanie określony.
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 być 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 GeoJSON Point typ geometrii. 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 Good dopasowania i Ambiguous oznacza, że odnaleziono więcej niż jedną lokalizację geokodu dla informacji o lokalizacji i że usługa geokodowania nie ma hierarchii wyszukiwania w górę, aby znaleźć dopasowanie. Podobnie lokalizacja geokodowana z kodami Ambiguous dopasowania i UpHierarchy oznacza, że nie można odnaleźć lokalizacji geokodu pasujących do wszystkich podanych informacji o lokalizacji, więc usługa geokodowania musiała przeszukiwać hierarchię i znajdować wiele dopasowań na tym poziomie. Przykładem elementu Ambiguous i UpHierarchy jest podanie pełnych informacji o adresie, ale usługa geokodu 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 są następujące: 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 w przypadku 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 przeniesienie w górę hierarchii geograficznej. Dzieje się tak, gdy nie znaleziono dopasowania dla żą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 UpHierarchy dopasowania z typem jednostki RoadBlock.
Properties
UsageTypeEnum	Najlepsze zastosowanie dla punktu kodu geograficznego. Każdy punkt kodu geograficznego Route jest definiowany jako punkt, Display punkt lub oba. 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 może określić wejście do parku, Route w którym można wejść z samochodem, a Display punkt może być punktem określającym centrum parku.

Address

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 podział administracyjny pierwszego zamówienia, ale w niektórych przypadkach zawiera on również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie.
countryRegion	CountryRegion
formattedAddress	string	Właściwość sformatowanego adresu
intersection	Intersection	Adres wyniku.
locality	string	właściwość locality
neighborhood	string	nieruchomość sąsiedztwa
postalCode	string	Właściwość Kod pocztowy

AdminDistricts

Nazwa podsieci w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako pierwsza kolejność podziału administracyjnego, ale w niektórych przypadkach zawiera on 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, Dla adminDistrict[0], może to być pełna nazwa stanu, takiego jak Waszyngton, For adminDistrict[1], może to być pełna nazwa powiatu
shortName	string	Krótka nazwa odpowiedniego pola adminDistrict, Dla adminDistrict[0], może to być krótka nazwa stanu, takiego jak WA, For adminDistrict[1], może to być krótka nazwa powiatu

CalculationMethodEnum

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

Nazwa	Typ	Opis
Interpolation	string	Punkt kodu geograficznego został dopasowany do punktu na drodze przy użyciu interpolacji.
InterpolationOffset	string	Punkt kodu geograficznego został dopasowany do punktu na drodze przy użyciu interpolacji z dodatkowym przesunięciem, aby przesunąć punkt na stronę ulicy.
Parcel	string	Punkt kodu geograficznego został dopasowany do środka paczki.
Rooftop	string	Punkt kodu geograficznego został dopasowany do dachu budynku.

ConfidenceEnum

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

Pewność lokalizacji geokodowanej opiera się na wielu czynnikach, w tym względnej ważności lokalizacji geokodowanej i lokalizacji użytkownika, jeśli zostanie określony.

Nazwa	Typ	Opis
High	string	Jeśli pewność siebie jest ustawiona na High, znaleziono co najmniej jeden silny mecz. Wiele High dopasowań ufności jest sortowanych w kolejności uporządkowanej 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 zostać odpowiednio zmieniona. Na przykład zapytanie o lokalizację dla "Paryż" zwraca wartość "Paris, France" i "Paris, TX" z ufnością High . "Paryż, Francja" jest zawsze klasyfikowany jako pierwszy ze względu na znaczenie, chyba że lokalizacja użytkownika wskazuje, że użytkownik znajduje się w Paryżu, TX lub w pobliżu Paryża, TX lub widoku mapy wskazuje, że użytkownik wyszukuje w tym obszarze.
Low	string
Medium	string	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 określać informacje o adresie, a usługa geokodu może być w stanie dopasować kod pocztowy. W takim przypadku jeśli usługa geokodowania ma pewność, że kod pocztowy jest zgodny z danymi, ustawiono pewność Medium siebie i ustawiono kod dopasowania, aby UpHierarchy określić, że nie może pasować do wszystkich informacji i musiał przeszukiwać hierarchię w górę. Jeśli informacje o lokalizacji w zapytaniu są niejednoznaczne i nie ma dodatkowych informacji dotyczących klasyfikacji lokalizacji (takich jak lokalizacja użytkownika lub względna ważność lokalizacji), pewność jest ustawiona na Mediumwartość . Na przykład zapytanie o lokalizację dla "148th Ave, Bellevue" może zwracać "148th Ave SE" i "148th Ave NE" zarówno z ufnością Medium . Jeśli informacje o lokalizacji w zapytaniu nie udostępniają wystarczającej ilości informacji do geokodowania określonej lokalizacji, może zostać zwrócona mniej dokładna wartość lokalizacji i ustawiono pewność na Mediumwartość . Jeśli na przykład podano adres, ale nie można odnaleźć dopasowania dla numeru domu, wynik geokodu z typem jednostki Roadblock może zostać zwrócony.

CountryRegion

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

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

FeatureCollectionEnum

Typ obiektu FeatureCollection musi być FeatureCollection.

Nazwa	Typ	Opis
FeatureCollection	string

FeaturesItem

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

FeatureTypeEnum

Typ funkcji musi mieć wartość Funkcja.

Nazwa	Typ	Opis
Feature	string

GeocodePoints

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 GeoJSON Point typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
usageTypes	UsageTypeEnum[]	Najlepsze zastosowanie dla punktu kodu geograficznego. Każdy punkt kodu geograficznego Route jest definiowany jako punkt, Display punkt lub oba. 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 może określić wejście do parku, Route w którym można wejść z samochodem, a Display punkt może być punktem określającym centrum parku.

GeocodingResponse

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

Nazwa	Typ	Opis
features	FeaturesItem[]
nextLink	string	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 być FeatureCollection.

GeoJsonPoint

Prawidłowy GeoJSON Point typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
bbox	number[]	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
coordinates	number[]	A Position to tablica liczb z co najmniej dwoma elementami. Pierwsze dwa elementy to długość geograficzna i szerokość geograficzna, dokładnie w tej kolejności. Wysokość/wysokość jest opcjonalnym trzecim elementem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
type	string: Point	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

Intersection

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

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

Na przykład lokalizacja geokodowana z kodami Good dopasowania i Ambiguous oznacza, że odnaleziono więcej niż jedną lokalizację geokodu dla informacji o lokalizacji i że usługa geokodowania nie ma hierarchii wyszukiwania w górę, aby znaleźć dopasowanie.

Podobnie lokalizacja geokodowana z kodami Ambiguous dopasowania i UpHierarchy oznacza, że nie można odnaleźć lokalizacji geokodu pasujących do wszystkich podanych informacji o lokalizacji, więc usługa geokodowania musiała przeszukiwać hierarchię i znajdować wiele dopasowań na tym poziomie. Przykładem elementu Ambiguous i UpHierarchy jest podanie pełnych informacji o adresie, ale usługa geokodu 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 są następujące:

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 w przypadku 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 przeniesienie w górę hierarchii geograficznej. Dzieje się tak, gdy nie znaleziono dopasowania dla żą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 UpHierarchy dopasowania z typem jednostki RoadBlock.

Nazwa	Typ	Opis
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Nazwa	Typ	Opis
address	Address	Adres wyniku
confidence	ConfidenceEnum	Poziom pewności, że wynik lokalizacji geokodowanej jest zgodny. Użyj tej wartości z kodem dopasowania, aby określić więcej pełnych informacji o dopasowaniu. Pewność lokalizacji geokodowanej opiera się na wielu czynnikach, w tym względnej ważności lokalizacji geokodowanej i lokalizacji użytkownika, jeśli zostanie określony.
geocodePoints	GeocodePoints[]	Kolekcja punktów geokodu, 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 Good dopasowania i Ambiguous oznacza, że odnaleziono więcej niż jedną lokalizację geokodu dla informacji o lokalizacji i że usługa geokodowania nie ma hierarchii wyszukiwania w górę, aby znaleźć dopasowanie. Podobnie lokalizacja geokodowana z kodami Ambiguous dopasowania i UpHierarchy oznacza, że nie można odnaleźć lokalizacji geokodu pasujących do wszystkich podanych informacji o lokalizacji, więc usługa geokodowania musiała przeszukiwać hierarchię i znajdować wiele dopasowań na tym poziomie. Przykładem elementu Ambiguous i UpHierarchy jest podanie pełnych informacji o adresie, ale usługa geokodu 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 są następujące: 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 w przypadku 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 przeniesienie w górę hierarchii geograficznej. Dzieje się tak, gdy nie znaleziono dopasowania dla żą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 UpHierarchy dopasowania z typem jednostki RoadBlock.
type	string	Jeden z: Adres Blokada RoadIntersection Sąsiedztwo Zapełnione miejsce Kod pocztowy 1 AdminDivision1 AdminDivision2 CountryRegion

UsageTypeEnum

Najlepsze zastosowanie dla punktu kodu geograficznego. Każdy punkt kodu geograficznego Route jest definiowany jako punkt, Display punkt lub oba. 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 może określić wejście do parku, Route w którym można wejść z samochodem, a Display punkt może być punktem określającym centrum parku.

Nazwa	Typ	Opis
Display	string
Route	string