Search - Get Reverse Geocoding Batch

サービス:: Maps

API バージョン:: 2026-01-01

クエリのバッチを 1 回のリクエストで Reverse Geocoding API に送信するために使用します。
API は、1 つの要求を使用してリバースジオコーディング API に最大 100 クエリのバッチを送信する HTTP 要求です。

同期バッチ要求の送信

軽量バッチ要求には、同期 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 オブジェクト逆ジオコーディングでは、サポートされている逆ジオコーディングURI パラメーターを受け取ることができます。

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

バッチ応答モデル

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

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

POST {endpoint}/reverseGeocode:batch?api-version=2026-01-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	Azure Mapsサービスのホストネーム。 Azureパブリッククラウドには`https://atlas.microsoft.com`を使いましょう。特定のAzure Maps地理やソブリンクラウドをターゲットにする場合は、Azure Maps地理的範囲を参照してください。
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の認証管理Manage certificationをご覧ください。
Accept-Language		string	検索結果を返す言語。詳細については、サポートされている言語のを参照してください。

名前

必須

型

説明

x-ms-client-id

string

Azure ADセキュリティモデルと連携して使用することを意図するアカウントを指定します。これはAzure Mapsアカウントの一意IDを表し、Azure Maps管理プレーンのアカウントAPIから取得できます。 Azure MapsにおけるMicrosoft Entra IDセキュリティの使用についての詳細は、Azure Mapsの認証管理Manage certificationをご覧ください。

Accept-Language

string

検索結果を返す言語。

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

要求本文

名前	型	説明
batchItems	ReverseGeocodingBatchRequestItem[]	このバッチで処理する逆ジオコーディングクエリ。各エントリは独立した逆ジオコーディングリクエストとして1つあります。サービスはクエリごとに同じ順序で対応する `GeocodingBatchResponse.batchItems` エントリを1つ返します。

応答

名前	型	説明
200 OK	GeocodingBatchResponse	要求は成功しました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

GeocodingBatchResponse

要求は成功しました。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

AadToken

これらはMicrosoft Entra OAuth 2.0フローです。 Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

Note

このセキュリティ定義使用して、アプリケーションがアクセスを要求している 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

subscription-key

これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して 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

要求のサンプル

HTTP

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"
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "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	ジオコードまたはオートコンプリートで提案された場所のアドレスを構造化されたフィールドに解析します。疎外は正常であり、解決されたエンティティが供給するフィールドのみが埋め込まれます。例えば、 `streetName` と `streetNumber` は道路レベルの住所にのみ現れ、 `intersection` は道路交差点の結果にのみ表示されます。
AddressAdminDistrictsItem	住所を含む行政区画です。例えば、州、州、郡などです。親 `Address.adminDistricts` 配列の1エントリとして返され、エントリは粗い順から細かい順に並んでいます。
AddressCountryRegion	住所を含む国または地域は、表示名およびISO 3166-1 Alpha-2国コードで識別されます。回答ではどちらのフィールドも省略することができます。
Azure.Core.Foundations.Error	エラーオブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。
CalculationMethodEnum	ジオコーディングポイントの計算に使用されたメソッド。
ConfidenceEnum	ジオコーディングされた場所の結果が一致する信頼度。この値をマッチコードと組み合わせて、試合に関するより完全な情報を取得しましょう。ジオコードされた位置の信頼度は、指定された場合の位置の相対的重要性やユーザーの位置など、多くの要因に基づいています。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
FeatureCollectionEnum	`GeoJSON`オブジェクトタイプは、順方向ジオコーディング、逆ジオコーディング、オートコンプリート操作(バッチ形式を含む)からの成功した応答のルートとして用いられます。唯一の値はRFC 7946で定義された「`FeatureCollection`」です。 `Get Polygon` は唯一の例外であり、その応答根は `GeoJSON Feature`である。詳細は `FeatureTypeEnum`を参照。
FeaturesItem	`GeocodingResponse`の`features`配列に単一のエントリがあり、`GeoJSON Feature`オブジェクトの形状に合致します。 1つのジオコーディング済みの位置を表します: `properties`上の構造化データ、 `geometry`上の代表座標、 `bbox`上のオプションの境界ボックス。
FeaturesItemProperties	機能の中 `properties` のペイロード `GeocodingResponse`。ジオコードされた位置のエンティティタイプおよびマッチ品質指標、解析されたアドレスコンポーネント、そして位置を特定の座標にピン留めする1つ以上のジオコードポイントを搭載しています。
FeatureTypeEnum	`Feature`オブジェクトの`GeoJSON`オブジェクトタイプ。各エントリは`FeatureCollection`応答の`features`配列内(ジオコーディング、逆ジオコーディング、オートコンプリート)にタグ付けされ、`Get Polygon`応答の根元に表示されます。唯一の値はRFC 7946で定義された「`Feature`」です。
GeocodePointsItem	1つの位置を示すジオコードポイント:座標と、そのポイントがどのように計算されたか(`calculationMethod`)や最適な用途(`usageTypes`)を記述したメタデータです。単一の特徴は通常、別々の `Display` 点と `Route` 点を返すため、発信者はタスクに合ったものを選択できます。
GeocodingBatchResponse	成功した対応機関は `Get Geocoding Batch`日に帰還しました。提出されたクエリの成功数の `summary` と、リクエスト内のクエリごとに1つの応答エントリを含む `batchItems` 配列を、リクエスト `batchItems` 配列と同じ順に含みます。
GeocodingBatchResponseItem	`GeocodingBatchResponse.batchItems`内の単一のエントリがあり、対応する`GeocodingBatchRequestBody.batchItems`エントリのクエリのいずれかの結果を含んでいます。成功したクエリはジオコード `features` を `GeocodingResponse`と同じ形で表示し、失敗したクエリは `error` を通じて診断情報を表示します。 1つのエントリーに `features` または `error` のうち正確に1つだけが入力されます。
GeocodingBatchResponseSummary	`Get Geocoding Batch`応答の集計カウントを保持します:提出されたバッチの規模や、そのクエリの処理数が成功裏に処理された数です。 `GeocodingBatchResponse.summary`の種類として使われます。
GeoJsonObjectType	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。
GeoJsonPoint	有効な `GeoJSON Point` geometry 型。詳細については、RFC 7946 を参照してください。
Intersection	道路交差点として解決された住所の交差点詳細 — 2つ以上の名前のある通りが交わる角。解決されたエンティティが `RoadIntersection`である場合にのみポップレーションされ、親 `Address.intersection` はそれ以外の場合は省略されます。
MatchCodesEnum	ジオコーディングサービスがどのように特定の位置結果を生み出したかを示すマッチコード値。特徴の `matchCodes` フィールドはこれらの値の配列であり、それらを `confidence` や `type` と組み合わせてマッチの質を評価します。
ResultTypeEnum	`Get Reverse Geocoding Batch`操作によって返されるエンティティタイプ。バッチごとのアイテム `resultTypes` フィールドに1つ以上の値として提供され、そのアイテムの応答を特定の種類の場所に限定します。フィールドを省略すると、すべてのエンティティタイプが対象となります。複数のタイプのエンティティが座標に一致する場合、最も具体的なもののみが返されます。具体的な順にリストアップ: `Address`、 `Neighborhood`、 `PopulatedPlace`、 `Postcode1`、 `AdminDivision1`、 `AdminDivision2`、 `CountryRegion`。
ReverseGeocodingBatchRequestBody	`Get Reverse Geocoding Batch`作戦の要請機関です。 1つ以上のリバースジオコーディングクエリ(1から100まで含む)を運び、サービスはこれを単一の呼び出しとして処理し、`GeocodingBatchResponse`上で並列`batchItems`配列として返します。
ReverseGeocodingBatchRequestItem	`ReverseGeocodingBatchRequestBody.batchItems`配列内の逆ジオコーディングクエリが1つあります。各項目は独立したリバースジオコーディング要求であり、URLクエリパラメータではなくフィールドとして表現される単一の `Get Reverse Geocoding`呼び出しに相当します。 `coordinates`でリバースジオコードを指定し、オプションで`resultTypes`でエンティティタイプを絞り込み、`view`で地政学的ビューを絞り込むこともできます。
UsageTypeEnum	ジオコードポイントの意図された用途。サービスが返すジオコードポイントは、クライアントアプリケーションがそのポイントをどのように利用すべきかを示す1つ以上の使用タイプを持ちます。例えば、地図上に位置を表示するか、車両をそこへルーティングするかなどです。

Address

Object

ジオコードまたはオートコンプリートで提案された場所のアドレスを構造化されたフィールドに解析します。疎外は正常であり、解決されたエンティティが供給するフィールドのみが埋め込まれます。例えば、 streetName と streetNumber は道路レベルの住所にのみ現れ、 intersection は道路交差点の結果にのみ表示されます。

名前	型	説明
addressLine	string	住所の最初の行、通常は通り名と番号です。たとえば、「 `"15127 NE 24th St"` 」のように入力します。
adminDistricts	AddressAdminDistrictsItem[]	住所を含む行政区分は、粗いものから良いものまで順に並んでいます。最初の項目は通常、一階の細分区分(例えばアメリカ合衆国州やカナダの州)です。その後の項目では、国、属属、地域によって定義された細かい区分(例えばインデックス1の郡)が扱われます。
countryRegion	AddressCountryRegion	住所を含む国または地域、表示名およびISO 3166-1 Alpha-2国コード。
formattedAddress	string	完全なアドレスは、そのアドレスの国や地域の慣習に従ってコンポーネントが結合された、人間が読みやすい単一の文字列として表示されます。例: `"15127 NE 24th St, Redmond, WA 98052"`。
intersection	Intersection	アドレスの交差する通りの詳細は、解決されたエンティティが `RoadIntersection` (例:2つの名前付き通りの角)である場合に入力されます。
locality	string	住所が属する地域:通常は市、町、または村です。たとえば、 `"Redmond"`と指定します。
neighborhood	string	地域内で名前が付けられた近隣地域を指す。
postalCode	string	住所の郵便番号が定義されている場合のこと。例: `"98052"`。
streetName	string	解決されたエンティティがストリートレベルの住所である場合、住所の通り名コンポーネントです。例: `"NE 24th St"`。
streetNumber	string	解決された事業体が通りレベルの住所の場合、通り上の家や建物番号。例: `"15127"`。

AddressAdminDistrictsItem

Object

住所を含む行政区画です。例えば、州、州、郡などです。親 Address.adminDistricts 配列の1エントリとして返され、エントリは粗い順から細かい順に並んでいます。

名前	型	説明
name	string	分譲地の正式名称。例えば、アメリカの州の `"Washington"` や郡の `"King County"` などです。
shortName	string	区分名の略称または略称で、定義されている場合の形です。例えば、アメリカの州の `"WA"` です。より細かい細分化はしばしば明確な短縮形を持たず、その場合は `shortName` 繰り返し `name` (例えば `"King County"`)が現れます。

AddressCountryRegion

Object

住所を含む国または地域は、表示名およびISO 3166-1 Alpha-2国コードで識別されます。回答ではどちらのフィールドも省略することができます。

名前	型	説明
ISO	string	国または地域向けのISO 3166-1 Alpha-2国コード。例えば、米国の`"US"`やイギリスの`"GB"`などです。
name	string	国名または地域の表示名。たとえば、「 `"米国"` 」のように入力します。

Azure.Core.Foundations.Error

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラーオブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

CalculationMethodEnum

列挙

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

値	説明
Interpolation	ジオコードポイントは、内挿を使用して道路上のポイントに一致しました。
InterpolationOffset	ジオコードポイントは、内挿を使用して道路上のポイントと照合され、追加のオフセットを使用してポイントを道路の脇にシフトしました。
Parcel	ジオコードポイントがパーセルの中心に一致しました。
Rooftop	ジオコードポイントは、建物の屋上と一致しました。

ConfidenceEnum

列挙

ジオコーディングされた場所の結果が一致する信頼度。この値をマッチコードと組み合わせて、試合に関するより完全な情報を取得しましょう。

ジオコードされた位置の信頼度は、指定された場合の位置の相対的重要性やユーザーの位置など、多くの要因に基づいています。

値説明

High

値	説明
High	信頼度が `High` に設定されている場合、1 つ以上の強力な一致が見つかりました。複数の `High` 信頼度の一致は、該当する場合は重要度順にランク付けされます。たとえば、ランドマークには重要性がありますが、住所には重要ではありません。リクエストに場所やビューが含まれている場合、順位はそれに応じて変動することがあります。例えば、「Paris」の位置クエリは「Paris, France」と「Paris, TX」の両方を信頼して返 `High` 返します。「パリ、フランス」は重要度が高いため常に1位にランクされますが、ユーザーの位置がパリ、TXに非常に近いことを示すか、地図ビューでそのエリアで検索していることを示している場合は例外です。
Medium	状況によっては、返される一致が要求で提供された情報と同じレベルではないことがあります。たとえば、リクエストで住所情報を指定する場合、ジオコードサービスは郵便番号のみに一致できる場合があります。この場合、ジオコードサービスが郵便番号がデータと一致していると自信を持っている場合、信頼度は `Medium` に設定され、マッチコードは `UpHierarchy` に設定され、サービスがすべての情報を一致できず上位検索が必要であることを示します。クエリ内の位置情報があいまいで、位置をランク付けするための追加情報 (ユーザーの位置や位置の相対的な重要度など) がない場合、信頼度は `Medium` に設定されます。例えば、「148th Ave, Bellevue」の位置クエリでは、「148th Ave SE」と「148th Ave NE」の両方が `Medium` 自信を持って返されることがあります。クエリ内の位置情報が特定の場所をジオコーディングするのに十分な情報を提供しない場合、精度の低い位置値が返され、信頼度が `Medium`に設定されることがあります。例えば、住所は提供されているが家番号に一致しない場合、 `RoadBlock` エンティティタイプのジオコード結果が返されることがあります。
Low	試合に対する自信が低い。

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

リクエストに場所やビューが含まれている場合、順位はそれに応じて変動することがあります。例えば、「Paris」の位置クエリは「Paris, France」と「Paris, TX」の両方を信頼して返 High 返します。「パリ、フランス」は重要度が高いため常に1位にランクされますが、ユーザーの位置がパリ、TXに非常に近いことを示すか、地図ビューでそのエリアで検索していることを示している場合は例外です。

Medium

状況によっては、返される一致が要求で提供された情報と同じレベルではないことがあります。たとえば、リクエストで住所情報を指定する場合、ジオコードサービスは郵便番号のみに一致できる場合があります。この場合、ジオコードサービスが郵便番号がデータと一致していると自信を持っている場合、信頼度は Medium に設定され、マッチコードは UpHierarchy に設定され、サービスがすべての情報を一致できず上位検索が必要であることを示します。

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

クエリ内の位置情報が特定の場所をジオコーディングするのに十分な情報を提供しない場合、精度の低い位置値が返され、信頼度が Mediumに設定されることがあります。例えば、住所は提供されているが家番号に一致しない場合、 RoadBlock エンティティタイプのジオコード結果が返されることがあります。

Low

試合に対する自信が低い。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

FeatureCollectionEnum

列挙

GeoJSONオブジェクトタイプは、順方向ジオコーディング、逆ジオコーディング、オートコンプリート操作(バッチ形式を含む)からの成功した応答のルートとして用いられます。唯一の値はRFC 7946で定義された「FeatureCollection」です。 Get Polygon は唯一の例外であり、その応答根は GeoJSON Featureである。詳細は FeatureTypeEnumを参照。

値	説明
FeatureCollection	`GeoJSON FeatureCollection`オブジェクトタイプです。成功するジオコーディング、逆ジオコーディング、オートコンプリート応答体の根源として現れます。 `Get Polygon` 代わりに `Feature` 根を使います。

FeaturesItem

Object

GeocodingResponseのfeatures配列に単一のエントリがあり、GeoJSON Featureオブジェクトの形状に合致します。 1つのジオコーディング済みの位置を表します: properties上の構造化データ、 geometry上の代表座標、 bbox上のオプションの境界ボックス。

名前	型	説明
bbox	number[] (double)	WGS 84の経度・緯度順で、特徴の幾何学を含む最小の軸に揃った長方形。 RFC 7946、セクション5に基づき`[westLon, southLat, eastLon, northLat]`としてエンコードされています。
geometry	GeoJsonPoint	主な `GeoJSON Point` はジオコードされた位置を表し、座標はWGS 84の経度/緯度の順序で示されています。
id	string	利用可能な場合、機能のオプションでサービス割り当ての識別子を付けます。
properties	FeaturesItemProperties	ジオコードされた場所に関する構造化データ(エンティティタイプ、マッチ品質指標、住所コンポーネント、1つ以上のジオコードポイントなど)。
type	FeatureTypeEnum	`GeoJSON`オブジェクトタイプです。 RFC 7946で定義された通り、常に`Feature`。

FeaturesItemProperties

Object

機能の中 properties のペイロード GeocodingResponse。ジオコードされた位置のエンティティタイプおよびマッチ品質指標、解析されたアドレスコンポーネント、そして位置を特定の座標にピン留めする1つ以上のジオコードポイントを搭載しています。

名前	型	説明
address	Address	ジオコードされた場所の住所を、地域、郵便番号、国・地域、そして(利用可能な場合)通り名や番号などの構造化されたフィールドに解析します。
confidence	ConfidenceEnum	ジオコードされた位置がリクエストにどれだけ強く一致しているか。 `matchCodes`と組み合わせて、試合の質を完全に把握しましょう。価値リストと格付けに影響を与える要因については `ConfidenceEnum` を参照してください。
geocodePoints	GeocodePointsItem[]	位置を示す1つ以上のジオコードポイントがあり、それぞれにその由来方法(`calculationMethod`)と最適な用途(`usageTypes`)が記されています。例えば、地図上の視覚的な配置用 `Display` 、ナビゲーション目的地として使うための `Route` などです。
matchCodes	MatchCodesEnum[]	ジオコーディングサービスがクエリに対してこの結果をどのように生成したか:要求された特異性での直接一致(`Good`)、複数の候補の一つ(`Ambiguous`)、あるいは地理的階層のより厳密なレベルへのフォールバック(`UpHierarchy`)。複数の値が存在する場合もあります。例えば、 `Ambiguous` と `UpHierarchy` の組み合わせは、サービスが要求された特異性をマッチングできず、より粗いレベルで複数のマッチを見つけたことを示します。値ごとの説明については `MatchCodesEnum` を参照してください。 `confidence` と組み合わせて、マッチ品質の完全な全体像を把握してください。
type	string	ジオコードされた位置が解決されたエンティティタイプ。 `Address`、`RoadBlock`、`RoadIntersection`、`Neighborhood`、`PopulatedPlace`、`Postcode1`、`AdminDivision1`、`AdminDivision2`、または`CountryRegion`のいずれかです。

FeatureTypeEnum

列挙

FeatureオブジェクトのGeoJSONオブジェクトタイプ。各エントリはFeatureCollection応答のfeatures配列内(ジオコーディング、逆ジオコーディング、オートコンプリート)にタグ付けされ、Get Polygon応答の根元に表示されます。唯一の値はRFC 7946で定義された「Feature」です。

値	説明
Feature	`GeoJSON Feature`オブジェクトタイプです。 `FeatureCollection`応答内のすべてのフィーチャーに現れ、`Get Polygon`応答のルートにも存在します。

GeocodePointsItem

Object

1つの位置を示すジオコードポイント:座標と、そのポイントがどのように計算されたか(calculationMethod)や最適な用途(usageTypes)を記述したメタデータです。単一の特徴は通常、別々の Display 点と Route 点を返すため、発信者はタスクに合ったものを選択できます。

名前	型	説明
calculationMethod	CalculationMethodEnum	ポイントの計算方法。例えば、建物の屋上にスナップしたり、道路の中心線に沿って補間したりします。価値リストは `CalculationMethodEnum` を参照してください。
geometry	GeoJsonPoint	このジオコードポイントの座標は `GeoJSON Point`で、WGS 84の経度・緯度順で値が示されます。
usageTypes	UsageTypeEnum[]	ジオコードポイントが最も適しているのは、地図上の視覚的な配置 `Display` 、ルート目的地として `Route` することなどです。点は両方を同時に持つこともあります。値ごとの詳細は `UsageTypeEnum` を参照してください。非自明範囲の特徴について各位置付けの方法も含まれます。

GeocodingBatchResponse

Object

成功した対応機関は Get Geocoding Batch日に帰還しました。提出されたクエリの成功数の summary と、リクエスト内のクエリごとに1つの応答エントリを含む batchItems 配列を、リクエスト batchItems 配列と同じ順に含みます。

名前	型	説明
batchItems	GeocodingBatchResponseItem[]	バッチの各クエリ結果。各エントリは、 `GeocodingBatchRequestBody.batchItems`内の同じ配列インデックスにあるリクエストエントリと位置的に対応しています。 `error` 入力されたエントリは失敗したクエリを表し、`features` 入力されたエントリは成功したクエリを表します。
nextLink	string	応答がページ分けされている場合、次のページを取得するためのURLが含まれています。これは、回答が1回の通話で返答できないほど多い場合に便利で、複数のページにわたる結果を閲覧できます。
summary	GeocodingBatchResponseSummary	集計はバッチ全体のカウント、提出されたクエリの総数、そして成功裏に完了した数です。

GeocodingBatchResponseItem

Object

GeocodingBatchResponse.batchItems内の単一のエントリがあり、対応するGeocodingBatchRequestBody.batchItemsエントリのクエリのいずれかの結果を含んでいます。成功したクエリはジオコード features を GeocodingResponseと同じ形で表示し、失敗したクエリは error を通じて診断情報を表示します。 1つのエントリーに features または error のうち正確に1つだけが入力されます。

名前	型	説明
error	ErrorDetail	バッチ内で失敗したクエリの診断情報であり、エントリごとのエラー経路が `features`の成功経路を補完します。エントリーが失敗した場合にのみ居住され、誤差ごとの形については `ErrorDetail` を参照してください。
features	FeaturesItem[]	このバッチエントリのクエリでジオコードされた `GeoJSON Feature` オブジェクトの配列です。各 `Feature` は単一のジオコードされた場所を表し、詳細は `properties` で、主座標は `geometry`で公開されます。エントリーが成功した時のみ居住。
nextLink	string	応答がページ分けされている場合、次のページを取得するためのURLが含まれています。これは、回答が1回の通話で返答できないほど多い場合に便利で、複数のページにわたる結果を閲覧できます。
optionalId	string	発信者が提供した識別子は対応する `GeocodingBatchRequestItem.optionalId`から反響して返ってきました。リクエストエントリで1つが提供された場合にのみ入力されました。配列位置が不十分な場合の応用側相関に有用です。
type	FeatureCollectionEnum	このエントリーの成功本体の `GeoJSON` オブジェクトタイプ。 RFC 7946で定義された通り、常に`FeatureCollection`。エントリーが成功した時のみ居住。

GeocodingBatchResponseSummary

Object

Get Geocoding Batch応答の集計カウントを保持します:提出されたバッチの規模や、そのクエリの処理数が成功裏に処理された数です。 GeocodingBatchResponse.summaryの種類として使われます。

名前	型	説明
successfulRequests	integer (int32)	バッチ内で正常に処理されたクエリの数、つまり`GeocodingBatchResponse.batchItems`の回答エントリが`error`ではなく`features`を持つもの。
totalRequests	integer (int32)	バッチで提出された問い合わせの総数。 `successfulRequests`を引いて失敗したクエリの数を導き出します。

GeoJsonObjectType

列挙

GeoJSON 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

値	説明
Point	ジオメトリを `GeoJSON Point` します。
MultiPoint	ジオメトリを `GeoJSON MultiPoint` します。
LineString	ジオメトリを `GeoJSON LineString` します。
MultiLineString	ジオメトリを `GeoJSON MultiLineString` します。
Polygon	ジオメトリを `GeoJSON Polygon` します。
MultiPolygon	ジオメトリを `GeoJSON MultiPolygon` します。
GeometryCollection	ジオメトリを `GeoJSON GeometryCollection` します。
Feature	`GeoJSON Feature` オブジェクト。
FeatureCollection	`GeoJSON FeatureCollection` オブジェクト。

GeoJsonPoint

Object

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

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

Intersection

Object

道路交差点として解決された住所の交差点詳細 — 2つ以上の名前のある通りが交わる角。解決されたエンティティが RoadIntersectionである場合にのみポップレーションされ、親 Address.intersection はそれ以外の場合は省略されます。

名前	型	説明
baseStreet	string	交差点の主要通り、通常は住所番号が参照する通りです。
displayName	string	交差点を人間が読みやすい名前で呼ぶ、例えば `"5th Avenue & Main Street"`。
intersectionType	string	交差点の形状を説明する短いラベル。例えば、平面交差点と橋や高架橋のような立体交差の交差点を区別することなどです。
secondaryStreet1	string	交差点で `baseStreet` の最初の交差点が出会います。
secondaryStreet2	string	交差点の2つ目の交差点、1本目がいる場合は。 3本以上の通りが交差する地点のみが居住しています。

MatchCodesEnum

列挙

ジオコーディングサービスがどのように特定の位置結果を生み出したかを示すマッチコード値。特徴の matchCodes フィールドはこれらの値の配列であり、それらを confidence や type と組み合わせてマッチの質を評価します。

値	説明
Good	ジオコーディングサービスはクエリを広げることなくこの候補を生成しました:結果は要求された具体度でクエリと一致します。
Ambiguous	場所は複数のマッチング候補の一つです。例えば、「128 Main St.」という住所を問い合わせると、「128 North Main St.」と「128 South Main St.」の2つの場所が返ってくることがあります。なぜなら、どちらを選ぶべきか判断する情報が不足しているからです。
UpHierarchy	この場所は地理的な階層の上位を意味します。これは、場所要求の一致が見つからなかった場合に発生するため、より正確でない結果が返されます。

ResultTypeEnum

列挙

Get Reverse Geocoding Batch操作によって返されるエンティティタイプ。バッチごとのアイテム resultTypes フィールドに1つ以上の値として提供され、そのアイテムの応答を特定の種類の場所に限定します。フィールドを省略すると、すべてのエンティティタイプが対象となります。複数のタイプのエンティティが座標に一致する場合、最も具体的なもののみが返されます。具体的な順にリストアップ: Address、 Neighborhood、 PopulatedPlace、 Postcode1、 AdminDivision1、 AdminDivision2、 CountryRegion。

値	説明
Address	特定の住所。
Neighborhood	人口密集地内の地域で認識された地域であり、しばしば非公式または文化的に定義された境界線があります。
PopulatedPlace	都市、町、村など、人間の居住地の集中エリア。
Postcode1	郵便番号のような最小の郵便番号カテゴリ。
AdminDivision1	国や地域内の第一行政レベル、例えば州や州。
AdminDivision2	国や地域内の第二の行政レベル、例えば郡。
CountryRegion	国や地域。

ReverseGeocodingBatchRequestBody

Object

Get Reverse Geocoding Batch作戦の要請機関です。 1つ以上のリバースジオコーディングクエリ(1から100まで含む)を運び、サービスはこれを単一の呼び出しとして処理し、GeocodingBatchResponse上で並列batchItems配列として返します。

名前	型	説明
batchItems	ReverseGeocodingBatchRequestItem[]	このバッチで処理する逆ジオコーディングクエリ。各エントリは独立した逆ジオコーディングリクエストとして1つあります。サービスはクエリごとに同じ順序で対応する `GeocodingBatchResponse.batchItems` エントリを1つ返します。

ReverseGeocodingBatchRequestItem

Object

ReverseGeocodingBatchRequestBody.batchItems配列内の逆ジオコーディングクエリが1つあります。各項目は独立したリバースジオコーディング要求であり、URLクエリパラメータではなくフィールドとして表現される単一の Get Reverse Geocoding呼び出しに相当します。 coordinatesでリバースジオコードを指定し、オプションでresultTypesでエンティティタイプを絞り込み、viewで地政学的ビューを絞り込むこともできます。

名前	型	説明
coordinates	number[] (double)	逆ジオコードの位置は、WGS 84順にエンコードされた `[longitude, latitude]` 。例えば、ワシントン州レッドモンドのポイントを `[-122.138681, 47.630358]` します。
optionalId	string	オプションの発信者提供識別子は、対応する応答エントリに `GeocodingBatchResponseItem.optionalId`として反響しました。配列位置のみに依存するのではなく、安定したアプリケーション側識別子によるリクエスト応答の相関に有用です。
resultTypes	ResultTypeEnum[]	回答を特定の場所に限定します。省略した場合、すべての事業体タイプが対象となります。複数のタイプのエンティティが一致する際の値リストと最も具体的な勝ち選定行動については、 `ResultTypeEnum` を参照してください。
view	string	紛争のある国境に適用されるべき地域を特定する ISO 3166-1 Alpha-2地域/国コードと回答におけるラベル。利用可能な値は「サポート済みビュー」を参照してください。

UsageTypeEnum

列挙

ジオコードポイントの意図された用途。サービスが返すジオコードポイントは、クライアントアプリケーションがそのポイントをどのように利用すべきかを示す1つ以上の使用タイプを持ちます。例えば、地図上に位置を表示するか、車両をそこへルーティングするかなどです。

値	説明
Display	ジオコードポイントは地図上に位置を表示するのに適しています。公園や建物のように非自明な範囲を持つ特徴の場合、 `Display` 点は通常、特徴の視覚的中心付近にあります。
Route	ジオコードポイントはルートの目的地として適しています。公園や建物のように非自明な範囲を持つ特徴の場合、 `Route` 点は通常、視覚的中心ではなく車両がアクセス可能な入口に配置されます。