Search - Get Geocoding Batch
を使用して、クエリのバッチを 1 つの要求で ジオコーディング API に送信します。
Get Geocoding Batch
API は、1 つの要求で最大 100 個のクエリのバッチをジオコーディング API に送信する HTTP POST
要求です。
同期バッチ要求を送信する
軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受信すると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 この API では、バッチ項目の数は 100 に制限されています。
POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01
バッチ要求の POST 本文
ジオコーディング クエリを送信するには、要求本文に形式のjson
配列が含まれておりbatchItems
、ヘッダーが に設定される要求をContent-Type
application/json
使用POST
します。 2 つのジオコーディング クエリを含むサンプル要求本文 を 次に示します。
{
"batchItems": [
{
"addressLine": "One, Microsoft Way, Redmond, WA 98052",
"top": 2
},
{
"addressLine": "Pike Pl",
"adminDistrict": "WA",
"locality": "Seattle",
"top": 3
}
]
}
ジオコーディング batchItem オブジェクトは、サポートされているジオコーディングURI パラメーターのいずれかを受け入れます。
バッチには、少なくとも 1 つの クエリが含まれている必要があります。
バッチ応答モデル
バッチ応答には、 summary
元のバッチ要求の一部であった を示す totalRequests
コンポーネント、 successfulRequests
つまり正常に実行されたクエリが含まれます。 バッチ応答には、 batchItems
バッチ要求内の各クエリに対する応答を含む配列も含まれます。
batchItems
には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 各項目は、次のいずれかの種類です。
GeocodingResponse
- クエリが正常に完了した場合。Error
- クエリが失敗した場合。 この場合、応答には と がmessage
含まれますcode
。
POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-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 で Azure AD セキュリティを使用するには、ガイダンスについては、次 の記事を 参照してください。 |
|
Accept-Language |
string |
検索結果を返す言語。 詳細については、「 サポートされている言語 」を参照してください。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
batchItems |
処理するクエリの一覧。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは Microsoft Entra OAuth 2.0 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上の Azure Maps リソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
注意
- このセキュリティ定義 では 、 ヘッダーを
x-ms-client-id
使用して、アプリケーションがアクセスを要求している 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 の一覧表示操作から作成される共有アクセス署名トークンです。
このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。
型:
apiKey
/:
header
例
A Geocoding Batch API call containing 2 Geocoding queries
要求のサンプル
POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01
{
"batchItems": [
{
"addressLine": "One, Microsoft Way, Redmond, WA 98052",
"top": 2,
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"addressLine": "Pike Pl",
"adminDistrict": "WA",
"locality": "Seattle",
"top": 3
}
]
}
応答のサンプル
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"type": "Address",
"confidence": "High",
"matchCodes": [
"Good"
],
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
"addressLine": "1 Microsoft Way"
},
"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
]
}
]
},
{
"error": {
"code": "Conflicting Parameters",
"message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'addressLine' was passed"
}
}
]
}
定義
名前 | 説明 |
---|---|
Address |
結果のアドレス |
Admin |
住所の国または地域の下位区分名。 この要素は通常、最初の順序の管理区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。 |
Calculation |
ジオコーディング ポイントの計算に使用されたメソッド。 |
Confidence |
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより完全な情報を確認します。 ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの場所 (指定されている場合) など、多くの要因に基づいています。 |
Country |
|
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Feature |
FeatureCollection オブジェクトの種類は FeatureCollection である必要があります。 |
Features |
|
Feature |
フィーチャーの種類は Feature である必要があります。 |
Geocode |
計算方法と推奨される用途が異なるジオコード ポイントのコレクション。 |
Geocoding |
処理する住所ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができるので、少なくとも 1 つのクエリを含む必要があります。 |
Geocoding |
Batch Query オブジェクト |
Geocoding |
このオブジェクトは、ジオコーディング バッチ サービスの正常な呼び出しから返されます。 |
Geocoding |
|
Geo |
有効な |
Intersection |
結果のアドレス。 |
Match |
応答内の各場所のジオコーディング レベルを表す 1 つ以上の一致コード値。 たとえば、 と の 同様に、 と の 次の値を指定できます。
|
Properties | |
Summary |
バッチ要求の概要 |
Usage |
ジオコーディング ポイントに最適な用途。
各ジオコーディング ポイントは、ポイント、ポイント、 |
Address
結果のアドレス
名前 | 型 | 説明 |
---|---|---|
addressLine |
string |
番地と番号を含む AddressLine |
adminDistricts |
住所の国または地域の下位区分名。 この要素は通常、最初の順序の管理区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。 |
|
countryRegion | ||
formattedAddress |
string |
書式設定された Address プロパティ |
intersection |
結果のアドレス。 |
|
locality |
string |
locality プロパティ |
neighborhood |
string |
neighborhood プロパティ |
postalCode |
string |
郵便番号プロパティ |
AdminDistricts
住所の国または地域の下位区分名。 この要素は通常、最初の順序の管理区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。
名前 | 型 | 説明 |
---|---|---|
name |
string |
対応する adminDistrict フィールドの名前(adminDistrict[0]の場合は、Washington、For adminDistrict[1]など)、これは郡の完全な名前である可能性があります。 |
shortName |
string |
対応する adminDistrict フィールドの短い名前(adminDistrict[0]の場合は、WA、For adminDistrict[1]など)、これは郡の短い名前である可能性があります。 |
CalculationMethodEnum
ジオコーディング ポイントの計算に使用されたメソッド。
名前 | 型 | 説明 |
---|---|---|
Interpolation |
string |
ジオコード ポイントは、補間を使用して道路上のポイントと一致しました。 |
InterpolationOffset |
string |
ジオコード ポイントは、道路の側面にポイントをシフトする追加のオフセットを使用して補間を使用して、道路上のポイントと一致しました。 |
Parcel |
string |
ジオコーディング ポイントがパーセルの中心と一致しました。 |
Rooftop |
string |
ジオコード ポイントが建物の屋上と一致しました。 |
ConfidenceEnum
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより完全な情報を確認します。
ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの場所 (指定されている場合) など、多くの要因に基づいています。
名前 | 型 | 説明 |
---|---|---|
High |
string |
信頼度が に 要求に場所またはビューが含まれている場合は、ランク付けが適切に変更される可能性があります。 たとえば、"Paris" の場所クエリでは、"Paris, France" と "Paris, TX" の両方が自信を持って |
Low |
string |
|
Medium |
string |
場合によっては、返される一致が要求で指定された情報と同じレベルではない場合があります。 たとえば、要求で住所情報を指定し、ジオコード サービスが郵便番号のみを照合できる場合があります。 この場合、ジオコーディング サービスに郵便番号がデータと一致するという信頼度がある場合、信頼度は に クエリの場所情報があいまいで、場所をランク付けするための追加情報がない場合 (ユーザーの場所や場所の相対的な重要度など)、信頼度は に クエリの場所情報で特定の場所をジオコーディングするのに十分な情報が提供されない場合は、精度の低い場所の値が返され、信頼度が に |
CountryRegion
名前 | 型 | 説明 |
---|---|---|
ISO |
string |
国/地域の ISO |
name |
string |
国/地域の名前 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
FeatureCollectionEnum
FeatureCollection オブジェクトの種類は FeatureCollection である必要があります。
名前 | 型 | 説明 |
---|---|---|
FeatureCollection |
string |
FeaturesItem
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
geometry |
有効な |
|
id |
string |
返される機能の ID |
properties | ||
type |
フィーチャーの種類は Feature である必要があります。 |
FeatureTypeEnum
フィーチャーの種類は Feature である必要があります。
名前 | 型 | 説明 |
---|---|---|
Feature |
string |
GeocodePoints
計算方法と推奨される用途が異なるジオコード ポイントのコレクション。
名前 | 型 | 説明 |
---|---|---|
calculationMethod |
ジオコーディング ポイントの計算に使用されたメソッド。 |
|
geometry |
有効な |
|
usageTypes |
ジオコーディング ポイントに最適な用途。
各ジオコーディング ポイントは、ポイント、ポイント、 |
GeocodingBatchRequestBody
処理する住所ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができるので、少なくとも 1 つのクエリを含む必要があります。
名前 | 型 | 説明 |
---|---|---|
batchItems |
処理するクエリの一覧。 |
GeocodingBatchRequestItem
Batch Query オブジェクト
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
addressLine |
string |
地域または postalCode プロパティで指定された、エリアに対する相対アドレスの公式の番地。 この要素の一般的な用途は、番地または公式の住所を指定することです。 クエリが指定されている場合は、このパラメーターを使用しないでください。 |
|
adminDistrict |
string |
WA などの住所の国区分部分。 クエリが指定されている場合は、このパラメーターを使用しないでください。 |
|
adminDistrict2 |
string |
キングなどの構造化された住所の郡。 クエリが指定されている場合は、このパラメーターを使用しないでください。 |
|
adminDistrict3 |
string |
構造化アドレスの名前付き領域。 クエリが指定されている場合は、このパラメーターを使用しないでください。 |
|
bbox |
number[] |
境界ボックス オブジェクトとして定義された、地球上の四角形の領域。 四角形の辺は、経度と緯度の値によって定義されます。 詳細については、「場所とエリアの種類」を参照してください。 このパラメーターを指定すると、場所クエリの結果を計算するときに地理的領域が考慮されます。 例: [lon1, lat1, lon2, lat2] |
|
coordinates |
number[] |
経度と緯度として指定された地球上のポイント。 このパラメーターを指定すると、ユーザーの場所が考慮され、返される結果がユーザーにより関連性が高い場合があります。 例: [lon, lat] |
|
countryRegion |
string |
ジオコーディング結果のシグナルを ISO 3166-1 Alpha-2 リージョン/国コード (FR./ など) に指定します。 クエリが指定されている場合は、このパラメーターを使用しないでください。 |
|
locality |
string |
住所の地域部分 (シアトルなど)。 クエリが指定されている場合は、このパラメーターを使用しないでください。 |
|
optionalId |
string |
対応する batchItem に表示される要求の ID |
|
postalCode |
string |
住所の郵便番号の部分。 クエリが指定されている場合は、このパラメーターを使用しないでください。 |
|
query |
string |
住所やランドマーク名など、場所に関する情報を含む文字列。 |
|
top |
integer |
5 |
返される応答の最大数。 既定値: 5、最小: 1、最大: 20。 |
view |
string |
auto |
ISO 3166-1 Alpha-2 リージョン/国コードを指定する文字列。 これにより、指定したユーザー領域に合わせて、地政学的な紛争の境界線とラベルが変更されます。 |
GeocodingBatchResponse
このオブジェクトは、ジオコーディング バッチ サービスの正常な呼び出しから返されます。
名前 | 型 | 説明 |
---|---|---|
batchItems |
バッチ結果を含む配列。 |
|
nextLink |
string |
は、返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。 |
summary |
バッチ要求の概要 |
GeocodingBatchResponseItem
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細。 |
|
features | ||
nextLink |
string |
は、返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。 |
optionalId |
string |
要求の ID と同じになる batchItem の id |
type |
FeatureCollection オブジェクトの種類は FeatureCollection である必要があります。 |
GeoJsonPoint
有効な GeoJSON Point
geometry 型。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
coordinates |
number[] |
は |
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 つしかないか、返されたすべての一致が強い一致と見なされます。 たとえば、New York のクエリでは、いくつかの Good 一致が返されます。
Ambiguous
: 場所は、一致する可能性のある一連の 1 つです。 たとえば、住所 128 Main St. に対してクエリを実行すると、選択するオプションを決定するのに十分な情報がないため、応答で 128 North Main St. と 128 South Main St. の 2 つの場所が返されることがあります。
UpHierarchy
: 場所は、地理的階層の上への移動を表します。 これは、場所要求の一致が見つからなかった場合に発生するため、精度の低い結果が返されます。 たとえば、要求されたアドレスの一致が見つからない場合は、RoadBlock エンティティ型を持つ の UpHierarchy
一致コードが返されることがあります。
名前 | 型 | 説明 |
---|---|---|
Ambiguous |
string |
|
Good |
string |
|
UpHierarchy |
string |
Properties
名前 | 型 | 説明 |
---|---|---|
address |
結果のアドレス |
|
confidence |
ジオコーディングされた場所の結果が一致する信頼度。 この値を match コードと共に使用して、一致に関するより完全な情報を確認します。 ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの場所 (指定されている場合) など、多くの要因に基づいています。 |
|
geocodePoints |
計算方法と推奨される使用方法が異なるジオコーディング ポイントのコレクション。 |
|
matchCodes |
応答内の各場所のジオコーディング レベルを表す 1 つ以上の一致コード値。 たとえば、 と の 同様に、 と の 次の値を指定できます。
|
|
type |
string |
つぎのいずれかです。
|
Summary
バッチ要求の概要
名前 | 型 | 説明 |
---|---|---|
successfulRequests |
integer |
バッチ内の成功した要求の数 |
totalRequests |
integer |
バッチ内の要求の合計数 |
UsageTypeEnum
ジオコーディング ポイントに最適な用途。
各ジオコーディング ポイントは、ポイント、ポイント、Display
またはその両方としてRoute
定義されます。
場所へのルートを作成する場合は、ポイントを使用 Route
します。 マップ上の場所を表示する場合は、ポイントを使用 Display
します。 たとえば、場所が公園の場合、 Route
ポイントは車で入ることができる公園への入り口を指定し Display
、ポイントは公園の中心を指定するポイントである場合があります。
名前 | 型 | 説明 |
---|---|---|
Display |
string |
|
Route |
string |