GetGeocodingBatch interface
メソッド
| post(Search |
バッチ API のジオコーディングの に適用: 価格 レベルを参照してください。 ジオコーディング バッチ API は、単一の API 呼び出しを使用して、ジオコーディング API にクエリのバッチを送信します。 この API を使用すると、呼び出し元は最大 100 クエリをバッチ処理できます。 同期バッチ要求の送信軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。 バッチ要求の POST 本文
ジオコーディング クエリを送信するには、要求本文に batchItem オブジェクト バッチには、少なくとも 1 つの クエリ バッチ応答モデルバッチ応答には、元のバッチ要求の一部であった
|
メソッドの詳細
post(SearchGetGeocodingBatchParameters)
バッチ 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 オブジェクト
バッチには、少なくとも 1 つの クエリ
バッチ応答モデル
バッチ応答には、元のバッチ要求の一部であった totalRequests と、正常に実行されたクエリ successfulRequests を示す summary コンポーネントが含まれています。 バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。
batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 各項目は、次のいずれかの種類です。
GeocodingResponse- クエリが正常に完了した場合。Error- クエリが失敗した場合。 この場合、応答にはcodeとmessageが含まれます。
function post(options: SearchGetGeocodingBatchParameters): StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>パラメーター
戻り値
Azure SDK for JavaScript