Search - Get Search Address Reverse Cross Street

參考

服務:: Maps

API 版本:: 1.0

使用從緯度和經度座標取得交叉街地位置資訊。

Get Search Address Reverse Cross Street API 是 HTTP GET 要求，當指定緯度和經度座標時，會傳回最接近的交叉街。有時候您可能需要將座標轉譯為 (範例：37.786505、-122.3862) 到人類可理解的交叉街。在追蹤您從裝置或資產收到 GPS 摘要的應用程式，並想要知道座標所在的位址時，通常需要這樣做。此端點會傳回指定座標的交叉街道資訊。

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

含選擇性參數:

GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}&limit={limit}&heading={heading}&radius={radius}&language={language}&view={view}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	ResponseFormat	所需的回應格式。值可以是 json 或 xml。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
query	query	True	number[]	指定為逗號分隔字串的適用查詢，後面接著經度，例如 “47.641268，-122.125679”。
heading	query		integer	以度為單位的車輛方向標題，用於沿著路段的行進。 0 是北，90 是東部等等，值範圍從 -360 到 360。精確度最多可以包含一個小數字數
language	query		string	應該傳回搜尋結果的語言。應該是其中一個支援的 IETF 語言標籤，不區分大小寫。當指定語言的數據不適用於特定欄位時，會使用預設語言。如需詳細資訊，請參閱支援的語言。
limit	query		integer	將傳回的回應數目上限。默認值：10，最小值：1 和最大值：100
radius	query		integer	以公尺為單位的半徑，讓結果受限於定義的區域
view	query		LocalizedMapView	View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。不同的國家/地區具有這類區域的不同檢視，而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。根據預設，View 參數會設定為「Unified」，即使您尚未在要求中定義它也一樣。您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。或者，您可以選擇設定 'View=Auto'，這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務中的 View 參數必須符合適用的法律，包括對應、地圖、影像和其他數據，以及您有權透過 Azure 地圖服務存取的第三方內容的國家/地區。範例：view=IN。如需詳細資訊，請參閱支援的檢視，並查看可用的檢視。

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定哪一個帳戶要與 Microsoft Entra ID 安全性模型搭配使用。它代表 Azure 地圖服務帳戶的唯一標識符，可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱	類型	Description
200 OK	ReverseSearchCrossStreetAddressResult	確定
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 REST API 的存取 Azure 地圖服務。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義提供一個解決方案，可透過能夠針對特定 API 和範圍進行存取控制的物件，將應用程式模型化 () 。

注意

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖服務管理 API 取得。
Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 設定。
Azure 角色型訪問控制是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API 從 Azure 管理平面設定。
Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。
如需 Microsoft 身分識別平台的詳細資訊，請參閱 Microsoft 身分識別平台概觀。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是當您在 Azure 入口網站或使用 PowerShell、CLI、Azure SDK 或 REST API 中建立 Azure 地圖服務帳戶時所佈建的共享密鑰。

使用此金鑰時，任何應用程式都可以存取所有 REST API。換句話說，此金鑰可作為發行帳戶中的主要金鑰。

對於公開的應用程式，我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API，以便安全地儲存密鑰。

類型: apiKey
位於: query

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 地圖服務資源上的列出 SAS 作業建立共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並精細控制到期、速率和區域 (特定令牌的使用) 。換句話說，SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在地圖帳戶資源上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 SAS 令牌。

類型: apiKey
位於: header

範例

Search address of the nearest intersection/crossroad

範例要求

HTTP

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

範例回覆

狀態碼:: 200

{
  "summary": {
    "numResults": 1,
    "queryTime": 41
  },
  "addresses": [
    {
      "address": {
        "streetName": "East Santa Clara Street & North 2nd Street",
        "crossStreet": "East Santa Clara Street",
        "municipalitySubdivision": "San Jose, Downtown San Jose",
        "municipality": "San Jose",
        "countrySecondarySubdivision": "Santa Clara",
        "countryTertiarySubdivision": "San Jose",
        "countrySubdivisionCode": "CA",
        "postalCode": "95113",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113",
        "countrySubdivisionName": "California"
      },
      "position": "37.33666,-121.88951"
    }
  ]
}

定義

名稱	Description
Address	結果的位址
BoundingBoxCompassNotation	位置的周框方塊。
Entity	周框方塊的實體類型來源。針對反向地理編碼，這一律等於位置。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
LatLongPairAbbreviated	以緯度和經度表示的位置，使用簡短名稱『lat』 & 『lon』。
LocalizedMapView	View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。不同的國家/地區具有這類區域的不同檢視，而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。根據預設，View 參數會設定為「Unified」，即使您尚未在要求中定義它也一樣。您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。或者，您可以選擇設定 'View=Auto'，這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務中的 View 參數必須符合適用的法律，包括對應相關資料、地圖、影像和其他數據，以及您有權透過 Azure 地圖服務存取的第三方內容。範例：view=IN。如需詳細資訊，請參閱支援的檢視，並查看可用的檢視。
QueryType	要傳回的查詢類型：NEARBY 或 NON_NEAR。
ResponseFormat	所需的回應格式。值可以是 json 或 xml。
ReverseSearchCrossStreetAddressResult	此物件會從成功搜尋 Address Reverse CrossStreet 呼叫傳回
ReverseSearchCrossStreetAddressResultItem	搜尋 Address Reverse Cross Street 回應的結果物件
SearchSummary	搜尋 API 回應的 Summary 物件。

Address

結果的位址

名稱	類型	Description
boundingBox	BoundingBoxCompassNotation	位置的周框方塊。
buildingNumber	string	街道上的建築物編號。已淘汰，請改用 streetNumber。
country	string	國家/地區名稱
countryCode	string	國家/地區 (注意：這是兩個字母代碼，而不是國家/地區名稱。)
countryCodeISO3	string	ISO alpha-3 國家/地區代碼
countrySecondarySubdivision	string	郡/縣
countrySubdivision	string	省/市
countrySubdivisionCode	string	`countrySubdivisionCode` 前面加上 `countryCode` ( countryCode-countrySubdivisionCode ) ，而連字元會形成 ISO 3166-2 程序代碼。範例：TX for Texas、SCT for Texas 和 ON for On for Ontario。
countrySubdivisionName	string	國家/地區系統管理階層的第一層完整名稱。只有在 countrySubdivision 以縮寫形式呈現時，才會顯示此字段。僅支援美國、加拿大和英國。
countryTertiarySubdivision	string	具名區域
crossStreet	string	要交叉的街道名稱。
extendedPostalCode	string	延伸郵遞區編碼 (可用性取決於區域) 。
freeformAddress	string	根據結果國家/地區來源地區的格式規則格式化的位址行，或在國家/地區的情況下，其完整國家/地區名稱。
localName	string	位址元件，表示將多個可尋址物件分組以用於尋址目的的地理區域或位置名稱，而不需要是系統管理單位。此欄位是用來建置 `freeformAddress` 屬性。 `localName` 代表郵遞區號。視位置而定， `localName` 是城市或城市或鎮的已知名稱。針對城市或鎮市的已知名稱，請使用 `localName` 而非 `municipality`。
municipality	string	城市/鎮注意： `municipality` 代表居住區。視位置而定， `municipality` 值可能與城市或城市或鎮的已知名稱不同。對於城市或城市通常已知的名稱，建議 `localName` 使用值，而不是 `municipality` 值。
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	「活動」是城市或城市內的地理當地語系化區域，具有獨特的特性，以及不同城市之間的社交互動。
postalCode	string	郵遞區區編碼/郵遞區號
routeNumbers	string[]	用來明確識別街道的代碼
street	string	街道名稱。已淘汰，請改用 streetName。
streetName	string	街道名稱。
streetNameAndNumber	string	街道名稱和數位。
streetNumber	string	街道上的建築物編號。

BoundingBoxCompassNotation

位置的周框方塊。

名稱	類型	Description
entity	Entity	周框方塊的實體類型來源。針對反向地理編碼，這一律等於位置。
northEast	string	北東部緯度，周框方塊的經度座標為逗號分隔浮點數
southWest	string	周框方塊的南西部緯度、經度座標，以逗號分隔的浮點數

Entity

周框方塊的實體類型來源。針對反向地理編碼，這一律等於位置。

名稱	類型	Description
position	string	定位實體

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

LatLongPairAbbreviated

以緯度和經度表示的位置，使用簡短名稱『lat』 & 『lon』。

名稱	類型	Description
lat	number	Latitude 屬性
lon	number	經度屬性

LocalizedMapView

View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。不同的國家/地區具有這類區域的不同檢視，而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。根據預設，View 參數會設定為「Unified」，即使您尚未在要求中定義它也一樣。您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。或者，您可以選擇設定 'View=Auto'，這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務中的 View 參數必須符合適用的法律，包括對應相關資料、地圖、影像和其他數據，以及您有權透過 Azure 地圖服務存取的第三方內容。範例：view=IN。

如需詳細資訊，請參閱支援的檢視，並查看可用的檢視。

名稱	類型	Description
AE	string	阿拉伯聯合大公國 (阿拉伯文檢視)
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	葉門 (阿拉伯文檢視)

QueryType

要傳回的查詢類型：NEARBY 或 NON_NEAR。

名稱	類型	Description
NEARBY	string	搜尋是在具有定義半徑的特定緯度和經度周圍執行
NON_NEAR	string	搜尋是在全域執行，而不會偏差特定緯度和經度，而且沒有定義的半徑

ResponseFormat

所需的回應格式。值可以是 json 或 xml。

名稱	類型	Description
json	string	JavaScript 物件表示法數據交換格式
xml	string	可延伸標記語言

ReverseSearchCrossStreetAddressResult

此物件會從成功搜尋 Address Reverse CrossStreet 呼叫傳回

名稱	類型	Description
addresses	ReverseSearchCrossStreetAddressResultItem[]	地址陣列
summary	SearchSummary	搜尋 Address Reverse Cross Street 回應的 Summary 物件

ReverseSearchCrossStreetAddressResultItem

搜尋 Address Reverse Cross Street 回應的結果物件

名稱	類型	Description
address	Address	結果的位址
position	string	位置屬性的格式為 “{latitude}，{longitude}”

SearchSummary

搜尋 API 回應的 Summary 物件。

名稱	類型	Description
fuzzyLevel	integer	提供結果所需的模糊層級上限。
geoBias	LatLongPairAbbreviated	指出內部搜尋引擎已套用地理空間偏差，以改善結果的排名。在某些方法中，這可以透過設定可用的 lat 和 lon 參數而受到影響。在其他情況下，它只是內部。
limit	integer	將傳回的回應數目上限
numResults	integer	回應中的結果數目。
offset	integer	完整結果集中傳回結果的起始位移。
query	string	用來產生這些搜尋結果的查詢參數。
queryTime	integer	解析查詢所花費的時間，以毫秒為單位。
queryType	QueryType	要傳回的查詢類型：NEARBY 或 NON_NEAR。
totalResults	integer	找到的結果總數。

共用方式為