Search - Get Geocode Autocomplete

サービス:: Maps

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

ユーザーの場所と部分的なクエリに基づいて、提案されたエンティティのランク付けされたリストを取得するために使用します。
ユーザーの位置情報と、完全なクエリ文字列のプレフィックスとして機能する部分クエリ(クエリプレフィックスと呼ばれる)が与えられたとき、Azure Maps AutocompleteのAPIは、ユーザーが検索している可能性が高い提案エンティティのリストを返します。これらのエンティティは、可能性が高いものから低いものの順にランク付けされます。

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}

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

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}&coordinates={coordinates}&bbox={bbox}&top={top}&resultTypeGroups={resultTypeGroups}&resultTypes={resultTypes}&view={view}&countryRegion={countryRegion}

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 バージョン。
query	query	True	string	必須。ユーザーのクエリプレフィックス。例:「1マイクロ」または「ミュアウッズ」。
bbox	query		number[]	`coordinates`が提供されていない場合に必要です。境界ボックスオブジェクトとして定義された、地球の四角形領域。四角形の辺は、経度と緯度の値によって定義されます。このパラメーターを指定すると、場所クエリの結果を計算するときに地理的領域が考慮されます。例: lon1、lat1、lon2、lat2。最小サイズ:約0.00001度(~0.01メートル)。最大サイズ: 最大グローバルエクステント (-180、-90 から 180、90)
coordinates	query		number[]	`bbox`が提供されていない場合に必要です。経度と緯度として指定された地球上の点。このパラメータを指定すると、ユーザーの位置情報が考慮され、返される結果がユーザーにとってより関連性が高まる場合があります。例: &coordinates=lon,lat ノート:`coordinates` が提供されている場合は、 `bbox` が 2 次信号になります。
countryRegion	query		string	オートコンプリート結果のシグナルは、FR など、指定された ISO 3166-1 Alpha-2 地域/国コードに。指定した国/地域の結果のみが返されます。
resultTypeGroups	query		AutocompleteResultTypeGroupsEnum[]	返されるエンティティ型グループのコンマ区切りリスト。可能な値は次のとおりです住所場所
resultTypes	query		AutocompleteResultTypeEnum[]	返されるエンティティ型のコンマ区切りリスト。タイプグループが [アドレス] に設定されている場合、サポートされるタイプは次のとおりです。住所道路封鎖その他のタイプはすべて、Place タイプグループに属します。これらには、AdminDivision1、Neighborhood、PopulatedPlace などのエンティティが含まれる場合があります。既定値は、使用可能なすべてのエンティティタイプです。
top	query		integer (int32) minimum: 1 maximum: 20	返される応答の最大数。デフォルト: 5、最小値: 1、最大値: 20。
view	query		string	ISO 3166-1 Alpha-2 地域/国番号を表す文字列。これにより、地政学的な紛争の境界とラベルが、指定されたユーザー領域に合わせて変更されます。既定では、要求で定義していない場合でも、View パラメーターは "Auto" に設定されます。詳細については、サポートされているビューのを参照し、使用可能なビューを参照してください。

要求ヘッダー

名前	必須	型	説明
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

検索結果を返す言語。

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

応答

名前	型	説明
200 OK	AutocompleteResponse	要求は成功しました。 Media Types: "application/geo+json", "application/json"
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。 Media Types: "application/geo+json", "application/json" ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

AutocompleteResponse

要求は成功しました。

Media Types: "application/geo+json", "application/json"

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

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 リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 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

例

Autocomplete API call to search for '1 Microsoft'

Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result

Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups

Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups

Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes

Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups

Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups

Autocomplete API call to search for '1 Microsoft'

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft&coordinates=-113.301894,49.201888

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "Address",
        "address": {
          "streetNumber": "1",
          "streetName": "Microsoft Way",
          "addressLine": "1 Microsoft Way",
          "locality": "Redmond",
          "adminDistricts": [
            {
              "name": "Washington"
            },
            {
              "name": "King County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "98052",
          "formattedAddress": "1 Microsoft Way, Redmond, Washington 98052, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "LandmarkBuilding",
        "address": {
          "locality": "Bellevue",
          "adminDistricts": [
            {
              "name": "Washington"
            },
            {
              "name": "King County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "Bellevue, Washington, United States"
        },
        "name": "Microsoft-Advanta C"
      }
    }
  ]
}

Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft Way, Redmond&coordinates=-113.301894,49.201888&resultTypeGroups=Place&resultTypes=RoadBlock

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": []
}

Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Mill Valley",
          "adminDistricts": [
            {
              "name": "California",
              "shortName": "CA"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "94941",
          "streetName": "Muir Woods Trail",
          "addressLine": "",
          "formattedAddress": "Muir Woods Trail, Mill Valley, CA 94941, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Sausalito",
          "adminDistricts": [
            {
              "name": "California",
              "shortName": "CA"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "94965",
          "streetName": "Muir Woods Rd",
          "addressLine": "",
          "formattedAddress": "Muir Woods Rd, Sausalito, CA 94965, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Las Vegas",
          "adminDistricts": [
            {
              "name": "Nevada",
              "shortName": "NV"
            },
            {
              "name": "Clark County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "89122",
          "streetName": "Muir Woods Pkwy",
          "addressLine": "",
          "formattedAddress": "Muir Woods Pkwy, Las Vegas, NV 89122, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Stockton",
          "adminDistricts": [
            {
              "name": "California",
              "shortName": "CA"
            },
            {
              "name": "San Joaquin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "95209",
          "streetName": "Muir Woods Ave",
          "addressLine": "",
          "formattedAddress": "Muir Woods Ave, Stockton, CA 95209, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Stonington",
          "adminDistricts": [
            {
              "name": "Maine",
              "shortName": "ME"
            },
            {
              "name": "Hancock County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "04681",
          "streetName": "Muir Woods Rd",
          "addressLine": "",
          "formattedAddress": "Muir Woods Rd, Stonington, ME 04681, United States"
        }
      }
    }
  ]
}

Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place&resultTypes=Park,PopulatedPlace

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "PopulatedPlace",
        "address": {
          "locality": "Muir Woods",
          "adminDistricts": [
            {
              "name": "Georgia"
            },
            {
              "name": "Fulton County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "30349",
          "formattedAddress": "Muir Woods, Georgia 30349, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "Park",
        "address": {
          "adminDistricts": [
            {
              "name": "California"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "California"
        },
        "name": "Muir Woods National Park"
      }
    }
  ]
}

Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "Park",
        "address": {
          "adminDistricts": [
            {
              "name": "California"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "California"
        },
        "name": "Muir Woods National Monument"
      }
    }
  ]
}

Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "Forest",
        "address": {
          "adminDistricts": [
            {
              "name": "Wisconsin"
            },
            {
              "name": "Dane County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "Wisconsin"
        },
        "name": "Muir Woods"
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "PopulatedPlace",
        "address": {
          "locality": "Muir Woods",
          "adminDistricts": [
            {
              "name": "Georgia"
            },
            {
              "name": "Fulton County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "30349",
          "formattedAddress": "Muir Woods, Georgia 30349, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "Park",
        "address": {
          "adminDistricts": [
            {
              "name": "California"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "California"
        },
        "name": "Muir Woods National Monument"
      }
    }
  ]
}

Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups

要求のサンプル

HTTP

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address&resultTypes=RoadBlock

応答のサンプル

状態コード:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "streetName": "Muir St",
          "addressLine": " Muir St",
          "locality": "Grosse Pointe Farms",
          "adminDistricts": [
            {
              "name": "Michigan"
            },
            {
              "name": "Wayne County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "48236",
          "formattedAddress": "Muir St, Grosse Pointe Farms, Michigan 48236, United States"
        }
      }
    }
  ]
}

定義

名前	説明
Address	ジオコードまたはオートコンプリートで提案された場所のアドレスを構造化されたフィールドに解析します。疎外は正常であり、解決されたエンティティが供給するフィールドのみが埋め込まれます。例えば、 `streetName` と `streetNumber` は道路レベルの住所にのみ現れ、 `intersection` は道路交差点の結果にのみ表示されます。
AddressAdminDistrictsItem	住所を含む行政区画です。例えば、州、州、郡などです。親 `Address.adminDistricts` 配列の1エントリとして返され、エントリは粗い順から細かい順に並んでいます。
AddressCountryRegion	住所を含む国または地域は、表示名およびISO 3166-1 Alpha-2国コードで識別されます。回答ではどちらのフィールドも省略することができます。
AutocompleteFeature	`AutocompleteResponse`の`features`配列に単一のエントリがあり、`GeoJSON Feature`オブジェクトの形状に準拠しています。これは1つのオートコンプリート提案を表しています。分類(`type`、 `typeGroup`)、解析済みの住所、オプションの地名が `properties`を通じて公開され、利用可能な場合は代表的な座標が `geometry` に示されます。
AutocompleteProperties	`AutocompleteFeature`の最中`properties`の搭載量です。結果の分類(`typeGroup`、 `type`)、解析されたアドレス、そして(多くの `Place`型付け結果の場合)別の表示名を保持します。
AutocompleteResponse	成功した対応機関は `Get Autocomplete`日に帰還しました。 `GeoJSON FeatureCollection`として符号化され、`features`配列にはオートコンプリート提案ごとに1つの`Feature`が含まれ、最も可能性が高い順にランク付けされます。
AutocompleteResultTypeEnum	`Get Autocomplete`が入力フィルター(`resultTypes`クエリパラメータを介して)および出力ラベル(各`AutocompleteProperties`の`type`フィールドを通じて)として使用されるオートコンプリート提案の分類です。メンバーは住所、道路区間、行政区域、人口密集地、自然の特徴、注目ポイントを含む地名録スタイルの分類を定義します。この分類は `AutocompleteResultTypeGroupsEnum`によって大きく分けられます。 `Address`は住所や道路区間をカバーし、他のすべての結果タイプを扱う `Place`です。
AutocompleteResultTypeGroupsEnum	オートコンプリートの提案を大まかに二つのグループに分類するものです。 `Get Autocomplete`は、`resultTypeGroups`クエリパラメータを通じて入力フィルターとして使用され(どの種類の提案が返されるかを制限)、また各`AutocompleteProperties`の`typeGroup`フィールドを通じて出力分類器として(返される提案がどのグループに属するかを識別)として使用されます。 `Address`グループは個々の住所や通り区間をカバーし、`Place`グループは行政区域、人口密集地、自然の特徴、観光地などのその他のエンティティタイプをカバーします。
Azure.Core.Foundations.Error	エラーオブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。
FeatureCollectionEnum	`GeoJSON`オブジェクトタイプは、順方向ジオコーディング、逆ジオコーディング、オートコンプリート操作(バッチ形式を含む)からの成功した応答のルートとして用いられます。唯一の値はRFC 7946で定義された「`FeatureCollection`」です。 `Get Polygon` は唯一の例外であり、その応答根は `GeoJSON Feature`である。詳細は `FeatureTypeEnum`を参照。
FeatureTypeEnum	`Feature`オブジェクトの`GeoJSON`オブジェクトタイプ。各エントリは`FeatureCollection`応答の`features`配列内(ジオコーディング、逆ジオコーディング、オートコンプリート)にタグ付けされ、`Get Polygon`応答の根元に表示されます。唯一の値はRFC 7946で定義された「`Feature`」です。
GeoJsonObjectType	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。
GeoJsonPoint	有効な `GeoJSON Point` geometry 型。詳細については、RFC 7946 を参照してください。
Intersection	道路交差点として解決された住所の交差点詳細 — 2つ以上の名前のある通りが交わる角。解決されたエンティティが `RoadIntersection`である場合にのみポップレーションされ、親 `Address.intersection` はそれ以外の場合は省略されます。

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	国名または地域の表示名。たとえば、「 `"米国"` 」のように入力します。

AutocompleteFeature

Object

AutocompleteResponseのfeatures配列に単一のエントリがあり、GeoJSON Featureオブジェクトの形状に準拠しています。これは1つのオートコンプリート提案を表しています。分類(type、 typeGroup)、解析済みの住所、オプションの地名が propertiesを通じて公開され、利用可能な場合は代表的な座標が geometry に示されます。

名前	型	説明
geometry	GeoJsonPoint	オートコンプリート提案の座標は `GeoJSON Point`で、WGS 84の経度/緯度順で値を示します。提案が単一の代表的な座標に解決しない場合は省略されることがあります。例えば、広範な地域や地名の提案などです。
properties	AutocompleteProperties	オートコンプリート提案に関する構造化データ、分類、解析された住所、そして( `Place`型提案の場合)地名が含まれます。物件ごとの形状については `AutocompleteProperties` を参照してください。
type	FeatureTypeEnum	`GeoJSON`オブジェクトタイプです。 RFC 7946で定義された通り、常に`Feature`。

AutocompleteProperties

Object

AutocompleteFeatureの最中propertiesの搭載量です。結果の分類(typeGroup、 type)、解析されたアドレス、そして(多くの Place型付け結果の場合)別の表示名を保持します。

名前	型	説明
address	Address	オートコンプリート結果のアドレスを構造化フィールドに解析します。 `Address`タイプされた結果は通常、街路レベルの詳細を含む。 `Place`型付けの結果は、地域、行政区、国/地域(通常はストリートレベルのフィールドは省略)を含みます。
name	string	提案された場所の展示名。構造化`address`に名前がすでに表示されていない場合(例えば、公園、ランドマーク、その他の名前のある特徴)に対して、`Place`型付けの結果に入力されます。 `Address`型付け結果および`address`に名前が含まれている`Place`型付け結果(例:`address.locality`に名前が記載されている人口のある場所)は省略。
type	AutocompleteResultTypeEnum	結果が解決される特定のエンティティの種類。例えば、住所、人口の多い場所、公園、またはランドマークなどです。 `AutocompleteResultTypeGroupsEnum`ごとに`Address`グループと`Place`グループに分割された完全な値リストについては、`AutocompleteResultTypeEnum`を参照してください。
typeGroup	AutocompleteResultTypeGroupsEnum	結果を広義に住所または名前のある場所のいずれかに分類すること。価値リストは `AutocompleteResultTypeGroupsEnum` を参照してください。

AutocompleteResponse

Object

成功した対応機関は Get Autocomplete日に帰還しました。 GeoJSON FeatureCollectionとして符号化され、features配列にはオートコンプリート提案ごとに1つのFeatureが含まれ、最も可能性が高い順にランク付けされます。

名前	型	説明
features	AutocompleteFeature[]	クエリが返す `GeoJSON Feature` オブジェクトの配列です。各 `Feature` は単一のオートコンプリート提案を表します。分類(`type`、 `typeGroup`)、解析された住所、オプションの地名は `properties`を通じて公開され、主要な座標は `geometry`で公開されます。
nextLink	string	応答がページ分けされている場合、次のページを取得するためのURLが含まれています。これは、回答が1回の通話で返答できないほど多い場合に便利で、複数のページにわたる結果を閲覧できます。
type	FeatureCollectionEnum	成功した`Get Autocomplete`応答体の`GeoJSON`オブジェクトタイプ。 RFC 7946で定義された通り、常に`FeatureCollection`。

AutocompleteResultTypeEnum

列挙

Get Autocompleteが入力フィルター(resultTypesクエリパラメータを介して)および出力ラベル(各AutocompletePropertiesのtypeフィールドを通じて)として使用されるオートコンプリート提案の分類です。メンバーは住所、道路区間、行政区域、人口密集地、自然の特徴、注目ポイントを含む地名録スタイルの分類を定義します。この分類は AutocompleteResultTypeGroupsEnumによって大きく分けられます。 Addressは住所や道路区間をカバーし、他のすべての結果タイプを扱う Placeです。

値	説明
Address	特定の住所。
AdminDivision1	国や地域内の第一行政レベル、例えば州や州。
AdminDivision2	国や地域内の第二の行政レベル、例えば郡。
AdminDivision3	国や地域内の第三の行政レベル、例えば地区、教区、または自治体。
AdministrativeBuilding	政府機関や公共行政機能が入っている建物。
Airport	航空機が定期的に離着陸し、乗客と貨物のための施設を備えています。
AirportTerminal	空港内の旅客ターミナルビル。
AmusementPark	乗り物、ゲーム、テーマ別アトラクションを備えたエンターテインメント施設です。
AncientSite	古代文明の考古学的遺物や文化的遺物が保存されている場所です。
Aquarium	水生植物や動物を展示・研究する公共施設です。
Archipelago	島の群れや連鎖。
Basin	地形の自然な窪地で、周囲はしばしば高地に囲まれています。
Battlefield	歴史的に重要な陸戦の舞台です。
Bay	陸地に部分的に囲まれた水域で、湾より小さく、入り江より大きい。
Beach	水辺に沿った砂や小石、その他の未固結堆積物の岸辺。
Bridge	道路、鉄道、または川や谷、その他の道路などの障害物を横断する構造物です。
BusinessStructure	一般的なビジネスや商業活動に使われる建物で、より特定のカテゴリーに該当しない建物。
Camp	キャンプ場や季節的な居住地など、一時的な居住のための避難所や施設がある場所。
Canal	輸送、灌漑、排水に使われる人工水路。
Casino	ギャンブルや運試しゲームに使われる施設です。
Castle	歴史的に要塞化された建物や建物群で、通常は貴族や王族の居住地に関連付けられています。
Cave	岩石に形成された自然の地下室または通路。
Cemetery	墓地や埋葬地。
Channel	二つの陸地を結ぶ航行可能な水路や、より大きな水域の主要な流路。
Church	公共のキリスト教礼拝に使われる建物です。
Cliff	岩や土の高く急な岩壁で、しばしば海岸や谷を見下ろしています。
Coast	海に面した名前付きの土地の区間です。
CommunityCenter	地域活動、会議、社会福祉活動を開催する施設です。
Continent	地球の主要な陸地の一つです。
CountryRegion	国や地域。
Crater	火山活動や隕石衝突によって形成される円形の窪地です。
CulturalRegion	言語、民族、遺産などの共通文化的特徴によって区別される地域。
Dam	水を貯めるために小川や川に設置されたバリア。
Delta	川がより大きな水域と接する場所に形成された沖積堆積物の地形です。
Desert	降水量が限られているため植生がまばらな広大な乾燥地域です。
DrainageBasin	河川とその支流によって排水された土地の地域です。
Dune	風に吹き飛ばされた砂の盛り上がりや尾根。
FacilityStructure	ユーティリティプラントやサービス施設などの専門施設を収容する構造物。
FerryTerminal	乗客や車両がフェリーに乗り降りする施設です。
FinancialStructure	銀行、信用組合、その他の金融サービス機関が入居する建物。
FireStation	消防士、装備、緊急対応車両が収容されている建物です。
Forest	樹木が支配的な広大な土地です。
Fort	防御用の軍事施設や土塁。
Garden	観賞用または科学的に管理された植物を展示するための栽培エリアです。
Geyser	時折水と蒸気の噴射が噴き出す温泉。
Glacier	自重でゆっくりと動く持続的な氷の塊。
GolfCourse	ゴルフをするためのフィールドが用意されていました。
GreaterPopulatedPlace	人口密集地を含み、それを超えて広がる大都市圏や都市圏。
HigherEducationFacility	大学、大学、またはそれに類する高等教育機関。
HistoricalSite	歴史的に重要な場所であり、しばしば文化遺産として保存されています。
Hospital	入院および外来ケアを提供する医療施設です。
HotSpring	地熱によって加熱された地下水が地表から湧き出る自然の湧き水です。
Ice	陸地や水を覆う自然の凍結水の塊または表層。
IndigenousPeoplesReserve	先住民またはコミュニティの故郷として認められた領土。
IndustrialStructure	製造、生産、またはその他の産業作業に使用される建物または施設。
Island	大陸よりも小さな、水に囲まれた陸地。
Isthmus	二つの大きな陸地をつなぎ、二つの水域を分けている狭い陸地帯。
Lake	陸地に囲まれた内陸の溜まった水域。
LandArea	より特定の地理的カテゴリーに当てはまらない名前付きの土地地域。
Landform	`Mountain`、`Valley`、`Plateau`のようなより特定のカテゴリーに当てはまらない自然の土地の特徴。
LandmarkBuilding	建築的、文化的、歴史的に重要な、認知性のあるランドマークとして機能する著名な建物。
Library	一般公開可能な書籍やその他のメディアのコレクションを収蔵する建物です。
Lighthouse	船舶を誘導するための航行灯を点灯した沿岸または港の構造物。
Marina	小型船やヨットのための係留やサービスを提供する港湾施設です。
Market	商品が売買される場所、通常は小売店で。
MedicalStructure	クリニックや医療事務所など、 `Hospital`以外の医療または健康関連サービスに使用される建物。
MetroStation	地下鉄、地下鉄、その他の都市型高速鉄道システムの駅です。
MilitaryBase	訓練、補給、または作戦のために軍が運営する施設。
Mission	宗教団体が運営する複合施設で、地域サービスを提供し信仰を広めています。
Monument	人物、出来事、または理念を称えるために建立された記念構造物や像。
Mosque	公共のイスラム礼拝に使われる建物です。
Mountain	周囲から大きくそびえ立ち、通常は急斜面と明確な頂上を持つ地形です。
MountainRange	連続した山脈を形成する連なりの山々です。
MultiModalStation	鉄道、バス、地下鉄の複合サービスなど、複数の交通手段に対応する駅です。
Museum	芸術的、科学的、または歴史的に興味深い物品を保存・展示する施設です。
NauticalStructure	桟橋、桟橋、ブイなど、海上や航海活動に関連する構造物。
Neighborhood	人口密集地内の地域で認識された地域であり、しばしば非公式または文化的に定義された境界線があります。
Oasis	砂漠の肥沃な地域で、自然の水源によって支えられています。
ObservationPoint	周囲の景観を一望できる展望台や展望台。
Ocean	地球の海洋の主要な区分の一つです。
OfficeBuilding	主に専門職や事務用オフィススペースとして使われる建物です。
Other	他の定義されたタイプには当てはまらない提案です。
Park	公共のレクリエーションや景観を楽しむために維持されているエリアです。
ParkingStructure	車両駐車専用の多層構造物です。
Pass	山脈や類似の障害物を通ったり越えたりする航行可能なルート。
Peninsula	水面に突き出た陸地で、ほとんど水に囲まれている。
Plain	比較的平坦または緩やかな起伏のある広大な土地です。
Planet	恒星の周りを回る天体で、地理的階層の根源として地球を表すために使われます。
Plateau	比較的平坦な高地で、片側または複数に急斜面がある場所です。
Playground	子供の遊びが楽しめるレクリエーションエリアです。
PlayingField	組織的なスポーツが行われるためのオープンスペースです。
Pole	北極や南極のような地理的な極点です。
PoliticalUnit	独立または従属する国家や領土など、自治的な政治的実体。
PopulatedPlace	都市、町、村など、人間の居住地の集中エリア。
Port	水上貨物や乗客の積み下ろし用のターミナルを備えた海事施設です。
Postcode1	郵便番号のような最小の郵便番号カテゴリ。
Promontory	低地や水域に突き出た目立つ高台地形。
RaceTrack	レース車両、動物、またはアスリートのために設計されたトラックやコース。
RailwayStation	乗客が列車に乗降する施設です。
Reef	水面近くの岩、砂、またはサンゴの沈んだまたは部分的に沈んだ尾根。
ReligiousStructure	宗教的な礼拝や実践に使われる建物で、 `Church`、 `Mosque`、 `Temple`などの特定のカテゴリーに該当しない建物。
Reserve	保護区画で、保護、野生生物、またはその他の制限された利用のために確保された土地です。
ResidentialStructure	主に人間の居住用に使われる建物、例えばアパートや住宅複合施設。
River	通常は海や湖、または他の川へ向かう低い標高へ流れている自然の水路。
RoadBlock	特定の家番号がない通り区間で、ジオコーディングサービスが正確な家番号を特定できない場合に返されます。名前に反して、この値は物理的な道路閉鎖を示すものではありません。
Ruin	元の機能を失った破壊または腐敗した構造物。
ScientificResearchBase	科学研究の拠点として使われる施設で、しばしば遠隔地や過酷な環境にあります。
Sea	陸地に部分的に囲まれた大きな塩水の塊で、海よりも小さい。
SeaplaneLandingArea	水上機が離着陸するための水域です。
Shrine	人物を記念したり、神聖な出来事や概念を記念する構造物や場所。
SkiArea	スキーやその他の冬季スポーツのためのレクリエーションエリアも整備されました。
Spring	地表から地下水が流れ出る自然の源です。
Stadium	観戦スポーツやイベントのための段差のある大きな会場です。
StatisticalDistrict	統計的または国勢調査目的で定義された地域、例えば大都市統計地域や国勢調査区。
Temple	宗教礼拝に捧げられた建物。
Theater	演劇、映画、その他のライブまたは録音パフォーマンスを上演する会場です。
TouristRailway	景観鉄道やヘリテージ鉄道は主に観光目的で運行されていました。
TouristStructure	観光センターや観光案内所など、観光客向けの建物。
Trailhead	ハイキング、サイクリング、またはレクリエーショントレイルの出発点です。
TransportationStructure	料金所、計量所、トランジットシェルターなどの交通インフラを支える構造物。
Tunnel	道路、鉄道、歩行者用の地下または水中通路です。
Valley	丘や山の間の細長い低地で、しばしば水路が存在します。
Volcano	火山活動によって形成された山や丘で、頂上に火口が通常あります。
Walkway	歩行者専用に指定された道や舗装された路面。
Wall	連続した垂直境界を形成する構造的な障壁で、防御、分離、または記念によく用いられます。
Waterfall	小川や川が垂直または急に落ちる地点。
WaterFeature	`Lake`、`River`、`Sea`など、より特定のカテゴリーに当てはまらない水域。
Wetland	水に浸潤し、湿地や湿地などの水生植物が生えている土地のことです。
Winery	ワインが生産され、しばしばテイスティングや販売のために提供される施設です。
Zoo	野生動物を一般公開・研究のために飼育する施設です。

AutocompleteResultTypeGroupsEnum

列挙

オートコンプリートの提案を大まかに二つのグループに分類するものです。 Get Autocompleteは、resultTypeGroupsクエリパラメータを通じて入力フィルターとして使用され(どの種類の提案が返されるかを制限)、また各AutocompletePropertiesのtypeGroupフィールドを通じて出力分類器として(返される提案がどのグループに属するかを識別)として使用されます。 Addressグループは個々の住所や通り区間をカバーし、Placeグループは行政区域、人口密集地、自然の特徴、観光地などのその他のエンティティタイプをカバーします。

値	説明
Address	特定の住所や道路区間に結びつく提案。
Place	行政区域、人口密集地、近隣地域、自然の特徴、注目ポイントなどの名称化された場所に関する提案。たとえば、 `AdminDivision1`、 `Neighborhood`、 `PopulatedPlace`などがあります。

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	内部エラー。

FeatureCollectionEnum

列挙

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

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

FeatureTypeEnum

列挙

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

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

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本以上の通りが交差する地点のみが居住しています。