Share via


Search - Get Search Address

Egy utcacím szélességi és hosszúsági koordinátáinak lekérésére használható strukturálatlan vagy lekérdezési bemeneti formátumban.

Az Get Search Address API egy HTTP-kérés GET , amely a földrajzi szélességi és hosszúsági koordinátákat adja vissza, ha egy címben vagy egy hely nevében adja meg a keresési feltételt.

Sok esetben a teljes keresési szolgáltatás túl sok lehet, például ha csak a hagyományos geokódolás érdekli. Keresés kizárólag címkereséshez is elérhető. A geokódolás úgy történik, hogy csak a kérdéses címmel vagy részleges címmel éri el a geokódvégpontot. A geokódolási keresési index lekérdezi az utcaszintű adatok fölötti összes adatot. A rendszer nem ad vissza POI-kat. Vegye figyelembe, hogy a geokódoló nagyon tolerálja az elírásokat és a hiányos címeket. Emellett mindent kezelni fog a pontos utcacímektől, utca- vagy kereszteződésektől, valamint a magasabb szintű földrajzi területektől, például a városközpontoktól, megyéktől, államoktól stb.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}
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}

URI-paraméterek

Name In Kötelező Típus Description
format
path True

ResponseFormat

A válasz kívánt formátuma. Az érték lehet json vagy xml.

api-version
query True

string

Azure Maps API verziószáma.

query
query True

string

A keresendő címnek (például "1 Microsoft way, Redmond, WA" ) megfelelően kell kódolnia az URL-címet.

btmRight
query

string

A határolókeret jobb alsó helyzete. Pl. 37.553,-122.453

countrySet
query

string[]

Ország-/régiókódok vesszővel tagolt sztringje, például FR,ES. Ez korlátozza a keresést a megadott országokra/régiókra

entityType
query

GeographicEntityType

Meghatározza a földrajzi helyeken végzett szűrés szintjét. Szűkíti a megadott földrajzi entitástípusok keresését, például csak önkormányzatot ad vissza. Az eredményként kapott válasz tartalmazza a földrajzi azonosítót és az entitástípust. Ha egynél több entitást ad meg vesszővel tagolt listaként, a végpont a "legkisebb elérhető entitást" adja vissza. A visszaadott geometria-azonosítóval lekérheti a földrajzi hely geometriája a Get Keresés Polygon API-val. Az entityType beállításakor a rendszer a következő paramétereket hagyja figyelmen kívül:

  • Címsor
  • szám
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
extendedPostalCodesFor
query

SearchIndexes[]

Indexek, amelyekhez kiterjesztett irányítószámokat kell felvenni az eredményekbe.

Az elérhető indexek a következők:

Addr = Címtartományok

Geo = Földrajzi helyek

PAD = Pontcímek

POI = Érdekes pontok

Str = Utcák

XStr = Keresztutcák (kereszteződések)

Az értéknek az indextípusok vesszővel tagolt listájának kell lennie (bármilyen sorrendben), indexek nélkül pedig a Nincs értéknek.

Alapértelmezés szerint a kiterjesztett irányítószámokat a Geo kivételével minden index tartalmazza. A földrajzi helyekre vonatkozó kiterjesztett irányítószám-listák meglehetősen hosszúak lehetnek, ezért szükség esetén explicit módon kell kérni őket.

Használati példák:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

A kiterjesztett irányítószám egy cím extendedPostalCode tulajdonságaként lesz visszaadva. A rendelkezésre állás régiófüggő.

language
query

string

Az a nyelv, amelyben a keresési eredményeket vissza kell adni. A támogatott IETF nyelvcímkék egyikének kell lennie, a kis- és nagybetűk nem különböztethetők meg. Ha a megadott nyelvű adatok nem érhetők el egy adott mezőhöz, a rendszer az alapértelmezett nyelvet használja.

Részletekért tekintse meg a támogatott nyelveket ismertető cikket.

lat
query

number

double

Szélesség, ahol az eredményeket elfogultnak kell lennie. Pl. 37.337

limit
query

integer

A visszaadott válaszok maximális száma. Alapértelmezett: 10, minimum: 1 és maximum: 100

lon
query

number

double

Hosszúság, ahol az eredményeket elfogultnak kell lennie. Pl. -121,89

ofs
query

integer

A visszaadott eredmények eltolása a teljes eredményhalmazon belül. Alapértelmezett: 0

radius
query

integer

Az eredmények meghatározott területre való korlátozásának mérőben megadott sugara

topLeft
query

string

A határolókeret bal felső helyzete. Pl. 37.553,-122.453

typeahead
query

boolean

Logikai. Ha a typeahead jelző be van állítva, a lekérdezés részleges bemenetként lesz értelmezve, és a keresés prediktív módba lép

view
query

LocalizedMapView

A View paraméter (más néven "felhasználói régió" paraméter) lehetővé teszi egy adott ország/régió megfelelő térképeinek megjelenítését a geopolitikailag vitatott régiókhoz. A különböző országok/régiók eltérő nézetekkel rendelkeznek az ilyen régiókról, és a Nézet paraméter lehetővé teszi, hogy az alkalmazás megfeleljen annak az országnak/régiónak, amelyet az alkalmazás használni fog. Alapértelmezés szerint a Nézet paraméter "Egyesített" értékre van állítva, még akkor is, ha még nem definiálta a kérésben. Az Ön felelőssége meghatározni a felhasználók helyét, majd helyesen beállítani a View paramétert az adott helyhez. Másik lehetőségként beállíthatja a "View=Auto" beállítást, amely a kérelem IP-címe alapján adja vissza a térképadatokat. A View paramétert Azure Maps a vonatkozó jogszabályoknak megfelelően kell használni, beleértve a térképekkel kapcsolatos jogszabályokat is, azon ország/régió vonatkozásában, ahol a térképeket, képeket és egyéb adatokat, valamint a Azure Maps keresztüli hozzáférésre jogosult harmadik féltől származó tartalmakat elérhetővé teszik. Példa: view=IN.

A részletekért tekintse meg a Támogatott nézetek című témakört , és tekintse meg az elérhető nézeteket.

Kérelem fejléce

Name Kötelező Típus Description
x-ms-client-id

string

Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást.

Válaszok

Name Típus Description
200 OK

SearchAddressResult

OK

Other Status Codes

ErrorResponse

Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0-folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Megjegyzés

  • Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.
  • A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID konfigurációkkal rendelkeznek.
  • Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
  • A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.
  • A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps fiókot hoz létre a Azure Portal vagy PowerShell, CLI, Azure SDK vagy REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetén javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.

Type: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Type: apiKey
In: header

Példák

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

Sample Request

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

Sample Response

{
  "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
          }
        }
      ]
    }
  ]
}

Definíciók

Name Description
Address

Az eredmény címe

AddressRanges

Az utca mindkét oldalán található címtartományt ismerteti a keresési eredményekhez. A címtartomány kezdő és záró helyének koordinátáit is tartalmazza.

BoundingBox

A nézetport bal felső és jobb alsó koordinátái által ábrázolt eredményt lefedő nézetport.

BoundingBoxCompassNotation

A hely határolókerete.

Brand

A POI-hoz társított márka

Classification

A visszaadott POI besorolása

ClassificationName

A besorolás neve

DataSources

Nem kötelező szakasz. Referenciaazonosítók a Get Keresés Polygon API-val való használathoz.

Entity

A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval.

EntryPoint

A visszaadott POI belépési pontja.

EntryPointType

A belépési pont típusa. Az érték lehet vagy alérték.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorDetail

A hiba részletei.

ErrorResponse

Hibaválasz

GeographicEntityType

Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető.

Geometry

Információ az eredmény geometriai alakjáról. Csak akkor jelenik meg, ha a típus == Földrajzi hely.

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

LocalizedMapView

A View paraméter (más néven "felhasználói régió" paraméter) lehetővé teszi egy adott ország/régió megfelelő térképeinek megjelenítését a geopolitikailag vitatott régiókhoz. A különböző országok/régiók különböző nézetekkel rendelkeznek az ilyen régiókról, és a Nézet paraméter lehetővé teszi, hogy az alkalmazás megfeleljen az alkalmazás által kiszolgálni kívánt ország/régió által megkövetelt nézetnek. Alapértelmezés szerint a View paraméter "Egyesített" értékre van állítva, még akkor is, ha még nem definiálta a kérelemben. Az Ön felelőssége, hogy meghatározza a felhasználók helyét, majd helyesen állítsa be a View paramétert az adott helyhez. Másik lehetőségként beállíthatja a "View=Auto" beállítást is, amely a kérés IP-címe alapján adja vissza a térképadatokat. Az Azure Maps View paraméterét a vonatkozó jogszabályoknak megfelelően kell használni, beleértve a térképekkel kapcsolatos jogszabályokat is, azon ország/régió tekintetében, ahol a térképeket, képeket és egyéb adatokat, valamint a Azure Maps keresztüli hozzáférésre jogosult harmadik féltől származó tartalmakat elérhetővé teszik. Példa: view=IN.

A részletekért tekintse meg a Támogatott nézetek című témakört , és tekintse meg az elérhető nézeteket.

MatchType

A fordított címkeresési művelethez tartozó egyezések típusai.

OperatingHours

PoI nyitvatartási ideje (érdekes pontok).

OperatingHoursTime

Dátumot és időpontot jelöl

OperatingHoursTimeRange

Nyitott időtartomány egy napra

PointOfInterest

A visszaadott POI részletei, beleértve az olyan információkat, mint a név, a telefon, az URL-cím és a besorolások.

PointOfInterestCategorySet

POI-kategória

QueryType

A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR.

ResponseFormat

A válasz kívánt formátuma. Az érték lehet json vagy xml.

SearchAddressResult

Ezt az objektumot egy sikeres Keresés hívás adja vissza.

SearchAddressResultItem

Eredményobjektum egy Keresés API-válaszhoz.

SearchAddressResultType

Az alábbiak egyike:

  • POI
  • Utca
  • Földrajzi hely
  • Pont címe
  • Címtartomány
  • Kereszt utca
SearchIndexes

Indexek, amelyekhez kiterjesztett irányítószámokat kell felvenni az eredményekbe.

Az elérhető indexek a következők:

Addr = Címtartományok

Geo = Földrajzi helyek

PAD = Pontcímek

POI = Érdekes pontok

Str = Utcák

XStr = Keresztutcák (kereszteződések)

Az értéknek az indextípusok vesszővel tagolt listájának kell lennie (bármilyen sorrendben), indexek nélkül pedig a Nincs értéknek.

Alapértelmezés szerint a kiterjesztett irányítószámokat a Geo kivételével minden index tartalmazza. A földrajzi helyekre vonatkozó kiterjesztett irányítószám-listák meglehetősen hosszúak lehetnek, ezért szükség esetén explicit módon kell őket kérni.

Használati példák:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

A kiterjesztett irányítószám egy cím extendedPostalCode tulajdonságaként lesz visszaadva. A rendelkezésre állás régiófüggő.

SearchSummary

Egy Keresés API-válasz összefoglaló objektuma.

Address

Az eredmény címe

Name Típus Description
boundingBox

BoundingBoxCompassNotation

A hely határolókerete.

buildingNumber

string

Az épület száma az utcán. ELAVULT, használja helyette a streetNumber parancsot.

country

string

ország/régió neve

countryCode

string

Country (Megjegyzés: Ez egy kétbetűs kód, nem ország/régió neve.)

countryCodeISO3

string

ISO alpha-3 országkód

countrySecondarySubdivision

string

Megye

countrySubdivision

string

Állam vagy tartomány

countrySubdivisionCode

string

countrySubdivisionCode az előtagja countryCode ( countryCode-countrySubdivisionCode ) és a kötőjel alkotja az ISO 3166-2 kódot. Példák: TX Texashoz, SCT Skóciához és ON Ontarióhoz.

countrySubdivisionName

string

Az ország-/régiószintű felügyeleti hierarchia első szintjének teljes neve. Ez a mező csak abban az esetben jelenik meg, ha a countrySubdivision rövidített formában jelenik meg. Csak az USA, Kanada és az Egyesült Királyság esetében támogatott.

countryTertiarySubdivision

string

Elnevezett terület

crossStreet

string

A keresztezett utca neve.

extendedPostalCode

string

Kiterjesztett irányítószám (a rendelkezésre állás a régiótól függ).

freeformAddress

string

Az eredmény származási országának/régiójának formázási szabályai szerint formázott címsor, illetve ország/régió esetén annak teljes országának/régiójának neve.

localName

string

Egy olyan címösszetevő, amely egy olyan földrajzi terület vagy hely nevét jelöli, amely több címezhető objektumot csoportosít címzés céljából, felügyeleti egység nélkül. Ez a mező a tulajdonság összeállítására freeformAddress szolgál. localName a postai önkormányzatot jelöli. A helytől localName függően a város vagy város általánosan ismert neve. Egy város vagy város általánosan ismert neveként használja localName a következőt: municipality.

municipality

string

Város /város
Megjegyzés: municipality a lakótelepi önkormányzatot jelöli. A helytől függően az municipality érték eltérhet egy város vagy város általánosan ismert nevétől. A város vagy város általánosan ismert nevének használata javasolt az localName érték helyett municipality .

municipalitySubdivision

string

Al- és Szuperváros

neighbourhood

string

A szomszédság egy földrajzilag honosított terület egy városban vagy városban, jellegzetes jellemzőkkel és a lakosság közötti társadalmi interakciókkal.

postalCode

string

Irányítószám / Irányítószám

routeNumbers

string[]

Az utca egyértelmű azonosítására használt kódok

street

string

Az utcanév. ELAVULT, használja helyette a streetName nevet.

streetName

string

Az utcanév.

streetNameAndNumber

string

Az utca neve és száma.

streetNumber

string

Az épület száma az utcán.

AddressRanges

Az utca mindkét oldalán található címtartományt ismerteti a keresési eredményekhez. A címtartomány kezdő és záró helyének koordinátáit is tartalmazza.

Name Típus Description
from

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

rangeLeft

string

Címtartomány az utca bal oldalán.

rangeRight

string

Címtartomány az utca jobb oldalán.

to

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

BoundingBox

A nézetport bal felső és jobb alsó koordinátái által ábrázolt eredményt lefedő nézetport.

Name Típus Description
btmRightPoint

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

topLeftPoint

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

BoundingBoxCompassNotation

A hely határolókerete.

Name Típus Description
entity

Entity

A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval.

northEast

string

Észak-keleti szélesség, a határolókeret hosszúsági koordinátája vesszővel tagolt lebegőpontos lebegőpontosként

southWest

string

Dél-nyugati szélesség, a határolókeret hosszúsági koordinátája vesszővel tagolt úszókként

Brand

A POI-hoz társított márka

Name Típus Description
name

string

A márka neve

Classification

A visszaadott POI besorolása

Name Típus Description
code

string

Kód tulajdonság

names

ClassificationName[]

Névtömb

ClassificationName

A besorolás neve

Name Típus Description
name

string

Name tulajdonság

nameLocale

string

Name Locale tulajdonság

DataSources

Nem kötelező szakasz. Referenciaazonosítók a Get Keresés Polygon API-val való használathoz.

Name Típus Description
geometry

Geometry

Információ az eredmény geometriai alakjáról. Csak akkor jelenik meg, ha a típus == Földrajzi hely.

Entity

A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval.

Name Típus Description
position

string

Pozíció entitás

EntryPoint

A visszaadott POI belépési pontja.

Name Típus Description
position

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

type

EntryPointType

A belépési pont típusa. Az érték lehet vagy alérték.

EntryPointType

A belépési pont típusa. Az érték lehet vagy alérték.

Name Típus Description
main

string

minor

string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.

type

string

A további adattípus.

ErrorDetail

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.

code

string

A hibakód.

details

ErrorDetail[]

A hiba részletei.

message

string

A hibaüzenet.

target

string

A hiba célja.

ErrorResponse

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.

GeographicEntityType

Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető.

Name Típus Description
Country

string

ország/régió neve

CountrySecondarySubdivision

string

Megye

CountrySubdivision

string

Állam vagy tartomány

CountryTertiarySubdivision

string

Elnevezett terület

Municipality

string

Város /város

MunicipalitySubdivision

string

Al- és Szuperváros

Neighbourhood

string

Szomszédságában

PostalCodeArea

string

Irányítószám / Irányítószám

Geometry

Információ az eredmény geometriai alakjáról. Csak akkor jelenik meg, ha a típus == Földrajzi hely.

Name Típus Description
id

string

Adja át ezt geometriaazonosítóként a Get Keresés Polygon API-nak az eredmény geometriai információinak lekéréséhez.

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

Name Típus Description
lat

number

Latitude tulajdonság

lon

number

Hosszúság tulajdonság

LocalizedMapView

A View paraméter (más néven "felhasználói régió" paraméter) lehetővé teszi egy adott ország/régió megfelelő térképeinek megjelenítését a geopolitikailag vitatott régiókhoz. A különböző országok/régiók különböző nézetekkel rendelkeznek az ilyen régiókról, és a Nézet paraméter lehetővé teszi, hogy az alkalmazás megfeleljen az alkalmazás által kiszolgálni kívánt ország/régió által megkövetelt nézetnek. Alapértelmezés szerint a View paraméter "Egyesített" értékre van állítva, még akkor is, ha még nem definiálta a kérelemben. Az Ön felelőssége, hogy meghatározza a felhasználók helyét, majd helyesen állítsa be a View paramétert az adott helyhez. Másik lehetőségként beállíthatja a "View=Auto" beállítást is, amely a kérés IP-címe alapján adja vissza a térképadatokat. Az Azure Maps View paraméterét a vonatkozó jogszabályoknak megfelelően kell használni, beleértve a térképekkel kapcsolatos jogszabályokat is, azon ország/régió tekintetében, ahol a térképeket, képeket és egyéb adatokat, valamint a Azure Maps keresztüli hozzáférésre jogosult harmadik féltől származó tartalmakat elérhetővé teszik. Példa: view=IN.

A részletekért tekintse meg a Támogatott nézetek című témakört , és tekintse meg az elérhető nézeteket.

Name Típus Description
AE

string

Egyesült Arab Emírségek (arab nézet)

AR

string

Argentína (argentin nézet)

Auto

string

Adja vissza a leképezési adatokat a kérelem IP-címe alapján.

BH

string

Bahrein (arab nézet)

IN

string

India (indiai nézet)

IQ

string

Irak (arab nézet)

JO

string

Jordánia (arab nézet)

KW

string

Kuvait (arab nézet)

LB

string

Libanon (arab nézet)

MA

string

Marokkó (marokkói nézet)

OM

string

Omán (arab nézet)

PK

string

Pakisztán (pakisztáni nézet)

PS

string

Palesztin Hatóság (arab nézet)

QA

string

Katar (arab nézet)

SA

string

Szaúd-Arábia (arab nézet)

SY

string

Szíria (arab nézet)

Unified

string

Egyesített nézet (egyebek)

YE

string

Jemen (arab nézet)

MatchType

A fordított címkeresési művelethez tartozó egyezések típusai.

Name Típus Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

PoI nyitvatartási ideje (érdekes pontok).

Name Típus Description
mode

string

A kérelemben használt érték: none vagy "nextSevenDays"

timeRanges

OperatingHoursTimeRange[]

A következő 7 nap időtartományainak listája

OperatingHoursTime

Dátumot és időpontot jelöl

Name Típus Description
date

string

Az aktuális naptárdátumot jelöli a POI időzónájában, például:"2019-02-07".

hour

integer

Az órák 24 órás formátumban vannak a POI helyi idejében; lehetséges értékek: 0-23.

minute

integer

A percek a poI helyi idejében vannak; lehetséges értékek: 0-59.

OperatingHoursTimeRange

Nyitott időtartomány egy napra

Name Típus Description
endTime

OperatingHoursTime

A következő 7 napos tartomány azon pontja, amikor egy adott POI zárva van, vagy a tartomány kezdete, ha az a tartomány előtt lett lezárva.

startTime

OperatingHoursTime

A következő 7 napos tartomány azon pontja, amikor egy adott POI meg van nyitva, vagy a tartomány kezdete, ha a tartomány előtt nyitották meg.

PointOfInterest

A visszaadott POI részletei, beleértve az olyan információkat, mint a név, a telefon, az URL-cím és a besorolások.

Name Típus Description
brands

Brand[]

Brands tömb. A visszaadott POI márkaneve.

categories

string[]

Kategóriák tömb

categorySet

PointOfInterestCategorySet[]

A legspecifikusabb POI-kategóriák listája

classifications

Classification[]

Besorolási tömb

name

string

A POI tulajdonság neve

openingHours

OperatingHours

PoI nyitvatartási ideje (érdekes pontok).

phone

string

Telefonszám tulajdonság

url

string

Webhely URL-címe tulajdonság

PointOfInterestCategorySet

POI-kategória

Name Típus Description
id

integer

Kategóriaazonosító

QueryType

A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR.

Name Típus Description
NEARBY

string

Keresés egy meghatározott sugarú szélesség és hosszúság körül hajtották végre

NON_NEAR

string

Keresés globálisan, egy bizonyos szélességre és hosszúságra való torzítás nélkül, meghatározott sugár nélkül hajtották végre

ResponseFormat

A válasz kívánt formátuma. Az érték lehet json vagy xml.

Name Típus Description
json

string

A JavaScript object Notation Data Interchange formátuma

xml

string

Az extensible Markup Language (Bővíthető korrektúranyelv)

SearchAddressResult

Ezt az objektumot egy sikeres Keresés hívás adja vissza.

Name Típus Description
results

SearchAddressResultItem[]

A Keresés API-eredmények listája.

summary

SearchSummary

Keresés API-válasz összefoglaló objektuma

SearchAddressResultItem

Eredményobjektum egy Keresés API-válaszhoz.

Name Típus Description
address

Address

Az eredmény címe

addressRanges

AddressRanges

Az utca mindkét oldalán található címtartományt ismerteti a keresési eredményekhez. A címtartomány kezdő és záró helyének koordinátáit is tartalmazza.

dataSources

DataSources

Nem kötelező szakasz. Referenciageometria-azonosító a Get Keresés Polygon API-val való használathoz.

detourTime

integer

Kitérő idő másodpercben. Csak a Keresés Route API-nak indított hívások esetén adva vissza.

dist

number

Egyenes vonal távolsága az eredmény és a földrajzi hely között méterben.

entityType

GeographicEntityType

Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető.

entryPoints

EntryPoint[]

EntryPoint-tömb. Ezek a helyszínen elérhető bejáratok típusait írják le. A típus lehet "fő" a főbejáratok, mint például a bejárati ajtó, vagy egy előszoba, és a "minor", az oldalsó és hátsó ajtók.

id

string

Id tulajdonság

info

string

Információk az eredmény eredeti adatforrásáról. Támogatási kérelmekhez használatos.

matchType

MatchType

Az egyezés típusával kapcsolatos információk.

Az alábbiak egyike:

  • AddressPoint
  • HouseNumberRange
  • Utca
poi

PointOfInterest

A visszaadott POI részletei, beleértve az olyan információkat, mint a név, a telefon, az URL-cím és a besorolások.

position

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

score

number

Az eredményhalmazon belüli érték, amely az eredmények közötti relatív egyezési pontszámot jelzi. Ezzel megállapíthatja, hogy az x eredmény kétszer akkora valószínűséggel lesz releváns, mint az y, ha az x értéke 2x az y értékével. Az értékek lekérdezésenként eltérőek, és csak egy eredményhalmaz relatív értékeként szolgálnak.

type

SearchAddressResultType

Az alábbiak egyike:

  • POI
  • Utca
  • Földrajzi hely
  • Pont címe
  • Címtartomány
  • Kereszt utca
viewport

BoundingBox

A nézetport bal felső és jobb alsó koordinátái által ábrázolt eredményt lefedő nézetport.

SearchAddressResultType

Az alábbiak egyike:

  • POI
  • Utca
  • Földrajzi hely
  • Pont címe
  • Címtartomány
  • Kereszt utca
Name Típus Description
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchIndexes

Indexek, amelyekhez kiterjesztett irányítószámokat kell felvenni az eredményekbe.

Az elérhető indexek a következők:

Addr = Címtartományok

Geo = Földrajzi helyek

PAD = Pontcímek

POI = Érdekes pontok

Str = Utcák

XStr = Keresztutcák (kereszteződések)

Az értéknek az indextípusok vesszővel tagolt listájának kell lennie (bármilyen sorrendben), indexek nélkül pedig a Nincs értéknek.

Alapértelmezés szerint a kiterjesztett irányítószámokat a Geo kivételével minden index tartalmazza. A földrajzi helyekre vonatkozó kiterjesztett irányítószám-listák meglehetősen hosszúak lehetnek, ezért szükség esetén explicit módon kell őket kérni.

Használati példák:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

A kiterjesztett irányítószám egy cím extendedPostalCode tulajdonságaként lesz visszaadva. A rendelkezésre állás régiófüggő.

Name Típus Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Egy Keresés API-válasz összefoglaló objektuma.

Name Típus Description
fuzzyLevel

integer

Az eredmények megadásához szükséges maximális intelligens szint.

geoBias

LatLongPairAbbreviated

Annak jelzése, hogy a belső keresőmotor mikor alkalmazott térinformatikai torzításokat az eredmények rangsorolásának javítása érdekében. Egyes metódusok ezt a lat és a lon paraméterek beállításával befolyásolhatják, ahol elérhetők. Más esetekben ez tisztán belső.

limit

integer

A visszaadott válaszok maximális száma

numResults

integer

A válaszban szereplő eredmények száma.

offset

integer

A visszaadott eredmények kezdő eltolása a teljes eredményhalmazon belül.

query

string

A keresési eredmények létrehozásához használt lekérdezési paraméter.

queryTime

integer

A lekérdezés feloldásával töltött idő ezredmásodpercben.

queryType

QueryType

A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR.

totalResults

integer

A talált eredmények teljes száma.