Search - Get Geocoding

Služba:: Maps

Verze rozhraní API:: 2026-01-01

Slouží k získání souřadnic zeměpisné délky a šířky ulice nebo názvu místa.
API Get Geocoding je požadavek HTTP GET , který vrací souřadnice zeměpisné délky a šířky prohledávaného místa.

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 se na koncový bod geokódování dostane pouze příslušná adresa nebo částečná adresa. 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. Poradí si také se vším od přesných adres ulic nebo ulic nebo křižovatek, stejně jako geografických oblastí vyšší úrovně, jako jsou centra měst, okresy a státy. Odpověď také vrátí podrobné vlastnosti adresy, jako jsou informace o ulici, PSČ, obci a zemi/oblasti.

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

S volitelnými parametry:

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

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Hostname služby Azure Maps. Použijte `https://atlas.microsoft.com` pro Azure veřejný cloud. Pro cílení na konkrétní Azure Maps geografii nebo suverénní cloud viz Azure Maps geografický rozsah.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
addressLine	query		string	Oficiální uliční čára adresy vztahující se k oblasti, jak je určeno lokalitou nebo poštovním kódem. Typickým použitím tohoto prvku by bylo poskytnutí 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 týkající se pododdílu země, například WA. 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íku jsou definovány hodnotami zeměpisné délky a šířky. Když zadáte tento parametr, při výpočtu výsledků dotazu na umístění se bere v úvahu zeměpisná oblast. Příklad: lon1,lat1,lon2,lat2. Minimální velikost: přibližně 0,00001 stupně (~0,01 metru). Maximální velikost: až do plného globálního rozsahu (-180,-90 až 180,90)
coordinates	query		number[]	Bod na Zemi určený jako zeměpisná délka a šířka. Když tento parametr zadáte, zohlední se poloha uživatele a výsledky mohou být pro uživatele relevantnější. Příklad: &souřadnic=lon,lat
countryRegion	query		string	Signál pro výsledek geokódování na kód oblasti/země ISO 3166-1 Alpha-2 , který je specifikován, např. FR. Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
locality	query		string	Část adresy označovaná lokalitou, například Seattle. Tento parametr by se neměl používat, pokud `query` je parametr zahrnut v požadavku.
postalCode	query		string	Část adresy týkající se poštovního směrovacího čísla. 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í, jako je adresa nebo název orientačního bodu.
top	query		integer (int32) minimum: 1 maximum: 20	Maximální počet odpovědí, které budou vráceny. Výchozí: 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	Specifikuje, který účet je určen pro použití ve spojení s bezpečnostním modelem Azure AD. Představuje jedinečné ID pro účet Azure Maps a lze jej získat z API účtu na Azure Maps management plane. Pro více informací o používání Microsoft Entra ID bezpečnosti v Azure Maps viz Spravovat autentizaci 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

Specifikuje, který účet je určen pro použití ve spojení s bezpečnostním modelem Azure AD. Představuje jedinečné ID pro účet Azure Maps a lze jej získat z API účtu na Azure Maps management plane. Pro více informací o používání Microsoft Entra ID bezpečnosti v Azure Maps viz Spravovat autentizaci v Azure Maps.

Odpovědi

Name	Typ	Description
200 OK	GeocodingResponse	Požadavek byl úspěšný. Media Types: "application/geo+json", "application/json"
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Media Types: "application/geo+json", "application/json" Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

GeocodingResponse

Požadavek byl úspěšný.

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

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

Hlavičky

x-ms-error-code: string

Zabezpečení

AadToken

Jsou to Microsoft Entra OAuth 2.0 Flows. V kombinaci s Azure řízením přístupu založeného na rolích lze použít k řízení přístupu k Azure Maps REST API. Role Azure kontroly přístupu se používají k určení přístupu k jednomu nebo více účtům nebo podzdrojů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.

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

Note

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 žádá o 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í unikátní autorizační URL 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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

Díky tomuto klíči má každá aplikace přístup ke všem rozhraní REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat důvěrných klientských aplikací přístup k rozhraním REST API služby Azure Maps, aby bylo možné 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=2026-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=2026-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=2026-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=2026-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 geokódované nebo automaticky doplňované navrhované lokality, rozdělená do strukturovaných polí. Řídkost je normální: jsou vyplněna pouze pole, která dodává vyřešená entita. Například `streetName` a se objevují `streetNumber` pouze u adres na úrovni ulice a `intersection` pouze u výsledků křižovatek silnic.
AddressAdminDistrictsItem	Administrativní jednotka, která obsahuje adresu. Například stát, provincie nebo okres. Vráceno jako jeden prvek v mateřském `Address.adminDistricts` poli, kde jsou položky seřazeny od nejhrubšího po nejjemnější.
AddressCountryRegion	Země nebo region, který adresu obsahuje, identifikovaný podle zobrazovaného názvu a kódu země ISO 3166-1 Alpha-2. Obě pole mohou být v odpovědi vynechána.
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
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á. Použijte tuto hodnotu spolu s kódy pro zápas, abyste získali úplnější informace o zápase. Jistota geokódované polohy závisí na mnoha faktorech, včetně relativního významu geokódované polohy a polohy uživatele, pokud je uvedena.
FeatureCollectionEnum	Typ objektu použitý `GeoJSON` jako základ úspěšných odpovědí z operací forward geocoding, reverse geocoding a autocomplete (včetně jejich dávkových variant). Jedinou hodnotou `FeatureCollection`je , jak je definováno v RFC 7946. `Get Polygon` je jedinou výjimkou: její odvětvený kořen je , `GeoJSON Feature`viz `FeatureTypeEnum`.
FeaturesItem	Jeden prvek v `features` poli , `GeocodingResponse`odpovídající tvaru objektu `GeoJSON Feature` . Představuje jedno geokódované místo: strukturovaná data na `properties`, reprezentativní souřadnice na `geometry`, a volitelný ohraničující rámeček na .`bbox`
FeaturesItemProperties	Užitečné `properties` zatížení funkce v .`GeocodingResponse` Nese indikátory typu entity a kvality shody pro geokódovanou polohu, její analyzované adresní komponenty a jeden nebo více geokódových bodů, které připojují polohu ke specifickým souřadnicím.
FeatureTypeEnum	Typ `GeoJSON` objektu pro `Feature` objekty. Označuje každý záznam uvnitř `features` pole `FeatureCollection` odpovědi (geokodování, reverzní geokódování, automatické doplňování) a objevuje se v kořeni `Get Polygon` odpovědi. Jedinou hodnotou `Feature`je , jak je definováno v RFC 7946.
GeocodePointsItem	Jeden geokódový bod pro lokaci: souřadnice plus metadata popisující, jak byl bod vypočítán (`calculationMethod`) a pro co je nejlépe přizpůsoben (`usageTypes`). Jediná funkce obvykle vrací oddělené `Display` a `Route` bodové, takže volající si mohou vybrat tu, která odpovídá úkolu.
GeocodingResponse	Těleso úspěšné odpovědi vráceno jako `Get Geocoding` a `Get Reverse Geocoding`, a tvar úspěchu na jednotlivé položky nesený uvnitř `GeocodingBatchResponse.batchItems`. Kódováno jako pole `GeoJSON FeatureCollection` obsahující `features` jeden na `Feature` každé geokódované místo.
GeoJsonObjectType	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.
GeoJsonPoint	Platný typ geometrie `GeoJSON Point`. Podrobnosti najdete v RFC 7946.
Intersection	Detaily křižovatky pro adresu vyřešenou jako křižovatka — roh, kde se setkávají dvě nebo více pojmenovaných ulic. Vyplňuje se pouze tehdy, když je vyřešená entita ; `RoadIntersection`rodič `Address.intersection` je jinak vynechán.
MatchCodesEnum	Hodnota kódu shody označující, jak geokódovací služba vytvořila konkrétní výsledek lokality. Pole `matchCodes` na prvku je pole těchto hodnot; kombinujte je s `confidence` a `type` pro vyhodnocení kvality shody.
UsageTypeEnum	Zamýšlené využití geokódového bodu. Geokódový bod vrácený službou nese jeden nebo více typů využití, které určují, jak by klientská aplikace měla bod spotřebovat: například zobrazení polohy na mapě oproti směrování vozidla k němu.

Address

Objekt

Adresa geokódované nebo automaticky doplňované navrhované lokality, rozdělená do strukturovaných polí. Řídkost je normální: jsou vyplněna pouze pole, která dodává vyřešená entita. Například streetName a se objevují streetNumber pouze u adres na úrovni ulice a intersection pouze u výsledků křižovatek silnic.

Name	Typ	Description
addressLine	string	První řádek adresy, obvykle název ulice a číslo. Například: `"15127 NE 24th St"`.
adminDistricts	AddressAdminDistrictsItem[]	Administrativní členění, která adresu obsahují, jsou seřazena od nejhrubšího po nejjemnější. První záznam je obvykle první řád pododdělení (například americký stát nebo kanadská provincie); Následující hesla pokrývají jemnější dělení, kde je definuje země, závislost nebo region (například okres s indexem 1).
countryRegion	AddressCountryRegion	Země nebo region, který adresu obsahuje, s jejím zobrazovaným názvem a kódem země ISO 3166-1 Alpha-2.
formattedAddress	string	Celá adresa byla vykreslena jako jeden lidsky čitelný řetězec, jehož komponenty byly spojeny podle konvencí země nebo regionu adresy. Příklad: `"15127 NE 24th St, Redmond, WA 98052"`.
intersection	Intersection	Údaje o křížící se ulici pro adresu, které se vyplňují, když je vyřešená entita ( `RoadIntersection` například roh dvou pojmenovaných ulic).
locality	string	Lokalita, do které adresa spadá: obvykle město, obec nebo vesnice. Například: `"Redmond"`.
neighborhood	string	Pojmenovaná čtvrť v rámci lokality, když je identifikována.
postalCode	string	Poštovní směrovací číslo adresy, kdy je určena. Příklad: `"98052"`.
streetName	string	Složka názvu ulice v adrese, když je vyřešený subjekt adresa na úrovni ulice. Příklad: `"NE 24th St"`.
streetNumber	string	Číslo domu nebo budovy na ulici, pokud je vyřešená entita adresa na úrovni ulice. Příklad: `"15127"`.

AddressAdminDistrictsItem

Objekt

Administrativní jednotka, která obsahuje adresu. Například stát, provincie nebo okres. Vráceno jako jeden prvek v mateřském Address.adminDistricts poli, kde jsou položky seřazeny od nejhrubšího po nejjemnější.

Name	Typ	Description
name	string	Plný název této čtvrti. Například `"Washington"` pro americký stát nebo `"King County"` okres.
shortName	string	Zkrácená nebo zkrácená forma názvu poddělení, když je definováno. Například `"WA"` pro americký stát. Jemnější dělení často nemají výraznou krátkou formu, v takovém případě `shortName` se opakuje `name` (například `"King County"`).

AddressCountryRegion

Objekt

Země nebo region, který adresu obsahuje, identifikovaný podle zobrazovaného názvu a kódu země ISO 3166-1 Alpha-2. Obě pole mohou být v odpovědi vynechána.

Name	Typ	Description
ISO	string	Kód země ISO 3166-1 Alpha-2 pro danou zemi nebo region. Například `"US"` pro USA nebo `"GB"` pro Spojené království.
name	string	Zobrazovaný název země nebo regionu. Například: `"USA"`.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

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á. Použijte tuto hodnotu spolu s kódy pro zápas, abyste získali úplnější informace o zápase.

Jistota geokódované polohy závisí na mnoha faktorech, včetně relativního významu geokódované polohy a polohy uživatele, pokud je uvedena.

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 místo nebo pohled, může se pořadí podle toho změnit. Například dotaz na polohu "Paris" vrátí s jistotou jak "Paris, France", tak "Paris, TX".`High` "Paříž, Francie" je vždy řazena na prvním místě podle důležitosti, pokud uživatelská poloha neukazuje, že se nachází v nebo velmi blízko Paříže, TX, nebo pokud zobrazení mapy neukazuje, že uživatel hledá v dané 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 důvěra nastavena na a `Medium` kód shody je nastaven tak, aby `UpHierarchy` označil, že služba nemohla spárovat všechny informace a musela hledat v hierarchii výš. 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 "148th Ave, Bellevue" může s jistotou vrátit jak "148th Ave SE", tak "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`. Například pokud je uvedena adresa, ale není nalezena shoda s číslem domu, může být vrácen výsledek geokódu s typem `RoadBlock` entity.
Low	Nízká důvěra v zápas.

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 místo nebo pohled, může se pořadí podle toho změnit. Například dotaz na polohu "Paris" vrátí s jistotou jak "Paris, France", tak "Paris, TX".High "Paříž, Francie" je vždy řazena na prvním místě podle důležitosti, pokud uživatelská poloha neukazuje, že se nachází v nebo velmi blízko Paříže, TX, nebo pokud zobrazení mapy neukazuje, že uživatel hledá v dané 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 důvěra nastavena na a Medium kód shody je nastaven tak, aby UpHierarchy označil, že služba nemohla spárovat všechny informace a musela hledat v hierarchii výš.

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 "148th Ave, Bellevue" může s jistotou vrátit jak "148th Ave SE", tak "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. Například pokud je uvedena adresa, ale není nalezena shoda s číslem domu, může být vrácen výsledek geokódu s typem RoadBlock entity.

Low

Nízká důvěra v zápas.

FeatureCollectionEnum

Výčet

Typ objektu použitý GeoJSON jako základ úspěšných odpovědí z operací forward geocoding, reverse geocoding a autocomplete (včetně jejich dávkových variant). Jedinou hodnotou FeatureCollectionje , jak je definováno v RFC 7946. Get Polygon je jedinou výjimkou: její odvětvený kořen je , GeoJSON Featureviz FeatureTypeEnum.

Hodnota	Description
FeatureCollection	Typ objektu `GeoJSON FeatureCollection` . Objevuje se jako kořen každého úspěšného geokódování, reverzního geokódování a autocomplete reakčního tělesa. `Get Polygon`používá místo toho kořen.`Feature`

FeaturesItem

Objekt

Jeden prvek v features poli , GeocodingResponseodpovídající tvaru objektu GeoJSON Feature . Představuje jedno geokódované místo: strukturovaná data na properties, reprezentativní souřadnice na geometry, a volitelný ohraničující rámeček na .bbox

Name	Typ	Description
bbox	number[] (double)	Nejmenší osově zarovnaný obdélník, který obsahuje geometrii objektu, v pořadí zeměpisné délky a šířky WGS 84. Kódováno podle `[westLon, southLat, eastLon, northLat]`RFC 7946, sekce 5.
geometry	GeoJsonPoint	Primární `GeoJSON Point` číslo představuje geokódovanou polohu, s koordinacemi v pořadí zeměpisné délky a šířky WGS 84.
id	string	Volitelný identifikátor přiřazený službě pro tuto funkci, pokud je k dispozici.
properties	FeaturesItemProperties	Strukturovaná data o geokódované lokalitě, včetně typu entity, indikátorů kvality shody, adresních komponent a jednoho nebo více geokódových bodů.
type	FeatureTypeEnum	Typ objektu `GeoJSON` . Vždy `Feature`, jak je definováno v RFC 7946.

FeaturesItemProperties

Objekt

Užitečné properties zatížení funkce v .GeocodingResponse Nese indikátory typu entity a kvality shody pro geokódovanou polohu, její analyzované adresní komponenty a jeden nebo více geokódových bodů, které připojují polohu ke specifickým souřadnicím.

Name	Typ	Description
address	Address	Adresa geokódované polohy, rozdělená do strukturovaných polí, jako je lokalita, PSČ, země/region a (pokud je k dispozici) název a číslo ulice.
confidence	ConfidenceEnum	Jak silně geokódovaná poloha odpovídá požadavku. Použijte spolu s tím `matchCodes` pro kompletní přehled o kvalitě zápasu. Podívejte se `ConfidenceEnum` na seznam hodnot a faktory, které ovlivňují hodnocení.
geocodePoints	GeocodePointsItem[]	Jeden nebo více geokódových bodů pro dané místo, každý označený způsobem, jakým byl odvozen (`calculationMethod`) a pro co je nejlépe vhodný (`usageTypes`). Například `Display` pro vizuální umístění na mapě nebo `Route` pro použití jako navigační cíl.
matchCodes	MatchCodesEnum[]	Jak geokódovací služba vytvořila tento výsledek vzhledem k dotazu: přímé shody na požadované specificitě (`Good`), jednoho z několika kandidátů (`Ambiguous`), nebo záložní varianta na méně přesnou úroveň geografické hierarchie (`UpHierarchy`). Může být přítomno více hodnot. Například plus párování znamená, `AmbiguousUpHierarchy` že služba nemohla odpovídat požadované specificitě a našla více shod na hrubší úrovni. Viz `MatchCodesEnum` popisy pro jednotlivé hodnoty; kombinujte s pro `confidence` kompletní přehled kvality shody.
type	string	Typ entity, na který se geokódovaná lokalita vyřešila. Jeden z: , , , , , `PopulatedPlace`, `Postcode1`, , `AdminDivision1`, `AdminDivision2`nebo `CountryRegion`. `NeighborhoodRoadIntersectionRoadBlockAddress`

FeatureTypeEnum

Výčet

Typ GeoJSON objektu pro Feature objekty. Označuje každý záznam uvnitř features pole FeatureCollection odpovědi (geokodování, reverzní geokódování, automatické doplňování) a objevuje se v kořeni Get Polygon odpovědi. Jedinou hodnotou Featureje , jak je definováno v RFC 7946.

Hodnota	Description
Feature	Typ objektu `GeoJSON Feature` . Objevuje se na každé vlastnosti uvnitř `FeatureCollection` odpovědi a na jejím základu `Get Polygon` .

GeocodePointsItem

Objekt

Jeden geokódový bod pro lokaci: souřadnice plus metadata popisující, jak byl bod vypočítán (calculationMethod) a pro co je nejlépe přizpůsoben (usageTypes). Jediná funkce obvykle vrací oddělené Display a Route bodové, takže volající si mohou vybrat tu, která odpovídá úkolu.

Name	Typ	Description
calculationMethod	CalculationMethodEnum	Jak se bod počítal. Například připnuté na střechu budovy nebo interpolované podél středové čáry silnice. Podívejte se `CalculationMethodEnum` na seznam hodnot.
geometry	GeoJsonPoint	Souřadnice tohoto geokódu je , `GeoJSON Point`s hodnotami v pořadí zeměpisné délky a šířky WGS 84.
usageTypes	UsageTypeEnum[]	K čemu je geokódový bod nejlépe vhodný — `Display` pro vizuální umístění na mapě nebo `Route` jako cíl trasy. Bod může nést obojí. Podívejte se `UsageTypeEnum` na detaily pro jednotlivé hodnoty, včetně toho, jak je každý z nich umístěn pro prvky s netriviálním rozsahem.

GeocodingResponse

Objekt

Těleso úspěšné odpovědi vráceno jako Get Geocoding a Get Reverse Geocoding, a tvar úspěchu na jednotlivé položky nesený uvnitř GeocodingBatchResponse.batchItems. Kódováno jako pole GeoJSON FeatureCollection obsahující features jeden na Feature každé geokódované místo.

Name	Typ	Description
features	FeaturesItem[]	Pole objektů `GeoJSON Feature` vrácených dotazem. Každá `Feature` reprezentuje jedno geokódované místo: jeho adresní složky, indikátory kvality shody a geokódové body jsou vystaveny přes `properties`, a jeho primární souřadnice přes `geometry`.
nextLink	string	Obsahuje URL pro načtení další stránky výsledků, pokud je odpověď stránkována. To je užitečné, když je odpověď příliš velká na to, aby byla vrácena jedním hovorem, což umožňuje uživatelům procházet více stránek výsledků.
type	FeatureCollectionEnum	Typ `GeoJSON` objektu úspěšného nebo `Get Reverse Geocoding` reakčního `Get Geocoding` tělesa. Vždy `FeatureCollection`, jak je definováno v RFC 7946.

GeoJsonObjectType

Výčet

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.

Hodnota	Description
Point	`GeoJSON Point` geometrie.
MultiPoint	`GeoJSON MultiPoint` geometrie.
LineString	`GeoJSON LineString` geometrie.
MultiLineString	`GeoJSON MultiLineString` geometrie.
Polygon	`GeoJSON Polygon` geometrie.
MultiPolygon	`GeoJSON MultiPolygon` geometrie.
GeometryCollection	`GeoJSON GeometryCollection` geometrie.
Feature	`GeoJSON Feature` objekt.
FeatureCollection	`GeoJSON FeatureCollection` objekt.

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

Detaily křižovatky pro adresu vyřešenou jako křižovatka — roh, kde se setkávají dvě nebo více pojmenovaných ulic. Vyplňuje se pouze tehdy, když je vyřešená entita ; RoadIntersectionrodič Address.intersection je jinak vynechán.

Name	Typ	Description
baseStreet	string	Hlavní ulice křižovatky — obvykle ta, na kterou odkazuje adresní číslo.
displayName	string	Lidsky čitelné jméno pro křižovatku, která kombinuje příčné ulice, například `"5th Avenue & Main Street"`.
intersectionType	string	Krátký popis popisující tvar průsečíku. Například rozlišení křižovatky v úrovni terénu od mimoúrovňového přechodu, jako je most nebo nadjezd.
secondaryStreet1	string	První příčná ulice, která se setkává `baseStreet` na křižovatce.
secondaryStreet2	string	Druhá příčná ulice na křižovatce, pokud je přítomen člověk. Osídleno pouze na křižovatkách tří nebo více ulic.

MatchCodesEnum

Výčet

Hodnota kódu shody označující, jak geokódovací služba vytvořila konkrétní výsledek lokality. Pole matchCodes na prvku je pole těchto hodnot; kombinujte je s confidence a type pro vyhodnocení kvality shody.

Hodnota	Description
Good	Geokódovací služba vyprodukovala tohoto kandidáta bez rozšíření dotazu: výsledek odpovídá dotazu na požadované specifikosti.
Ambiguous	Místo je jedním z několika možných shod. Například při dotazu na adresu "128 Main St." může odpověď vrátit dvě místa pro "128 North Main St." a "128 South Main St.", protože není dostatek informací k určení, kterou možnost zvolit.
UpHierarchy	Tato lokalita představuje postup 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.

UsageTypeEnum

Výčet

Zamýšlené využití geokódového bodu. Geokódový bod vrácený službou nese jeden nebo více typů využití, které určují, jak by klientská aplikace měla bod spotřebovat: například zobrazení polohy na mapě oproti směrování vozidla k němu.

Hodnota	Description
Display	Geokódový bod je vhodný pro zobrazení polohy na mapě. U objektu s netriviálním rozsahem (například park nebo budova) je `Display` bod obvykle blízko vizuálního středu objektu.
Route	Geokódový bod je vhodný jako cíl trasy. U objektu s netriviálním rozsahem (například park nebo budova) je `Route` bod obvykle umístěn u vstupu přístupného vozidlem, nikoli ve vizuálním centru.