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
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ž zadáte tento parametr, vezme se v úvahu umístění uživatele a vrácené 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 principálu služby může být udělen přístup prostřednictvím vestavěné role nebo vlastní role složené z jednoho či více oprávnění k Azure Maps REST API.\n\nPro implementaci scénářů doporučujeme zobrazit koncepty autentizace. Shrnuto, tato definice bezpečnosti poskytuje řešení pro modelování aplikací pomocí objektů schopných kontroly přístupu ke specifickým API a rozsahům.\n\n#### Poznámky\n* Tato bezpečnostní definice vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému Azure Maps zdroji aplikace žádá přístup. Tuto možnost lze získat z API pro správu Maps.\n* \nAuthorization URL je specifický pro instanci Azure veřejného cloudu. Suverénní cloudy mají unikátní autorizační URL a konfigurace Microsoft Entra ID. \n* \nŘízení přístupu založené na rolích Azure je konfigurováno z Azure management plane prostřednictvím Azure portálu, PowerShellu, CLI, Sady Azure SDK nebo REST API.\n* \nVyužití Azure Maps Web SDK umožňuje konfigurační nastavení aplikace pro více případů použití.\n* Pro více informací o Microsoft identity platform viz přehled Microsoft identity platform přehled.

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 zpřístupní, když Vytvoříte Azure Maps účet v Azure portálu nebo pomocí PowerShell, CLI, Sady Azure SDK či REST API.\n\n S tímto klíčem může jakákoli aplikace přistupovat ke všem REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, na který jsou vydávány.\n\n Pro veřejně přístupné aplikace doporučujeme použít přístup confidential client applications k přístupu Azure Maps REST API, aby mohl být klíč bezpečně uložen.

Typ: apiKey
V: header

SAS Token

Tento token sdíleného přístupového podpisu je vytvořen operací List SAS na Azure Maps resource přes Azure management plane přes Azure portál, PowerShell, CLI, Sady Azure SDK nebo REST API.\n\n S tímto tokenem je jakákoli aplikace oprávněna přistupovat pomocí Azure Kontroly přístupu založené na rolích a jemná opatření k expiraci, rychlosti a regionům využití konkrétního tokenu. Jinými slovy, SAS Token lze použít k tomu, aby aplikace mohly bezpečněji kontrolovat přístup než sdílený klíč.\n\n Pro veřejně vystavené aplikace doporučujeme nastavit konkrétní seznam povolených původů na zdroji účtu Map, aby se omezilo zneužívání vykreslování a pravidelně obnovovat SAS Token.

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 {endpoint}/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 {endpoint}/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 {endpoint}/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 {endpoint}/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 výsledku
AddressAdminDistrictsItem	Název dílčího dělení v zemi nebo oblasti adresy.
AddressCountryRegion	Země nebo oblast s uvedením jejího názvu a kódu ISO.
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á. 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.
FeatureCollectionEnum	Určuje typ `GeoJSON`. Jediný podporovaný typ objektu je `FeatureCollection`. Další informace naleznete v tématu RFC 7946.
FeaturesItem	Objekt funkce.
FeaturesItemProperties	Vlastnosti tohoto prvku.
FeatureTypeEnum	Typ funkce musí být Funkce.
GeocodePointsItem	Geokódový bod.
GeocodingResponse	Tento objekt se vrátí z úspěšného volání geokódování.
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	Adresa výsledku.
MatchCodesEnum	Enum představující kód zápasu.
UsageTypeEnum	Enum představující typ použití.

Address

Objekt

Adresa výsledku

Name	Typ	Description
addressLine	string	AddressLine , který obsahuje název ulice a číslo popisné
adminDistricts	AddressAdminDistrictsItem[]	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	AddressCountryRegion	Země nebo oblast s uvedením jejího názvu a kódu ISO.
formattedAddress	string	Vlastnost formátované adresy
intersection	Intersection	Adresa výsledku.
locality	string	Nemovitost lokality
neighborhood	string	Nemovitosti v okolí
postalCode	string	Vlastnost PSČ
streetName	string	Název ulice z formattedAddress
streetNumber	string	Číslo na ulici, pokud je k dispozici, z formattedAddress

AddressAdminDistrictsItem

Objekt

Název dílčího dělení v zemi nebo oblasti adresy.

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.

AddressCountryRegion

Objekt

Země nebo oblast s uvedením jejího názvu a kódu ISO.

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

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á. 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	Nízká úroveň

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

Nízká úroveň

FeatureCollectionEnum

Výčet

Určuje typ GeoJSON. Jediný podporovaný typ objektu je FeatureCollection. Další informace naleznete v tématu RFC 7946.

Hodnota	Description
FeatureCollection	Určuje typ objektu `GeoJSONFeatureCollection`.

FeaturesItem

Objekt

Objekt funkce.

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	FeaturesItemProperties	Vlastnosti tohoto prvku.
type	FeatureTypeEnum	Typ funkce musí být Funkce.

FeaturesItemProperties

Objekt

Vlastnosti tohoto prvku.

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	GeocodePointsItem[]	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: * Adresa * Silniční zátaras * Křižovatka silnic * Čtvrť * Osídlené místo * PSČ1 * Administrativní divize1 * Administrativní divize2 * ZeměRegion

FeatureTypeEnum

Výčet

Typ funkce musí být Funkce.

Hodnota	Description
Feature	Určuje typ objektu `GeoJSON` Feature.

GeocodePointsItem

Objekt

Geokódový bod.

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[]	Z dotazu se vrátila řada funkcí.
nextLink	string	Je odkaz na další stránku vrácených funkcí. Pokud se jedná o poslední stránku, žádné toto pole.
type	FeatureCollectionEnum	Určuje typ `GeoJSON`. Jediný podporovaný typ objektu je `FeatureCollection`. Další informace naleznete v tématu 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

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

Enum představující kód zápasu.

Hodnota	Description
Good	Dobré
Ambiguous	Mnohoznačný
UpHierarchy	UpHierarchy

UsageTypeEnum

Výčet

Enum představující typ použití.

Hodnota	Description
Display	Display
Route	Cesta