Search - Get Search Address Reverse

Service:

Maps

API Version:

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}

With optional parameters:

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 を使用すると、Get Search Polygon API を使用してその地理のジオメトリを取得できます。 entityType が設定されている場合、次のパラメーターは無視されます。 見出し 実数 returnRoadUse returnSpeedLimit roadUse returnMatchType
heading	query		integer	道路のセグメントに沿って移動するための車両の方向見出しを度単位で指定します。 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 パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、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	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 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 プラットフォームの概要」を参照してください。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用してプロビジョニングされる共有キーです。

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

例

Searches addresses for coordinates 37.337,-121.89

Sample Request

HTTP

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

Sample Response

Status code:

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 パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、View パラメーターを使用すると、アプリケーションが提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。
MatchType	逆引きアドレス検索操作の一致の種類。
QueryType	返されるクエリの種類: NEARBY または NON_NEAR。
ResponseFormat	応答の目的の形式。 値には json または xml を指定できます。
ReverseSearchAddressResult	このオブジェクトは、アドレス反転呼び出しが成功したSearchから返されます
ReverseSearchAddressResultItem	Search Address Reverse 応答の Result オブジェクト
RoadUseType	道路の使用可能な用途について説明します。
SearchSummary	Search API 応答の Summary オブジェクト。

Address

結果のアドレス

名前	型	説明
boundingBox	BoundingBoxCompassNotation	場所の境界ボックス。
buildingNumber	string	通りの建物番号。 非推奨です。代わりに streetNumber を使用してください。
country	string	国/地域名
countryCode	string	国 (注: これは国/地域名ではなく、2 文字のコードです)。
countryCodeISO3	string	ISO alpha-3 国コード
countrySecondarySubdivision	string	County
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

場所の境界ボックス。

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

Entity

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

名前	型	説明
position	string	Position エンティティ

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

GeographicEntityType

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

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

LatLongPairAbbreviated

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

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

LocalizedMapView

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

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

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

MatchType

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

名前	型	説明
AddressPoint	string
HouseNumberRange	string
Street	string

QueryType

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

名前	型	説明
NEARBY	string	Searchは、定義された半径を持つ特定の緯度と経度を中心に実行されました
NON_NEAR	string	Searchは、特定の緯度と経度に偏らず、半径が定義されていない、グローバルに実行されました

ResponseFormat

応答の目的の形式。 値には json または xml を指定できます。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式
xml	string	拡張可能なマークアップ言語

ReverseSearchAddressResult

このオブジェクトは、アドレス反転呼び出しが成功したSearchから返されます

名前	型	説明
addresses	ReverseSearchAddressResultItem[]	アドレス配列
summary	SearchSummary	Search アドレス反転応答の Summary オブジェクト

ReverseSearchAddressResultItem

Search Address Reverse 応答の Result オブジェクト

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

RoadUseType

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

名前	型	説明
Arterial	string
LimitedAccess	string
LocalStreet	string
Ramp	string
Rotary	string
Terminal	string

SearchSummary

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

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