Search - Post Search Address Batch

Reference

Služba:: Maps

Verze rozhraní API:: 1.0

Slouží k odeslání dávky dotazů do rozhraní API adresy Search v jednom asynchronním požadavku.
Rozhraní Post Search Address Batch API je požadavek HTTPPOST, který odesílá dávky dotazů do rozhraní API Search adresy v jednom synchronním voláním rozhraní API. Můžete volat rozhraní API Search Address Batch a spustit buď asynchronně (async), nebo synchronně (synchronizovat). Asynchronní rozhraní API umožňuje volajícímu dávkovat až 10 000 dotazů a synchronizovat rozhraní API až 100 dotazů.

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/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Odeslání asynchronního dávkového požadavku

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků na vyhledávání.

Umožňuje načtení výsledků v samostatném volání (je možné stáhnout více položek).
Asynchronní rozhraní API je optimalizované z hlediska spolehlivosti a neočekává se, že dojde k vypršení časového limitu.
Počet položek dávky je pro toto rozhraní API omezený na 10 000 .

Když vytvoříte požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 spolu s adresou URL přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Asynchronní odpovědi se ukládají po dobu 14 dnů. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po uplynutí doby vypršení platnosti.

Mějte na paměti, že asynchronní dávkové požadavky jsou dlouhotrvající operace. Tady je typická posloupnost operací:

Klient odešle žádost Search Address Batch POST do Azure Maps.

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}

Server odpoví jedním z následujících způsobů:

HTTP 202 Accepted – Dávkový požadavek byl přijat.

HTTP Error – Při zpracování požadavku Batch došlo k chybě. Může se jednat o stavový 400 Bad Request kód nebo jakýkoli jiný Error .
Pokud byl dávkový požadavek úspěšně přijat, Location hlavička v odpovědi obsahuje adresu URL pro stažení výsledků dávkového požadavku. Tento identifikátor URI stavu vypadá takto:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Klient vydá na adresu URL pro stažení získanou GET v kroku 3 žádost o stažení výsledků dávky.

Text POST pro žádost Batch

K odeslání dotazů na vyhledávací adresu 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í 5 dotazů na vyhledávací adresu :

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Dotaz na vyhledávací adresu v dávce je pouze částečná adresa URL bez protokolu, základní adresy URL, cesty, verze rozhraní API a klíče předplatného. Může přijmout libovolný z podporovaných parametrů identifikátoru URIvyhledávací adresy. Řetězcové hodnoty v dotazu na vyhledávací adresu musí být správně uvozené (např. znak " by měl být uvozován znakem \ ) a měl by být také správně zakódovaný do adresy URL.

Asynchronní rozhraní API umožňuje volajícímu dávkovat až 10 000 dotazů a synchronizovat rozhraní API až 100 dotazů a dávka by měla obsahovat alespoň 1 dotaz.

Stažení asynchronních dávkových výsledků

Pokud chcete stáhnout výsledky asynchronní dávky, odešlete GET požadavek na koncový bod dávkového stahování. Tuto adresu URL ke stažení můžete získat z Location hlavičky úspěšného POST dávkového požadavku a vypadá takto:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Tady je typická posloupnost operací pro stažení výsledků dávky:

Klient odešle GET požadavek pomocí adresy URL pro stažení.
Server odpoví jedním z následujících způsobů:

HTTP 202 Accepted – Dávkový požadavek byl přijat, ale stále se zpracovává. Zkuste to prosím znovu za nějakou dobu.

HTTP 200 OK – Dávkový požadavek se úspěšně zpracoval. Tělo odpovědi obsahuje všechny výsledky dávky.

Model dávkové odpovědi

Vrácený obsah dat je podobný pro asynchronní a synchronizační požadavky. Když se při stahování výsledků asynchronního požadavku dávky dokončí zpracování dávky, tělo odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje komponentu summarytotalRequests , která označuje, že byly součástí původního dávkového požadavku, a successfulRequeststj. 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 v souboru batchItems obsahuje statusCode pole a response . Každý response v batchItems má jeden z následujících typů:

SearchAddressResult – Pokud se dotaz úspěšně dokončil.
Error – Pokud dotaz selhal. Odpověď bude v tomto případě obsahovat a code .message

Tady je ukázka dávkové odpovědi se 2 úspěšnými a 1 neúspěšnými výsledky:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
api-version	query	True	string	Číslo verze rozhraní API 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í Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích.

Text požadavku

Name	Typ	Description
batchItems	BatchRequestItem[]	Seznam dotazů ke zpracování.

Odpovědi

Name	Typ	Description
200 OK	SearchAddressBatchProcessResult	OK
202 Accepted		Podporuje se pouze pro asynchronní požadavek. Žádost byla přijata: Žádost byla přijata ke zpracování. K opakování nebo získání přístupu k výsledkům použijte adresu URL v hlavičce umístění. Hlavičky Location: string
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Name

Typ

Description

200 OK

SearchAddressBatchProcessResult

202 Accepted

Podporuje se pouze pro asynchronní požadavek. Žádost byla přijata: Žádost byla přijata ke zpracování. K opakování nebo získání přístupu k výsledkům použijte adresu URL v hlavičce umístění.

Hlavičky

Location: string

Other Status Codes

ErrorResponse

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

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky 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 Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. 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 Azure Maps rozhraní REST API.

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í Azure Maps prostředku, 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 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 Microsoft identity platform najdete v přehledu 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 vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem může každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.

U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím 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

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Ukázkový požadavek

HTTP

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=400 Broad St, Seattle, WA 98109&limit=3"
    },
    {
      "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
    },
    {
      "query": "?query=350 5th Ave, New York, NY 10118&limit=1"
    }
  ]
}

Ukázková odpověď

Stavový kód:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Stavový kód:: 202

Operation-Location: URL to download the results of the long-running batch request.

Definice

Name	Description
Address	Adresa výsledku
AddressRanges	Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuté souřadnice počátečního a koncového umístění rozsahu adres.
BatchRequest	Tento typ představuje text požadavku pro službu Batch.
BatchRequestItem	Objekt žádosti Batch
BoundingBox	Zobrazení, které pokrývá výsledek představovaný souřadnicemi vlevo nahoře a vpravo dole v oblasti zobrazení.
BoundingBoxCompassNotation	Ohraničující rámeček umístění.
Brand	Značka přidružená k poi
Classification	Klasifikace pro vrácené BŽS
ClassificationName	Název klasifikace
DataSources	Volitelný oddíl. Referenční ID pro použití s rozhraním Get Search Polygon API
Entity	Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.
EntryPoint	Vstupní bod pro vrácené BŽ.
EntryPointType	Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
GeographicEntityType	Typ entity Zeměpis. K dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici.
Geometry	Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis.
JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
MatchType	Typy shody pro operaci zpětného vyhledávání adres
OperatingHours	Otevírací doba pro poi (body zájmu)
OperatingHoursTime	Představuje datum a čas.
OperatingHoursTimeRange	Otevřený časový rozsah pro den
PointOfInterest	Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace.
PointOfInterestCategorySet	Kategorie POI
QueryType	Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.
Response	Výsledek dotazu. SearchAddressResult, pokud se dotaz úspěšně dokončil, v opačném případě ErrorResponse.
SearchAddressBatchItem	Položka vrácená voláním služby Batch adresy Search.
SearchAddressBatchProcessResult	Tento objekt se vrátí z úspěšného volání služby Batch adresy Search.
SearchAddressResultItem	Objekt Result pro odpověď rozhraní API Search.
SearchAddressResultType	Jedna z těchto možností: POI Ulice Geografie Adresa bodu Rozsah adres Křížová ulice
SearchSummary	Souhrnný objekt pro odpověď rozhraní API Search.
Summary	Souhrn výsledků žádosti o dávku

Address

Adresa výsledku

Name	Typ	Description
boundingBox	BoundingBoxCompassNotation	Ohraničující rámeček umístění.
buildingNumber	string	Číslo budovy na ulici. ZASTARALÉ, použijte místo toho streetNumber.
country	string	název země/oblasti
countryCode	string	Země (Poznámka: Toto je dvoumísmenný kód, nikoli název země/oblasti.)
countryCodeISO3	string	Kód země ISO alfa-3
countrySecondarySubdivision	string	County
countrySubdivision	string	Země/region nebo kraj
countrySubdivisionCode	string	`countrySubdivisionCode` s předponou `countryCode` ( countryCode-countrySubdivisionCode ) a spojovník tvoří kód ISO 3166-2. Příklady: TX pro Texas, SCT pro Skotsko a ON pro Ontario.
countrySubdivisionName	string	Úplný název první úrovně hierarchie správy země/oblasti. Toto pole se zobrazí pouze v případě, že se countrySubdivision zobrazí ve zkrácené podobě. Podporováno pouze pro USA, Kanadu a Spojené království.
countryTertiarySubdivision	string	Pojmenovaná oblast
crossStreet	string	Název ulice, která je překřížena.
extendedPostalCode	string	Rozšířené PSČ (dostupnost závisí na oblasti).
freeformAddress	string	Řádek adresy formátovaný podle pravidel formátování země/oblasti původu výsledku nebo v případě země/oblasti úplný název země/oblasti.
localName	string	Komponenta adresy, která představuje název zeměpisné oblasti nebo lokality, která seskupuje více adresovatelných objektů pro účely adresování, aniž by to byla jednotka pro správu. Toto pole slouží k sestavení `freeformAddress` vlastnosti. `localName` zastupuje poštovní obec. V závislosti na umístění `localName` je běžně známý název města nebo města. Pro běžně známý název města nebo města použijte `localName` místo `municipality`.
municipality	string	Město / město Poznámka: `municipality` představuje obytnou obec. V závislosti na umístění `municipality` se hodnota může lišit od běžně známého názvu města nebo města. Pro běžně známý název města se doporučuje `localName` místo hodnoty použít `municipality` hodnotu.
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Sousedství je geograficky lokalizovaná oblast v rámci města nebo města s výraznými charakteristikami a sociálními interakcemi mezi obyvateli.
postalCode	string	PSČ
routeNumbers	string[]	Kódy používané k jednoznačné identifikaci ulice
street	string	Název ulice. ZASTARALÉ, použijte místo toho streetName.
streetName	string	Název ulice.
streetNameAndNumber	string	Název ulice a číslo.
streetNumber	string	Číslo budovy na ulici.

AddressRanges

Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuté souřadnice počátečního a koncového umístění rozsahu adres.

Name	Typ	Description
from	LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
rangeLeft	string	Rozsah adres na levé straně ulice.
rangeRight	string	Rozsah adres na pravé straně ulice.
to	LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

BatchRequest

Tento typ představuje text požadavku pro službu Batch.

Name	Typ	Description
batchItems	BatchRequestItem[]	Seznam dotazů ke zpracování.

BatchRequestItem

Objekt žádosti Batch

Name	Typ	Description
query	string	Tento parametr obsahuje řetězec dotazu, který se používá k provedení nestrukturované operace geografického kódování. Řetězec dotazu se předá doslovně rozhraní API pro vyhledávání ke zpracování.

BoundingBox

Zobrazení, které pokrývá výsledek představovaný souřadnicemi vlevo nahoře a vpravo dole v oblasti zobrazení.

Name	Typ	Description
btmRightPoint	LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

BoundingBoxCompassNotation

Ohraničující rámeček umístění.

Name	Typ	Description
entity	Entity	Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.
northEast	string	Severní a východní zeměpisná šířka, souřadnice délky ohraničujícího rámečku jako čárkami oddělené floaty
southWest	string	Jihovýchodní zeměpisná šířka, souřadnice délky ohraničujícího rámečku jako plovoucí čárky oddělené čárkami

Brand

Značka přidružená k poi

Name	Typ	Description
name	string	Název značky

Classification

Klasifikace pro vrácené BŽS

Name	Typ	Description
code	string	Vlastnost kódu
names	ClassificationName[]	Pole Názvů

ClassificationName

Název klasifikace

Name	Typ	Description
name	string	Name – vlastnost
nameLocale	string	Vlastnost Name Locale

DataSources

Volitelný oddíl. Referenční ID pro použití s rozhraním Get Search Polygon API

Name	Typ	Description
geometry	Geometry	Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis.

Entity

Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.

Name	Typ	Description
position	string	Pozice entity

EntryPoint

Vstupní bod pro vrácené BŽ.

Name	Typ	Description
position	LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
type	EntryPointType	Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší.

EntryPointType

Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší.

Name	Typ	Description
main	string
minor	string

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.

GeographicEntityType

Typ entity Zeměpis. K dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici.

Name	Typ	Description
Country	string	název země/oblasti
CountrySecondarySubdivision	string	County
CountrySubdivision	string	Země/region nebo kraj
CountryTertiarySubdivision	string	Pojmenovaná oblast
Municipality	string	Město / město
MunicipalitySubdivision	string	Sub / Super City
Neighbourhood	string	Sousedství
PostalCodeArea	string	PSČ

Geometry

Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis.

Name	Typ	Description
id	string	Předejte ho jako geometryId rozhraní Get Search Polygon API, abyste získali informace o geometrii pro tento výsledek.

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

Name	Typ	Description
json	string	Formát výměny dat zápisu objektů JavaScriptu

LatLongPairAbbreviated

Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

Name	Typ	Description
lat	number	Vlastnost Zeměpisná šířka
lon	number	Zeměpisná délka – vlastnost

MatchType

Typy shody pro operaci zpětného vyhledávání adres

Name	Typ	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Otevírací doba pro poi (body zájmu)

Name	Typ	Description
mode	string	Hodnota použitá v požadavku: none nebo "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Seznam časových rozsahů pro příštích 7 dnů

OperatingHoursTime

Představuje datum a čas.

Name	Typ	Description
date	string	Představuje aktuální datum kalendáře v časovém pásmu POI, například "2019-02-07".
hour	integer	Hodiny jsou v místním čase poi ve formátu 24 hodin. možné hodnoty jsou 0 - 23.
minute	integer	Minuty jsou v místním čase poi; možné hodnoty jsou 0 - 59.

OperatingHoursTimeRange

Otevřený časový rozsah pro den

Name	Typ	Description
endTime	OperatingHoursTime	Bod v rozsahu příštích 7 dnů, kdy je dané poi uzavřeno, nebo začátek rozsahu, pokud byl uzavřen před rozsahem.
startTime	OperatingHoursTime	Bod v rozsahu příštích 7 dnů, kdy se dané poi otevírá, nebo začátek rozsahu, pokud byl otevřen před rozsahem.

PointOfInterest

Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace.

Name	Typ	Description
brands	Brand[]	Pole značek. Název značky pro vrácené poi.
categories	string[]	Matice kategorií
categorySet	PointOfInterestCategorySet[]	Seznam nejkonfiektnějších kategorií poi
classifications	Classification[]	Pole klasifikace
name	string	Název vlastnosti POI
openingHours	OperatingHours	Otevírací doba pro poi (body zájmu)
phone	string	Vlastnost Telefonní číslo
url	string	Vlastnost Adresa URL webu

PointOfInterestCategorySet

Kategorie POI

Name	Typ	Description
id	integer	ID kategorie

QueryType

Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.

Name	Typ	Description
NEARBY	string	Search byla provedena kolem určité zeměpisné šířky a délky s definovaným poloměrem.
NON_NEAR	string	Search byla provedena globálně, bez zkreslení na určitou zeměpisnou šířku a délku a bez definovaného poloměru.

Response

Výsledek dotazu. SearchAddressResult, pokud se dotaz úspěšně dokončil, v opačném případě ErrorResponse.

Name	Typ	Description
error	ErrorDetail	Objekt chyby.
results	SearchAddressResultItem[]	Seznam výsledků rozhraní API Search.
summary	SearchSummary	Souhrnný objekt pro odpověď rozhraní API Search

SearchAddressBatchItem

Položka vrácená voláním služby Batch adresy Search.

Name	Typ	Description
response	Response	Výsledek dotazu. SearchAddressResult, pokud se dotaz úspěšně dokončil, v opačném případě ErrorResponse.
statusCode	integer	Stavový kód požadavku HTTP.

SearchAddressBatchProcessResult

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

Name	Typ	Description
batchItems	SearchAddressBatchItem[]	Pole obsahující výsledky dávky.
summary	Summary	Souhrn výsledků žádosti o dávku

SearchAddressResultItem

Objekt Result pro odpověď rozhraní API Search.

Name	Typ	Description
address	Address	Adresa výsledku
addressRanges	AddressRanges	Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuty souřadnice počátečního a koncového umístění rozsahu adres.
dataSources	DataSources	Volitelný oddíl. REFERENČNÍ ID geometrie pro použití s rozhraním Get Search Polygon API.
detourTime	integer	Čas objížďky v sekundách. Vráceno pouze pro volání rozhraní API Search Along Route.
dist	number	Přímá vzdálenost mezi výsledkem a umístěním geobias v metrech.
entityType	GeographicEntityType	Typ entity Zeměpis. K dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici.
entryPoints	EntryPoint[]	Pole vstupních bodů. Ty popisují typy vchodů, které jsou k dispozici na místě. Typ může být "hlavní" pro hlavní vchody, jako jsou přední dveře nebo vstupní halu, a "vedlejší" pro boční a zadní dveře.
id	string	Vlastnost Id
info	string	Informace o původním zdroji dat výsledku. Používá se pro žádosti o podporu.
matchType	MatchType	Informace o typu shody. Jedna z těchto možností: AddressPoint HouseNumberRange Ulice
poi	PointOfInterest	Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace
position	LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
score	number	Hodnota v sadě výsledků k označení relativního skóre shody mezi výsledky. Tuto možnost můžete použít k určení, že výsledek x bude dvakrát tak relevantní jako výsledek y, pokud je hodnota x 2x hodnota y. Hodnoty se v jednotlivých dotazech liší a jsou míněné pouze jako relativní hodnota pro jednu sadu výsledků dotazu.
type	SearchAddressResultType	Jedna z těchto možností: POI Ulice Geografie Adresa bodu Rozsah adres Křížová ulice
viewport	BoundingBox	Zobrazení, které pokrývá výsledek představovaný souřadnicemi levého horního a pravého dolního rohu oblasti.

SearchAddressResultType

Jedna z těchto možností:

POI
Ulice
Geografie
Adresa bodu
Rozsah adres
Křížová ulice

Name	Typ	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Souhrnný objekt pro odpověď rozhraní API Search.

Name	Typ	Description
fuzzyLevel	integer	Maximální přibližná úroveň požadovaná k poskytnutí výsledků.
geoBias	LatLongPairAbbreviated	Označení, kdy interní vyhledávací web použil geoprostorové předsudky ke zlepšení hodnocení výsledků. V některých metodách to může být ovlivněno nastavením parametrů lat a lon tam, kde jsou k dispozici. V ostatních případech je čistě interní.
limit	integer	Maximální počet odpovědí, které budou vráceny
numResults	integer	Počet výsledků v odpovědi
offset	integer	Počáteční posun vrácených výsledků v rámci celé sady výsledků.
query	string	Parametr dotazu, který byl použit k vytvoření těchto výsledků hledání.
queryTime	integer	Doba strávená překladem dotazu v milisekundách
queryType	QueryType	Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.
totalResults	integer	Celkový počet nalezených výsledků

Summary

Souhrn výsledků žádosti o dávku

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

Sdílet prostřednictvím

Search - Post Search Address Batch

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

Odeslání asynchronního dávkového požadavku

Text POST pro žádost Batch

Stažení asynchronních dávkových výsledků

Model dávkové odpovědi

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

AADToken

Rozsahy

subscription-key

SAS Token

Příklady

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Ukázkový požadavek

Ukázková odpověď

Definice

Address

AddressRanges

BatchRequest

BatchRequestItem

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

JsonFormat

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Další materiály