Search - Get Search Address Reverse

リファレンス

サービス:: Maps

API バージョン:: 1.0

緯度と経度の座標から番地と位置情報を取得するために使用します。
Get Search Address Reverse API は、緯度と経度の座標が指定されたときに番地または場所を返す HTTP GET 要求です。

座標 (例: 37.786505、-122.3862) を人間が理解できる番地に変換する必要がある場合があります。ほとんどの場合、これは、デバイスまたは資産から GPS フィードを受信し、座標が配置されているアドレスを知りたいアプリケーションを追跡するために必要です。このエンドポイントは、特定の座標のアドレス情報を返します。

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}

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

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&entityType={entityType}&view={view}

URI パラメーター

名前	/	必須	型	説明
format	path	True	ResponseFormat	応答の目的の形式。値は、json することも、xml することもできます。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	number[]	緯度の後に経度 (例: "47.641268,-122.125679") で構成されるコンマ区切り文字列として指定された該当するクエリ。
allowFreeformNewline	query		boolean	書式設定されたアドレスの改行の形式。 true の場合、アドレスには改行が含まれます。 false の場合、改行はコンマに変換されます。
entityType	query		GeographicEntityType	地理に対して実行されるフィルター処理のレベルを指定します。指定した geography エンティティ型の検索を絞り込みます。たとえば、市区町村のみを返します。結果の応答には、geography ID と一致したエンティティ型が含まれます。コンマ区切りリストとして複数のエンティティを指定した場合、エンドポイントは "使用可能な最小エンティティ" を返します。返された Geometry ID を使用して、検索ポリゴンの取得 API 使用して、その地理のジオメトリを取得できます。 entityType が設定されている場合、次のパラメーターは無視されます。見出し数字 returnRoadUse returnSpeedLimit roadUse returnMatchType
heading	query		integer minimum: -360 maximum: 360	道路のセグメントに沿って移動するための車両の方向見出しを度単位で指定します。 0 は北、90 は東などであり、値の範囲は -360 から 360 です。有効桁数には小数点以下 1 桁まで含めることができます。
language	query		string	検索結果を返す言語。サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。詳細については、サポートされている言語のを参照してください。
number	query		string	文字列としての番地。要求と共に数値が送信された場合、応答には、道路の側面 (左/右) と、その番号のオフセット位置が含まれる場合があります。
radius	query		integer	結果が定義された領域に制限される範囲の半径 (メートル単位)
returnMatchType	query		boolean	応答で達成されたジオコーダーの一致の種類に関する情報を含めます。
returnRoadUse	query		boolean	ブーリアン。道路の戻り値を有効にするには、道路レベルで逆ジオコーディングの配列を使用します。
returnSpeedLimit	query		boolean	ブーリアン。ポストされた速度制限のリターンを有効にするには
roadUse	query		RoadUseType[]	逆ジオコーディングを特定の種類の道路用途に制限する。逆ジオコーディングの道路使用配列には、LimitedAccess、動脈、ターミナル、ランプ、ロータリー、LocalStreet の 1 つ以上を使用できます
view	query		LocalizedMapView	View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。または、要求の IP アドレスに基づいてマップデータを返す 'View=Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つ第三者のコンテンツが利用できる国/地域のマッピングに関する法律を含む、適用される法律に従って使用する必要があります。例: view=IN。詳細については、サポートされているビューのを参照し、使用可能なビューを参照してください。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーンアカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンス次の記事を参照してください。

応答

名前	型	説明
200 OK	ReverseSearchAddressResult	わかりました
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

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

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

注

このセキュリティ定義使用して、アプリケーションがアクセスを要求している 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 Maps アカウントを作成場合にプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。つまり、このキーは、発行されたアカウントのマスターキーとして使用できます。

パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアントアプリケーションアプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。

型: apiKey
/: query

SAS Token

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

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

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

型: apiKey
/: header

例

Searches addresses for coordinates 37.337,-121.89

要求のサンプル

HTTP

GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89

応答のサンプル

状態コード:: 200

{
  "summary": {
    "queryTime": 5,
    "numResults": 1
  },
  "addresses": [
    {
      "address": {
        "streetNumber": "31",
        "routeNumbers": [],
        "streetName": "N 2nd St",
        "streetNameAndNumber": "31 N 2nd St",
        "countryCode": "US",
        "countrySubdivisionCode": "CA",
        "countrySubdivisionName": "California",
        "municipality": "San Jose",
        "postalCode": "95113",
        "country": "United States of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "31 N 2nd St, San Jose CA 95113",
        "extendedPostalCode": "951131217"
      },
      "position": "37.337090,-121.889820"
    }
  ]
}

定義

名前	説明
Address	結果のアドレス
BoundingBoxCompassNotation	場所の境界ボックス。
Entity	境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeographicEntityType	Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。
LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
LocalizedMapView	View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。または、要求の IP アドレスに基づいてマップデータを返す 'View=Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つ第三者のコンテンツが利用できる国/地域のマッピングに関する法律を含む、適用される法律に従って使用する必要があります。例: view=IN。詳細については、サポートされているビューのを参照し、使用可能なビューを参照してください。
MatchType	逆アドレス検索操作の一致の種類。
QueryType	返されるクエリの種類: NEARBY または NON_NEAR。
ResponseFormat	応答の目的の形式。値は、json することも、xml することもできます。
ReverseSearchAddressResult	このオブジェクトは、検索アドレスの逆引き呼び出しが成功した場合に返されます
ReverseSearchAddressResultItem	検索アドレスの逆引き応答の結果オブジェクト
RoadUseType	道路の使用可能な用途について説明します。
SearchSummary	Search API 応答の概要オブジェクト。

Address

Object

結果のアドレス

名前	型	説明
boundingBox	BoundingBoxCompassNotation	場所の境界ボックス。
buildingNumber	string	通りの建物番号。非推奨、代わりに streetNumber を使用してください。
country	string	国/地域名
countryCode	string	国 (注: 国/地域名ではなく、2 文字のコードです)。
countryCodeISO3	string	ISO alpha-3 国コード
countrySecondarySubdivision	string	郡
countrySubdivision	string	都道府県
countrySubdivisionCode	string	`countrySubdivisionCode` プレフィックスは `countryCode` ( countryCode-countrySubdivisionCode) で、ハイフンは ISO 3166-2 コードを形成します。例: テキサス州の TX、スコットランドの SCT、オンタリオ州の場合は ON。
countrySubdivisionName	string	国/地域管理階層の第 1 レベルのフルネーム。このフィールドは、countrySubdivision が省略形で表示される場合にのみ表示されます。米国、カナダ、英国でのみサポートされます。
countryTertiarySubdivision	string	名前付き領域
crossStreet	string	交差している通りの名前。
extendedPostalCode	string	拡張郵便番号 (利用可能状況は地域によって異なります)。
freeformAddress	string	結果の配信元の国/地域の書式設定規則に従って書式設定された住所行、または国/地域の場合は、その完全な国/地域名。
localName	string	管理単位にならずに、アドレス指定の目的で複数のアドレス可能オブジェクトをグループ化する地理的領域または地域の名前を表すアドレスコンポーネント。このフィールドは、`freeformAddress` プロパティのビルドに使用されます。 `localName` は、郵便番号の市区町村を表します。場所に応じて、`localName` は市区町村の一般的な名前です。市区町村の一般的な名前については、`municipality`の代わりに `localName` を使用します。
municipality	string	市区町村注: `municipality` は、居住区町村を表します。場所によっては、`municipality` の値が、市区町村の一般的な名前と異なる場合があります。市区町村の一般的な名前については、`municipality` 値の代わりに `localName` 値を使用することをお勧めします。
municipalitySubdivision	string	サブ/スーパーシティ
neighbourhood	string	地域は、都市または町内の地理的にローカライズされた地域であり、住民間の特徴的な特徴と社会的相互作用があります。
postalCode	string	郵便番号/郵便番号
routeNumbers	string[]	道路を明確に識別するために使用されるコード
street	string	番地の名前。非推奨、代わりに streetName を使用してください。
streetName	string	番地の名前。
streetNameAndNumber	string	番地の名前と番号。
streetNumber	string	通りの建物番号。

BoundingBoxCompassNotation

Object

場所の境界ボックス。

名前	型	説明
entity	Entity	境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。
northEast	string	北東緯度、境界ボックスの経度座標 (コンマ区切り浮動小数点数)
southWest	string	境界ボックスの南西緯度、経度座標 (コンマ区切り浮動小数点数)

Entity

列挙

境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。

値	説明
position	位置エンティティ

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

GeographicEntityType

列挙

Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。

値	説明
Country	国/地域名
CountrySecondarySubdivision	郡
CountrySubdivision	都道府県
CountryTertiarySubdivision	名前付き領域
Municipality	市区町村
MunicipalitySubdivision	サブ/スーパーシティ
Neighbourhood	近所
PostalCodeArea	郵便番号/郵便番号

LatLongPairAbbreviated

Object

短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

名前	型	説明
lat	number (double)	Latitude プロパティ
lon	number (double)	Longitude プロパティ

LocalizedMapView

列挙

View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。または、要求の IP アドレスに基づいてマップデータを返す 'View=Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つ第三者のコンテンツが利用できる国/地域のマッピングに関する法律を含む、適用される法律に従って使用する必要があります。例: view=IN。

詳細については、サポートされているビューのを参照し、使用可能なビューを参照してください。

値	説明
AE	アラブ首長国連邦 (アラビアビュー)
AR	アルゼンチン (アルゼンチンビュー)
Auto	要求の IP アドレスに基づいてマップデータを返します。
BH	バーレーン (アラビアビュー)
IN	インド (インドビュー)
IQ	イラク (アラビア語ビュー)
JO	ヨルダン (アラビアビュー)
KW	クウェート (アラビアビュー)
LB	レバノン (アラビア語ビュー)
MA	モロッコ (モロッコビュー)
OM	オマーン (アラビアビュー)
PK	パキスタン (パキスタンビュー)
PS	パレスチナ自治政府 (アラビア語ビュー)
QA	カタール (アラビアビュー)
SA	サウジアラビア (アラビア語ビュー)
SY	シリア (アラビアビュー)
Unified	統合ビュー (その他)
YE	イエメン (アラビアビュー)

MatchType

列挙

逆アドレス検索操作の一致の種類。

値	説明
AddressPoint
HouseNumberRange
Street

QueryType

列挙

返されるクエリの種類: NEARBY または NON_NEAR。

値	説明
NEARBY	半径が定義された特定の緯度と経度を中心に検索が実行されました
NON_NEAR	特定の緯度と経度に偏らず、半径が定義されていない、グローバルに検索が実行されました

ResponseFormat

列挙

応答の目的の形式。値は、json することも、xml することもできます。

値	説明
json	JavaScript オブジェクト表記データ交換形式をする
xml	拡張マークアップ言語をする

ReverseSearchAddressResult

Object

このオブジェクトは、検索アドレスの逆引き呼び出しが成功した場合に返されます

名前	型	説明
addresses	ReverseSearchAddressResultItem[]	Addresses 配列
summary	SearchSummary	検索アドレスの逆引き応答の概要オブジェクト

ReverseSearchAddressResultItem

Object

検索アドレスの逆引き応答の結果オブジェクト

名前	型	説明
address	Address	結果のアドレス
matchType	MatchType	一致の種類に関する情報。つぎのいずれかです。 AddressPoint HouseNumberRange 通り
position	string	"{latitude},{longitude}" の形式でプロパティを配置する
roadUse	RoadUseType[]	道路の使用可能な用途について説明します。

RoadUseType

列挙

道路の使用可能な用途について説明します。

値	説明
Arterial
LimitedAccess
LocalStreet
Ramp
Rotary
Terminal

SearchSummary

Object

Search API 応答の概要オブジェクト。

名前	型	説明
fuzzyLevel	integer	結果を提供するために必要な最大あいまいレベル。
geoBias	LatLongPairAbbreviated	内部検索エンジンが地理空間バイアスを適用して結果のランク付けを向上させるタイミングを示します。一部のメソッドでは、lat パラメーターと lon パラメーターを使用可能な場合に設定することで、この影響を受ける可能性があります。該当しない場合は、純粋な結果にのみ左右されます。
limit	integer	返される応答の最大数
numResults	integer	応答の結果の数。
offset	integer	完全な結果セット内の返された結果の開始オフセット。
query	string	これらの検索結果の生成に使用されたクエリパラメーター。
queryTime	integer	クエリの解決に費やされた時間 (ミリ秒単位)。
queryType	QueryType	返されるクエリの種類: NEARBY または NON_NEAR。
totalResults	integer	検出された結果の合計数。

次の方法で共有

Search - Get Search Address Reverse

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

スコープ

subscription-key

SAS Token

例

Searches addresses for coordinates 37.337,-121.89

要求のサンプル

応答のサンプル

定義

Address

BoundingBoxCompassNotation

Entity

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

LatLongPairAbbreviated

LocalizedMapView

MatchType

QueryType

ResponseFormat

ReverseSearchAddressResult

ReverseSearchAddressResultItem

RoadUseType

SearchSummary

その他のリソース