Search - Get Reverse Geocoding Batch

リファレンス

Service:: Maps

API Version:: 2024-04-01-preview

Batch API の逆ジオコーディング

逆ジオコーディングバッチ API は、1 回の API 呼び出しのみを使用して、クエリのバッチを逆ジオコーディング API に送信します。この API を使用すると、呼び出し元は最大 100 個のクエリをバッチ処理できます。

同期バッチ要求を送信する

軽量バッチ要求には、同期 API をお勧めします。サービスが要求を受信すると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウトエラー (408 応答) を返します。この API では、バッチ項目の数は 100 に制限されています。

POST https://atlas.microsoft.com/reverseGeocode:batch

バッチ要求の POST 本文

逆ジオコーディングクエリを送信するには、要求本文に形式のjson配列が含まれておりbatchItems、ヘッダーがに設定される要求をContent-Typeapplication/json使用POSTします。 2 つの 逆ジオコーディング クエリを含むサンプル要求本文を次に示します。

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

逆ジオコーディング batchItem オブジェクトは、サポートされている逆ジオコーディングURI パラメーターのいずれかを受け入れます。

バッチには、少なくとも 1 つの クエリが含まれている必要があります。

バッチ応答モデル

バッチ応答には、 summary 元のバッチ要求の一部であったを示す totalRequests コンポーネント、 successfulRequests つまり正常に実行されたクエリが含まれます。バッチ応答には、 batchItems バッチ要求内の各クエリに対する応答を含む配列も含まれます。 batchItemsには、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。各項目は、次のいずれかの種類です。

GeocodingResponse - クエリが正常に完了した場合。
Error - クエリが失敗した場合。この場合、応答にはとがmessage含まれますcode。

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2024-04-01-preview

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	検索結果を返す言語。詳細については、「サポートされている言語」を参照してください。

名前

必須

型

説明

x-ms-client-id

string

Azure AD セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure Mapsで Azure AD セキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

Accept-Language

string

検索結果を返す言語。

詳細については、「サポートされている言語」を参照してください。

要求本文

名前	型	説明
batchItems	ReverseGeocodingBatchRequestItem[]	処理するクエリの一覧。

応答

名前	型	説明
200 OK	GeocodingBatchResponse	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。 Headers x-ms-error-code: string

名前

型

説明

200 OK

GeocodingBatchResponse

Other Status Codes

ErrorResponse

予期しないエラーが発生しました。

Headers

x-ms-error-code: string

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 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 プラットフォームの概要」を参照してください。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
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 にアクセスする権限が与えられている。つまり、これらは現在、発行先のアカウントのマスターキーとして扱うことができます。

パブリックに公開されているアプリケーションの場合、このキーを安全に格納できる REST API のサーバー間アクセスAzure Maps使用することをお勧めします。

Type: apiKey
In: header

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

例

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Sample Request

HTTP

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2024-04-01-preview

{
  "batchItems": [
    {
      "coordinates": [
        -122.128275,
        47.639429
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        -122.341979399674,
        47.6095253501216
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Sample Response

Status code:: 200

{
  "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
          ]
        }
      ]
    },
    {
      "optionalId": "3K5O3Y832J2YV6D7XNGUSM4ECCUGDEFN172CJQNN",
      "error": {
        "code": "400 Bad Request",
        "message": "The provided coordinates in query are invalid, out of range, or not in the expected format"
      }
    }
  ]
}

定義

名前	説明
Address	結果のアドレス
AdminDistricts	住所の国または地域のサブ区分名。この要素は通常、最初の注文管理区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。
CalculationMethodEnum	ジオコーディングポイントの計算に使用されたメソッド。
ConfidenceEnum	ジオコーディングされた場所の結果が一致する信頼度。この値を match コードと共に使用して、一致に関するより完全な情報を確認します。ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの場所 (指定されている場合) など、多くの要因に基づいています。
CountryRegion
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FeatureCollectionEnum	FeatureCollection オブジェクトの種類は FeatureCollection である必要があります。
FeaturesItem
FeatureTypeEnum	フィーチャーの種類は Feature である必要があります。
GeocodePoints	計算方法と推奨される使用方法が異なるジオコーディングポイントのコレクション。
GeocodingBatchResponse	このオブジェクトは、成功したジオコーディングバッチサービス呼び出しから返されます。
GeocodingBatchResponseItem
GeoJsonPoint	有効な `GeoJSON Point` geometry 型。詳細については、 RFC 7946 を参照してください。
Intersection	結果のアドレス。
MatchCodesEnum	応答内の各場所のジオコーディングレベルを表す 1 つ以上の一致コード値。たとえば、との`GoodAmbiguous`一致コードを持つジオコーディングされた場所は、位置情報に対して複数のジオコーディングの場所が見つかり、ジオコーディングサービスで一致を検索するための階層が検索されていないことを意味します。同様に、との`AmbiguousUpHierarchy`一致コードを持つジオコーディングされた場所は、指定されたすべての位置情報と一致するジオコーディングの場所が見つからなかったことを意味するため、ジオコーディングサービスは階層を上から検索し、そのレベルで複数の一致を検出する必要がありました。との結果の`AmbiguousUpHierarchy`例は、完全な住所情報を指定したが、ジオコードサービスが番地の一致を見つけられないため、代わりに複数の RoadBlock 値の情報を返す場合です。次の値を指定できます。 `Good`: 場所に一致するものが 1 つだけあるか、返されたすべての一致が厳密な一致と見なされます。たとえば、New York のクエリでは、いくつかの Good 一致が返されます。 `Ambiguous`: 場所は、一致する可能性のある一連の 1 つです。たとえば、番地 128 Main St.を照会すると、選択するオプションを決定するのに十分な情報がないため、応答から 128 North Main St. と 128 South Main St. の 2 つの場所が返されることがあります。 `UpHierarchy`: 場所は、地理的階層の上への移動を表します。これは、場所要求の一致が見つからなかった場合に発生するため、より正確でない結果が返されます。たとえば、要求されたアドレスの一致が見つからない場合、RoadBlock エンティティ型を持つの `UpHierarchy` 一致コードが返される場合があります。
Properties
ResultTypeEnum	応答で必要なエンティティ型を指定します。指定した型のみが返されます。指定したエンティティ型にポイントをマップできない場合、応答で場所情報は返されません。既定値は、考えられるすべてのエンティティです。次のオプションから選択したエンティティ型のコンマ区切りのリスト。 Address "近隣" PopulatedPlace Postcode1 AdminDivision1 AdminDivision2 CountryRegion これらのエンティティ型は、最も特定のエンティティから最も固有でないエンティティに順序付けられます。複数のエンティティ型のエンティティが見つかった場合は、最も具体的なエンティティのみが返されます。たとえば、エンティティ型とエンティティが両方の型で見つかったとして Address と AdminDistrict1 を指定した場合、応答では Address エンティティ情報のみが返されます。
ReverseGeocodingBatchRequestBody	逆ジオコーディングクエリ/処理要求の一覧。リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。
ReverseGeocodingBatchRequestItem	Batch Query オブジェクト
Summary	バッチ要求の概要
UsageTypeEnum	ジオコーディングポイントに最適な用途。各ジオコーディングポイントは、ポイント、ポイント、`Display`またはその両方として`Route`定義されます。場所へのルートを作成する場合は、ポイントを使用 `Route` します。マップ上に位置を表示する場合は、ポイントを使用 `Display` します。たとえば、場所が公園の場合、 `Route` ポイントは車で入力できる公園への入り口を指定し `Display` 、ポイントは公園の中心を指定するポイントである場合があります。

Address

結果のアドレス

名前	型	説明
addressLine	string	番地と番号を含む AddressLine
adminDistricts	AdminDistricts[]	住所の国または地域のサブ区分名。この要素は通常、最初の注文管理区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。
countryRegion	CountryRegion
formattedAddress	string	書式設定された Address プロパティ
intersection	Intersection	結果のアドレス。
locality	string	locality プロパティ
neighborhood	string	neighborhood プロパティ
postalCode	string	郵便番号プロパティ

AdminDistricts

住所の国または地域のサブ区分名。この要素は通常、最初の注文管理区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。

名前	型	説明
name	string	対応する adminDistrict フィールドの名前(adminDistrict[0]の場合)、ワシントン、AdminDistrict[1]などの州のフルネームを指定できます。これは郡のフルネームである可能性があります
shortName	string	対応する adminDistrict フィールドの短い名前である adminDistrict[0]の場合、これは WA、AdminDistrict[1]などの状態の短い名前である可能性があります。これは、郡の短い名前である可能性があります

CalculationMethodEnum

ジオコーディングポイントの計算に使用されたメソッド。

名前	型	説明
Interpolation	string	ジオコードポイントは、補間を使用して道路上のポイントと一致しました。
InterpolationOffset	string	ジオコードポイントは、道路の側面にポイントをシフトする追加のオフセットを使用して補間を使用して、道路上のポイントと一致しました。
Parcel	string	ジオコーディングポイントがパーセルの中心に一致しました。
Rooftop	string	ジオコードポイントは、建物の屋上に一致しました。

ConfidenceEnum

ジオコーディングされた場所の結果が一致する信頼度。この値を match コードと共に使用して、一致に関するより完全な情報を確認します。

ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの場所 (指定されている場合) など、多くの要因に基づいています。

名前型説明

High

名前	型	説明
High	string	信頼度がに `High`設定されている場合、1 つ以上の強力な一致が見つかりました。複数の `High` 信頼度の一致は、該当する場合、重要度順にランク付けされた順序で並べ替えられます。たとえば、ランドマークには重要度がありますが、住所は重要ではありません。要求に場所またはビューが含まれている場合、ランク付けは適切に変更される可能性があります。たとえば、"Paris" の場所クエリでは、"Paris, France" と "Paris, TX" の両方が自信を持って `High` 返されます。 "Paris, France" は、ユーザーの場所がパリ、TX、またはマップビューでユーザーがそのエリアで検索していることを示す場合を除き、重要度により常に 1 位にランク付けされます。
Low	string
Medium	string	状況によっては、返される一致が要求で指定された情報と同じレベルになっていない場合があります。たとえば、要求で住所情報を指定したり、ジオコードサービスが郵便番号と一致することしかできない場合があります。この場合、ジオコーディングサービスに郵便番号がデータと一致するという信頼度がある場合、信頼度はに `Medium` 設定され、一致コードはに `UpHierarchy` 設定され、すべての情報と一致することができず、階層を検索する必要があることを指定します。クエリ内の位置情報があいまいで、場所をランク付けするための追加情報 (ユーザーの場所や場所の相対的な重要度など) がない場合、信頼度はに `Medium`設定されます。たとえば、"148th Ave, Bellevue" の場所クエリでは、"148th Ave SE" と "148th Ave NE" の両方が信頼度で `Medium` 返される場合があります。クエリ内の位置情報が特定の場所をジオコーディングするのに十分な情報を提供しない場合は、より正確でない場所の値が返され、信頼度がに `Medium`設定される可能性があります。たとえば、住所が指定されていても、住宅番号に一致するものが見つからない場合、Roadblock エンティティ型のジオコーディング結果が返される場合があります。

string

信頼度がに High設定されている場合、1 つ以上の強力な一致が見つかりました。複数の High 信頼度の一致は、該当する場合、重要度順にランク付けされた順序で並べ替えられます。たとえば、ランドマークには重要度がありますが、住所は重要ではありません。

要求に場所またはビューが含まれている場合、ランク付けは適切に変更される可能性があります。たとえば、"Paris" の場所クエリでは、"Paris, France" と "Paris, TX" の両方が自信を持って High 返されます。 "Paris, France" は、ユーザーの場所がパリ、TX、またはマップビューでユーザーがそのエリアで検索していることを示す場合を除き、重要度により常に 1 位にランク付けされます。

Low

string

Medium

string

状況によっては、返される一致が要求で指定された情報と同じレベルになっていない場合があります。たとえば、要求で住所情報を指定したり、ジオコードサービスが郵便番号と一致することしかできない場合があります。この場合、ジオコーディングサービスに郵便番号がデータと一致するという信頼度がある場合、信頼度はに Medium 設定され、一致コードはに UpHierarchy 設定され、すべての情報と一致することができず、階層を検索する必要があることを指定します。

クエリ内の位置情報があいまいで、場所をランク付けするための追加情報 (ユーザーの場所や場所の相対的な重要度など) がない場合、信頼度はに Medium設定されます。たとえば、"148th Ave, Bellevue" の場所クエリでは、"148th Ave SE" と "148th Ave NE" の両方が信頼度で Medium 返される場合があります。

クエリ内の位置情報が特定の場所をジオコーディングするのに十分な情報を提供しない場合は、より正確でない場所の値が返され、信頼度がに Medium設定される可能性があります。たとえば、住所が指定されていても、住宅番号に一致するものが見つからない場合、Roadblock エンティティ型のジオコーディング結果が返される場合があります。

CountryRegion

名前	型	説明
ISO	string	国/地域の ISO
name	string	国/地域の名前

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

FeatureCollectionEnum

FeatureCollection オブジェクトの種類は FeatureCollection である必要があります。

名前	型	説明
FeatureCollection	string

FeaturesItem

名前	型	説明
bbox	number[]	境界ボックス。使用されるプロジェクション - EPSG:3857。詳細については、 RFC 7946 を参照してください。
geometry	GeoJsonPoint	有効な `GeoJSON Point` geometry 型。詳細については、 RFC 7946 を参照してください。
id	string	返される機能の ID
properties	Properties
type	FeatureTypeEnum	フィーチャーの種類は Feature である必要があります。

FeatureTypeEnum

フィーチャーの種類は Feature である必要があります。

名前	型	説明
Feature	string

GeocodePoints

計算方法と推奨される使用方法が異なるジオコーディングポイントのコレクション。

名前	型	説明
calculationMethod	CalculationMethodEnum	ジオコーディングポイントの計算に使用されたメソッド。
geometry	GeoJsonPoint	有効な `GeoJSON Point` geometry 型。詳細については、 RFC 7946 を参照してください。
usageTypes	UsageTypeEnum[]	ジオコーディングポイントに最適な用途。各ジオコーディングポイントは、ポイント、ポイント、`Display`またはその両方として`Route`定義されます。場所へのルートを作成する場合は、ポイントを使用 `Route` します。マップ上に位置を表示する場合は、ポイントを使用 `Display` します。たとえば、場所が公園の場合、 `Route` ポイントは車で入力できる公園への入り口を指定し `Display` 、ポイントは公園の中心を指定するポイントである場合があります。

GeocodingBatchResponse

このオブジェクトは、成功したジオコーディングバッチサービス呼び出しから返されます。

名前	型	説明
batchItems	GeocodingBatchResponseItem[]	バッチ結果を含む配列。
nextLink	string	は、返される機能の次のページへのリンクです。最後のページの場合は、このフィールドはありません。
summary	Summary	バッチ要求の概要

GeocodingBatchResponseItem

名前	型	説明
error	ErrorDetail	エラーの詳細。
features	FeaturesItem[]
nextLink	string	は、返される機能の次のページへのリンクです。最後のページの場合は、このフィールドはありません。
optionalId	string	要求の ID と同じ batchItem の id
type	FeatureCollectionEnum	FeatureCollection オブジェクトの種類は FeatureCollection である必要があります。

GeoJsonPoint

有効な GeoJSON Point geometry 型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
bbox	number[]	境界ボックス。使用されるプロジェクション - EPSG:3857。詳細については、 RFC 7946 を参照してください。
coordinates	number[]	は `Position` 、2 つ以上の要素を持つ数値の配列です。最初の 2 つの要素は経度と緯度で、正確にはその順序です。高度/標高は、省略可能な 3 番目の要素です。詳細については、 RFC 7946 を参照してください。
type	string: Point	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

Intersection

結果のアドレス。

名前	型	説明
baseStreet	string	場所のプライマリストリート。
displayName	string	交差部分の完全な名前。
intersectionType	string	交差部分の種類。
secondaryStreet1	string	最初の交差する通り。
secondaryStreet2	string	存在する場合は、2 番目の交差する通り。

MatchCodesEnum

応答内の各場所のジオコーディングレベルを表す 1 つ以上の一致コード値。

たとえば、とのGoodAmbiguous一致コードを持つジオコーディングされた場所は、位置情報に対して複数のジオコーディングの場所が見つかり、ジオコーディングサービスで一致を検索するための階層が検索されていないことを意味します。

同様に、とのAmbiguousUpHierarchy一致コードを持つジオコーディングされた場所は、指定されたすべての位置情報と一致するジオコーディングの場所が見つからなかったことを意味するため、ジオコーディングサービスは階層を上から検索し、そのレベルで複数の一致を検出する必要がありました。との結果のAmbiguousUpHierarchy例は、完全な住所情報を指定したが、ジオコードサービスが番地の一致を見つけられないため、代わりに複数の 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	Address	結果のアドレス
confidence	ConfidenceEnum	ジオコーディングされた場所の結果が一致する信頼度。この値を一致コードと共に使用して、一致に関するより完全な情報を確認します。ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの場所 (指定されている場合) など、多くの要因に基づいています。
geocodePoints	GeocodePoints[]	計算方法と推奨される使用方法が異なるジオコーディングポイントのコレクション。
matchCodes	MatchCodesEnum[]	応答内の各場所のジオコーディングレベルを表す 1 つ以上の一致コード値。たとえば、との`GoodAmbiguous`一致コードを持つジオコーディングされた場所は、場所情報に対して複数のジオコードの場所が見つかり、ジオコードサービスが一致を検索するための階層を検索しなかったことを意味します。同様に、との`AmbiguousUpHierarchy`一致コードを持つジオコーディングされた場所は、指定されたすべての場所の情報と一致するジオコーディングの場所が見つからなかったことを意味するため、ジオコーディングサービスは階層を上から検索し、そのレベルで複数の一致を検出する必要がありました。との結果の`AmbiguousUpHierarchy`例は、完全な住所情報を指定したが、ジオコードサービスが番地の一致を見つけず、代わりに複数の RoadBlock 値の情報を返す場合です。次の値を指定できます。 `Good`: 場所に一致するものが 1 つしかないか、返されたすべての一致が強い一致と見なされます。たとえば、New York のクエリでは、いくつかの Good 一致が返されます。 `Ambiguous`: 場所は、一致する可能性のある一連の 1 つです。たとえば、住所 128 Main St. に対してクエリを実行すると、選択するオプションを決定するのに十分な情報がないため、応答で 128 North Main St. と 128 South Main St. の 2 つの場所が返されることがあります。 `UpHierarchy`: 場所は、地理的階層の上への移動を表します。これは、場所要求の一致が見つからなかった場合に発生するため、精度の低い結果が返されます。たとえば、要求されたアドレスの一致が見つからない場合は、RoadBlock エンティティ型を持つの `UpHierarchy` 一致コードが返されることがあります。
type	string	つぎのいずれかです。 Address 障害 RoadIntersection "近隣" PopulatedPlace Postcode1 AdminDivision1 AdminDivision2 CountryRegion

ResultTypeEnum

応答で必要なエンティティ型を指定します。指定した型のみが返されます。指定したエンティティ型にポイントをマップできない場合、応答で場所情報は返されません。既定値は、考えられるすべてのエンティティです。次のオプションから選択したエンティティ型のコンマ区切りのリスト。

Address
"近隣"
PopulatedPlace
Postcode1
AdminDivision1
AdminDivision2
CountryRegion

これらのエンティティ型は、最も特定のエンティティから最も固有でないエンティティに順序付けられます。複数のエンティティ型のエンティティが見つかった場合は、最も具体的なエンティティのみが返されます。たとえば、エンティティ型とエンティティが両方の型で見つかったとして Address と AdminDistrict1 を指定した場合、応答では Address エンティティ情報のみが返されます。

名前	型	説明
Address	string
AdminDivision1	string
AdminDivision2	string
CountryRegion	string
Neighborhood	string
PopulatedPlace	string
Postcode1	string

ReverseGeocodingBatchRequestBody

逆ジオコーディングクエリ/処理要求の一覧。リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。

名前	型	説明
batchItems	ReverseGeocodingBatchRequestItem[]	処理するクエリの一覧。

ReverseGeocodingBatchRequestItem

Batch Query オブジェクト

名前	型	説明
coordinates	number[]	逆ジオコーディングする場所の座標。例: [lon,lat]
optionalId	string	対応する batchItem に表示される要求の ID
resultTypes	ResultTypeEnum[]	応答で必要なエンティティ型を指定します。指定した型のみが返されます。指定したエンティティ型にポイントをマップできない場合、応答で場所情報は返されません。既定値は、考えられるすべてのエンティティです。次のオプションから選択したエンティティ型のコンマ区切りのリスト。 Address "近隣" PopulatedPlace Postcode1 AdminDivision1 AdminDivision2 CountryRegion これらのエンティティ型は、最も特定のエンティティから最も固有でないエンティティに順序付けられます。複数のエンティティ型のエンティティが見つかった場合は、最も具体的なエンティティのみが返されます。たとえば、エンティティ型とエンティティが両方の型で見つかったとして Address と AdminDistrict1 を指定した場合、応答では Address エンティティ情報のみが返されます。
view	string	ISO 3166-1 Alpha-2 リージョン/国コードを指定する文字列。これにより、地政学的な紛争の境界線とラベルが、指定されたユーザー領域に合わせて変更されます。

Summary

バッチ要求の概要

名前	型	説明
successfulRequests	integer	バッチ内の成功した要求の数
totalRequests	integer	バッチ内の要求の合計数

UsageTypeEnum

ジオコーディングポイントに最適な用途。各ジオコーディングポイントは、ポイント、ポイント、Displayまたはその両方としてRoute定義されます。場所へのルートを作成する場合は、ポイントを使用 Route します。マップ上に位置を表示する場合は、ポイントを使用 Display します。たとえば、場所が公園の場合、 Route ポイントは車で入力できる公園への入り口を指定し Display 、ポイントは公園の中心を指定するポイントである場合があります。

名前	型	説明
Display	string
Route	string

Search - Get Reverse Geocoding Batch

同期バッチ要求を送信する

バッチ要求の POST 本文

バッチ応答モデル

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

AADToken

Scopes

subscription-key

SAS Token

例

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Sample Request

Sample Response

定義

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

ResultTypeEnum

ReverseGeocodingBatchRequestBody

ReverseGeocodingBatchRequestItem

Summary

UsageTypeEnum

その他のリソース