Search - Get Search Address

Služba:

Maps

Verze rozhraní API:

1.0

Umožňuje získat souřadnice zeměpisné šířky a délky adresy v nestrukturovaném formátu nebo ve vstupním formátu dotazu.

Rozhraní API Get Search Address je požadavek HTTP GET vrací souřadnice zeměpisné šířky a délky při předání adresy nebo názvu místa jako kritérií hledání.

V mnoha případech může být kompletní vyhledávací služba příliš velká, například pokud vás zajímá pouze tradiční geokódování. K vyhledávání adres se dá přistupovat také výhradně. Geokódování se provádí stisknutím koncového bodu geografického kódu s pouze adresou nebo částečnou adresou. Index vyhledávání geokódování bude dotazován na vše nad daty na úrovni ulice. Nebudou vráceny žádné ukazatele POI. Mějte na paměti, že geokódér je velmi odolný proti překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo průsečíků a také na vyšší úrovni geografických oblastí, jako jsou centra měst, okresy, státy atd.

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

S volitelnými parametry:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&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 služby Azure Maps
query	query	True	string	Adresa, kterou chcete vyhledat (např. "1 Microsoft way, Redmond, WA"), musí být správně zakódovaná.
btmRight	query		string	Pravá dolní pozice ohraničujícího rámečku. Např. 37,553,-122,453
countrySet	query		string[]	Čárkami oddělený řetězec kódů zemí/oblastí, např. FR, ES. Tím se omezí hledání na zadané země nebo oblasti.
entityType	query		GeographicEntityType	Určuje úroveň filtrování prováděné v geografických oblastech. Zpřesní hledání zadaných typů entit, například vrácení 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". Id vrácené geometrie lze použít k získání geometrie dané geografické oblasti prostřednictvím Získat polygon rozhraní API pro vyhledávání. Při nastavení entityType se ignorují následující parametry: nadpis číslo returnRoadUse returnSpeedLimit roadUse returnMatchType
extendedPostalCodesFor	query		SearchIndexes[]	Do výsledků by měly být zahrnuty indexy, pro které by měly být zahrnuté rozšířené POŠTOVNÍ směrovací čísla. Dostupné indexy jsou: Addr = Rozsahy adres geo = zeměpisné oblasti 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Č zahrnuté pro všechny indexy s výjimkou Geo. Rozšířené seznamy PSČ pro zeměpisné oblasti můžou být poměrně dlouhé, takže je potřeba je explicitně vyžádat v případě potřeby. Příklady použití: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozšířené PSČ se vrátí jako extendedPostalCode vlastnost adresy. Dostupnost je závislá na oblasti.
language	query		string	Jazyk, ve kterém mají být vráceny výsledky hledání. Měla 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 dostupná, použije se výchozí jazyk. Podrobnosti najdete v podporovaných jazycích.
lat	query		number (double)	Zeměpisná šířka, kde by měly být výsledky zkreslené. Např. 37.337
limit	query		integer minimum: 1 maximum: 100	Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 10, minimum: 1 a maximum: 100
lon	query		number (double)	Zeměpisná délka, kde by měly být výsledky zkreslené. Např. -121,89
ofs	query		integer minimum: 0 maximum: 1900	Počáteční posun vrácených výsledků v celé sadě výsledků Výchozí hodnota: 0
radius	query		integer	Poloměr v metrech k výsledkům, které mají být omezeny na definovanou oblast
topLeft	query		string	Levá horní pozice ohraničujícího rámečku. Např. 37,553,-122,453
typeahead	query		boolean	Booleovský. Pokud je nastavený příznak typeahead, dotaz se interpretuje jako částečný vstup a hledání přejde do prediktivního režimu.
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 geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení ve službě Azure Maps se musí používat v souladu s příslušný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 přes Azure Maps, je zpřístupněn. Příklad: view=IN. Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.

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

Odpovědi

Name	Typ	Description
200 OK	SearchAddressResult	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Jedná se o Microsoft Entra OAuth 2.0 Flow. Při spárování s přístupu na základě role Azure se dá řídit přístup k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role Azure slouží k určení přístupu k jednomu nebo více úč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 více oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit koncepty ověřování . Stručně ř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 rozsahy.

Poznámka:

• Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému prostředku Azure Maps aplikace žádá o přístup. Můžete ho získat z rozhraní API pro správu Maps.
• Authorization URL je specifická pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné adresy URL autorizace a konfigurace MICROSOFT Entra ID.
• Řízení přístupu na základě role Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad AZURE SDK nebo rozhraní REST API.
• Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
• Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

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

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

Díky tomuto klíči má každá aplikace přístup ke všem rozhraní REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat důvěrných klientských aplikací přístup k rozhraním REST API služby Azure Maps, aby bylo možné klíč 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 Vypsat SAS v prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad SDK Azure 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 Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze 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ů na prostředku účtu Map omezit zneužití vykreslování a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Ukázkový požadavek

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Ukázková odpověď

Stavový kód:

200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "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 980525544",
        "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	Oblast zobrazení, která pokrývá výsledek reprezentovaný souřadnicemi oblasti zobrazení v levém horním a pravém dolním rohu.
BoundingBoxCompassNotation	Ohraničující rámeček umístění.
Brand	Značka přidružená k poi
Classification	Klasifikace vrácené poI
ClassificationName	Název klasifikace
DataSources	Volitelný oddíl. Referenční ID pro použití s rozhraním API Get Search Polygon.
Entity	Zdroj typu entity ohraničujícího rámečku. V případě zpětného geokódování se toto umístění vždy rovná pozici.
EntryPoint	Vstupní bod pro vrácenou žádost o zadání.
EntryPointType	Typ vstupního bodu. Hodnota může být hlavní nebo menší.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
GeographicEntityType	Typ entity zeměpisu Je k dispozici pouze v případech, kdy byla požadována entita EntityType a je k dispozici.
Geometry	Informace o geometrickém tvaru výsledku Je k dispozici pouze v případě, že typ == Zeměpis.
LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka s krátkými názvy "lat" & "lon".
LocalizedMapView	Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení ve službě Azure Maps se musí používat v souladu s příslušný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 přes Azure Maps, je zpřístupněn. Příklad: view=IN. Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.
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ého rozsahu pro den
PointOfInterest	Podrobnosti o vrácené poI, včetně informací, jako je jméno, telefon, adresa URL a klasifikace.
PointOfInterestCategorySet	Kategorie POI
QueryType	Typ vráceného dotazu: NEDALE nebo NON_NEAR.
ResponseFormat	Požadovaný formát odpovědi Hodnota může být json nebo xml.
SearchAddressResult	Tento objekt se vrátí z úspěšných volání hledání.
SearchAddressResultItem	Objekt výsledku pro odpověď rozhraní API vyhledávání
SearchAddressResultType	Jedna z těchto možností: POI Ulice Zeměpis Adresa bodu Rozsah adres Křížová ulice
SearchIndexes	Do výsledků by měly být zahrnuty indexy, pro které by měly být zahrnuté rozšířené POŠTOVNÍ směrovací čísla. Dostupné indexy jsou: Addr = Rozsahy adres geo = zeměpisné oblasti 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Č zahrnuté pro všechny indexy s výjimkou Geo. Rozšířené seznamy PSČ pro zeměpisné oblasti můžou být poměrně dlouhé, takže je potřeba je explicitně vyžádat v případě potřeby. Příklady použití: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozšířené PSČ se vrátí jako extendedPostalCode vlastnost adresy. Dostupnost je závislá na oblasti.
SearchSummary	Souhrnný objekt odpovědi rozhraní API služby Search

Address

Objekt

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 argument streetNumber.
country	string	název země/oblasti
countryCode	string	Země (Poznámka: Jedná se o dvoumísmenný kód, nikoli název země/oblasti.)
countryCodeISO3	string	Kód země ISO alfa-3
countrySecondarySubdivision	string	Kraj
countrySubdivision	string	Stát nebo provincie
countrySubdivisionCode	string	countrySubdivisionCode 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 pro správu země/oblasti. Toto pole se zobrazí pouze v případě, že se zeměSubdivision 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á se překříží.
extendedPostalCode	string	Rozšířená PSČ (dostupnost závisí na oblasti).
freeformAddress	string	Řádek adresy naformátovaný podle pravidel formátování země nebo oblasti původu výsledku nebo v případě země/oblasti má úplný název země/oblasti.
localName	string	Součást 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 slouží k sestavení vlastnosti freeformAddress. localName představuje 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 místo localNamemunicipality .
municipality	string	Město / město Poznámka: municipality představuje místní obec. V závislosti na umístění se hodnota municipality může lišit od běžně známého názvu města nebo města. U běžně známého názvu města nebo města se navrhuje, aby se místo hodnoty localName použila hodnota municipality.
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Čtvrť 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Č / PSČ
routeNumbers	string[]	Kódy používané k jednoznačné identifikaci ulice
street	string	Název ulice. ZASTARALÉ, použijte místo toho název ulice.
streetName	string	Název ulice.
streetNameAndNumber	string	Název a číslo ulice.
streetNumber	string	Číslo budovy na ulici.

AddressRanges

Objekt

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í reprezentované jako zeměpisná šířka a délka s krátkými názvy "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 s krátkými názvy "lat" & "lon".

BoundingBox

Objekt

Oblast zobrazení, která pokrývá výsledek reprezentovaný souřadnicemi oblasti zobrazení v levém horním a pravém dolním rohu.

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

BoundingBoxCompassNotation

Objekt

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

Name	Typ	Description
entity	Entity	Zdroj typu entity ohraničujícího rámečku. V případě zpětného geokódování se toto umístění vždy rovná pozici.
northEast	string	Severní východ zeměpisné šířky, souřadnice zeměpisné délky ohraničujícího rámečku jako čárkami oddělené plováky
southWest	string	Zeměpisná šířka – západ, souřadnice zeměpisné délky ohraničujícího rámečku jako čárkami oddělené plováky

Brand

Objekt

Značka přidružená k poi

Name	Typ	Description
name	string	Název značky

Classification

Objekt

Klasifikace vrácené poI

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

ClassificationName

Objekt

Název klasifikace

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

DataSources

Objekt

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

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

Entity

Výčet

Zdroj typu entity ohraničujícího rámečku. V případě zpětného geokódování se toto umístění vždy rovná pozici.

Hodnota	Description
position	Entita Pozice

EntryPoint

Objekt

Vstupní bod pro vrácenou žádost o zadání.

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

EntryPointType

Výčet

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

Hodnota	Description
main
minor

ErrorAdditionalInfo

Objekt

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

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

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

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GeographicEntityType

Výčet

Typ entity zeměpisu Je k dispozici pouze v případech, kdy byla požadována entita EntityType a je k dispozici.

Hodnota	Description
Country	název země/oblasti
CountrySecondarySubdivision	Kraj
CountrySubdivision	Stát nebo provincie
CountryTertiarySubdivision	Pojmenovaná oblast
Municipality	Město / město
MunicipalitySubdivision	Sub / Super City
Neighbourhood	Sousedství
PostalCodeArea	PSČ / PSČ

Geometry

Objekt

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

Name	Typ	Description
id	string	Předejte ho jako geometryId do Get Search Polygon API k načtení informací o geometrii pro tento výsledek.

LatLongPairAbbreviated

Objekt

Umístění reprezentované jako zeměpisná šířka a délka s krátkými názvy "lat" & "lon".

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

LocalizedMapView

Výčet

Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení ve službě Azure Maps se musí používat v souladu s příslušný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 přes Azure Maps, je zpřístupněn. Příklad: view=IN.

Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.

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

MatchType

Výčet

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

Hodnota	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Objekt

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

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

OperatingHoursTime

Objekt

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 ve formátu 24 hodin v místním čase nákupního práva; možné hodnoty jsou 0 až 23.
minute	integer	Minuty se nacházejí v místním čase poI; možné hodnoty jsou 0 až 59.

OperatingHoursTimeRange

Objekt

Otevření časového rozsahu pro den

Name	Typ	Description
endTime	OperatingHoursTime	Bod v následujícím 7denním rozsahu, kdy je daná poI uzavřena, nebo začátek rozsahu, pokud byl uzavřen před rozsahem.
startTime	OperatingHoursTime	Bod v následujícím 7denním rozsahu, kdy se daná poI otevírá, nebo začátek rozsahu, pokud byl otevřen před rozsahem.

PointOfInterest

Objekt

Podrobnosti o vrácené 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ácenou žádost o pomoc.
categories	string[]	Pole kategorií
categorySet	PointOfInterestCategorySet[]	Seznam nejvýrazně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ího čísla
url	string	Vlastnost url webu

PointOfInterestCategorySet

Objekt

Kategorie POI

Name	Typ	Description
id	integer	ID kategorie

QueryType

Výčet

Typ vráceného dotazu: NEDALE nebo NON_NEAR.

Hodnota	Description
NEARBY	Hledání bylo provedeno kolem určité zeměpisné šířky a délky s definovaným poloměrem.
NON_NEAR	Vyhledávání bylo provedeno globálně, bez předsudků na určitou zeměpisnou šířku a délku a bez definovaného poloměru.

ResponseFormat

Výčet

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

Hodnota	Description
json	formát výměny dat javascriptového objektu
xml	rozšiřitelného jazyka značek

SearchAddressResult

Objekt

Tento objekt se vrátí z úspěšných volání hledání.

Name	Typ	Description
results	SearchAddressResultItem[]	Seznam výsledků rozhraní API vyhledávání
summary	SearchSummary	Souhrnný objekt odpovědi rozhraní API služby Search

SearchAddressResultItem

Objekt

Objekt výsledku pro odpověď rozhraní API vyhledávání

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. ID referenční geometrie pro použití s rozhraním API Get Search Polygon.
detourTime	integer	Doba objížďky v sekundách. Vráceno pouze pro volání rozhraní API pro vyhledávání podél trasy.
dist	number (double)	Přímá vzdálenost mezi výsledkem a umístěním geobias v metrech.
entityType	GeographicEntityType	Typ entity zeměpisu Je k dispozici pouze v případech, kdy byla požadována entita EntityType 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 "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é 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 s krátkými názvy "lat" & "lon".
score	number (double)	Hodnota v sadě výsledků označující relativní odpovídající skóre mezi výsledky. To můžete použít k určení, že výsledek x je dvakrát tak pravděpodobné, že bude relevantní jako výsledek y, pokud je hodnota x 2x hodnota y. Hodnoty se mezi dotazy liší a jsou určeny pouze jako relativní hodnota pro jednu sadu výsledků.
type	SearchAddressResultType	Jedna z těchto možností: POI Ulice Zeměpis Adresa bodu Rozsah adres Křížová ulice
viewport	BoundingBox	Oblast zobrazení, která pokrývá výsledek reprezentovaný souřadnicemi oblasti zobrazení v levém horním a pravém dolním rohu.

SearchAddressResultType

Výčet

Jedna z těchto možností:

• POI
• Ulice
• Zeměpis
• Adresa bodu
• Rozsah adres
• Křížová ulice

Hodnota	Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Výčet

Do výsledků by měly být zahrnuty indexy, pro které by měly být zahrnuté rozšířené POŠTOVNÍ směrovací čísla.

Dostupné indexy jsou:

Addr = Rozsahy adres

geo = zeměpisné oblasti

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Č zahrnuté pro všechny indexy s výjimkou Geo. Rozšířené seznamy PSČ pro zeměpisné oblasti můžou být poměrně dlouhé, takže je potřeba je explicitně vyžádat v případě potřeby.

Příklady použití:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

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

Hodnota	Description
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Objekt

Souhrnný objekt odpovědi rozhraní API služby Search

Name	Typ	Description
fuzzyLevel	integer	Maximální úroveň přibližné hodnoty potřebná k zadání výsledků.
geoBias	LatLongPairAbbreviated	Označení, kdy interní vyhledávací modul 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, pokud jsou k dispozici. V jiných případech je to čistě interní.
limit	integer	Maximální počet vrácených odpovědí
numResults	integer	Počet výsledků v odpovědi
offset	integer	Počáteční posun vrácených výsledků v celé sadě výsledků.
query	string	Parametr dotazu, který se použil k vytvoření těchto výsledků hledání.
queryTime	integer	Čas strávený překladem dotazu v milisekundách
queryType	QueryType	Typ vráceného dotazu: NEDALE nebo NON_NEAR.
totalResults	integer	Celkový počet nalezených výsledků