Search - Get Geocoding

リファレンス

サービス:: Maps

API バージョン:: 2023-06-01

番地または場所の名前の経度と緯度の座標を取得するには、を使用します。

Get Geocoding API は、検索対象の場所の経度と緯度の座標を返す HTTP GET 要求です。

多くの場合、従来のジオコーディングにのみ関心がある場合など、完全な検索サービスが多すぎる可能性があります。検索には、アドレス検索専用にアクセスすることもできます。ジオコーディングは、問題の住所または一部の住所のみを使用してジオコーディングエンドポイントにヒットすることによって実行されます。ジオコーディング検索インデックスは、道路レベルのデータの上にあるすべてのものに対してクエリが実行されます。ポイントオブインタレスト (POI) は返されません。ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。また、正確な通りの住所や通りや交差点、市内中心部、郡、州などのより高いレベルの地域からすべてを処理します。応答では、番地、郵便番号、市区町村、国/地域情報などの詳細な住所プロパティも返されます。

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01

省略可能なパラメーターを含む:

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	Azure Maps API のバージョン番号。
addressLine	query		string	地域または postalCode プロパティで指定された、エリアに対する相対的な住所の公式の番地。この要素の一般的な用途は、番地または公式の住所を指定することです。クエリが指定されている場合は、このパラメーターを使用しないでください。
adminDistrict	query		string	WA など、住所の国区分部分。クエリが指定されている場合は、このパラメーターを使用しないでください。
adminDistrict2	query		string	King などの構造化された住所の郡。クエリが指定されている場合は、このパラメーターを使用しないでください。
adminDistrict3	query		string	構造化アドレスの名前付き領域。クエリが指定されている場合は、このパラメーターを使用しないでください。
bbox	query		number[]	境界ボックスオブジェクトとして定義された、地球上の四角形の領域。四角形の辺は、経度と緯度の値によって定義されます。このパラメーターを指定すると、場所クエリの結果を計算するときに地理的領域が考慮されます。例: lon1、lat1、lon2、lat2
coordinates	query		number[]	経度と緯度として指定された地球上のポイント。このパラメーターを指定すると、ユーザーの場所が考慮され、返される結果はユーザーにより関連性が高い場合があります。例: &coordinates=lon,lat
countryRegion	query		string	ジオコーディング結果のシグナルを ISO 3166-1 Alpha-2 リージョン/国コード (FR./ など) に指定します。クエリが指定されている場合は、このパラメーターを使用しないでください。
locality	query		string	シアトルなどの住所のローカリティ部分。クエリが指定されている場合は、このパラメーターを使用しないでください。
postalCode	query		string	住所の郵便番号の部分。クエリが指定されている場合は、このパラメーターを使用しないでください。
query	query		string	住所やランドマーク名など、場所に関する情報を含む文字列。
top	query		integer int32	返される応答の最大数。既定値: 5、最小: 1、最大: 20。
view	query		string	ISO 3166-1 Alpha-2 地域/国コードを表す文字列。これにより、地政学的な紛争の境界線とラベルが、指定されたユーザー領域に合わせて変更されます。既定では、View パラメーターは、要求で定義していない場合でも "Auto" に設定されます。詳細については、「サポートされているビュー」を参照し、使用可能なビューを参照してください。

要求ヘッダー

名前	必須	型	説明
Accept-Language		string	検索結果を返す言語。詳細については、「サポートされている言語」を参照してください。
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 セキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

名前	型	説明
200 OK	GeocodingResponse	OK Media Types: "application/geo+json" ヘッダー x-ms-request-id: string
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。 Media Types: "application/geo+json"

名前

型

説明

200 OK

GeocodingResponse

Media Types: "application/geo+json"

ヘッダー

x-ms-request-id: string

Other Status Codes

ErrorResponse

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

Media Types: "application/geo+json"

セキュリティ

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

例

Search detail address 15127 NE 24th Street, Redmond, WA

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Search detail address 15127 NE 24th Street, Redmond, WA by query

Search landmark Empire State Building by query

Search detail address 15127 NE 24th Street, Redmond, WA

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=15127 NE 24th Street Redmond WA

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=empire state building

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

定義

名前	説明
Address	結果のアドレス
AdminDistricts	住所の国または地域の下位区分名。この要素は通常、最初の順序の管理区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。
CalculationMethodEnum	ジオコーディングポイントの計算に使用されたメソッド。
ConfidenceEnum	ジオコーディングされた場所の結果が一致する信頼度。この値を一致コードと共に使用して、一致に関するより完全な情報を確認します。ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの場所 (指定されている場合) など、多くの要因に基づいています。
CountryRegion
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FeatureCollectionEnum	FeatureCollection オブジェクトの種類は FeatureCollection である必要があります。
FeaturesItem
FeatureTypeEnum	フィーチャーの種類は Feature である必要があります。
GeocodePoints	計算方法と推奨される用途が異なるジオコードポイントのコレクション。
GeocodingResponse	このオブジェクトは、成功したジオコーディング呼び出しから返されます
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
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]の場合は、Washington、For adminDistrict[1]など)、これは郡の完全な名前である可能性があります。
shortName	string	対応する adminDistrict フィールドの短い名前(adminDistrict[0]の場合は、WA、For adminDistrict[1]など)、これは郡の短い名前である可能性があります。

CalculationMethodEnum

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

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

ConfidenceEnum

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

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

名前型説明

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` 、ポイントは公園の中心を指定するポイントである場合があります。

GeocodingResponse

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

名前	型	説明
features	FeaturesItem[]
nextLink	string	は、返される機能の次のページへのリンクです。最後のページの場合は、このフィールドはありません。
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

UsageTypeEnum

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

名前	型	説明
Display	string
Route	string

次の方法で共有

Search - Get Geocoding

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

スコープ

subscription-key

SAS Token

例

Search detail address 15127 NE 24th Street, Redmond, WA

要求のサンプル

応答のサンプル

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

要求のサンプル

応答のサンプル

Search detail address 15127 NE 24th Street, Redmond, WA by query

要求のサンプル

応答のサンプル

Search landmark Empire State Building by query

要求のサンプル

応答のサンプル

定義

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingResponse

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

UsageTypeEnum

その他のリソース