Sdílet prostřednictvím

Search - Get Geocoding

  • Reference
Služba:
Maps
Verze rozhraní API:
2023-06-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 hledaného umístění.

V mnoha případech může být kompletní vyhledávací služba příliš mnoho, například pokud vás zajímá pouze tradiční geokódování. Vyhledávání je také přístupné pro výhradní vyhledávání adres. Geokódování se provádí tak, že do koncového bodu geokódování zasáhnete jenom příslušnou adresu nebo částečnou adresu. Index vyhledávání geokódování se bude dotazovat na vše nad daty na úrovni ulice. Nebudou vráceny žádné body zájmu (BŽ). Všimněte si, že geokódér je velmi tolerantní k překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo křižovatek, stejně jako vyšší úrovně geografických míst, jako jsou centra měst, okresy a státy. Odpověď také vrátí podrobné vlastnosti adresy, jako jsou například informace o ulici, PSČ, obci a zemi/oblasti.

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01
S volitelnými parametry: 
GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Parametry 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 specifikováno vlastností lokality nebo PSČ. Typickým použitím tohoto prvku je zadání adresy nebo jakékoli oficiální adresy.

Pokud je dotaz zadaný, neměl by tento parametr používat.
adminDistrict
 query

string

Část adresy subdivision country, například WA.

Pokud je dotaz zadaný, neměl by tento parametr používat.
adminDistrict2
 query

string

Hrabství pro strukturovanou adresu, například King.

Pokud je dotaz zadaný, neměl by tento parametr používat.
adminDistrict3
 query

string

Pojmenovaná oblast strukturované adresy

Pokud je dotaz zadaný, neměl by tento parametr používat.
bbox
 query

number[]

Obdélníková oblast na zemi definovaná jako objekt ohraničujícího rámečku. Strany obdélníků jsou definovány hodnotami zeměpisné délky a zeměpisné šířky. Při zadání tohoto parametru se při výpočtu výsledků dotazu na umístění bere v úvahu geografická 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 bere v úvahu umístění uživatele a vrácené výsledky můžou být pro uživatele relevantnější. Příklad: &souřadnice=lon,lat
countryRegion
 query

string

Signál pro výsledek geokódování pro iso 3166-1 Alfa-2 kód oblasti/země , který je zadán, např. FR./

Pokud je dotaz zadaný, neměl by tento parametr používat.
locality
 query

string

Místní část adresy, například Seattle.

Pokud je dotaz zadaný, neměl by tento parametr používat.
postalCode
 query

string

Část poštovního směrovacího čísla adresy.

Pokud je dotaz zadaný, neměl by tento parametr používat.
query
 query

string

Řetězec, který obsahuje informace o umístění, například adresu nebo název orientačního bodu.
top
 query

integer

int32

Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 5, minimum: 1 a maximum: 20.
view
 query

string

Řetězec, který představuje kód oblasti/země ISO 3166-1 Alpha-2. 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 nedefinoval.

Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

Hlavička požadavku

Name Vyžadováno Typ Description
Accept-Language

string

Jazyk, ve kterém se mají vracet výsledky hledání.

Podrobnosti najdete v části Podporované jazyky .
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 účtu Azure Maps a dá se načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Azure AD ve službě Azure Maps najdete v následujících článcích .

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"

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika úč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, která se skládá 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 si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámka

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.
  • Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID.
  • Řízení přístupu na základě role v 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

Toto je sdílený klíč, který se zřizuje 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 Azure SDK 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, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystaveny.

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 List SAS v prostředku Azure Maps prostřednictvím roviny správy Azure portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK 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 v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné 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ů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali 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

GET https://atlas.microsoft.com/geocode?api-version=2023-06-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",
          "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

GET https://atlas.microsoft.com/geocode?api-version=2023-06-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",
          "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

GET https://atlas.microsoft.com/geocode?api-version=2023-06-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",
          "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

GET https://atlas.microsoft.com/geocode?api-version=2023-06-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 pro adresu. Tento prvek se obvykle považuje za správní pododdíl prvního řádu, ale v některých případech obsahuje také pododdíl druhého, třetího nebo čtvrtého 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, kterou výsledek geokódovaného umístění odpovídá. Tuto hodnotu použijte spolu s kódem shody k určení úplnějších informací o shodě.

Spolehlivost geokódovaného umístění je založená na mnoha faktorech, včetně relativní důležitosti geograficky zakódovaného umístění a polohy uživatele, pokud je zadána.
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 jejich výpočtu a navrhovaném použití.
GeocodingResponse

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

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

Adresa výsledku.
MatchCodesEnum

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

Například geokódované umístění s odpovídajícími kódy 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 neměla vyhledávání v hierarchii, aby našla shodu.

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

Možné hodnoty jsou:

Good: Umístění má pouze jednu shodu nebo se všechny vrácené shody považují 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. Například při dotazu na adresu ulice 128 Main St., odpověď může vrátit dvě umístění pro 128 North Main St. a 128 South Main St. , protože není k dispozici dostatek informací k určení, kterou možnost zvolit.

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

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

Address

Adresa výsledku

Name Typ Description
addressLine

string

AddressLine obsahující název ulice a číslo
adminDistricts

AdminDistricts[]

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

CountryRegion

formattedAddress

string

Vlastnost Formátovaná adresa
intersection

Intersection

Adresa výsledku.
locality

string

lokalita nemovitosti
neighborhood

string

nemovitost v sousedství
postalCode

string

Vlastnost PSČ

AdminDistricts

Název dílčího dělení v zemi nebo oblasti pro adresu. Tento prvek se obvykle považuje za správní pododdíl prvního řádu, ale v některých případech obsahuje také pododdíl druhého, třetího nebo čtvrtého 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, například 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, například WA, Pro adminDistrict[1], může to být krátký název okresu.

CalculationMethodEnum

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

Name Typ Description
Interpolation

string

Bod geografického kódu byl spárován s bodem na silnici pomocí interpolace.
InterpolationOffset

string

Bod geokódu byl spárován s bodem na silnici pomocí interpolace s dodatečným posunem, aby se bod přesunul na stranu ulice.
Parcel

string

Bod geokódu byl spárován se středem parcely.
Rooftop

string

Bod geokódu byl spárován se střechou budovy.

ConfidenceEnum

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

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

Name Typ Description
High

string

Pokud je hodnota spolehlivosti nastavená na High, byla nalezena jedna nebo více silných shod. Více High shod spolehlivosti je seřazeno v pořadí podle důležitosti, pokud je to možné. Například orientační body mají důležitost, ale adresy ne.

Pokud žádost obsahuje umístění nebo zobrazení, může se pořadí odpovídajícím způsobem změnit. Například dotaz na umístění pro "Paříž" vrátí "Paříž, Francie" i "Paříž, TX" oba s High jistotou. "Paříž, Francie" je vzhledem k důležitosti vždy na prvním místě, pokud umístění uživatele neukazuje, že se uživatel nachází v Paříži nebo je velmi blízko, TX nebo zobrazení mapy značí, že uživatel hledá v dané oblasti.
Low

string

Medium

string

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 zadat informace o adrese a služba geografického kódu může odpovídat pouze PSČ. Pokud má v tomto případě služba geografického kódu jistotu, že PSČ odpovídá datům, je nastavena hodnota Medium spolehlivosti a kód shody je nastaven na UpHierarchy hodnotu , aby bylo možné určit, že nemůže odpovídat všem informacím a musel hledat v hierarchii.

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

Pokud informace o poloze v dotazu neposkytují dostatek informací ke geografickému kódování konkrétního umístění, může se vrátit méně přesná hodnota polohy a spolehlivost je nastavená na Medium. Pokud je například zadána adresa, ale nenajde se shoda s číslem domu, může se vrátit výsledek geografického kódu s typem entity Roadblock.

CountryRegion

Name Typ Description
ISO

string

ISO země/oblasti
name

string

název země/oblasti

ErrorAdditionalInfo

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

Name Typ Description
info

object

Další informace.
type

string

Typ další informace.

ErrorDetail

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

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

FeatureCollectionEnum

Typ FeatureCollection objektu musí být FeatureCollection.

Name Typ Description
FeatureCollection

string

FeaturesItem

Name Typ Description
bbox

number[]

Ohraničující rámeček. Použitá projekce - EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 .
geometry

GeoJsonPoint

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

string

ID vrácené funkce
properties

Properties

type

FeatureTypeEnum

Typ funkce musí být Funkce.

FeatureTypeEnum

Typ funkce musí být Funkce.

Name Typ Description
Feature

string

GeocodePoints

Kolekce bodů geografického kódu, které se liší ve způsobu jejich výpočtu a 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ý GeoJSON Point typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
usageTypes

UsageTypeEnum[]

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

GeocodingResponse

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, toto pole není.
type

FeatureCollectionEnum

Typ FeatureCollection objektu musí být FeatureCollection.

GeoJsonPoint

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

Name Typ Description
bbox

number[]

Ohraničující rámeček. Použitá projekce - EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 .
coordinates

number[]

A Position je matice čísel se dvěma nebo více prvky. První dva prvky jsou zeměpisná délka a zeměpisná šířka, přesně v daném pořadí. Třetím prvkem je nadmořská výška nebo nadmořská výška. Podrobnosti najdete v dokumentu RFC 7946 .
type string:

Point

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

Intersection

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í se ulice.
secondaryStreet2

string

Pokud existuje, druhá protínající se ulice.

MatchCodesEnum

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

Například geokódované umístění s odpovídajícími kódy 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 neměla vyhledávání v hierarchii, aby našla shodu.

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

Možné hodnoty jsou:

Good: Umístění má pouze jednu shodu nebo se všechny vrácené shody považují 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. Například při dotazu na adresu ulice 128 Main St., odpověď může vrátit dvě umístění pro 128 North Main St. a 128 South Main St. , protože není k dispozici dostatek informací k určení, kterou možnost zvolit.

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

Name Typ Description
Ambiguous

string

Good

string

UpHierarchy

string

Properties

Name Typ Description
address

Address

Adresa výsledku
confidence

ConfidenceEnum

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

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

GeocodePoints[]

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

MatchCodesEnum[]

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

Například geokódované umístění s odpovídajícími kódy 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 neměla vyhledávání v hierarchii, aby našla shodu.

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

Možné hodnoty jsou:

Good: Umístění má pouze jednu shodu nebo se všechny vrácené shody považují 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. Například při dotazu na adresu ulice 128 Main St., odpověď může vrátit dvě umístění pro 128 North Main St. a 128 South Main St. , protože není k dispozici dostatek informací k určení, kterou možnost zvolit.

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

string

Jedna z těchto možností:

  • Adresa
  • Zátaras
  • Silničníintersection
  • Sousedství
  • Vyplněné místo
  • PSČ1
  • AdminDivision1
  • AdminDivision2
  • CountryRegion

UsageTypeEnum

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

Name Typ Description
Display

string

Route

string