Search - Post Search Address Batch
A használatával lekérdezések kötegét küldheti el a Keresés Address API-nak egyetlen aszinkron kérésben.
Az Post Search Address Batch
API egy HTTP-kérésPOST
, amely lekérdezések kötegeit küldi Keresés Address API-nak egyetlen szinkron API-hívásban. Meghívhatja Keresés Address Batch API-t aszinkron (aszinkron) vagy szinkron (szinkronizálási) futtatáshoz. Az aszinkron API lehetővé teszi, hogy a hívó legfeljebb 10 000 lekérdezést kötenek össze, és akár 100 lekérdezést szinkronizáljon az API-val.
Szinkron batch-kérelem elküldése
A szinkron API használata egyszerű kötegelt kérésekhez ajánlott. Amikor a szolgáltatás kérést kap, a batch-elemek kiszámítása után azonnal válaszol, és később nem lesz lehetőség az eredmények lekérésére. A szinkron API időtúllépési hibát (408-ra adott válasz) ad vissza, ha a kérés 60 másodpercnél tovább tart. Ehhez az API-hoz a kötegelemek száma 100-ra van korlátozva.
POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
Aszinkron Batch-kérelem elküldése
Az aszinkron API alkalmas nagy mennyiségű, viszonylag összetett keresési kérés feldolgozására
- Lehetővé teszi az eredmények lekérését egy külön hívásban (több letöltés is lehetséges).
- Az aszinkron API megbízhatóságra van optimalizálva, és várhatóan nem fog időtúllépésbe ütközni.
- Ehhez az API-hoz a kötegelemek száma legfeljebb 10 000 lehet.
Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibaadatok nem érhetők el. Az aszinkron válaszok tárolása 14 napig történik. Az átirányítási URL-cím 404-et ad vissza, ha a lejárati idő után használják.
Vegye figyelembe, hogy az aszinkron kötegelt kérés hosszú ideig futó művelet. Íme egy tipikus műveletsor:
- Az ügyfél Keresés Cím Batch-kérést
POST
küld a Azure Maps.
POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}
A kiszolgáló az alábbiak egyikével válaszol:
HTTP
202 Accepted
– A Batch-kérelem el lett fogadva.HTTP
Error
– Hiba történt a Batch-kérelem feldolgozása során. Ez lehet egy400 Bad Request
vagy bármely másError
állapotkód.Ha a kötegkérelmet sikeresen elfogadták, a
Location
válasz fejléce tartalmazza a kötegelt kérelem eredményeinek letöltésére vonatkozó URL-címet. Az állapot URI-ja a következőképpen néz ki:
GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- Az ügyfél kérést
GET
küld a 3. lépésben beszerzett letöltési URL-címre a kötegelt eredmények letöltéséhez.
POST törzs a Batch-kérelemhez
A keresési cím lekérdezéseinek elküldéséhez olyan kérést POST
kell használnia, amelyben a kérelem törzse json
formátumban fogja tartalmazni a batchItems
tömböt, a fejléc pedig értékre Content-Type
application/json
lesz állítva. Íme egy mintakérés törzse, amely 5 keresési címlekérdezést tartalmaz:
{
"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"}
]
}
A kötegekben található keresési cím lekérdezések csak részleges URL-címek a protokoll, az alap URL-cím, az elérési út, az api-verzió és az előfizetési kulcs nélkül . A támogatott keresési címekURI-paramétereinek bármelyikét elfogadhatja. A keresési cím lekérdezésében szereplő sztringértékeket megfelelően kell feloldani (például a " karaktert a \ karakterrel kell feloldani), és megfelelő URL-kódolásúnak kell lennie.
Az aszinkron API lehetővé teszi, hogy a hívó legfeljebb 10 000 lekérdezést kötenek össze, és legfeljebb 100 lekérdezést szinkronizáljon az API-val, és a kötegnek legalább 1 lekérdezést kell tartalmaznia.
Aszinkron Batch-eredmények letöltése
Az aszinkron kötegeredmények letöltéséhez kérést GET
küld a kötegletöltési végpontnak. Ez a Location
letöltési URL-cím lekérhető egy sikeres POST
kötegelt kérelem fejlécéből, és a következőképpen néz ki:
https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
A kötegeredmények letöltésének tipikus műveletsorai a következők:
Az ügyfél kérést
GET
küld a letöltési URL-cím használatával.A kiszolgáló az alábbiak egyikével válaszol:
HTTP
202 Accepted
– A Batch-kérést elfogadták, de még folyamatban van a feldolgozás. Próbálkozzon újra egy ideig.HTTP
200 OK
– A Batch-kérelem feldolgozása sikerült. A válasz törzse tartalmazza az összes kötegelt eredményt.
Batch-válaszmodell
A visszaadott adattartalom hasonló az aszinkron és szinkronizálási kérelmekhez. Az aszinkron kötegkérelem eredményeinek letöltésekor, ha a köteg feldolgozása befejeződött, a válasz törzse tartalmazza a kötegelt választ. Ez a kötegelt válasz tartalmaz egy summary
összetevőt, amely azt jelzi, hogy az totalRequests
eredeti kötegkérelm successfulRequests
részét képezte, azaz a sikeresen végrehajtott lekérdezéseket. A batch-válasz egy batchItems
tömböt is tartalmaz, amely a batch-kérelem minden egyes lekérdezésére választ tartalmaz. A batchItems
pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. Minden elem tartalmaz batchItems
statusCode
és response
mezőket. Mindegyik response
a batchItems
következő típusok egyikét tartalmazza:
SearchAddressResult
– Ha a lekérdezés sikeresen befejeződött.Error
– Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egycode
és egymessage
elemet fog tartalmazni.
Íme egy minta Batch-válasz 2 sikeres és 1 sikertelen eredménnyel:
{
"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
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
format
|
path | True |
A válasz kívánt formátuma. Csak |
|
api-version
|
query | True |
string |
Azure Maps API verziószáma. |
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. |
Kérelem törzse
Name | Típus | Description |
---|---|---|
batchItems |
A feldolgozandó lekérdezések listája. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Csak aszinkron kérés esetén támogatott. Kérelem elfogadva: A kérelem feldolgozásra el lett fogadva. Az eredmények újrapróbálkozásához vagy eléréséhez használja a Hely fejlécében található URL-címet. Fejlécek Location: string |
|
Other Status Codes |
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.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
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.
Típus:
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.
Típus:
apiKey
In:
header
Példák
An Address Geocoding Batch API call containing 5 Address Geocoding API queries
Mintakérelem
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"
}
]
}
Mintaválasz
{
"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
}
}
]
}
]
}
}
]
}
Operation-Location: URL to download the results of the long-running batch request.
Definíciók
Name | Description |
---|---|
Address |
Az eredmény címe |
Address |
Az utca mindkét oldalán található címtartományt ismerteti a keresési eredményhez. A címtartomány kezdő és záró helyének koordinátáit tartalmazza. |
Batch |
Ez a típus a Batch szolgáltatás kérelemtörzsét jelöli. |
Batch |
Batch-kérelemobjektum |
Bounding |
A nézetport bal felső és jobb alsó koordinátái által képviselt eredményt lefedő nézetport. |
Bounding |
A hely határolókerete. |
Brand |
A POI-hoz társított márka |
Classification |
A visszaadott POI besorolása |
Classification |
A besorolás neve |
Data |
Nem kötelező szakasz. Referenciaazonosítók a Get Keresés Polygon API-hoz. |
Entity |
A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval. |
Entry |
A visszaadott POI belépési pontja. |
Entry |
A belépési pont típusa. Az érték lehet fő vagy alérték. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Geographic |
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. |
Json |
A válasz kívánt formátuma. Csak |
Lat |
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon". |
Match |
A fordított címkeresési művelet egyezésének típusai. |
Operating |
A POI nyitvatartási ideje (érdekes pontok). |
Operating |
Dátumot és időpontot jelöl |
Operating |
Nyitott időtartomány egy napra |
Point |
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. |
Point |
POI-kategória |
Query |
A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR. |
Response |
A lekérdezés eredménye. SearchAddressResult ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyéb módon. |
Search |
Az Keresés Address Batch szolgáltatáshívásából visszaadott elem. |
Search |
Ezt az objektumot egy sikeres Keresés Batch-szolgáltatáshívás adja vissza. |
Search |
Eredményobjektum egy Keresés API-válaszhoz. |
Search |
Az alábbiak egyike:
|
Search |
Egy Keresés API-válasz összefoglaló objektuma. |
Summary |
A kötegelt kérelem eredményeinek összegzése |
Address
Az eredmény címe
Name | Típus | Description |
---|---|---|
boundingBox |
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 |
Ország (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 |
|
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 |
Névvel ellátott 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, ország/régió esetén a teljes ország/régió neve. |
localName |
string |
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 létrehozásához |
municipality |
string |
Város / Város |
municipalitySubdivision |
string |
Al/Szuperváros |
neighbourhood |
string |
A szomszédság egy földrajzilag honosított terület egy városban vagy városban, amely megkülönböztető jellemzőkkel és társadalmi interakciókkal rendelkezik a lakosok között. |
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 utcanév és a szám. |
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ényhez. A címtartomány kezdő és záró helyének koordinátáit tartalmazza.
Name | Típus | Description |
---|---|---|
from |
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon". |
|
rangeLeft |
string |
Címtartomány az utca bal oldalán. |
rangeRight |
string |
Címtartomány az utca jobb oldalán. |
to |
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon". |
BatchRequest
Ez a típus a Batch szolgáltatás kérelemtörzsét jelöli.
Name | Típus | Description |
---|---|---|
batchItems |
A feldolgozandó lekérdezések listája. |
BatchRequestItem
Batch-kérelemobjektum
Name | Típus | Description |
---|---|---|
query |
string |
Ez a paraméter egy strukturálatlan geokódolási művelet végrehajtásához használt lekérdezési sztringet tartalmaz. A lekérdezési sztringet a rendszer szó szerint átadja a keresési API-nak feldolgozás céljából. |
BoundingBox
A nézetport bal felső és jobb alsó koordinátái által képviselt eredményt lefedő nézetport.
Name | Típus | Description |
---|---|---|
btmRightPoint |
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon". |
|
topLeftPoint |
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon". |
BoundingBoxCompassNotation
A hely határolókerete.
Name | Típus | Description |
---|---|---|
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 elválasztott úszókként |
southWest |
string |
Dél-nyugati szélesség, a határolókeret hosszúsági koordinátája vesszővel elválasztott úszóké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 |
Code tulajdonság |
names |
Névtömb |
ClassificationName
A besorolás neve
Name | Típus | Description |
---|---|---|
name |
string |
Név tulajdonság |
nameLocale |
string |
Name Locale tulajdonság |
DataSources
Nem kötelező szakasz. Referenciaazonosítók a Get Keresés Polygon API-hoz.
Name | Típus | Description |
---|---|---|
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 |
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon". |
|
type |
A belépési pont típusa. Az érték lehet fő vagy alérték. |
EntryPointType
A belépési pont típusa. Az érték lehet fő 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 információtípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
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 |
Névvel ellátott terület |
Municipality |
string |
Város / Város |
MunicipalitySubdivision |
string |
Al/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 adatainak lekéréséhez. |
JsonFormat
A válasz kívánt formátuma. Csak json
a formátum támogatott.
Name | Típus | Description |
---|---|---|
json |
string |
LatLongPairAbbreviated
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".
Name | Típus | Description |
---|---|---|
lat |
number |
Latitude tulajdonság |
lon |
number |
Hosszúság tulajdonság |
MatchType
A fordított címkeresési művelet egyezésének típusai.
Name | Típus | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
A POI nyitvatartási ideje (érdekes pontok).
Name | Típus | Description |
---|---|---|
mode |
string |
A kérelemben használt érték: nincs vagy "nextSevenDays" |
timeRanges |
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 |
A következő 7 napos tartomány azon pontja, amikor egy adott POI bezárul, vagy a tartomány kezdete, ha a tartomány előtt bezárták. |
|
startTime |
A következő 7 napos tartomány azon pontja, amikor egy adott POI meg van nyitva, vagy a tartomány kezdete, ha azt 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[] |
Márkák tömb. A visszaadott POI márkaneve. |
categories |
string[] |
Kategóriák tömb |
categorySet |
A legspecifikusabb POI-kategóriák listája |
|
classifications |
Besorolási tömb |
|
name |
string |
A POI tulajdonság neve |
openingHours |
A 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 végezték el |
NON_NEAR |
string |
Keresés globálisan végezték el, anélkül, hogy torzítanak egy bizonyos szélességre és hosszúságra, és nincs meghatározott sugár |
Response
A lekérdezés eredménye. SearchAddressResult ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyéb módon.
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
|
results |
Keresés API-eredmények listája. |
|
summary |
Keresés API-válasz összefoglaló objektuma |
SearchAddressBatchItem
Az Keresés Address Batch szolgáltatáshívásából visszaadott elem.
Name | Típus | Description |
---|---|---|
response |
A lekérdezés eredménye. SearchAddressResult ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyéb módon. |
|
statusCode |
integer |
HTTP-kérés állapotkódja. |
SearchAddressBatchProcessResult
Ezt az objektumot egy sikeres Keresés Batch-szolgáltatáshívás adja vissza.
Name | Típus | Description |
---|---|---|
batchItems |
A kötegelt eredményeket tartalmazó tömb. |
|
summary |
A kötegelt kérelem eredményeinek összegzése |
SearchAddressResultItem
Eredményobjektum egy Keresés API-válaszhoz.
Name | Típus | Description |
---|---|---|
address |
Az eredmény címe |
|
addressRanges |
Az utca mindkét oldalán található címtartományt ismerteti a keresési eredményhez. A címtartomány kezdő és záró helyének koordinátáit tartalmazza. |
|
dataSources |
Nem kötelező szakasz. Referenciageometriai azonosító a Get Keresés Polygon API-hoz. |
|
detourTime |
integer |
Kitérő másodpercben. Csak a Keresés Route API-ra irányuló hívások esetén ad vissza. |
dist |
number |
Egyenes vonal távolsága az eredmény és a geobiák helye között méterben. |
entityType |
Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető. |
|
entryPoints |
EntryPoint-tömb. Ezek a helyszínen elérhető bejáratok típusait írják le. A típus lehet "fő" a főbejáratokhoz, például a bejárati ajtóhoz vagy az előszobához, valamint "minor" az oldalsó és hátsó ajtókhoz. |
|
id |
string |
Id tulajdonság |
info |
string |
Információ az eredmény eredeti adatforrásáról. Támogatási kérelmekhez használható. |
matchType |
Az egyezés típusára vonatkozó információk. Az alábbiak egyike:
|
|
poi |
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 |
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon". |
|
score |
number |
Az eredményhalmazon belüli érték, amely az eredmények közötti relatív egyező pontszámot jelzi. Ezzel megállapíthatja, hogy az x eredmény kétszer akkora valószínűséggel lesz releváns, mint 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 értik. |
type |
Az alábbiak egyike:
|
|
viewport |
A nézetport bal felső és jobb alsó koordinátái által képviselt 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 |
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 fuzzy szint. |
geoBias |
Annak jelzése, hogy a belső keresőmotor térinformatikai torzításokat alkalmazott az eredmények rangsorolásának javítására. Egyes metódusok ezt a lat és a lon paraméterek beállításával befolyásolhatják, ahol elérhető. Más esetekben ez tisztán belső. |
|
limit |
integer |
A visszaadott válaszok maximális száma |
numResults |
integer |
A válasz eredményeinek száma. |
offset |
integer |
A visszaadott eredmények kezdő eltolása a teljes eredménykészleten belül. |
query |
string |
A keresési eredmények előállítá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 |
A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR. |
|
totalResults |
integer |
A talált eredmények teljes száma. |
Summary
A kötegelt kérelem eredményeinek összegzése
Name | Típus | Description |
---|---|---|
successfulRequests |
integer |
Sikeres kérelmek száma a kötegben |
totalRequests |
integer |
A kötegben lévő kérések teljes száma |