Search - Get Geocoding
住所または場所の名前の経度と緯度の座標を取得するために使用します。
Get Geocoding API は、検索対象の場所の経度と緯度の座標を返す HTTP GET リクエストです。
多くの場合、従来のジオコーディングのみに関心がある場合など、完全な検索サービスが多すぎる可能性があります。 検索には、アドレス検索専用にアクセスすることもできます。 ジオコーディングは、問題の住所または部分的な住所のみでジオコーディング エンドポイントをヒットすることによって実行されます。 ジオコーディング検索インデックスは、道路レベルのデータより上のすべてのデータに対してクエリを実行します。 ポイントオブインタレスト(POI)は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、正確な住所、道路、交差点、市内中心部、郡、州などの高レベルの地理情報まで、あらゆるものを処理します。 応答は、番地、郵便番号、自治体、国/地域情報などの詳細な住所プロパティも返します。
GET {endpoint}/geocode?api-version=2026-01-01
GET {endpoint}/geocode?api-version=2026-01-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 パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
address
|
query |
string |
地域または郵便番号のプロパティで指定されている、エリアを基準とした住所の公式の道路線。 この要素の一般的な使用法は、住所または公式の住所を提供することです。 このパラメータは、 |
|
|
admin
|
query |
string |
住所の国のサブディビジョン部分 (WA など)。 このパラメータは、 |
|
|
admin
|
query |
string |
構造化アドレスの郡 (King など)。 このパラメータは、 |
|
|
admin
|
query |
string |
構造化アドレスの名前付き領域。 このパラメータは、 |
|
|
bbox
|
query |
number[] |
境界ボックス オブジェクトとして定義された、地球の四角形領域。 四角形の辺は、経度と緯度の値によって定義されます。 このパラメーターを指定すると、場所クエリの結果を計算するときに地理的領域が考慮されます。 例: lon1、lat1、lon2、lat2。 最小サイズ:約0.00001度(~0.01メートル)。 最大サイズ: 最大グローバル エクステント (-180、-90 から 180、90) |
|
|
coordinates
|
query |
number[] |
経度と緯度として指定された地球上の点。 このパラメーターを指定すると、ユーザーの場所が考慮され、返される結果がユーザーにとってより関連性の高いものになる可能性があります。 例: &coordinates=lon,lat |
|
|
country
|
query |
string |
ISO 3166-1 Alpha-2 地域/国コード (FR など)に指定されたジオコーディング結果のシグナル。 このパラメータは、 |
|
|
locality
|
query |
string |
住所の地域部分 (シアトルなど)。 このパラメータは、 |
|
|
postal
|
query |
string |
住所の郵便番号部分。 このパラメータは、 |
|
|
query
|
query |
string |
住所やランドマーク名など、場所に関する情報を含む文字列。 |
|
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
返される応答の最大数。 デフォルト: 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におけるMicrosoft Entra IDセキュリティの使用についての詳細は、Azure Maps |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は成功しました。 Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
予期しないエラー応答。 Media Types: "application/geo+json", "application/json" ヘッダー 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
例
Search detail address 15127 NE 24th Street, Redmond, WA
要求のサンプル
GET {endpoint}/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond
応答のサンプル
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",
"streetName": "NE 24th St",
"streetNumber": "15127",
"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
要求のサンプル
GET {endpoint}/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US
応答のサンプル
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",
"streetName": "NE 24th St",
"streetNumber": "15127",
"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
要求のサンプル
GET {endpoint}/geocode?api-version=2026-01-01&query=15127 NE 24th Street Redmond WA
応答のサンプル
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",
"streetName": "NE 24th St",
"streetNumber": "15127",
"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
要求のサンプル
GET {endpoint}/geocode?api-version=2026-01-01&query=empire state building
応答のサンプル
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 |
結果のアドレス |
|
Address |
住所の国または地域の下位区分名。 |
|
Address |
国または地域の名前と ISO コード。 |
|
Azure. |
エラー オブジェクト。 |
|
Azure. |
エラーの詳細を含む応答。 |
|
Azure. |
エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。 |
|
Calculation |
ジオコーディング ポイントの計算に使用されたメソッド。 |
|
Confidence |
ジオコーディングされた場所の結果が一致する信頼度。 この値を一致コードと共に使用して、一致に関するより詳細な情報を確認します。 ジオコーディングされた場所の信頼度は、ジオコーディングされた場所の相対的な重要度やユーザーの位置 (指定されている場合) など、多くの要因に基づいています。 |
|
Feature |
|
|
Features |
特徴オブジェクトです。 |
|
Features |
特徴の特性。 |
|
Feature |
フィーチャーの種類は Feature である必要があります。 |
|
Geocode |
ジオコードポイントだ。 |
|
Geocoding |
このオブジェクトは、ジオコーディング呼び出しが成功したときに返されます |
|
Geo |
|
|
Geo |
有効な |
| Intersection |
結果のアドレス。 |
|
Match |
マッチコードを表す枚挙式です。 |
|
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 |
低 |
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 |
ジオコーディング ポイントに最適です。 各ジオコーディング ポイントは、 |
GeocodingResponse
このオブジェクトは、ジオコーディング呼び出しが成功したときに返されます
| 名前 | 型 | 説明 |
|---|---|---|
| features |
クエリから返された特徴の配列。 |
|
| nextLink |
string |
返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。 |
| type |
|
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 |
上位階層 |
UsageTypeEnum
使用タイプを表す枚挙式です。
| 値 | 説明 |
|---|---|
| Display |
表示方法 |
| Route |
Route |