GetReverseGeocodingBatch interface

バッチ 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 が含まれます。

function post(options: SearchGetReverseGeocodingBatchParameters): StreamableMethod<SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse>

パラメーター

戻り値