Search - Get Search Address
使用 以非結構化或查詢輸入格式取得街地道址的緯度和經度座標。
Get Search Address
API 是 HTTP GET
要求,在傳遞街地道址或地點名稱作為搜尋準則時,會傳回緯度和經度座標。
在許多情況下,完整搜尋服務可能太多,例如,如果您只對傳統地理編碼感興趣。 您也可以存取 搜尋,以獨佔方式查閱位址。 地理編碼是藉由點擊地理編碼端點,只叫用有問題的位址或部分位址來執行。 地理編碼搜尋索引將會查詢街道層級數據上方的所有專案。 不會傳回任何 POI。 請注意,地理編碼器非常容許錯字和不完整的位址。 它也會處理來自確切街地道址或街道或交集的所有專案,以及較高層級的地理位置,例如城市中心、縣市、州等。
GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
format
|
path | True |
所需的回應格式。 值可以是 json 或 xml。 |
|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
query
|
query | True |
string |
搜尋 (位址,例如“1 Microsoft way,Redmond, WA”) ,必須正確編碼 URL。 |
btm
|
query |
string |
周框方塊的右下角位置。 例如 37.553,-122.453 |
|
country
|
query |
string[] |
國家/地區代碼的逗號分隔字串,例如FR、ES。 這會將搜尋限制為指定的國家/地區 |
|
entity
|
query |
指定在地理位置上執行的篩選層級。 縮小指定地理實體類型的搜尋範圍,例如只傳回一些資源。 產生的回應會包含地理標識符,以及相符的實體類型。 如果您以逗號分隔清單的形式提供多個實體,端點將會傳回「可用的最小實體」。 傳回的幾何標識碼可用來透過 Get 搜尋 Polygon API 取得該地理位置的幾何。 設定 entityType 時,會忽略下列參數:
|
||
extended
|
query |
結果中應包含延伸郵遞區編碼的索引。 可用的索引如下: Addr = 位址範圍 地理 = 地理位置 PAD = 點位址 POI = 景點 Str = 街道 XStr = 交叉街道 (交集) 值應該是以逗號分隔的索引類型清單, (任何順序) 或 無 索引。 根據預設,除了 Geo 以外,所有索引都會包含延伸郵遞區號。 地理位置的延伸郵遞區號清單可能很長,因此必須在需要時明確要求。 使用範例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 延伸郵遞區編碼會以位址的 extendedPostalCode 屬性傳回。 可用性與區域相關。 |
||
language
|
query |
string |
應該傳回搜尋結果的語言。 應該是其中一個支援的 IETF 語言標記,不區分大小寫。 當特定欄位無法使用指定語言的數據時,會使用預設語言。 如需詳細資訊,請參閱 支援的語言 。 |
|
lat
|
query |
number double |
結果應該偏向的緯度。 例如 37.337 |
|
limit
|
query |
integer |
將傳回的回應數目上限。 默認值:10,最小值:1 和最大值:100 |
|
lon
|
query |
number double |
結果應該偏差的經度。 例如 -121.89 |
|
ofs
|
query |
integer |
在完整結果集中開始傳回結果的位移。 預設值:0 |
|
radius
|
query |
integer |
以公尺為單位的半徑,讓結果受限於定義的區域 |
|
top
|
query |
string |
周框方塊的左上方位置。 例如 37.553,-122.453 |
|
typeahead
|
query |
boolean |
布林值。 如果已設定 typeahead 旗標,查詢將會解譯為部分輸入,而搜尋將會進入預測模式 |
|
view
|
query |
View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地緣政治爭議區域的正確地圖。 不同的國家/地區具有這類區域的不同檢視,而 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 |
確定 |
|
Other Status Codes |
發生意外錯誤。 |
安全性
AADToken
這些是 OAuth 2.0 流程 Microsoft Entra。 與 Azure 角色型存取控制配對時,可用來控制對 #DCE09187BC8C145B7A57716F1BD872117 REST API 的存取。 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 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務 資源上的列出 SAS 作業建立的共用存取簽章令牌。
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並更精細地控制到期、速率和區域 (特定令牌的使用) 。 換句話說,SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式來控制存取。
對於公開的應用程式,我們建議在 地圖帳戶資源 上設定允許的來源特定清單,以限制轉譯濫用,並定期更新 SAS 令牌。
類型:
apiKey
位於:
header
範例
Search detail address 15127 NE 24th Street, Redmond, WA 98052
範例要求
GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052
範例回覆
{
"summary": {
"query": "15127 NE 24th Street, Redmond, WA 98052",
"queryType": "NON_NEAR",
"queryTime": 58,
"numResults": 1,
"offset": 0,
"totalResults": 1,
"fuzzyLevel": 1
},
"results": [
{
"type": "Point Address",
"id": "US/PAD/p0/19173426",
"score": 14.51,
"address": {
"streetNumber": "15127",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525544",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6308,
"lon": -122.1385
},
"viewport": {
"topLeftPoint": {
"lat": 47.6317,
"lon": -122.13983
},
"btmRightPoint": {
"lat": 47.6299,
"lon": -122.13717
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6315,
"lon": -122.13852
}
}
]
}
]
}
定義
名稱 | Description |
---|---|
Address |
結果的位址 |
Address |
描述街道兩邊的位址範圍,以取得搜尋結果。 包含位址範圍的開始和結束位置座標。 |
Bounding |
檢視區,涵蓋檢視區左上角和右下座標所代表的結果。 |
Bounding |
位置的周框方塊。 |
Brand |
與 POI 相關聯的品牌 |
Classification |
所傳回POI的分類 |
Classification |
分類的名稱 |
Data |
選擇性章節。 與 Get 搜尋 Polygon API 搭配使用的參考標識碼。 |
Entity |
周框方塊的實體類型來源。 針對反向地理編碼,這一律等於位置。 |
Entry |
所傳回POI的進入點。 |
Entry |
進入點的類型。 值可以是 主要 或 次要。 |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Geographic |
Geography 實體類型。 只有在要求 entityType 且可供使用時才存在。 |
Geometry |
結果幾何圖形的相關信息。 只有在類型 == Geography 時才存在。 |
Lat |
以緯度和經度表示的位置,使用簡短名稱 『lat』 & 『lon』。 |
Localized |
View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。 不同的國家/地區具有這類區域的不同檢視,而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。 根據預設,View 參數會設定為 「Unified」,即使您尚未在要求中定義它也一樣。 您必須負責判斷使用者的位置,然後正確設定該位置的 View 參數。 或者,您可以選擇設定 'View=Auto',這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務 中的 View 參數必須符合適用的法律,包括對應、地圖、影像和其他數據,以及您有權透過 Azure 地圖服務 存取的第三方內容的國家/地區。 範例:view=IN。 如需詳細資訊,請參閱 支援的檢視 ,並查看可用的檢視。 |
Match |
反向位址搜尋作業的相符類型。 |
Operating |
POI (景點) 的上班時間。 |
Operating |
表示日期和時間 |
Operating |
一天的開啟時間範圍 |
Point |
傳回 POI 的詳細數據,包括名稱、電話、URL 位址和分類等資訊。 |
Point |
POI 類別 |
Query |
要傳回的查詢類型:NEARBY 或 NON_NEAR。 |
Response |
所需的回應格式。 值可以是 json 或 xml。 |
Search |
此物件會從成功的 搜尋呼叫傳回。 |
Search |
搜尋 API 回應的結果物件。 |
Search |
值為下列其中之一:
|
Search |
結果中應包含擴充郵遞區編碼的索引。 可用的索引包括: Addr = 位址範圍 地理位置 = 地理位置 PAD = 點位址 POI = 景點 Str = 街道 XStr = 交叉 (交集) 值應該是以逗號分隔的索引類型清單, (無索引的任何順序) 或 None 。 根據預設,除了 Geo 之外,所有索引都會包含延伸郵遞區號。 地理位置的延伸郵遞區號清單可能很長,因此必須在需要時明確要求。 使用範例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 延伸郵遞區編碼會以位址的 extendedPostalCode 屬性傳回。 可用性與區域相依。 |
Search |
搜尋 API 回應的 Summary 物件。 |
Address
結果的位址
名稱 | 類型 | Description |
---|---|---|
boundingBox |
位置的周框方塊。 |
|
buildingNumber |
string |
街道上的建築物編號。 已淘汰,請改用 streetNumber。 |
country |
string |
國家/地區名稱 |
countryCode |
string |
國家/地區 (注意:這是兩個字母代碼,而不是國家/地區名稱。) |
countryCodeISO3 |
string |
ISO alpha-3 國家/地區代碼 |
countrySecondarySubdivision |
string |
郡/縣 |
countrySubdivision |
string |
省/市 |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
國家/地區系統管理階層的第一層完整名稱。 只有在 countrySubdivision 以縮寫形式呈現時,才會顯示此字段。 僅支援美國、加拿大和英國。 |
countryTertiarySubdivision |
string |
具名區域 |
crossStreet |
string |
要交叉的街道名稱。 |
extendedPostalCode |
string |
延伸郵遞區編碼 (可用性取決於區域) 。 |
freeformAddress |
string |
根據結果國家/地區來源地區的格式規則格式化的位址行,或在國家/地區的情況下,其完整國家/地區名稱。 |
localName |
string |
位址元件,表示將多個可尋址物件分組以用於尋址目的的地理區域或位置名稱,而不需要是系統管理單位。 此欄位是用來建置 |
municipality |
string |
城市/鎮 |
municipalitySubdivision |
string |
Sub / Super City |
neighbourhood |
string |
「活動」是城市或城市內的地理當地語系化區域,具有獨特的特性,以及不同城市之間的社交互動。 |
postalCode |
string |
郵遞區區編碼/郵遞區號 |
routeNumbers |
string[] |
用來明確識別街道的代碼 |
street |
string |
街道名稱。 已淘汰,請改用 streetName。 |
streetName |
string |
街道名稱。 |
streetNameAndNumber |
string |
街道名稱和數位。 |
streetNumber |
string |
街道上的建築物編號。 |
AddressRanges
描述街道兩邊的位址範圍,以取得搜尋結果。 包含位址範圍的開始和結束位置座標。
名稱 | 類型 | Description |
---|---|---|
from |
以緯度和經度表示的位置,使用簡短名稱 『lat』 & 『lon』。 |
|
rangeLeft |
string |
街道左側的位址範圍。 |
rangeRight |
string |
街道右側的位址範圍。 |
to |
以緯度和經度表示的位置,使用簡短名稱 『lat』 & 『lon』。 |
BoundingBox
檢視區,涵蓋檢視區左上角和右下座標所代表的結果。
名稱 | 類型 | Description |
---|---|---|
btmRightPoint |
以緯度和經度表示的位置,使用簡短名稱 『lat』 & 『lon』。 |
|
topLeftPoint |
以緯度和經度表示的位置,使用簡短名稱 『lat』 & 『lon』。 |
BoundingBoxCompassNotation
位置的周框方塊。
名稱 | 類型 | Description |
---|---|---|
entity |
周框方塊的實體類型來源。 針對反向地理編碼,這一律等於位置。 |
|
northEast |
string |
以逗號分隔浮點數作為周框方塊的北東部緯度、經度座標 |
southWest |
string |
周框方塊的南西部緯度、經度座標,以逗號分隔的浮點數 |
Brand
與 POI 相關聯的品牌
名稱 | 類型 | Description |
---|---|---|
name |
string |
品牌的名稱 |
Classification
所傳回POI的分類
名稱 | 類型 | Description |
---|---|---|
code |
string |
Code 屬性 |
names |
名稱陣列 |
ClassificationName
分類的名稱
名稱 | 類型 | Description |
---|---|---|
name |
string |
Name 屬性 |
nameLocale |
string |
Name Locale 屬性 |
DataSources
選擇性章節。 與 Get 搜尋 Polygon API 搭配使用的參考標識碼。
名稱 | 類型 | Description |
---|---|---|
geometry |
結果幾何圖形的相關信息。 只有在類型 == Geography 時才存在。 |
Entity
周框方塊的實體類型來源。 針對反向地理編碼,這一律等於位置。
名稱 | 類型 | Description |
---|---|---|
position |
string |
位置實體 |
EntryPoint
所傳回POI的進入點。
名稱 | 類型 | Description |
---|---|---|
position |
以緯度和經度表示的位置,使用簡短名稱 『lat』 & 『lon』。 |
|
type |
進入點的類型。 值可以是 主要 或 次要。 |
EntryPointType
進入點的類型。 值可以是 主要 或 次要。
名稱 | 類型 | Description |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
GeographicEntityType
Geography 實體類型。 只有在要求 entityType 且可供使用時才存在。
名稱 | 類型 | Description |
---|---|---|
Country |
string |
國家/地區名稱 |
CountrySecondarySubdivision |
string |
郡/縣 |
CountrySubdivision |
string |
省/市 |
CountryTertiarySubdivision |
string |
具名區域 |
Municipality |
string |
城市/鎮 |
MunicipalitySubdivision |
string |
Sub / Super City |
Neighbourhood |
string |
附近 |
PostalCodeArea |
string |
郵遞區區編碼/郵遞區號 |
Geometry
結果幾何圖形的相關信息。 只有在類型 == Geography 時才存在。
名稱 | 類型 | Description |
---|---|---|
id |
string |
將此當做 geometryId 傳遞至 Get 搜尋 Polygon API,以擷取此結果的幾何資訊。 |
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 |
葉門 (阿拉伯文檢視) |
MatchType
反向位址搜尋作業的相符類型。
名稱 | 類型 | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
POI (景點) 的上班時間。
名稱 | 類型 | Description |
---|---|---|
mode |
string |
要求中使用的值:none 或 “nextSevenDays” |
timeRanges |
接下來 7 天的時間範圍清單 |
OperatingHoursTime
表示日期和時間
名稱 | 類型 | Description |
---|---|---|
date |
string |
代表 POI 時區中的目前行事曆日期,例如 “2019-02-07”。 |
hour |
integer |
小時以 POI 當地時間的 24 小時格式表示;可能的值為 0 - 23。 |
minute |
integer |
分鐘是在 POI 的當地時間;可能的值為 0 - 59。 |
OperatingHoursTimeRange
一天的開啟時間範圍
名稱 | 類型 | Description |
---|---|---|
endTime |
當指定的 POI 關閉時,接下來 7 天範圍內的點,如果範圍在範圍之前關閉,則為該範圍的開頭。 |
|
startTime |
當指定 POI 開啟時,接下來 7 天範圍內的點,如果範圍在範圍之前開啟,則為該範圍的開頭。 |
PointOfInterest
傳回 POI 的詳細數據,包括名稱、電話、URL 位址和分類等資訊。
名稱 | 類型 | Description |
---|---|---|
brands |
Brand[] |
品牌陣列。 所傳回POI的品牌名稱。 |
categories |
string[] |
類別陣列 |
categorySet |
最特定的 POI 類別清單 |
|
classifications |
分類陣列 |
|
name |
string |
POI 屬性的名稱 |
openingHours |
POI (景點) 的上班時間。 |
|
phone |
string |
電話號碼屬性 |
url |
string |
網站 URL 屬性 |
PointOfInterestCategorySet
POI 類別
名稱 | 類型 | Description |
---|---|---|
id |
integer |
類別目錄識別碼 |
QueryType
要傳回的查詢類型:NEARBY 或 NON_NEAR。
名稱 | 類型 | Description |
---|---|---|
NEARBY |
string |
搜尋 是在具有定義半徑的特定緯度和經度周圍執行 |
NON_NEAR |
string |
搜尋 是全域執行,而不會偏差特定緯度和經度,也不會有定義的半徑 |
ResponseFormat
所需的回應格式。 值可以是 json 或 xml。
名稱 | 類型 | Description |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
此物件會從成功的 搜尋呼叫傳回。
名稱 | 類型 | Description |
---|---|---|
results |
#DB9722335E05548C3AA2ACF3D4190C4D0 API 結果的清單。 |
|
summary |
搜尋 API 回應的摘要物件 |
SearchAddressResultItem
搜尋 API 回應的結果物件。
名稱 | 類型 | Description |
---|---|---|
address |
結果的位址 |
|
addressRanges |
描述街道兩邊的位址範圍,以取得搜尋結果。 包含位址範圍的開始和結束位置座標。 |
|
dataSources |
選擇性章節。 參考幾何標識符,以搭配 Get 搜尋 Polygon API 使用。 |
|
detourTime |
integer |
以秒為單位的導覽時間。 只會針對路由 API 的 搜尋 呼叫傳回。 |
dist |
number |
結果與地理偏差位置之間的直線距離,以公尺為單位。 |
entityType |
Geography 實體類型。 只有在要求 entityType 且可供使用時才存在。 |
|
entryPoints |
EntryPoints 的陣列。 這些描述位置可用的入口類型。 此類型可以是主要入口的「主要」,例如門門或大廳,以及「次要」,適用於側門和後門。 |
|
id |
string |
Id 屬性 |
info |
string |
Result 原始數據源的相關信息。 用於支援要求。 |
matchType |
相符專案類型的相關信息。 值為下列其中之一:
|
|
poi |
傳回 POI 的詳細數據,包括名稱、電話、URL 位址和分類等資訊。 |
|
position |
以緯度和經度表示的位置,使用簡短名稱 『lat』 & 『lon』。 |
|
score |
number |
結果集中的值,表示結果之間的相對比對分數。 您可以使用這個來判斷如果 x 的值是 y 值 2 倍,結果 x 可能與結果 y 相關兩倍。 這些值會隨著查詢而有所不同,只是做為一個結果集的相對值。 |
type |
值為下列其中之一:
|
|
viewport |
檢視區,涵蓋檢視區左上角和右下座標所代表的結果。 |
SearchAddressResultType
值為下列其中之一:
- POI
- 街道
- [地理位置]
- 點地址
- 位址範圍
- 交叉路口
名稱 | 類型 | Description |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchIndexes
結果中應包含擴充郵遞區編碼的索引。
可用的索引包括:
Addr = 位址範圍
地理位置 = 地理位置
PAD = 點位址
POI = 景點
Str = 街道
XStr = 交叉 (交集)
值應該是以逗號分隔的索引類型清單, (無索引的任何順序) 或 None 。
根據預設,除了 Geo 之外,所有索引都會包含延伸郵遞區號。 地理位置的延伸郵遞區號清單可能很長,因此必須在需要時明確要求。
使用範例:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
延伸郵遞區編碼會以位址的 extendedPostalCode 屬性傳回。 可用性與區域相依。
名稱 | 類型 | Description |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
SearchSummary
搜尋 API 回應的 Summary 物件。
名稱 | 類型 | Description |
---|---|---|
fuzzyLevel |
integer |
提供結果所需的模糊層級上限。 |
geoBias |
指出內部搜尋引擎已套用地理空間偏差,以改善結果的排名。 在某些方法中,這可以透過設定可用的 lat 和 lon 參數而受到影響。 在其他情況下,它只是內部。 |
|
limit |
integer |
將傳回的回應數目上限 |
numResults |
integer |
回應中的結果數目。 |
offset |
integer |
完整結果集中傳回結果的起始位移。 |
query |
string |
用來產生這些搜尋結果的查詢參數。 |
queryTime |
integer |
解析查詢所花費的時間,以毫秒為單位。 |
queryType |
要傳回的查詢類型:NEARBY 或 NON_NEAR。 |
|
totalResults |
integer |
找到的結果總數。 |