@azure-rest/maps-search package

Az eredmény címe

GeoJSON GeocodingFeature földrajzi terület határait leíró objektum. A funkció geometriája a GeoJSON GeometryCollection.

Vegye figyelembe, hogy a szolgáltatás általában polygon vagy MultiPolygon altípusú GeometryCollection értéket ad vissza.

Egy Határ objektum tulajdonságai.

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

A hiba részletei.

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Érvényes GeoJSON FeatureCollection objektumtípus. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON Feature objektumtípus. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON GeometryCollection objektumtípus. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON LineString geometriatípus. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON MultiLineString geometriatípus. Részletekért tekintse meg RFC 7946.

Egy GeoJson MultiPointáltal tárolt adatok.

Érvényes GeoJSON MultiPoint geometriatípus. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON MultiPolygon objektumtípus. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON objektum. Részletekért tekintse meg RFC 7946.

Egy GeoJson Pointáltal tárolt adatok.

Érvényes GeoJSON Point geometriatípus. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON Polygon geometriatípus. Részletekért tekintse meg RFC 7946.

A cím geokódolási lekérdezéseinek/feldolgozandó kéréseinek listája. A lista legfeljebb 100 lekérdezést tartalmazhat, és legalább 1 lekérdezést kell tartalmaznia.

Batch Query-objektum

Ezt az objektumot egy sikeres Geokódolási Batch-szolgáltatáshívás adja vissza.

A kötegkérelem összegzése

Ezt az objektumot egy sikeres geokódolási hívás adja vissza

Egy Határ objektum geometriája szerzői jogi információi.

Az eredmény címe.

Az ügyfél opcionális paraméterei

A fordított geokódolási lekérdezések/feldolgozásra irányuló kérések listája. A lista legfeljebb 100 lekérdezést tartalmazhat, és legalább 1 lekérdezést kell tartalmaznia.

Batch Query-objektum

A Get Geocoding API egy HTTP-GET kérés, amely a keresett hely hosszúsági és szélességi koordinátáit adja vissza.

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. A keresés kizárólag a 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ódolási végpontot. A geokódolási keresési index lekérdezi az utcaszintű adatok fölötti összes adatot. A rendszer nem ad vissza érdeklődési pontot (POI-kat). Vegye figyelembe, hogy a geokódoló nagyon tolerálja az elírásokat és a hiányos címeket. Emellett a pontos utcacímektől, utca- vagy metszetektől, valamint a magasabb szintű földrajzi területektől, például a városközpontoktól, megyéktől és államoktól kezdve mindennel foglalkozik. A válasz olyan részletes címtulajdonságokat is visszaad, mint az utca, az irányítószám, az önkormányzat és az ország/régió adatai.

A Get Geocoding Batch API egy OLYAN HTTP-POST-kérés, amely legfeljebb 100 lekérdezést küld a Geokódolási API-nak egyetlen kérelemben.

Szinkronizálási kötegkérelem küldése

A szinkron API ajánlott az egyszerűsített kötegelt kérelmekhez. Amikor a szolgáltatás kérést kap, azonnal válaszol a kötegelemek kiszámításakor, és nem lesz lehetőség az eredmények későbbi lekérésére. A szinkron API időtúllépési hibát (408-ra) ad vissza, ha a kérés 60 másodpercnél tovább tart. A kötegelemek száma az API-hoz legfeljebb 100 .

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

POST törzs a Batch-kérelemhez

A geokódolási lekérdezések küldéséhez egy POST kérést kell használnia, amelyben a kérelem törzse batchItems formátumban tartalmazza a json tömböt, és a Content-Type fejléc application/jsonlesz beállítva. Íme egy mintakérési törzs, amely 2 geokódolási lekérdezést tartalmaz:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

A batchItem geokódolási objektum a támogatott geokódolásiURI-paraméterekbármelyikét elfogadhatja.

A kötegnek legalább 1 lekérdezést kell tartalmaznia.

Batch Response Model

A kötegválasz egy summary összetevőt tartalmaz, amely jelzi az eredeti kötegelt kérelem részét képező totalRequests, és successfulRequests, azaz a sikeresen végrehajtott lekérdezéseket. A kötegelt válasz tartalmaz egy batchItems tömböt is, 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 a következő típusok egyikét tartalmazza:

• GeocodingResponse – Ha a lekérdezés sikeresen befejeződött.

• Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message tartalmaz.

A Get Geocoding Batch API egy OLYAN HTTP-POST-kérés, amely legfeljebb 100 lekérdezést küld a Geokódolási API-nak egyetlen kérelemben.

Szinkronizálási kötegkérelem küldése

A szinkron API ajánlott az egyszerűsített kötegelt kérelmekhez. Amikor a szolgáltatás kérést kap, azonnal válaszol a kötegelemek kiszámításakor, és nem lesz lehetőség az eredmények későbbi lekérésére. A szinkron API időtúllépési hibát (408-ra) ad vissza, ha a kérés 60 másodpercnél tovább tart. A kötegelemek száma az API-hoz legfeljebb 100 .

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

POST törzs a Batch-kérelemhez

A geokódolási lekérdezések küldéséhez egy POST kérést kell használnia, amelyben a kérelem törzse batchItems formátumban tartalmazza a json tömböt, és a Content-Type fejléc application/jsonlesz beállítva. Íme egy mintakérési törzs, amely 2 geokódolási lekérdezést tartalmaz:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

A batchItem geokódolási objektum a támogatott geokódolásiURI-paraméterekbármelyikét elfogadhatja.

A kötegnek legalább 1 lekérdezést kell tartalmaznia.

Batch Response Model

A kötegválasz egy summary összetevőt tartalmaz, amely jelzi az eredeti kötegelt kérelem részét képező totalRequests, és successfulRequests, azaz a sikeresen végrehajtott lekérdezéseket. A kötegelt válasz tartalmaz egy batchItems tömböt is, 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 a következő típusok egyikét tartalmazza:

• GeocodingResponse – Ha a lekérdezés sikeresen befejeződött.

• Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message tartalmaz.

A Get Geocoding API egy HTTP-GET kérés, amely a keresett hely hosszúsági és szélességi koordinátáit adja vissza.

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. A keresés kizárólag a 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ódolási végpontot. A geokódolási keresési index lekérdezi az utcaszintű adatok fölötti összes adatot. A rendszer nem ad vissza érdeklődési pontot (POI-kat). Vegye figyelembe, hogy a geokódoló nagyon tolerálja az elírásokat és a hiányos címeket. Emellett a pontos utcacímektől, utca- vagy metszetektől, valamint a magasabb szintű földrajzi területektől, például a városközpontoktól, megyéktől és államoktól kezdve mindennel foglalkozik. A válasz olyan részletes címtulajdonságokat is visszaad, mint az utca, az irányítószám, az önkormányzat és az ország/régió adatai.

A Get Polygon API egy HTTP-GET-kérés, amely egy földrajzi terület körvonalának, például egy városnak vagy egy országrégiónak a sokszögadatait szolgáltatja.

A Get Polygon API egy HTTP-GET-kérés, amely egy földrajzi terület körvonalának, például egy városnak vagy egy országrégiónak a sokszögadatait szolgáltatja.

A Get Reverse Geocoding API egy HTTP-GET kérés, amellyel egy koordinátát (például: 37.786505, -122.3862) lefordítunk egy emberi, érthető utcacímre. Hasznos az olyan alkalmazások nyomon követéséhez, amelyekben GPS-hírcsatornát kap az eszközről vagy az eszközről, és tudni szeretné a koordinátákkal társított címet. Ez a végpont egy adott koordináta címadatait adja vissza.

A Get Reverse Geocoding Batch API egy OLYAN HTTP-POST-kérés, amely legfeljebb 100 lekérdezést küld Fordított geokódolási API-nak egyetlen kéréssel.

Szinkronizálási kötegkérelem küldése

A szinkron API ajánlott az egyszerűsített kötegelt kérelmekhez. Amikor a szolgáltatás kérést kap, azonnal válaszol a kötegelemek kiszámításakor, és nem lesz lehetőség az eredmények későbbi lekérésére. A szinkron API időtúllépési hibát (408-ra) ad vissza, ha a kérés 60 másodpercnél tovább tart. A kötegelemek száma az API-hoz legfeljebb 100 .

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

POST törzs a Batch-kérelemhez

A fordított geokódolási lekérdezések küldéséhez egy POST kérést fog használni, amelyben a kérelemtörzs batchItems formátumban tartalmazza a json tömböt, a Content-Type fejléc pedig application/jsonlesz. Íme egy mintakérési törzs, amely 2 fordított geokódolási lekérdezést tartalmaz:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Egy fordított geokódolási batchItem objektum a támogatott fordított geokódolásiURI-paraméterekbármelyikét elfogadhatja.

A kötegnek legalább 1 lekérdezést kell tartalmaznia.

Batch Response Model

A kötegválasz egy summary összetevőt tartalmaz, amely jelzi az eredeti kötegelt kérelem részét képező totalRequests, és successfulRequests, azaz a sikeresen végrehajtott lekérdezéseket. A kötegelt válasz tartalmaz egy batchItems tömböt is, 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 a következő típusok egyikét tartalmazza:

• GeocodingResponse – Ha a lekérdezés sikeresen befejeződött.

• Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message tartalmaz.

A Get Reverse Geocoding Batch API egy OLYAN HTTP-POST-kérés, amely legfeljebb 100 lekérdezést küld Fordított geokódolási API-nak egyetlen kéréssel.

Szinkronizálási kötegkérelem küldése

A szinkron API ajánlott az egyszerűsített kötegelt kérelmekhez. Amikor a szolgáltatás kérést kap, azonnal válaszol a kötegelemek kiszámításakor, és nem lesz lehetőség az eredmények későbbi lekérésére. A szinkron API időtúllépési hibát (408-ra) ad vissza, ha a kérés 60 másodpercnél tovább tart. A kötegelemek száma az API-hoz legfeljebb 100 .

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

POST törzs a Batch-kérelemhez

A fordított geokódolási lekérdezések küldéséhez egy POST kérést fog használni, amelyben a kérelemtörzs batchItems formátumban tartalmazza a json tömböt, a Content-Type fejléc pedig application/jsonlesz. Íme egy mintakérési törzs, amely 2 fordított geokódolási lekérdezést tartalmaz:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Egy fordított geokódolási batchItem objektum a támogatott fordított geokódolásiURI-paraméterekbármelyikét elfogadhatja.

A kötegnek legalább 1 lekérdezést kell tartalmaznia.

Batch Response Model

A kötegválasz egy summary összetevőt tartalmaz, amely jelzi az eredeti kötegelt kérelem részét képező totalRequests, és successfulRequests, azaz a sikeresen végrehajtott lekérdezéseket. A kötegelt válasz tartalmaz egy batchItems tömböt is, 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 a következő típusok egyikét tartalmazza:

• GeocodingResponse – Ha a lekérdezés sikeresen befejeződött.

• Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message tartalmaz.

A Get Reverse Geocoding API egy HTTP-GET kérés, amellyel egy koordinátát (például: 37.786505, -122.3862) lefordítunk egy emberi, érthető utcacímre. Hasznos az olyan alkalmazások nyomon követéséhez, amelyekben GPS-hírcsatornát kap az eszközről vagy az eszközről, és tudni szeretné a koordinátákkal társított címet. Ez a végpont egy adott koordináta címadatait adja vissza.

Érvényes GeoJSON Feature objektumtípus. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. Részletekért tekintse meg RFC 7946.

Érvényes GeoJSON objektum. Részletekért tekintse meg RFC 7946.

Létrehoz egy MapsSearchClient-példányt egy előfizetési kulcsból.

Példa

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);

Létrehoz egy MapsSearch-példányt egy Azure Identity TokenCredential.

Példa

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");

Létrehoz egy MapsSearch-példányt egy Azure Identity AzureSASCredential.

Példa

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);