@azure-rest/maps-search package

結果のアドレス

GeoJSON GeocodingFeature 地理的領域の境界を記述するオブジェクトです。 フィーチャのジオメトリは、GeoJSON GeometryCollectionで記述されます。

このサービスは通常、Polygon または MultiPolygon サブタイプを持つ GeometryCollection を返します。

Boundary オブジェクトのプロパティ。

リソース管理エラーの追加情報。

エラーの詳細。

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

有効な GeoJSON FeatureCollection オブジェクト型。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON Feature オブジェクト型。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON GeometryCollection オブジェクト型。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ 型のいずれかである必要があります。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON LineString geometry 型。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON MultiLineString geometry 型。 詳細については、RFC 7946 を参照してください。

GeoJson MultiPointに含まれるデータ。

有効な GeoJSON MultiPoint geometry 型。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON MultiPolygon オブジェクト型。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON オブジェクト。 詳細については、RFC 7946 を参照してください。

GeoJson Pointに含まれるデータ。

有効な GeoJSON Point geometry 型。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON Polygon geometry 型。 詳細については、RFC 7946 を参照してください。

処理する住所ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。

Batch Query オブジェクト

このオブジェクトは、成功したジオコーディング バッチ サービス呼び出しから返されます。

バッチ要求の概要

このオブジェクトは、ジオコーディング呼び出しが成功した場合に返されます

Boundary オブジェクトのジオメトリの著作権情報。

結果のアドレス。

処理する逆ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。

Batch Query オブジェクト

ジオコーディング

適用対象: 価格 レベルを参照してください。

多くの場合、従来のジオコーディングのみに関心がある場合など、完全な検索サービスが多すぎる可能性があります。 検索には、アドレス検索専用にアクセスすることもできます。 ジオコーディングは、問題の住所または住所の一部のみを使用してジオコーディング エンドポイントにヒットすることによって実行されます。 ジオコーディング検索インデックスは、道路レベルのデータより上のすべてのデータに対してクエリを実行します。 ポイント オブ インタレスト (POI) は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、市区町村、郡、州などのより高いレベルの地域だけでなく、正確な番地や通りや交差点からすべてを処理します。

バッチ API のジオコーディングの

に適用: 価格 レベルを参照してください。

ジオコーディング バッチ API は、単一の API 呼び出しを使用して、ジオコーディング API にクエリのバッチを送信します。 この API を使用すると、呼び出し元は最大 100 クエリをバッチ処理できます。

同期バッチ要求の送信

軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。

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

バッチ要求の POST 本文

ジオコーディング クエリを送信するには、要求本文に json 形式の batchItems 配列が含まれる POST 要求を使用し、Content-Type ヘッダーを application/jsonに設定します。 ジオコーディング クエリを 2 含む要求本文の例を次に示します。

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

batchItem オブジェクト ジオコーディングでは、サポートされている ジオコーディングURI パラメーター受け取ることができます。

バッチには、少なくとも 1 つの クエリ 含める必要があります。

バッチ応答モデル

バッチ応答には、元のバッチ要求の一部であった totalRequests と、正常に実行されたクエリ successfulRequests を示す summary コンポーネントが含まれています。 バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。 batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 各項目は、次のいずれかの種類です。

• GeocodingResponse - クエリが正常に完了した場合。

• Error - クエリが失敗した場合。 この場合、応答には code と message が含まれます。

バッチ API のジオコーディングの

に適用: 価格 レベルを参照してください。

ジオコーディング バッチ API は、単一の API 呼び出しを使用して、ジオコーディング API にクエリのバッチを送信します。 この API を使用すると、呼び出し元は最大 100 クエリをバッチ処理できます。

同期バッチ要求の送信

軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。

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

バッチ要求の POST 本文

ジオコーディング クエリを送信するには、要求本文に json 形式の batchItems 配列が含まれる POST 要求を使用し、Content-Type ヘッダーを application/jsonに設定します。 ジオコーディング クエリを 2 含む要求本文の例を次に示します。

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

batchItem オブジェクト ジオコーディングでは、サポートされている ジオコーディングURI パラメーター受け取ることができます。

バッチには、少なくとも 1 つの クエリ 含める必要があります。

バッチ応答モデル

バッチ応答には、元のバッチ要求の一部であった totalRequests と、正常に実行されたクエリ successfulRequests を示す summary コンポーネントが含まれています。 バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。 batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 各項目は、次のいずれかの種類です。

• GeocodingResponse - クエリが正常に完了した場合。

• Error - クエリが失敗した場合。 この場合、応答には code と message が含まれます。

ジオコーディング

適用対象: 価格 レベルを参照してください。

多くの場合、従来のジオコーディングのみに関心がある場合など、完全な検索サービスが多すぎる可能性があります。 検索には、アドレス検索専用にアクセスすることもできます。 ジオコーディングは、問題の住所または住所の一部のみを使用してジオコーディング エンドポイントにヒットすることによって実行されます。 ジオコーディング検索インデックスは、道路レベルのデータより上のすべてのデータに対してクエリを実行します。 ポイント オブ インタレスト (POI) は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、市区町村、郡、州などのより高いレベルの地域だけでなく、正確な番地や通りや交差点からすべてを処理します。

多角形の を取得する

適用対象: 価格 レベルを参照してください。

市区町村や国の地域などの地理的領域のアウトラインの多角形データを提供します。

多角形の を取得する

適用対象: 価格 レベルを参照してください。

市区町村や国の地域などの地理的領域のアウトラインの多角形データを提供します。

逆ジオコーディング の

適用対象: 価格 レベルを参照してください。

座標 (例: 37.786505、-122.3862) を人間が理解できる番地に変換します。 ほとんどの場合、これは、デバイスまたは資産から GPS フィードを受信し、座標が配置されているアドレスを知りたいアプリケーションを追跡するために必要です。 このエンドポイントは、特定の座標のアドレス情報を返します。

バッチ API の逆ジオコーディングの

に適用: 価格 レベルを参照してください。

逆ジオコーディング バッチ API は、1 つの API 呼び出しのみを使用して、逆ジオコーディング API クエリのバッチを送信します。 この API を使用すると、呼び出し元は最大 100 クエリをバッチ処理できます。

同期バッチ要求の送信

軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。

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

バッチ要求の POST 本文

逆ジオコーディング クエリを送信するには、POST 要求を使用します。要求本文には batchItems 配列が json 形式で格納され、Content-Type ヘッダーは application/jsonに設定されます。 逆ジオコーディング クエリを 2 含むサンプル要求本文を次に示します。

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

batchItem オブジェクト 逆ジオコーディングでは、サポートされている 逆ジオコーディングURI パラメーターを受け取ることができます。

バッチには、少なくとも 1 つの クエリ 含める必要があります。

バッチ応答モデル

バッチ応答には、元のバッチ要求の一部であった totalRequests と、正常に実行されたクエリ successfulRequests を示す summary コンポーネントが含まれています。 バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。 batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 各項目は、次のいずれかの種類です。

• GeocodingResponse - クエリが正常に完了した場合。

• Error - クエリが失敗した場合。 この場合、応答には code と message が含まれます。

バッチ API の逆ジオコーディングの

に適用: 価格 レベルを参照してください。

逆ジオコーディング バッチ API は、1 つの API 呼び出しのみを使用して、逆ジオコーディング API クエリのバッチを送信します。 この API を使用すると、呼び出し元は最大 100 クエリをバッチ処理できます。

同期バッチ要求の送信

軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。

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

バッチ要求の POST 本文

逆ジオコーディング クエリを送信するには、POST 要求を使用します。要求本文には batchItems 配列が json 形式で格納され、Content-Type ヘッダーは application/jsonに設定されます。 逆ジオコーディング クエリを 2 含むサンプル要求本文を次に示します。

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

batchItem オブジェクト 逆ジオコーディングでは、サポートされている 逆ジオコーディングURI パラメーターを受け取ることができます。

バッチには、少なくとも 1 つの クエリ 含める必要があります。

バッチ応答モデル

バッチ応答には、元のバッチ要求の一部であった totalRequests と、正常に実行されたクエリ successfulRequests を示す summary コンポーネントが含まれています。 バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。 batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 各項目は、次のいずれかの種類です。

• GeocodingResponse - クエリが正常に完了した場合。

• Error - クエリが失敗した場合。 この場合、応答には code と message が含まれます。

逆ジオコーディング の

適用対象: 価格 レベルを参照してください。

座標 (例: 37.786505、-122.3862) を人間が理解できる番地に変換します。 ほとんどの場合、これは、デバイスまたは資産から GPS フィードを受信し、座標が配置されているアドレスを知りたいアプリケーションを追跡するために必要です。 このエンドポイントは、特定の座標のアドレス情報を返します。

有効な GeoJSON Feature オブジェクト型。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ 型のいずれかである必要があります。 詳細については、RFC 7946 を参照してください。

有効な GeoJSON オブジェクト。 詳細については、RFC 7946 を参照してください。

サブスクリプション キーから MapsSearchClient のインスタンスを作成します。

例

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

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

Azure Identity TokenCredentialから MapsSearch のインスタンスを作成します。

例

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

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

Azure Identity AzureSASCredentialから MapsSearch のインスタンスを作成します。

例

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

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