Sdílet prostřednictvím

Search - Get Reverse Geocoding Batch

  • Reference
Služba:
Maps
Verze rozhraní API:
2023-06-01

Slouží k odeslání dávky dotazů do rozhraní API pro reverzní geokódování v rámci jednoho požadavku.

Rozhraní Get Reverse Geocoding Batch API je požadavek HTTP POST , který pomocí jednoho požadavku odesílá dávky až 100 dotazů do rozhraní API pro reverzní geokódování .

Odeslání synchronní dávkové žádosti

Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, zareaguje, jakmile se dávkové položky vypočítají, a nebude možné později načíst výsledky. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet položek dávky je pro toto rozhraní API omezený na 100 .

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Text POST pro žádost Batch

K odeslání reverzních geokódovacích dotazů použijete POST požadavek, ve kterém text požadavku bude obsahovat batchItems pole ve json formátu a hlavička Content-Type bude nastavená na application/json. Tady je ukázkový text požadavku obsahující 2 dotazy zpětného geografického kódování :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Objekt batchItem pro reverzní geokódování může přijmout libovolný z podporovaných parametrů URIzpětného geokódování.

Dávka by měla obsahovat alespoň 1 dotaz.

Model dávkové odpovědi

Dávková odpověď obsahuje komponentu summarytotalRequests , která označuje, které byly součástí původního dávkového požadavku, tj successfulRequests . dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje batchItems také pole, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. Bude batchItems obsahovat výsledky ve stejném pořadí, v jakém byly původní dotazy odeslány v dávkovém požadavku. Každá položka má jeden z následujících typů:

  • GeocodingResponse – Pokud se dotaz úspěšně dokončil.

  • Error – Pokud dotaz selhal. Odpověď bude v tomto případě obsahovat a code .message

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
api-version
 query True

string

Číslo verze rozhraní API služby Azure Maps

Hlavička požadavku

Name Vyžadováno Typ Description
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 je možné ho 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 .
Accept-Language

string

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

Podrobnosti najdete v části Podporované jazyky .

Text požadavku

Name Typ Description
batchItems

ReverseGeocodingBatchRequestItem[]

Seznam dotazů ke zpracování.

Odpovědi

Name Typ Description
200 OK

GeocodingBatchResponse

OK
Other Status Codes

ErrorResponse

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

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 Azure Maps REST API. Ří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 složené z jednoho nebo několika 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 pro konkrétní rozhraní API a obory.

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. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
  • 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í sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
  • Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

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

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí 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 autorizaci 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 vystavené.

U veřejně vystavených aplikací doporučujeme použít 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 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 autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečený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 účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Ukázkový požadavek

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

{
  "batchItems": [
    {
      "coordinates": [
        -122.128275,
        47.639429
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        -122.341979399674,
        47.6095253501216
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Ukázková odpověď

Stavový kód:
200 
{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
              "addressLine": "1 Microsoft Way"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ]
    },
    {
      "optionalId": "3K5O3Y832J2YV6D7XNGUSM4ECCUGDEFN172CJQNN",
      "error": {
        "code": "400 Bad Request",
        "message": "The provided coordinates in query are invalid, out of range, or not in the expected format"
      }
    }
  ]
}

Definice

Name Description
Address

Adresa výsledku
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.
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í.
GeocodingBatchResponse

Tento objekt se vrátí z úspěšného volání služby Batch geokódování.
GeocodingBatchResponseItem
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
ResultTypeEnum

Zadejte typy entit, které chcete v odpovědi použít. Vrátí se pouze typy, které zadáte. Pokud bod nelze mapovat na typy entit, které zadáte, v odpovědi se nevrátí žádné informace o poloze. Výchozí hodnota jsou všechny možné entity. Seznam typů entit oddělených čárkami vybraných z následujících možností

  • Adresa
  • Sousedství
  • Vyplněné místo
  • PSČ1
  • AdminDivision1
  • AdminDivision2
  • CountryRegion

Tyto typy entit jsou seřazené od nejkonsekvnější entity k nejméně konkrétní entitě. Pokud se najdou entity s více než jedním typem entity, vrátí se pouze nejkonvičtější entita. Pokud například zadáte Address a AdminDistrict1 jako typy entit a entity byly nalezeny pro oba typy, vrátí se v odpovědi pouze informace o entitě Adresa.
ReverseGeocodingBatchRequestBody

Seznam dotazů a požadavků zpětného geokódování, které se mají zpracovat. Seznam může obsahovat maximálně 100 dotazů a musí obsahovat alespoň 1 dotaz.
ReverseGeocodingBatchRequestItem

Objekt dávkového dotazu
Summary

Souhrn dávkové žádosti
UsageTypeEnum

Nejvhodnější 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 k umístění, použijte Route body. Pokud zobrazujete místo na mapě, použijte Display body. Pokud je umístěním například park, může bod určovat vstup do parku, Route kam můžete vjet 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 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.

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, For 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 geografického kó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 geografického kódu byl spárován se středem parcely.
Rooftop

string

Geokódový bod 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[]

Nejvhodnější 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 k umístění, použijte Route body. Pokud zobrazujete místo na mapě, použijte Display body. Pokud je umístěním například park, může bod určovat vstup do parku, Route kam můžete vjet autem, a Display bod může být bod, který určuje střed parku.

GeocodingBatchResponse

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

Name Typ Description
batchItems

GeocodingBatchResponseItem[]

Pole obsahující výsledky dávky.
nextLink

string

Je odkaz na další stránku vrácených funkcí. Pokud se jedná o poslední stránku, toto pole není.
summary

Summary

Souhrn dávkové žádosti

GeocodingBatchResponseItem

Name Typ Description
error

ErrorDetail

Podrobnosti o chybě
features

FeaturesItem[]

nextLink

string

Je odkaz na další stránku vrácených funkcí. Pokud se jedná o poslední stránku, toto pole není.
optionalId

string

id položky batchItem, která by byla stejná jako id v požadavku.
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ůniku
intersectionType

string

Typ průniku.
secondaryStreet1

string

První protínající se ulice.
secondaryStreet2

string

Pokud existuje, druhá ulice se protíná.

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

ResultTypeEnum

Zadejte typy entit, které chcete v odpovědi použít. Vrátí se pouze typy, které zadáte. Pokud bod nelze mapovat na typy entit, které zadáte, v odpovědi se nevrátí žádné informace o poloze. Výchozí hodnota jsou všechny možné entity. Seznam typů entit oddělených čárkami vybraných z následujících možností

  • Adresa
  • Sousedství
  • Vyplněné místo
  • PSČ1
  • AdminDivision1
  • AdminDivision2
  • CountryRegion

Tyto typy entit jsou seřazené od nejkonsekvnější entity k nejméně konkrétní entitě. Pokud se najdou entity s více než jedním typem entity, vrátí se pouze nejkonvičtější entita. Pokud například zadáte Address a AdminDistrict1 jako typy entit a entity byly nalezeny pro oba typy, vrátí se v odpovědi pouze informace o entitě Adresa.

Name Typ Description
Address

string

AdminDivision1

string

AdminDivision2

string

CountryRegion

string

Neighborhood

string

PopulatedPlace

string

Postcode1

string

ReverseGeocodingBatchRequestBody

Seznam dotazů a požadavků zpětného geokódování, které se mají zpracovat. Seznam může obsahovat maximálně 100 dotazů a musí obsahovat alespoň 1 dotaz.

Name Typ Description
batchItems

ReverseGeocodingBatchRequestItem[]

Seznam dotazů ke zpracování.

ReverseGeocodingBatchRequestItem

Objekt dávkového dotazu

Name Typ Description
coordinates

number[]

Souřadnice umístění, které chcete převést na geokódování. Příklad: [lon,lat]
optionalId

string

id požadavku, který se zobrazí v odpovídající hodnotě batchItem
resultTypes

ResultTypeEnum[]

Zadejte typy entit, které chcete v odpovědi použít. Vrátí se pouze typy, které zadáte. Pokud bod nelze mapovat na typy entit, které zadáte, v odpovědi se nevrátí žádné informace o poloze. Výchozí hodnota jsou všechny možné entity. Seznam typů entit oddělených čárkami vybraných z následujících možností

  • Adresa
  • Sousedství
  • Vyplněné místo
  • PSČ1
  • AdminDivision1
  • AdminDivision2
  • CountryRegion

Tyto typy entit jsou seřazené od nejkonsekvnější entity k nejméně konkrétní entitě. Pokud se najdou entity s více než jedním typem entity, vrátí se pouze nejkonvičtější entita. Pokud například zadáte Address a AdminDistrict1 jako typy entit a entity byly nalezeny pro oba typy, vrátí se v odpovědi pouze informace o entitě Adresa.
view

string

Řetězec, který určuje ISO 3166-1 Alpha-2 kód oblasti nebo země. Tím se změní geopolitické sporné ohraničení a popisky tak, aby odpovídaly zadané oblasti uživatele.

Summary

Souhrn dávkové žádosti

Name Typ Description
successfulRequests

integer

Počet úspěšných požadavků v dávce
totalRequests

integer

Celkový počet požadavků v dávce

UsageTypeEnum

Nejvhodnější 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 k umístění, použijte Route body. Pokud zobrazujete místo na mapě, použijte Display body. Pokud je umístěním například park, může bod určovat vstup do parku, Route kam můžete vjet autem, a Display bod může být bod, který určuje střed parku.

Name Typ Description
Display

string

Route

string