Search - Post Search Inside Geometry
使用 在一個多個幾何內執行自由格式搜尋。
Post Search Inside Geometry
API 是 和 HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a
POSTrequest where the request body will contain the
geometryobject represented as a
GeoJSON 內容類型header will be set to
應用程式/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following
GeoJSON geometrycan be represented as a
GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>The
type and the
FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. The
FeatureCollection GeoJSON Featureobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>A
object should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>A
objects. Each
object for the Circle geometry is composed of a _center_ represented using a
Feature GeoJSON Pointtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sample
FeatureCollectionrepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>The
geometry GeoJSON GeometryCollection GeometryCollectioncan contain a max of 50
can be represented as a
object. This is the recommended option if the geometry contains a list of Polygons only. The
GeoJSON Polygonobject can have a max of 50 coordinates. Please see the Examples section below for a sample
objects. Each
Polygon GeometryCollectioncan contain a max of 50
representation.<br><br></li><li>**GeoJSON Polygon**<br>The
geometrycan be represented as a
GeoJSON Polygonobject. This is the recommended option if the geometry contains a single Polygon. The
object can have a max of 50 coordinates. Please see the Examples section below for a sample
多邊形的表示法。
.
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
format
|
path | True |
所需的回應格式。 值可以是 json 或 xml。 |
|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
query
|
query | True |
string |
要搜尋 (的 POI 名稱,例如“擷取 ) ” “) 。 必須正確編碼 URL。 |
category
|
query |
integer[] |
類別集標識碼的逗號分隔清單,可用來將結果限製為特定的景點類別。 標識符順序並不重要。 每個要求支援的值數目
|
|
extended
|
query |
結果中應包含擴充郵遞區編碼的索引。 可用的索引包括: Addr = 位址範圍 地理位置 = 地理位置 PAD = 點位址 POI = 景點 Str = 街道 XStr = 交叉 (交集) 值應該是以逗號分隔的索引類型清單, (無索引的任何順序) 或 None 。 根據預設,除了 Geo 之外,所有索引都會包含延伸郵遞區號。 地理位置的延伸郵遞區號清單可能很長,因此必須在需要時明確要求。 使用範例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 延伸郵遞區編碼會以位址的 extendedPostalCode 屬性傳回。 可用性與區域相依。 |
||
idx
|
query |
應用於搜尋的索引逗號分隔清單。 項目順序並不重要。 可用的索引包括:Addr = 位址範圍插補、地理位置 = 地理位置、PAD = 點位址、POI = 景點、Str = 街道、Xstr = 交叉街道 (交集) |
||
language
|
query |
string |
應該傳回搜尋結果的語言。 應該是其中一個支援的 IETF 語言標籤,不區分大小寫。 當指定語言的數據不適用於特定欄位時,會使用預設語言。 如需詳細資訊,請參閱 支援的語言 。 |
|
limit
|
query |
integer |
將傳回的回應數目上限。 默認值:10,最小值:1 和最大值:100 |
|
opening
|
query |
POI (景點) 的作業時數。 作業時數的可用性會根據可用的數據而有所不同。 如果未通過,則不會傳回任何開啟時間資訊。 支援的值:nextSevenDays |
||
view
|
query |
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 |
---|---|---|
geometry | GeoJsonObject: |
有效的 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
發生意外錯誤。 |
安全性
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 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務 資源上的清單 SAS 作業建立共用存取簽章令牌。
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並精細控制到期、速率和區域 (特定令牌的使用) 。 換句話說,SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 地圖帳戶資源 上設定允許的來源特定清單,以限制轉譯濫用,並定期更新 SAS 令牌。
類型:
apiKey
位於:
header
範例
Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
範例要求
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
},
{
"type": "Polygon",
"coordinates": [
[
[
-123.43576049804686,
37.7524152343544
],
[
-123.43301391601562,
37.70660472542312
],
[
-123.36434936523438,
37.712059855877314
],
[
-123.43576049804686,
37.7524152343544
]
]
]
}
]
}
}
範例回覆
{
"summary": {
"query": "burger",
"queryType": "NON_NEAR",
"queryTime": 21,
"numResults": 2,
"offset": 0,
"totalResults": 4,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "9P2i9inRyndAA-_V40J8oA",
"score": 2.0041828156,
"info": "search:ta:840061003419653-US",
"poi": {
"name": "Burger Joint",
"phone": "+1 415-349-4331",
"categorySet": [
{
"id": 7315015
}
],
"categories": [
"fast food",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
},
{
"type": "POI",
"id": "hkr-N07YS6Gv2dOciQ9lwA",
"score": 2.0041515827,
"info": "search:ta:840067000526682-US",
"poi": {
"name": "Sound of Burgers",
"categorySet": [
{
"id": 7315
}
],
"categories": [
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
}
]
}
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
範例要求
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.143035,
47.653536
],
[
-122.187164,
47.617556
],
[
-122.114981,
47.570599
],
[
-122.132756,
47.654009
],
[
-122.143035,
47.653536
]
]
]
},
"properties": {}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"subType": "Circle",
"radius": 100
}
}
]
}
}
範例回覆
{
"summary": {
"query": "pizza",
"queryType": "NON_NEAR",
"queryTime": 34,
"numResults": 2,
"offset": 0,
"totalResults": 21,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "-UuwTye4GGsea4KmCLvoqQ",
"score": 2.1455535889,
"info": "search:ta:840537000108972-US",
"poi": {
"name": "Biryani & Pizza House",
"categorySet": [
{
"id": 7315036
}
],
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
]
},
"address": {
"streetNumber": "15025",
"streetName": "Northeast 24th Street",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "98052-5531",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
"localName": "Redmond"
},
"position": {
"lat": 47.630786,
"lon": -122.139302
},
"viewport": {
"topLeftPoint": {
"lat": 47.63169,
"lon": -122.14064
},
"btmRightPoint": {
"lat": 47.62989,
"lon": -122.13797
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63079,
"lon": -122.13931
}
},
{
"type": "main",
"position": {
"lat": 47.63147,
"lon": -122.13935
}
}
]
},
{
"type": "POI",
"id": "7r095LCcCSkdoGoeLcnvsQ",
"score": 2.1454992294,
"info": "search:ta:840537000103468-US",
"poi": {
"name": "Pagliacci Pizza",
"categorySet": [
{
"id": 7315036
}
],
"url": "www.pagliacci.com/",
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-14",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-20",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-20",
"hour": 11,
"minute": 0
}
}
]
}
},
"address": {
"streetNumber": "15238",
"streetName": "Bel Red Road",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"extendedPostalCode": "98007-3815",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
"localName": "Bellevue"
},
"position": {
"lat": 47.628008,
"lon": -122.13646
},
"viewport": {
"topLeftPoint": {
"lat": 47.62891,
"lon": -122.13779
},
"btmRightPoint": {
"lat": 47.62711,
"lon": -122.13513
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6283,
"lon": -122.13611
}
}
]
}
]
}
Search for subs joints inside a geometry represented as a GeoJSON Polygon type
範例要求
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
}
}
範例回覆
{
"summary": {
"query": "subs",
"queryType": "NON_NEAR",
"queryTime": 42,
"numResults": 2,
"offset": 0,
"totalResults": 5,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "HOIWGiNwVv0z6bF8MO3EbA",
"score": 2.1455111504,
"info": "search:ta:840069009512242-US",
"poi": {
"name": "Adams Grub Truck",
"phone": "+1 415-307-8844",
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "1465",
"streetName": "Carroll Avenue",
"municipality": "San Francisco",
"neighbourhood": "Bayview",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94124",
"extendedPostalCode": "94124-3604",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
"localName": "San Francisco"
},
"position": {
"lat": 37.72328,
"lon": -122.39091
},
"viewport": {
"topLeftPoint": {
"lat": 37.72418,
"lon": -122.39205
},
"btmRightPoint": {
"lat": 37.72238,
"lon": -122.38977
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72348,
"lon": -122.39073
}
}
]
},
{
"type": "POI",
"id": "bXbc0QxTRlkSo8GnU7EU-Q",
"score": 2.1454677582,
"info": "search:ta:840061001992959-US",
"poi": {
"name": "SUBWAY San Francisco San Francisco",
"phone": "+1 415-657-9898",
"brands": [
{
"name": "SUBWAY"
}
],
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-13",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-13",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-14",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-15",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-15",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-16",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-16",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 8,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 20,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 21,
"minute": 30
}
}
]
}
},
"address": {
"streetNumber": "2599",
"streetName": "San Bruno Avenue",
"municipality": "San Francisco",
"neighbourhood": "Portola",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-1504",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.729004,
"lon": -122.403956
},
"viewport": {
"topLeftPoint": {
"lat": 37.7299,
"lon": -122.40509
},
"btmRightPoint": {
"lat": 37.7281,
"lon": -122.40282
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72892,
"lon": -122.40414
}
}
]
}
]
}
定義
名稱 | Description |
---|---|
Address |
結果的位址 |
Address |
描述街道兩邊的位址範圍,以取得搜尋結果。 包含位址範圍的開始和結束位置座標。 |
Bounding |
檢視區,涵蓋檢視區左上角和右下角座標所代表的結果。 |
Bounding |
位置的周框方塊。 |
Brand |
與 POI 相關聯的品牌 |
Classification |
所傳回POI的分類 |
Classification |
分類的名稱 |
Data |
選擇性章節。 與 Get 搜尋 Polygon API 搭配使用的參考標識碼。 |
Entity |
周框方塊的實體類型來源。 針對反向地理編碼,這一律等於位置。 |
Entry |
要傳回之 POI 的進入點。 |
Entry |
進入點的類型。 值可以是 主要 或 次要。 |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Geographic |
Geography 實體類型。 只有在要求 entityType 且可供使用時才存在。 |
Geo |
有效的 |
Geo |
有效的 |
Geo |
有效的 |
Geo |
有效的 |
Geo |
有效的 |
Geo |
有效的 |
Geo |
有效的 |
Geo |
有效的 |
Geo |
有效的 |
Geo |
有效的 |
Geometry |
結果幾何圖形的相關信息。 只有在類型 == Geography 時才存在。 |
Lat |
以緯度和經度表示的位置,使用簡短名稱 『lat』 & 『lon』。 |
Localized |
View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。 不同的國家/地區具有這類區域的不同檢視,而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。 根據預設,View 參數會設定為 「Unified」,即使您尚未在要求中定義它也一樣。 您必須負責判斷使用者的位置,然後正確設定該位置的 View 參數。 或者,您可以選擇設定 'View=Auto',這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務 中的 View 參數必須符合適用的法律,包括對應、地圖、影像和其他數據,以及您有權透過 Azure 地圖服務 存取的第三方內容的國家/地區。 範例:view=IN。 如需詳細資訊,請參閱 支援的檢視 ,並查看可用的檢視。 |
Match |
反向位址搜尋作業的相符類型。 |
Operating |
POI (景點) 的上班時間。 |
Operating |
POI (景點) 的作業時數。 作業時數的可用性會根據可用的數據而有所不同。 如果未通過,則不會傳回任何開啟時間資訊。 支援的值:nextSevenDays |
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 |
此類型代表內部 Geometry 服務內 搜尋 的要求本文。 |
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 |
郵遞區區編碼/郵遞區號 |
GeoJsonFeature
有效的 GeoJSON Feature
物件類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
featureType |
string |
功能的類型。 值取決於目前功能所屬的數據模型。 某些數據模型可能會有空的值。 |
geometry | GeoJsonGeometry: |
有效的 |
id |
string |
功能的標識碼。 |
type |
string:
Feature |
指定 |
GeoJsonFeatureCollection
有效的 GeoJSON FeatureCollection
物件類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
features |
包含有效 |
|
type |
string:
Feature |
指定 |
GeoJsonGeometry
有效的 GeoJSON
geometry 物件。 此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
type |
Geo |
指定 |
GeoJsonGeometryCollection
有效的 GeoJSON GeometryCollection
物件類型。 如需詳細資訊,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
包含有效 |
type |
string:
Geometry |
指定 |
GeoJsonLineString
有效的 GeoJSON LineString
幾何類型。 如需詳細資訊,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
coordinates |
number[] |
幾何的 |
type |
string:
Line |
指定 |
GeoJsonMultiLineString
有效的 GeoJSON MultiLineString
幾何類型。 如需詳細資訊,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
coordinates |
number[] |
幾何的 |
type |
string:
Multi |
指定 |
GeoJsonMultiPoint
有效的 GeoJSON MultiPoint
幾何類型。 如需詳細資訊,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
coordinates |
number[] |
幾何的 |
type |
string:
Multi |
指定 |
GeoJsonMultiPolygon
有效的 GeoJSON MultiPolygon
物件類型。 如需詳細資訊,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
coordinates |
number[] |
包含有效 |
type |
string:
Multi |
指定 |
GeoJsonPoint
有效的 GeoJSON Point
幾何類型。 如需詳細資訊,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
coordinates |
number[] |
|
type |
string:
Point |
指定 |
GeoJsonPolygon
有效的 GeoJSON Polygon
幾何類型。 如需詳細資訊,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
coordinates |
number[] |
|
type |
string:
Polygon |
指定 |
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 天的時間範圍清單 |
OperatingHoursRange
POI (景點) 的作業時數。 作業時數的可用性會根據可用的數據而有所不同。 如果未通過,則不會傳回任何開啟時間資訊。 支援的值:nextSevenDays
名稱 | 類型 | Description |
---|---|---|
nextSevenDays |
string |
顯示下一周的作業時數,從 POI 當地時間的目前日期開始。 |
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 |
#D7AD7C2996B25469195543432A5B78000 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 |
SearchInsideGeometryRequest
此類型代表內部 Geometry 服務內 搜尋 的要求本文。
名稱 | 類型 | Description |
---|---|---|
geometry | GeoJsonObject: |
有效的 |
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 |
找到的結果總數。 |