Search - Get Reverse Geocoding Batch
クエリのバッチを 1 回のリクエストで Reverse Geocoding API に送信するために使用します。
同期バッチ要求の送信
軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。
POST https://atlas.microsoft.com/reverseGeocode:batch?api-version={api-version}
バッチ要求の 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 {endpoint}/reverseGeocode:batch?api-version=2026-01-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する 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 |
要求は成功しました。 |
|
| Other Status Codes |
予期しないエラー応答。 ヘッダー x-ms-error-code: string |
セキュリティ
AadToken
これらはMicrosoft Entra OAuth 2.0フローです。
Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 任意のユーザー、グループ、またはサービスプリンシパルは、組み込みの役割や1つ以上のREST API権限からなるカスタムロールを通じてアクセス権Azure Maps付与されます。\n\nシナリオを実装するには、authentication conceptsを見ることをお勧めします。 まとめると、このセキュリティ定義は、特定のAPIやスコープでアクセス制御が可能なオブジェクトを通じてアプリケーションをモデリングするソリューションを提供します。\n\n#### 注記\n* このセキュリティ定義要求x-ms-client-idヘッダーを使用してアプリケーションがどのAzure Mapsリソースへのアクセスを要求しているかを示します。 これはMaps管理APIから取得可能です。\n* \nAuthorization URLはAzureパブリッククラウドインスタンス専用です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。 \n* \nAzureロールベースのアクセス制御は、
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
これは共有キーで、AzureポータルでCreate a Azure Maps accountを行うか、PowerShell、CLI、Azure SDK、REST APIを使ってプロビジョニングされます。\n\n このキーがあれば、どのアプリケーションでもすべてのREST APIにアクセスできます。 つまり、この鍵は発行された口座のマスターキーとして使うことができます。\n\n 公開されているアプリケーションについては、confidential client applications方式を用いてREST API Azure Mapsにアクセスし、鍵を安全に保存できるようにすることをお勧めします。
型:
apiKey
/:
header
SAS Token
これは共有アクセス署名トークンで、
型:
apiKey
/:
header
例
A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries
要求のサンプル
POST {endpoint}/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 |
結果のアドレス |
|
Address |
住所の国または地域の下位区分名。 |
|
Address |
国または地域の名前と ISO コード。 |
|
Azure. |
エラー オブジェクト。 |
|
Azure. |
エラーの詳細を含む応答。 |
|
Azure. |
エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。 |
|
Calculation |
ジオコーディング ポイントの計算に使用されたメソッド。 |
|
Confidence |
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより詳細な情報を確認します。 ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの位置 (指定されている場合) など、多くの要因に基づいています。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Feature |
|
|
Features |
特徴オブジェクトです。 |
|
Features |
特徴の特性。 |
|
Feature |
フィーチャーの種類は Feature である必要があります。 |
|
Geocode |
ジオコードポイントだ。 |
|
Geocoding |
このオブジェクトは、正常なジオコーディング Batch サービス呼び出しから返されます。 |
|
Geocoding |
バッチ対応の項目です。 |
|
Geocoding |
バッチ要求の概要 |
|
Geo |
|
|
Geo |
有効な |
| Intersection |
結果のアドレス。 |
|
Match |
マッチコードを表す枚挙式です。 |
|
Result |
結果型を表すエンラム数です。 |
|
Reverse |
処理する逆ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。 |
|
Reverse |
Batch Query オブジェクト |
|
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 の通りの番号 (使用可能な場合) |
AddressAdminDistrictsItem
住所の国または地域の下位区分名。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
対応する adminDistrict フィールドの名前。AdminDistrict[0] の場合、ワシントン州、AdminDistrict の場合[1]など、州の完全な名前を指定できます。これは郡の完全な名前である可能性があります。 |
| shortName |
string |
対応する adminDistrict フィールドの短い名前。AdminDistrict[0] の場合、これは WA、For adminDistrict[1]、これは郡の短い名前である可能性があります。 |
AddressCountryRegion
国または地域の名前と ISO コード。
| 名前 | 型 | 説明 |
|---|---|---|
| ISO |
string |
国/地域の ISO |
| name |
string |
国/地域の名前 |
Azure.Core.Foundations.Error
エラー オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
| details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
| message |
string |
エラーの人間が判読できる表現。 |
| target |
string |
エラーのターゲット。 |
Azure.Core.Foundations.ErrorResponse
エラーの詳細を含む応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
Azure.Core.Foundations.InnerError
エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
| innererror |
内部エラー。 |
CalculationMethodEnum
ジオコーディング ポイントの計算に使用されたメソッド。
| 値 | 説明 |
|---|---|
| Interpolation |
ジオコード ポイントは、内挿を使用して道路上のポイントに一致しました。 |
| InterpolationOffset |
ジオコード ポイントは、内挿を使用して道路上のポイントと照合され、追加のオフセットを使用してポイントを道路の脇にシフトしました。 |
| Parcel |
ジオコード ポイントがパーセルの中心に一致しました。 |
| Rooftop |
ジオコード ポイントは、建物の屋上と一致しました。 |
ConfidenceEnum
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより詳細な情報を確認します。
ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの位置 (指定されている場合) など、多くの要因に基づいています。
| 値 | 説明 |
|---|---|
| High |
信頼度が リクエストに場所またはビューが含まれている場合、ランキングは適切に変更される可能性があります。 たとえば、"Paris" の場所クエリでは、"Paris, France" と "Paris, TX" の両方が |
| Medium |
状況によっては、返される一致が要求で提供された情報と同じレベルではないことがあります。 たとえば、リクエストで住所情報を指定する場合、ジオコード サービスは郵便番号のみに一致できる場合があります。 この場合、ジオコード サービスが郵便番号がデータに一致するという信頼度がある場合、信頼度は クエリ内の位置情報があいまいで、位置をランク付けするための追加情報 (ユーザーの位置や位置の相対的な重要度など) がない場合、信頼度は クエリ内の位置情報が特定の場所をジオコーディングするのに十分な情報を提供しない場合、精度の低い位置値が返され、信頼度が |
| Low |
低 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細です。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
FeatureCollectionEnum
GeoJSON 型を指定します。 サポートされているオブジェクトの種類は FeatureCollectionのみです。 詳細については、RFC 7946
| 値 | 説明 |
|---|---|
| FeatureCollection |
|
FeaturesItem
特徴オブジェクトです。
| 名前 | 型 | 説明 |
|---|---|---|
| bbox |
number[] (double) |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、RFC 7946 を参照してください。 |
| geometry |
有効な |
|
| id |
string |
返される機能の ID |
| properties |
特徴の特性。 |
|
| type |
フィーチャーの種類は Feature である必要があります。 |
FeaturesItemProperties
特徴の特性。
| 名前 | 型 | 説明 |
|---|---|---|
| address |
結果のアドレス |
|
| confidence |
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより詳細な情報を確認します。 ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの位置 (指定されている場合) など、多くの要因に基づいています。 |
|
| geocodePoints |
計算方法と推奨される使用方法が異なるジオコーディング ポイントのコレクション。 |
|
| matchCodes |
応答内の各場所のジオコーディング レベルを表す 1 つ以上の一致コード値。 たとえば、 同様に、 指定できる値は次のとおりです。
|
|
| type |
string |
1つ:* 住所 * ロードブロック * 道路交差点 * 近隣 * 人口付き場所 * 郵便番号1 * 行政区1 * 行政区2 * 国地域 |
FeatureTypeEnum
フィーチャーの種類は Feature である必要があります。
| 値 | 説明 |
|---|---|
| Feature |
|
GeocodePointsItem
ジオコードポイントだ。
| 名前 | 型 | 説明 |
|---|---|---|
| calculationMethod |
ジオコーディング ポイントの計算に使用されたメソッド。 |
|
| geometry |
有効な |
|
| usageTypes |
ジオコーディング ポイントに最適です。 各ジオコーディング ポイントは、 |
GeocodingBatchResponse
このオブジェクトは、正常なジオコーディング Batch サービス呼び出しから返されます。
| 名前 | 型 | 説明 |
|---|---|---|
| batchItems |
バッチ結果を含む配列。 |
|
| nextLink |
string |
返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。 |
| summary |
バッチ要求の概要 |
GeocodingBatchResponseItem
バッチ対応の項目です。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラーの詳細。 |
|
| features |
クエリから返された特徴の配列。 |
|
| nextLink |
string |
返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。 |
| optionalId |
string |
リクエストの id と同じ batchItem の id |
| type |
|
GeocodingBatchResponseSummary
バッチ要求の概要
| 名前 | 型 | 説明 |
|---|---|---|
| successfulRequests |
integer (int32) |
バッチ内の成功した要求の数 |
| totalRequests |
integer (int32) |
バッチ内の要求の合計数 |
GeoJsonObjectType
GeoJSON 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクト タイプのいずれかである必要があります。
| 値 | 説明 |
|---|---|
| Point |
ジオメトリを |
| MultiPoint |
ジオメトリを |
| LineString |
ジオメトリを |
| MultiLineString |
ジオメトリを |
| Polygon |
ジオメトリを |
| MultiPolygon |
ジオメトリを |
| GeometryCollection |
ジオメトリを |
| Feature |
|
| FeatureCollection |
|
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
マッチコードを表す枚挙式です。
| 値 | 説明 |
|---|---|
| Good |
よし |
| Ambiguous |
あいまい |
| UpHierarchy |
上位階層 |
ResultTypeEnum
結果型を表すエンラム数です。
| 値 | 説明 |
|---|---|
| Address |
住所 |
| Neighborhood |
近所 |
| PopulatedPlace |
PopulatedPlace |
| Postcode1 |
Postcode1 |
| AdminDivision1 |
AdminDivision1 |
| AdminDivision2 |
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 地域/国コードを指定する文字列。 これにより、地政学的な紛争の境界とラベルが、指定されたユーザー領域に合わせて変更されます。 |
UsageTypeEnum
使用タイプを表す枚挙式です。
| 値 | 説明 |
|---|---|
| Display |
表示方法 |
| Route |
Route |