Search - Get Reverse Geocoding Batch
クエリのバッチを 1 回のリクエストで Reverse Geocoding API に送信するために使用します。
同期バッチ要求の送信
軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。
バッチ要求の POST 本文
逆ジオコーディング クエリを送信するには、POST 要求を使用します。要求本文には batchItems 配列が json 形式で格納され、Content-Type ヘッダーは application/jsonに設定されます。 逆ジオコーディング クエリを 2
{
"batchItems": [
{
"coordinates": [-122.128275, 47.639429],
"resultTypes": ["Address", "PopulatedPlace"]
},
{
"coordinates": [-122.341979399674, 47.6095253501216]
}
]
}
batchItem オブジェクト
バッチには、少なくとも 1 つの クエリ
バッチ応答モデル
バッチ応答には、元のバッチ要求の一部であった summary と、正常に実行されたクエリ totalRequests を示す successfulRequests コンポーネントが含まれています。 バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。
batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 各項目は、次のいずれかの種類です。
GeocodingResponse- クエリが正常に完了した場合。Error- クエリが失敗した場合。 この場合、応答にはcodeとmessageが含まれます。
POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2026-01-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-id |
string |
Azure AD セキュリティ モデルと組み合わせて使用するアカウントを指定します。 これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーン アカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用する方法の詳細については、「 Azure Maps での認証の管理」を参照してください。 |
|
| Accept-Language |
string |
検索結果を返す言語。 詳細については、サポートされている言語の を参照してください。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| batchItems |
処理するクエリの一覧。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
[OK] |
|
| Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは、Microsoft Entra OAuth 2.0 フロー
シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。
注
- このセキュリティ定義 使用して、アプリケーションがアクセスを要求している Azure Maps リソースを示す必要があります。 これは、Maps 管理 APIから取得できます。
-
Authorization URLは、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Microsoft Entra ID 構成があります。 - Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して
Azure 管理プレーンから構成されます。 - Azure Maps Web SDK を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。
- Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介して Azure Maps リソース を作成するときにプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスすることが承認されます。 つまり、これらは現在、発行先のアカウントのマスター キーとして扱うことができます。
公開されているアプリケーションの場合、このキーを安全に格納できる Azure Maps REST API のサーバー間アクセスを使用することをお勧めします。
型:
apiKey
/:
header
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース のリスト SAS 操作から作成される Shared Access Signature トークンです。
このトークンを使用すると、すべてのアプリケーションは、Azure ロールベースのアクセス制御と、特定のトークンに対する使用の有効期限、レート、およびリージョンに対するきめ細かな制御を使用してアクセスすることが承認されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。
型:
apiKey
/:
header
例
A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries
要求のサンプル
POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2026-01-01
{
"batchItems": [
{
"coordinates": [
-122.138681,
47.630358
],
"resultTypes": [
"Address",
"PopulatedPlace"
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"coordinates": [
47.630358,
-122.138681
],
"optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
}
]
}
応答のサンプル
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"type": "Address",
"confidence": "Medium",
"matchCodes": [
"Good"
],
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King County",
"shortName": "King Co."
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "2267 152nd Ave NE, Redmond, Washington 98052, United States",
"streetName": "152nd Ave NE",
"streetNumber": "2267",
"addressLine": "2267 152nd Ave NE"
},
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.128275,
47.639429
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display",
"Route"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.127028,
47.638545
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.128275,
47.639429
]
},
"bbox": [
-122.1359181505759,
47.63556628242932,
-122.1206318494241,
47.643291717570676
]
}
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"error": {
"code": "Bad Request",
"message": "The provided coordinates (-122.138681,47.630358) in coordinates field are invalid or out of range"
},
"optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
}
]
}
定義
| 名前 | 説明 |
|---|---|
| Address |
結果のアドレス |
|
Admin |
住所の国または地域の下位区分名。 この要素は通常、最初の注文管理下位区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。 |
|
Calculation |
ジオコーディング ポイントの計算に使用されたメソッド。 |
|
Confidence |
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより詳細な情報を確認します。 ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの位置 (指定されている場合) など、多くの要因に基づいています。 |
|
Country |
国または地域の名前と ISO コード。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Feature |
|
|
Features |
|
|
Feature |
フィーチャーの種類は Feature である必要があります。 |
|
Geocode |
計算方法と推奨される使用方法が異なるジオコーディング ポイントのコレクション。 |
|
Geocoding |
このオブジェクトは、正常なジオコーディング Batch サービス呼び出しから返されます。 |
|
Geocoding |
|
|
Geo |
有効な |
| Intersection |
結果のアドレス。 |
|
Match |
応答内の各場所のジオコーディング レベルを表す 1 つ以上の一致コード値。 たとえば、 同様に、 指定できる値は次のとおりです。
|
| Properties | |
|
Result |
応答で使用するエンティティの種類を指定します。 指定した型のみが返されます。 指定したエンティティ タイプにポイントをマッピングできない場合、応答で位置情報は返されません。 デフォルト値は、すべての可能なエンティティです。 次のオプションから選択したエンティティ型のコンマ区切りリスト。
これらのエンティティタイプは、最も具体的なエンティティから最も具体的でないエンティティの順に並べられます。 複数のエンティティタイプのエンティティが見つかった場合は、最も具体的なエンティティのみが返されます。 たとえば、エンティティの種類として Address と AdminDistrict1 を指定し、両方の種類のエンティティが見つかった場合、応答では Address エンティティ情報のみが返されます。 |
|
Reverse |
処理する逆ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。 |
|
Reverse |
Batch Query オブジェクト |
| Summary |
バッチ要求の概要 |
|
Usage |
ジオコーディング ポイントに最適です。
各ジオコーディング ポイントは、 |
Address
結果のアドレス
| 名前 | 型 | 説明 |
|---|---|---|
| addressLine |
string |
番地名と番地を含む住所 |
| adminDistricts |
住所の国または地域の下位区分名。 この要素は通常、最初の注文管理下位区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。 |
|
| countryRegion |
国または地域の名前と ISO コード。 |
|
| formattedAddress |
string |
書式設定されたアドレス プロパティ |
| intersection |
結果のアドレス。 |
|
| locality |
string |
Locality プロパティ |
| neighborhood |
string |
近隣物件 |
| postalCode |
string |
郵便番号プロパティ |
| streetName |
string |
formattedAddress の通りの名前 |
| streetNumber |
string |
formattedAddress の通りの番号 (使用可能な場合) |
AdminDistricts
住所の国または地域の下位区分名。 この要素は通常、最初の注文管理下位区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
対応する adminDistrict フィールドの名前。AdminDistrict[0] の場合、ワシントン州、AdminDistrict の場合[1]など、州の完全な名前を指定できます。これは郡の完全な名前である可能性があります。 |
| shortName |
string |
対応する adminDistrict フィールドの短い名前。AdminDistrict[0] の場合、これは WA、For adminDistrict[1]、これは郡の短い名前である可能性があります。 |
CalculationMethodEnum
ジオコーディング ポイントの計算に使用されたメソッド。
| 値 | 説明 |
|---|---|
| Interpolation |
ジオコード ポイントは、内挿を使用して道路上のポイントに一致しました。 |
| InterpolationOffset |
ジオコード ポイントは、内挿を使用して道路上のポイントと照合され、追加のオフセットを使用してポイントを道路の脇にシフトしました。 |
| Parcel |
ジオコード ポイントがパーセルの中心に一致しました。 |
| Rooftop |
ジオコード ポイントは、建物の屋上と一致しました。 |
ConfidenceEnum
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより詳細な情報を確認します。
ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの位置 (指定されている場合) など、多くの要因に基づいています。
| 値 | 説明 |
|---|---|
| High |
信頼度が リクエストに場所またはビューが含まれている場合、ランキングは適切に変更される可能性があります。 たとえば、"Paris" の場所クエリでは、"Paris, France" と "Paris, TX" の両方が |
| Medium |
状況によっては、返される一致が要求で提供された情報と同じレベルではないことがあります。 たとえば、リクエストで住所情報を指定する場合、ジオコード サービスは郵便番号のみに一致できる場合があります。 この場合、ジオコード サービスが郵便番号がデータに一致するという信頼度がある場合、信頼度は クエリ内の位置情報があいまいで、位置をランク付けするための追加情報 (ユーザーの位置や位置の相対的な重要度など) がない場合、信頼度は クエリ内の位置情報が特定の場所をジオコーディングするのに十分な情報を提供しない場合、精度の低い位置値が返され、信頼度が |
| Low |
CountryRegion
国または地域の名前と ISO コード。
| 名前 | 型 | 説明 |
|---|---|---|
| ISO |
string |
国/地域の ISO |
| name |
string |
国/地域の名前 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細です。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
FeatureCollectionEnum
GeoJSON 型を指定します。 サポートされているオブジェクトの種類は FeatureCollectionのみです。 詳細については、RFC 7946
| 値 | 説明 |
|---|---|
| FeatureCollection |
|
FeaturesItem
| 名前 | 型 | 説明 |
|---|---|---|
| bbox |
number[] (double) |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、RFC 7946 を参照してください。 |
| geometry |
有効な |
|
| id |
string |
返される機能の ID |
| properties | ||
| type |
フィーチャーの種類は Feature である必要があります。 |
FeatureTypeEnum
フィーチャーの種類は Feature である必要があります。
| 値 | 説明 |
|---|---|
| Feature |
|
GeocodePoints
計算方法と推奨される使用方法が異なるジオコーディング ポイントのコレクション。
| 名前 | 型 | 説明 |
|---|---|---|
| calculationMethod |
ジオコーディング ポイントの計算に使用されたメソッド。 |
|
| geometry |
有効な |
|
| usageTypes |
ジオコーディング ポイントに最適です。
各ジオコーディング ポイントは、 |
GeocodingBatchResponse
このオブジェクトは、正常なジオコーディング Batch サービス呼び出しから返されます。
| 名前 | 型 | 説明 |
|---|---|---|
| batchItems |
バッチ結果を含む配列。 |
|
| nextLink |
string |
返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。 |
| summary |
バッチ要求の概要 |
GeocodingBatchResponseItem
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラーの詳細。 |
|
| features | ||
| nextLink |
string |
返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。 |
| optionalId |
string |
リクエストの id と同じ batchItem の id |
| type |
|
GeoJsonPoint
有効な GeoJSON Point geometry 型。 詳細については、RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| bbox |
number[] (double) |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、RFC 7946 を参照してください。 |
| coordinates |
number[] (double) |
|
| type |
string:
Point |
|
Intersection
結果のアドレス。
| 名前 | 型 | 説明 |
|---|---|---|
| baseStreet |
string |
場所のプライマリ ストリート。 |
| displayName |
string |
交差部分の完全な名前。 |
| intersectionType |
string |
交差部分の種類。 |
| secondaryStreet1 |
string |
最初の交差する通り。 |
| secondaryStreet2 |
string |
存在する場合は、2 番目の交差する通り。 |
MatchCodesEnum
応答内の各場所のジオコーディング レベルを表す 1 つ以上の一致コード値。
たとえば、Good と Ambiguous の一致コードを持つジオコーディングされた場所は、位置情報に対して複数のジオコーディングの場所が見つかったこと、およびジオコーディング サービスが一致を検索するために上階層を検索していないことを意味します。
同様に、Ambiguous と UpHierarchy の一致コードを持つジオコーディングされた場所は、指定されたすべての位置情報と一致するジオコーディングの場所が見つからなかったことを意味するため、ジオコーディング サービスでは上位階層を検索し、そのレベルで複数の一致が見つかりました。
Ambiguous と UpHierarchy 結果の例は、住所情報を入力したが、ジオコーディング サービスが番地の一致を見つけられない場合、代わりに複数の RoadBlock 値の情報を返す場合です。
指定できる値は次のとおりです。
Good: 場所に一致するものが 1 つしかないか、返されたすべての一致が強い一致と見なされます。 たとえば、ニューヨークのクエリでは、いくつかの Good 一致が返されます。
Ambiguous: 場所は一致する可能性のあるセットの 1 つです。 たとえば、番地 128 Main St. のクエリを実行すると、選択するオプションを決定するのに十分な情報がないため、応答で 128 North Main St. と 128 South Main St. の 2 つの場所が返されることがあります。
UpHierarchy: 場所は、地理的階層への移動を表します。 これは、場所要求の一致が見つからなかった場合に発生するため、より正確でない結果が返されます。 たとえば、要求されたアドレスの一致が見つからない場合は、RoadBlock エンティティ型の UpHierarchy の一致コードが返される可能性があります。
| 値 | 説明 |
|---|---|
| Good | |
| Ambiguous | |
| UpHierarchy |
Properties
| 名前 | 型 | 説明 |
|---|---|---|
| address |
結果のアドレス |
|
| confidence |
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより詳細な情報を確認します。 ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの位置 (指定されている場合) など、多くの要因に基づいています。 |
|
| geocodePoints |
計算方法と推奨される使用方法が異なるジオコーディング ポイントのコレクション。 |
|
| matchCodes |
応答内の各場所のジオコーディング レベルを表す 1 つ以上の一致コード値。 たとえば、 同様に、 指定できる値は次のとおりです。
|
|
| type |
string |
つぎのいずれかです。
|
ResultTypeEnum
応答で使用するエンティティの種類を指定します。 指定した型のみが返されます。 指定したエンティティ タイプにポイントをマッピングできない場合、応答で位置情報は返されません。 デフォルト値は、すべての可能なエンティティです。 次のオプションから選択したエンティティ型のコンマ区切りリスト。
- 住所
- 近所
- PopulatedPlace
- Postcode1
- AdminDivision1
- AdminDivision2
- 国/地域
これらのエンティティタイプは、最も具体的なエンティティから最も具体的でないエンティティの順に並べられます。 複数のエンティティタイプのエンティティが見つかった場合は、最も具体的なエンティティのみが返されます。 たとえば、エンティティの種類として Address と AdminDistrict1 を指定し、両方の種類のエンティティが見つかった場合、応答では Address エンティティ情報のみが返されます。
| 値 | 説明 |
|---|---|
| Address | |
| Neighborhood | |
| PopulatedPlace | |
| Postcode1 | |
| AdminDivision1 | |
| AdminDivision2 | |
| CountryRegion |
ReverseGeocodingBatchRequestBody
処理する逆ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。
| 名前 | 型 | 説明 |
|---|---|---|
| batchItems |
処理するクエリの一覧。 |
ReverseGeocodingBatchRequestItem
Batch Query オブジェクト
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] (double) |
ジオコーディングを逆にする場所の座標。 例: [lon,lat] |
| optionalId |
string |
対応するbatchItemに表示されるリクエストのid |
| resultTypes |
応答で使用するエンティティの種類を指定します。 指定した型のみが返されます。 指定したエンティティ タイプにポイントをマッピングできない場合、応答で位置情報は返されません。 デフォルト値は、すべての可能なエンティティです。 次のオプションから選択したエンティティ型のコンマ区切りリスト。
これらのエンティティタイプは、最も具体的なエンティティから最も具体的でないエンティティの順に並べられます。 複数のエンティティタイプのエンティティが見つかった場合は、最も具体的なエンティティのみが返されます。 たとえば、エンティティの種類として Address と AdminDistrict1 を指定し、両方の種類のエンティティが見つかった場合、応答では Address エンティティ情報のみが返されます。 |
|
| view |
string |
ISO 3166-1 Alpha-2 地域/国コードを指定する文字列。 これにより、地政学的な紛争の境界とラベルが、指定されたユーザー領域に合わせて変更されます。 |
Summary
バッチ要求の概要
| 名前 | 型 | 説明 |
|---|---|---|
| successfulRequests |
integer (int32) |
バッチ内の成功した要求の数 |
| totalRequests |
integer (int32) |
バッチ内の要求の合計数 |
UsageTypeEnum
ジオコーディング ポイントに最適です。
各ジオコーディング ポイントは、Route ポイント、Display ポイント、またはその両方として定義されます。
場所へのルートを作成する場合は、Route ポイントを使用します。 マップ上に位置を表示する場合は、Display ポイントを使用します。 たとえば、場所が公園の場合、Route ポイントは車で入ることができる公園への入り口を指定し、Display ポイントは公園の中心を指定する点である場合があります。
| 値 | 説明 |
|---|---|
| Display | |
| Route |