Search - Get Geocoding

Služba:: Maps

Verze rozhraní API:: 2025-01-01

Slouží k získání souřadnic zeměpisné délky a šířky ulice nebo názvu místa.

Rozhraní Get Geocoding API je požadavek HTTP GET, který vrací souřadnice zeměpisné délky a zeměpisné šířky prohledávaného umístění.

V mnoha případech může být kompletní vyhledávací služba příliš velká, například pokud vás zajímá pouze tradiční geokódování. K vyhledávání adres se dá přistupovat také výhradně. Geokódování se provádí tak, že na koncový bod geokódování dosáhnete jenom adresy nebo částečné adresy. Index vyhledávání geokódování bude dotazován na vše nad daty na úrovni ulice. Nebudou vráceny žádné body zájmu (POI). Mějte na paměti, že geokódér je velmi odolný proti překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo průsečíků i zeměpisných oblastí vyšší úrovně, jako jsou centra měst, okresy a státy. Odpověď také vrátí podrobné vlastnosti adresy, jako je ulice, PSČ, obec a informace o zemi/oblasti.

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps
addressLine	query		string	Oficiální řádek ulice adresy vzhledem k oblasti, jak je určeno lokalitou nebo PSČ, vlastnosti. Typickým použitím tohoto prvku by bylo poskytnutí poštovní adresy nebo jakékoli oficiální adresy. Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
adminDistrict	query		string	Část adresy, jako je wa, část rozdělení země. Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
adminDistrict2	query		string	Okres pro strukturovanou adresu, například King. Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
adminDistrict3	query		string	Pojmenovaná oblast pro strukturovanou adresu. Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
bbox	query		number[]	Obdélníková plocha na zemi definovaná jako ohraničující objekt rámečku. Strany obdélníků jsou definovány hodnotami zeměpisné délky a zeměpisné šířky. Při zadávání tohoto parametru se při výpočtu výsledků dotazu na umístění bere v úvahu zeměpisná oblast. Příklad: lon1,lat1,lon2,lat2
coordinates	query		number[]	Bod na zemi zadaný jako zeměpisná délka a zeměpisná šířka. Při zadání tohoto parametru se zohlední umístění uživatele a vrácené výsledky můžou být pro uživatele relevantnější. Příklad: &souřadnic=lon,lat
countryRegion	query		string	Signál pro výsledek geokódování do ISO 3166-1 Alfa-2 oblasti/země, která je určena např. FR./ Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
locality	query		string	Část adresy v lokalitě, například Seattle. Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
postalCode	query		string	Část PSČ adresy. Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
query	query		string	Řetězec, který obsahuje informace o umístění, například název adresy nebo orientačního bodu.
top	query		integer (int32) minimum: 1 maximum: 20	Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 5, minimum: 1 a maximum: 20.
view	query		string	Řetězec představující ISO 3166-1 Alfa-2 oblast/kód země. Tím se změní geopolitické sporné ohraničení a popisky tak, aby odpovídaly zadané oblasti uživatele. Ve výchozím nastavení je parametr View nastavený na "Auto", i když jste ho v požadavku nenadefinili. Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Accept-Language		string	Jazyk, ve kterém mají být vráceny výsledky hledání. Podrobnosti najdete v podporovaných jazycích.
x-ms-client-id		string	Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Azure AD. Představuje jedinečné ID pro účet Azure Maps a dá se načíst z rozhraní API účtu roviny správy Azure Maps. Další informace o používání zabezpečení Microsoft Entra ID v Azure Maps najdete v tématu Správa ověřování v Azure Maps.

Name

Vyžadováno

Typ

Description

Accept-Language

string

Jazyk, ve kterém mají být vráceny výsledky hledání.

Podrobnosti najdete v podporovaných jazycích.

x-ms-client-id

string

Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Azure AD. Představuje jedinečné ID pro účet Azure Maps a dá se načíst z rozhraní API účtu roviny správy Azure Maps. Další informace o používání zabezpečení Microsoft Entra ID v Azure Maps najdete v tématu Správa ověřování v Azure Maps.

Odpovědi

Name	Typ	Description
200 OK	GeocodingResponse	OK Media Types: "application/geo+json" Hlavičky x-ms-request-id: string
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě. Media Types: "application/geo+json"

Name

Typ

Description

200 OK

GeocodingResponse

Media Types: "application/geo+json"

Hlavičky

x-ms-request-id: string

Other Status Codes

ErrorResponse

Došlo k neočekávané chybě.

Media Types: "application/geo+json"

Zabezpečení

AADToken

Jedná se o Microsoft Entra OAuth 2.0 Flow. Při spárování s přístupu na základě role Azure se dá řídit přístup k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role Azure slouží k určení přístupu k jednomu nebo více účtům prostředků Nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.

Chcete-li implementovat scénáře, doporučujeme zobrazit koncepty ověřování. Stručně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a rozsahy.

Poznámka:

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému prostředku Azure Maps aplikace požaduje přístup. To lze získat z rozhraní API pro správu Maps.
Authorization URL je specifická pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné adresy URL autorizace a konfigurace MICROSOFT Entra ID.
Řízení přístupu na základě role Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad AZURE SDK nebo rozhraní REST API.
Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jedná se o sdílený klíč, který je zřízený při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad SDK Azure nebo rozhraní REST API.

S tímto klíčem má každá aplikace oprávnění pro přístup ke všem rozhraním REST API. Jinými slovy, tyto klíče lze v současné době považovat za hlavní klíče k účtu, pro který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat přístup mezi servery k rozhraním REST API služby Azure Maps, kde je možné tento klíč bezpečně uložit.

Typ: apiKey
V: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace Vypsat SAS v prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad SDK Azure nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů na prostředku účtu Map omezit zneužití vykreslování a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
      ]
    }
  ]
}

Definice

Name	Description
Address	Adresa výsledku
AdminDistricts	Název dílčího dělení v zemi nebo oblasti adresy. Tento prvek je obvykle považován za první dílčí dělení správního řádu, ale v některých případech obsahuje také druhé, třetí nebo čtvrté rozdělení pořadí v zemi, závislosti nebo oblasti.
CalculationMethodEnum	Metoda, která se použila k výpočtu bodu geografického kódu.
ConfidenceEnum	Úroveň spolehlivosti, že výsledek geokódovaného umístění odpovídá. Tuto hodnotu použijte s kódem shody k určení podrobnějších informací o shodě. Spolehlivost geokódovaného umístění je založená na mnoha faktorech, včetně relativní důležitosti geokódovaného umístění a umístění uživatele, pokud je zadáno.
CountryRegion
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
FeatureCollectionEnum	Typ FeatureCollection objektu musí být FeatureCollection.
FeaturesItem
FeatureTypeEnum	Typ funkce musí být Funkce.
GeocodePoints	Kolekce bodů geografického kódu, které se liší ve způsobu výpočtu a jejich navrhovaném použití.
GeocodingResponse	Tento objekt se vrátí z úspěšného volání geokódování.
GeoJsonPoint	Platný typ geometrie `GeoJSON Point`. Podrobnosti najdete v RFC 7946.
Intersection	Adresa výsledku.
MatchCodesEnum	Jedna nebo více hodnot kódu, které představují úroveň geokódování pro každé umístění v odpovědi. Například geograficky zakódované umístění s kódy shody `Good` a `Ambiguous` znamená, že pro informace o poloze bylo nalezeno více než jedno umístění geografického kódu a že služba geografického kódu nenalezla shodu v hierarchii. Podobně geokódované umístění s kódy shody `Ambiguous` a `UpHierarchy` znamená, že umístění geografického kódu nebylo nalezeno tak, aby odpovídalo všem zadaným informacím o poloze, takže služba geografického kódu musela prohledávat hierarchii a najít více shod na této úrovni. Příkladem `Ambiguous` a výsledku `UpHierarchy` je zadání úplných informací o adrese, ale služba geografického kódu nemůže najít shodu adresy a místo toho vrátí informace pro více než jednu hodnotu RoadBlock. Možné hodnoty: `Good`: Umístění má pouze jednu shodu nebo všechny vrácené shody jsou považovány za silné shody. Například dotaz na New York vrátí několik dobrých shod. `Ambiguous`: Umístění je jednou ze sady možných shod. Když například zadáte dotaz na adresu ulice 128 Main St., odpověď může vrátit dvě místa pro 128 severního hlavního a 128 jižního hlavního st. , protože neexistuje dostatek informací pro určení, kterou možnost zvolit. `UpHierarchy`: Umístění představuje přesun v geografické hierarchii. K tomu dochází v případě, že nebyla nalezena shoda požadavku na umístění, takže se vrátí méně přesný výsledek. Pokud například nelze najít shodu požadované adresy, může se vrátit kód shody `UpHierarchy` s typem entity RoadBlock.
Properties
UsageTypeEnum	Nejlepší použití pro bod geografického kódu. Každý bod geografického kódu je definován jako bod `Route`, `Display` bod nebo obojí. Pokud vytváříte trasu do umístění, použijte `Route` body. Pokud zobrazujete umístění na mapě, použijte `Display` body. Například pokud je umístění parkem, může `Route` bod určit vstup do parku, kde můžete vstoupit s autem, a `Display` bod může být bod, který určuje střed parku.

Address

Objekt

Adresa výsledku

Name	Typ	Description
addressLine	string	AddressLine, která obsahuje název ulice a číslo
adminDistricts	AdminDistricts[]	Název dílčího dělení v zemi nebo oblasti adresy. Tento prvek je obvykle považován za první dílčí dělení správního řádu, ale v některých případech obsahuje také druhé, třetí nebo čtvrté rozdělení pořadí v zemi, závislosti nebo oblasti.
countryRegion	CountryRegion
formattedAddress	string	Vlastnost Formátovaná adresa
intersection	Intersection	Adresa výsledku.
locality	string	nemovitosti v lokalitě
neighborhood	string	sousedství – ubytování
postalCode	string	Vlastnost PSČ
streetName	string	Název ulice z formattedAddress
streetNumber	string	Číslo na ulici, pokud je k dispozici, z formattedAddress

AdminDistricts

Objekt

Název dílčího dělení v zemi nebo oblasti adresy. Tento prvek je obvykle považován za první dílčí dělení správního řádu, ale v některých případech obsahuje také druhé, třetí nebo čtvrté rozdělení pořadí v zemi, závislosti nebo oblasti.

Name	Typ	Description
name	string	Název odpovídajícího pole adminDistrict for adminDistrict[0], může to být úplný název státu, jako je Washington, For adminDistrict[1], může to být úplný název okresu.
shortName	string	Krátký název odpovídajícího pole adminDistrict for adminDistrict[0], může to být krátký název státu, jako je WA, For adminDistrict[1], může to být krátký název okresu.

CalculationMethodEnum

Výčet

Metoda, která se použila k výpočtu bodu geografického kódu.

Hodnota	Description
Interpolation	Bod geokódu byl přiřazen k bodu na silnici pomocí interpolace.
InterpolationOffset	Bod geokódu byl přiřazen k bodu na silnici pomocí interpolace s dodatečným odsazením pro posunutí bodu na stranu ulice.
Parcel	Bod geokódu byl přiřazen ke středu parcely.
Rooftop	Bod geokódu byl přiřazen ke střeše budovy.

ConfidenceEnum

Výčet

Úroveň spolehlivosti, že výsledek geokódovaného umístění odpovídá. Tuto hodnotu použijte s kódem shody k určení podrobnějších informací o shodě.

Spolehlivost geokódovaného umístění je založená na mnoha faktorech, včetně relativní důležitosti geokódovaného umístění a umístění uživatele, pokud je zadáno.

Hodnota Description

High

Hodnota	Description
High	Pokud je spolehlivost nastavena na `High`, byla nalezena jedna nebo více silných shod. Vícenásobné `High` shody spolehlivosti jsou seřazeny v seřazeném pořadí podle důležitosti, pokud je to možné. Například orientační body mají význam, ale adresy ne. Pokud požadavek obsahuje umístění nebo výběr, může se pořadí odpovídajícím způsobem změnit. Například dotaz na polohu pro "Paříž" vrátí "Paříž, Francie" a "Paříž, TX" s `High` důvěrou. "Paříž, Francie" je vždy zařazena na první místo z důvodu důležitosti, pokud poloha uživatele nenaznačuje, že se uživatel nachází v Paříži nebo velmi blízko Paříže, TX nebo pokud zobrazení mapy nenaznačuje, že uživatel hledá v této oblasti.
Medium	V některých situacích nemusí být vrácená shoda na stejné úrovni jako informace uvedené v požadavku. Požadavek může například obsahovat informace o adrese a služba geokódování může být schopna spárovat pouze poštovní směrovací číslo. V tomto případě, pokud má služba geokódu jistotu, že poštovní směrovací číslo odpovídá datům, je tato spolehlivost nastavena na `Medium` hodnotu a kód shody je nastaven na hodnotu tak `UpHierarchy` , aby určoval, že nemohl odpovídat všem informacím a musel hledat v hierarchii nahoru. Pokud jsou informace o umístění v dotazu nejednoznačné a nejsou k dispozici žádné další informace pro jejich pořadí (například umístění uživatele nebo relativní důležitost umístění), je spolehlivost nastavena na `Medium`. Například dotaz na polohu pro "148th Ave, Bellevue" může s jistotou vrátit "148th Ave SE" a "148th Ave NE".`Medium` Pokud informace o poloze v dotazu neposkytují dostatek informací pro geografické kódování konkrétního umístění, může být vrácena méně přesná hodnota umístění a spolehlivost je nastavena na `Medium`. Pokud je například zadána adresa, ale pro číslo domu není nalezena shoda, může být vrácen výsledek geokódu s typem entity Roadblock.
Low

Pokud je spolehlivost nastavena na High, byla nalezena jedna nebo více silných shod. Vícenásobné High shody spolehlivosti jsou seřazeny v seřazeném pořadí podle důležitosti, pokud je to možné. Například orientační body mají význam, ale adresy ne.

Pokud požadavek obsahuje umístění nebo výběr, může se pořadí odpovídajícím způsobem změnit. Například dotaz na polohu pro "Paříž" vrátí "Paříž, Francie" a "Paříž, TX" s High důvěrou. "Paříž, Francie" je vždy zařazena na první místo z důvodu důležitosti, pokud poloha uživatele nenaznačuje, že se uživatel nachází v Paříži nebo velmi blízko Paříže, TX nebo pokud zobrazení mapy nenaznačuje, že uživatel hledá v této oblasti.

Medium

V některých situacích nemusí být vrácená shoda na stejné úrovni jako informace uvedené v požadavku. Požadavek může například obsahovat informace o adrese a služba geokódování může být schopna spárovat pouze poštovní směrovací číslo. V tomto případě, pokud má služba geokódu jistotu, že poštovní směrovací číslo odpovídá datům, je tato spolehlivost nastavena na Medium hodnotu a kód shody je nastaven na hodnotu tak UpHierarchy , aby určoval, že nemohl odpovídat všem informacím a musel hledat v hierarchii nahoru.

Pokud jsou informace o umístění v dotazu nejednoznačné a nejsou k dispozici žádné další informace pro jejich pořadí (například umístění uživatele nebo relativní důležitost umístění), je spolehlivost nastavena na Medium. Například dotaz na polohu pro "148th Ave, Bellevue" může s jistotou vrátit "148th Ave SE" a "148th Ave NE".Medium

Pokud informace o poloze v dotazu neposkytují dostatek informací pro geografické kódování konkrétního umístění, může být vrácena méně přesná hodnota umístění a spolehlivost je nastavena na Medium. Pokud je například zadána adresa, ale pro číslo domu není nalezena shoda, může být vrácen výsledek geokódu s typem entity Roadblock.

Low

CountryRegion

Objekt

Name	Typ	Description
ISO	string	ISO země/oblasti
name	string	název země/oblasti

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

FeatureCollectionEnum

Výčet

Typ FeatureCollection objektu musí být FeatureCollection.

Hodnota	Description
FeatureCollection

FeaturesItem

Objekt

Name	Typ	Description
bbox	number[] (double)	Ohraničující rámeček. Použitá projekce - EPSG:3857. Podrobnosti najdete v RFC 7946.
geometry	GeoJsonPoint	Platný typ geometrie `GeoJSON Point`. Podrobnosti najdete v RFC 7946.
id	string	ID pro vrácenou funkci
properties	Properties
type	FeatureTypeEnum	Typ funkce musí být Funkce.

FeatureTypeEnum

Výčet

Typ funkce musí být Funkce.

Hodnota	Description
Feature

GeocodePoints

Objekt

Kolekce bodů geografického kódu, které se liší ve způsobu výpočtu a jejich navrhovaném použití.

Name	Typ	Description
calculationMethod	CalculationMethodEnum	Metoda, která se použila k výpočtu bodu geografického kódu.
geometry	GeoJsonPoint	Platný typ geometrie `GeoJSON Point`. Podrobnosti najdete v RFC 7946.
usageTypes	UsageTypeEnum[]	Nejlepší použití pro bod geografického kódu. Každý bod geografického kódu je definován jako bod `Route`, `Display` bod nebo obojí. Pokud vytváříte trasu do umístění, použijte `Route` body. Pokud zobrazujete umístění na mapě, použijte `Display` body. Například pokud je umístění parkem, může `Route` bod určit vstup do parku, kde můžete vstoupit s autem, a `Display` bod může být bod, který určuje střed parku.

GeocodingResponse

Objekt

Tento objekt se vrátí z úspěšného volání geokódování.

Name	Typ	Description
features	FeaturesItem[]
nextLink	string	Je odkaz na další stránku vrácených funkcí. Pokud se jedná o poslední stránku, žádné toto pole.
type	FeatureCollectionEnum	Typ FeatureCollection objektu musí být FeatureCollection.

GeoJsonPoint

Objekt

Platný typ geometrie GeoJSON Point. Podrobnosti najdete v RFC 7946.

Name	Typ	Description
bbox	number[] (double)	Ohraničující rámeček. Použitá projekce - EPSG:3857. Podrobnosti najdete v RFC 7946.
coordinates	number[] (double)	`Position` je matice čísel se dvěma nebo více prvky. První dva prvky jsou zeměpisné délky a zeměpisnou šířkupřesně v daném pořadí. nadmořské výšky nebo zvýšení výšky je volitelný třetí prvek. Podrobnosti najdete v RFC 7946.
type	string: Point	Určuje typ `GeoJSON`. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

Intersection

Objekt

Adresa výsledku.

Name	Typ	Description
baseStreet	string	Primární ulice pro umístění.
displayName	string	Úplný název průsečíku
intersectionType	string	Typ průsečíku
secondaryStreet1	string	První protínající ulici.
secondaryStreet2	string	Pokud existuje, druhá protíná ulici.

MatchCodesEnum

Výčet

Jedna nebo více hodnot kódu, které představují úroveň geokódování pro každé umístění v odpovědi.

Například geograficky zakódované umístění s kódy shody Good a Ambiguous znamená, že pro informace o poloze bylo nalezeno více než jedno umístění geografického kódu a že služba geografického kódu nenalezla shodu v hierarchii.

Podobně geokódované umístění s kódy shody Ambiguous a UpHierarchy znamená, že umístění geografického kódu nebylo nalezeno tak, aby odpovídalo všem zadaným informacím o poloze, takže služba geografického kódu musela prohledávat hierarchii a najít více shod na této úrovni. Příkladem Ambiguous a výsledku UpHierarchy je zadání úplných informací o adrese, ale služba geografického kódu nemůže najít shodu adresy a místo toho vrátí informace pro více než jednu hodnotu RoadBlock.

Možné hodnoty:

Good: Umístění má pouze jednu shodu nebo všechny vrácené shody jsou považovány za silné shody. Například dotaz na New York vrátí několik dobrých shod.

Ambiguous: Umístění je jednou ze sady možných shod. Když například zadáte dotaz na adresu ulice 128 Main St., odpověď může vrátit dvě místa pro 128 severního hlavního a 128 jižního hlavního st. , protože neexistuje dostatek informací pro určení, kterou možnost zvolit.

UpHierarchy: Umístění představuje přesun v geografické hierarchii. K tomu dochází v případě, že nebyla nalezena shoda požadavku na umístění, takže se vrátí méně přesný výsledek. Pokud například nelze najít shodu požadované adresy, může se vrátit kód shody UpHierarchy s typem entity RoadBlock.

Hodnota	Description
Good
Ambiguous
UpHierarchy

Properties

Objekt

Name	Typ	Description
address	Address	Adresa výsledku
confidence	ConfidenceEnum	Úroveň spolehlivosti, že výsledek geokódovaného umístění odpovídá. Tuto hodnotu použijte s kódem shody k určení podrobnějších informací o shodě. Spolehlivost geokódovaného umístění je založená na mnoha faktorech, včetně relativní důležitosti geokódovaného umístění a umístění uživatele, pokud je zadáno.
geocodePoints	GeocodePoints[]	Kolekce bodů geografického kódu, které se liší ve způsobu výpočtu a jejich navrhovaném použití.
matchCodes	MatchCodesEnum[]	Jedna nebo více hodnot kódu, které představují úroveň geokódování pro každé umístění v odpovědi. Například geograficky zakódované umístění s kódy shody `Good` a `Ambiguous` znamená, že pro informace o poloze bylo nalezeno více než jedno umístění geografického kódu a že služba geografického kódu nenalezla shodu v hierarchii. Podobně geokódované umístění s kódy shody `Ambiguous` a `UpHierarchy` znamená, že umístění geografického kódu nebylo nalezeno tak, aby odpovídalo všem zadaným informacím o poloze, takže služba geografického kódu musela prohledávat hierarchii a najít více shod na této úrovni. Příkladem `Ambiguous` a výsledku `UpHierarchy` je zadání úplných informací o adrese, ale služba geografického kódu nemůže najít shodu adresy a místo toho vrátí informace pro více než jednu hodnotu RoadBlock. Možné hodnoty: `Good`: Umístění má pouze jednu shodu nebo všechny vrácené shody jsou považovány za silné shody. Například dotaz na New York vrátí několik dobrých shod. `Ambiguous`: Umístění je jednou ze sady možných shod. Když například zadáte dotaz na adresu ulice 128 Main St., odpověď může vrátit dvě místa pro 128 severního hlavního a 128 jižního hlavního st. , protože neexistuje dostatek informací pro určení, kterou možnost zvolit. `UpHierarchy`: Umístění představuje přesun v geografické hierarchii. K tomu dochází v případě, že nebyla nalezena shoda požadavku na umístění, takže se vrátí méně přesný výsledek. Pokud například nelze najít shodu požadované adresy, může se vrátit kód shody `UpHierarchy` s typem entity RoadBlock.
type	string	Jedna z těchto možností: Adresa Zátaras RoadIntersection Sousedství PopulatedPlace Psč1 AdminDivision1 AdminDivision2 Stát/Kraj

UsageTypeEnum

Výčet

Nejlepší použití pro bod geografického kódu. Každý bod geografického kódu je definován jako bod Route, Display bod nebo obojí. Pokud vytváříte trasu do umístění, použijte Route body. Pokud zobrazujete umístění na mapě, použijte Display body. Například pokud je umístění parkem, může Route bod určit vstup do parku, kde můžete vstoupit s autem, a Display bod může být bod, který určuje střed parku.

Hodnota	Description
Display
Route

Sdílet prostřednictvím

Search - Get Geocoding

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

AADToken

Rozsahy

subscription-key

SAS Token

Příklady

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

Ukázkový požadavek

Ukázková odpověď

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

Ukázkový požadavek

Ukázková odpověď

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

Ukázkový požadavek

Ukázková odpověď

Search landmark Empire State Building by query

Ukázkový požadavek

Ukázková odpověď

Definice

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingResponse

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

UsageTypeEnum