Search - Get Search Address Structured

Reference

Služba:: Maps

Verze rozhraní API:: 1.0

Slouží k získání souřadnic zeměpisné šířky a délky adresy v nestrukturovaném vstupním formátu nebo formátu dotazu.
Rozhraní Get Search Address Structured API (geokódování strukturovaných adres) je požadavek HTTP GET , který vrací souřadnice zeměpisné šířky a délky uliční adresy v nestrukturovaném vstupním formátu nebo formátu dotazu.

Index vyhledávání geokódování se bude dotazovat na vše nad daty na úrovni ulice. Nebudou vráceny žádné 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, státy atd.

GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&countryCode={countryCode}

S volitelnými parametry:

GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&language={language}&countryCode={countryCode}&limit={limit}&ofs={ofs}&streetNumber={streetNumber}&streetName={streetName}&crossStreet={crossStreet}&municipality={municipality}&municipalitySubdivision={municipalitySubdivision}&countryTertiarySubdivision={countryTertiarySubdivision}&countrySecondarySubdivision={countrySecondarySubdivision}&countrySubdivision={countrySubdivision}&postalCode={postalCode}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	ResponseFormat	Požadovaný formát odpovědi. Hodnota může být json nebo xml.
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.
countryCode	query	True	string	2 nebo 3 písmena ISO3166-1 část kódu země/oblasti adresy. Např. USA.
countrySecondarySubdivision	query		string	Země nebo oblast pro strukturovanou adresu
countrySubdivision	query		string	Část dílčího dělení země/oblasti adresy
countryTertiarySubdivision	query		string	Pojmenovaná oblast strukturované adresy
crossStreet	query		string	Název křížové ulice pro strukturovanou adresu
entityType	query		GeographicEntityType	Určuje úroveň filtrování prováděného v geografických oblastech. Zužuje hledání pro zadané typy entit geografie, například vrátí pouze obce. Výsledná odpověď bude obsahovat ID zeměpisné oblasti a odpovídající typ entity. Pokud jako seznam oddělený čárkami zadáte více než jednu entitu, koncový bod vrátí nejmenší dostupnou entitu. Vrácené ID geometrie lze použít k získání geometrie dané geografické oblasti prostřednictvím rozhraní Get Search Polygon API. Při nastavení entityType se ignorují následující parametry: Čísla číslo returnRoadUse returnSpeedLimit silničnípoužití typ returnMatch
extendedPostalCodesFor	query		SearchIndexes[]	Indexy, jejichž rozšířená PSČ by měla být zahrnuta do výsledků. Dostupné indexy jsou: Addr = Rozsahy adres Geo = Geografická oblast PAD = adresy bodů POI = body zájmu Str = Ulice XStr = Křížové ulice (průsečíky) Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo Žádný pro žádné indexy. Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je nutné je v případě potřeby explicitně vyžádat. Příklady použití: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.
language	query		string	Jazyk, ve kterém se mají vracet výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk. Podrobnosti najdete v části Podporované jazyky .
limit	query		integer	Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 10, minimum: 1 a maximum: 100
municipality	query		string	Část adresy obce
municipalitySubdivision	query		string	Subdivision (sub/super city) pro strukturovanou adresu
ofs	query		integer	Počáteční posun vrácených výsledků v rámci celé sady výsledků. Výchozí hodnota: 0
postalCode	query		string	Část poštovního směrovacího čísla adresy
streetName	query		string	Část názvu ulice adresy
streetNumber	query		string	Část adresy s číslem ulice
view	query		LocalizedMapView	Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

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 dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name	Typ	Description
200 OK	SearchAddressResult	OK
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, která se skládá 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 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í Azure Maps prostředku, 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 Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
Použití sady Azure Maps Web SDK umožňuje nastavit aplikaci 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á každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps 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 prostředku Azure Maps 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 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 address in Redmond, WA in structured form

Ukázkový požadavek

HTTP

GET https://atlas.microsoft.com/search/address/structured/json?api-version=1.0&countryCode=US&streetNumber=15127&streetName=NE%2024th%20Street&municipality=Redmond&postalCode=98052

Ukázková odpověď

Stavový kód:: 200

{
  "summary": {
    "query": "15127 98052 ne redmond wa",
    "queryType": "NON_NEAR",
    "queryTime": 57,
    "numResults": 1,
    "offset": 0,
    "totalResults": 34,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.30129317913035,
      "lon": -120.88247999999997
    }
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/37974392",
      "score": 8.074,
      "dist": 101274.64693865852,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 98052",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Definice

Name	Description
Address	Adresa výsledku
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.
BoundingBox	Zobrazení, které pokrývá výsledek představovaný souřadnicemi levého horního a pravého dolního rohu oblasti.
BoundingBoxCompassNotation	Ohraničující rámeček umístění.
Brand	Značka přidružená k poi
Classification	Klasifikace pro vrácené poi
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é poi.
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	Odpověď na chybu
GeographicEntityType	Typ entity Zeměpis. Je 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.
LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
LocalizedMapView	Parametr View (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení takových oblastí a parametr View umožňuje, aby aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified", i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak pro toto umístění správně nastavit parametr View. Případně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr View v Azure Maps musí být použit v souladu s platnými zákony, včetně těch, které se týkají mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps jsou dostupné. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.
MatchType	Typy shody pro operaci zpětného vyhledávání adresy
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.
ResponseFormat	Požadovaný formát odpovědi. Hodnota může být json nebo xml.
SearchAddressResult	Tento objekt je vrácen z úspěšných volání Search.
SearchAddressResultItem	Objekt výsledku pro odpověď rozhraní API Search.
SearchAddressResultType	Jedna z těchto možností: POI Ulice Geografie Adresa bodu Rozsah adres Křížová ulice
SearchIndexes	Indexy, jejichž rozšířená PSČ by měla být zahrnuta do výsledků. Dostupné indexy jsou: Addr = Rozsahy adres Geo = Geografická oblast PAD = adresy bodů POI = body zájmu Str = Ulice XStr = Křížové ulice (průsečíky) Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo Žádný pro žádné indexy. Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je nutné je v případě potřeby explicitně vyžádat. Příklady použití: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.
SearchSummary	Souhrnný objekt pro odpověď rozhraní API Search

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, ne název země/oblasti.)
countryCodeISO3	string	ISO alfa-3 kód země
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 je countrySubdivision prezentováno ve zkrácené podobě. Podporováno pouze pro USA, Kanadu a Spojené království.
countryTertiarySubdivision	string	Pojmenovaná oblast
crossStreet	string	Název překračované ulice.
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 geografické oblasti nebo lokality, která seskupuje více adresovatelných objektů pro účely adresování, aniž by to byla jednotka pro správu. Toto pole se používá 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. Jako 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 zahrnuty souřadnice počátečního a koncového umístění rozsahu adres.

Name	Typ	Description
from	LatLongPairAbbreviated	Umístění vyjádřené 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í vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

BoundingBox

Zobrazení, které pokrývá výsledek představovaný souřadnicemi levého horního a pravého dolního rohu oblasti.

Name	Typ	Description
btmRightPoint	LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	Umístění vyjádřené 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é poi

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é poi.

Name	Typ	Description
position	LatLongPairAbbreviated	Umístění vyjádřené 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 podverze.

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

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GeographicEntityType

Typ entity Zeměpis. Je 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.

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

LocalizedMapView

Parametr View (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení takových oblastí a parametr View umožňuje, aby aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified", i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak pro toto umístění správně nastavit parametr View. Případně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr View v Azure Maps musí být použit v souladu s platnými zákony, včetně těch, které se týkají mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps jsou dostupné. Příklad: view=IN.

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

Name	Typ	Description
AE	string	Spojené arabské emiráty (zobrazení v arabštině)
AR	string	Argentina (argentinské zobrazení)
Auto	string	Vrátí mapová data na základě IP adresy požadavku.
BH	string	Bahrajn (zobrazení v arabštině)
IN	string	Indie (indické zobrazení)
IQ	string	Irák (zobrazení v arabštině)
JO	string	Jordánsko (arabské zobrazení)
KW	string	Kuvajt (zobrazení v arabštině)
LB	string	Libanon (zobrazení arabštiny)
MA	string	Maroko (marocké zobrazení)
OM	string	Omán (zobrazení arabštiny)
PK	string	Pákistán (pákistánské zobrazení)
PS	string	Palestinská samospráva (zobrazení v arabštině)
QA	string	Katar (zobrazení v arabštině)
SA	string	Saúdská Arábie (arabské zobrazení)
SY	string	Sýrie (zobrazení arabštiny)
Unified	string	Sjednocené zobrazení (ostatní)
YE	string	Jemen (arabské zobrazení)

MatchType

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

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í kalendářní datum v časovém pásmu BZ, 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 až 23.
minute	integer	Minuty jsou v místním čase poi; možné hodnoty jsou 0 až 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[]	Pole kategorií
categorySet	PointOfInterestCategorySet[]	Seznam nejkonsekvnějších kategorií poi
classifications	Classification[]	Pole klasifikace
name	string	Název vlastnosti POI
openingHours	OperatingHours	Otevírací doba pro bod zájmu (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.

ResponseFormat

Požadovaný formát odpovědi. Hodnota může být json nebo xml.

Name	Typ	Description
json	string	Formát výměny dat v zápisu objektů JavaScriptu
xml	string	Rozšiřitelný jazyk značek

SearchAddressResult

Tento objekt je vrácen z úspěšných volání Search.

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

SearchAddressResultItem

Objekt výsledku 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. Je 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 "main" pro hlavní vchody, jako jsou přední dveře, nebo předsálí, a "minor" 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í reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
score	number	Hodnota v sadě výsledků označující relativní skóre shody mezi výsledky. Můžete ho použít k určení, že výsledek x je dvakrát tak pravděpodobný jako výsledek y, pokud je hodnota x 2x hodnota y. Hodnoty se v jednotlivých dotazech liší a jsou určeny pouze jako relativní hodnota pro jednu sadu výsledků.
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 vlevo nahoře a vpravo dole v oblasti zobrazení.

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

SearchIndexes

Indexy, jejichž rozšířená PSČ by měla být zahrnuta do výsledků.

Dostupné indexy jsou:

Addr = Rozsahy adres

Geo = Geografická oblast

PAD = adresy bodů

POI = body zájmu

Str = Ulice

XStr = Křížové ulice (průsečíky)

Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo Žádný pro žádné indexy.

Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je nutné je v případě potřeby explicitně vyžádat.

Příklady použití:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.

Name	Typ	Description
Addr	string
Geo	string
PAD	string
POI	string
Str	string
Xstr	string

SearchSummary

Souhrnný objekt pro odpověď rozhraní API Search

Name	Typ	Description
fuzzyLevel	integer	Maximální úroveň přibližnosti vyžadovaná k poskytnutí výsledků
geoBias	LatLongPairAbbreviated	Označení, kdy interní vyhledávací web použil geoprostorové předsudky ke zlepšení pořadí výsledků. V některých metodách to může být ovlivněno nastavením parametrů lat a lon, pokud jsou k dispozici. V ostatních případech je čistě interní.
limit	integer	Maximální počet odpovědí, které se vrátí
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ÍZKO nebo NON_NEAR.
totalResults	integer	Celkový počet nalezených výsledků

Sdílet prostřednictvím