Search - Get Search POI

服務:

Maps

API 版本:

1.0

使用 依名稱搜尋景點。

Points of Interest (POI) Search API 是 HTTP GET 要求，可讓您依名稱要求POI結果。 它也支援其他查詢參數，例如語言，以及依國家/地區或周框方塊驅動之感興趣的區域篩選結果。 端點只會傳回符合查詢字串的POI結果。 回應包括POI詳細數據，例如位址、座標位置和類別。

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

含選擇性參數:

GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

URI 參數

名稱	位於	必要	類型	Description
format	path	True	ResponseFormat	所需的回應格式。 值可以是 json 或 xml。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
query	query	True	string	要搜尋 (的 POI 名稱，例如，必須正確編碼“) ”) 的 (。
brandSet	query		string[]	以逗號分隔的品牌名稱清單，可用來將結果限製為特定品牌。 項目順序並不重要。 提供多個品牌時，只會傳回屬於 (至少) 其中一個提供清單的結果。 名稱中包含 “，” 的品牌應該放在引號中。 使用範例： brandSet=Foo brandSet=Foo，Bar brandSet=“A，B，C 逗號”，Bar
btmRight	query		string	周框方塊的右下角位置。 例如 37.553，-122.453
categorySet	query		integer[]	類別集標識碼的逗號分隔清單，可用來將結果限製為特定的景點類別。 標識符順序並不重要。 每個要求支援的值數目 categorySet 上限為 10。 提供多個類別標識碼時，只會傳回屬於 (至少) 提供清單中的其中一個類別的 POI。 您可以使用 POI 類別 API 來探索支援的類別清單。 使用範例： categorySet=7315 (搜尋 來自餐廳) 類別的景點 categorySet=7315025,7315017 (搜尋 義大利文或法文餐廳) 類別的景點
connectorSet	query		ElectricVehicleConnector[]	以逗號分隔的連接器類型清單，可用來將結果限製為支援特定連接器類型的車輛月臺。 項目順序並不重要。 提供多個連接器類型時，只會傳回至少屬於 () 其中一個提供清單的結果。 可用的連接器類型如下： StandardHouseholdCountrySpecific - 這些是特定區域的標準家庭連接器。 它們全都是 AC 單一階段和標準電壓和標準 Amperage。 另請參閱： 外掛程式 & 套接字類型 - 世界標準。 IEC62196Type1 - 輸入 1 連接器，如 IEC 62196-2 標準中所定義。 在第一次發行標準之後，在原始製造商或 SAE J1772 之後，也稱為 Yazaki。 大部分會與 120V 單一階段或最多 240V 個單一階段基礎結構搭配使用。 IEC62196Type1CCS - 輸入 1 型組合連接器，如 IEC 62196-3 標準中所定義。 連接器是以類型 1 連接器為基礎，如 IEC 62196-2 標準所定義，另外還有兩個直接 (DC) 聯繫人，以允許 DC 快速充電。 IEC62196Type2CableAttached - 輸入 2 連接器，如 IEC 62196-2 標準中所定義。 以纜線的形式提供，並附加至充電點。 IEC62196Type2Outlet - 輸入 2 連接器，如 IEC 62196-2 標準中所定義。 提供作為充電點的套接字集。 IEC62196Type2CCS - 輸入 2 型組合連接器，如 IEC 62196-3 標準中所定義。 連接器是以 IEC 62196-2 標準中所定義的類型 2 連接器為基礎，另外還有兩個直接 (DC) 聯繫人，以允許 DC 快速充電。 IEC62196Type3 - 輸入 3 連接器，如 IEC 62196-2 標準中所定義。 在原始製造商之後也稱為「詐騙」。 大部分都與最多 240V 單一階段或最多 420V 三階段基礎結構搭配使用。 Chademo - 由東京電力公司與產業合作夥伴所組成的關聯所命名的 CHAdeMO 連接器。 因此也稱為TEPCO的連接器。 它支援快速DC充電。 IEC60309AC1PhaseBlue - 工業藍色連接器是 IEC 60309 標準中定義的連接器。 其有時稱為標準、色彩和單一階段連接器的事實組合。 連接器通常具有 「P+N+E， 6h」 組態。 IEC60309DCWhite - 工業白色連接器是 IEC 60309 標準中定義的 DC 連接器。 Tesla - Tesla 連接器是地區特定的 Tesla Supercharger 連接器。 亦即，它是指 Tesla 的專屬連接器，有時稱為 Tesla 埠，通常僅限於 北美洲 或歐洲第 2) 類型的修改類型 2 (DC。 使用範例： connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached
countrySet	query		string[]	國家/地區代碼的逗號分隔字串，例如FR、ES。 這會將搜尋限制為指定的國家/地區
extendedPostalCodesFor	query		PointOfInterestExtendedPostalCodes[]	結果中應包含延伸郵遞區編碼的索引。 可用的索引如下： POI = 景點 值應該是 POI 或 None ，以停用延伸郵遞區號。 預設會包含延伸郵遞區號。 使用範例： extendedPostalCodesFor=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
openingHours	query		OperatingHoursRange	POI (景點) 的作業時數。 作業時數的可用性會根據可用的數據而有所不同。 如果未通過，則不會傳回任何開啟時間資訊。 支援的值：nextSevenDays
radius	query		integer	以公尺為單位的半徑，讓結果受限於定義的區域
topLeft	query		string	周框方塊的左上方位置。 例如 37.553，-122.453
typeahead	query		boolean	布林值。 如果已設定 typeahead 旗標，查詢將會解譯為部分輸入，而搜尋將會進入預測模式
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	SearchAddressResult	確定
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

這些是 OAuth 2.0 流程 Microsoft Entra。 與 Azure 角色型存取控制配對時，可用來控制對 #DB6A5D9C1E6B84BD8B03CCB2D600BAB78 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 for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results

範例要求

HTTP

GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays

範例回覆

狀態碼:

200

{
  "summary": {
    "query": "juice bars",
    "queryType": "NON_NEAR",
    "queryTime": 36,
    "numResults": 5,
    "offset": 0,
    "totalResults": 12,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.606038,
      "lon": -122.333345
    }
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/9223158",
      "score": 5.664,
      "dist": 667.2710170950347,
      "info": "search:ta:840539001755244-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-6240804",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "400",
        "streetName": "Pine St",
        "municipalitySubdivision": "Seattle, Central Business District",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98101",
        "extendedPostalCode": "981011628",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "400 Pine St, Seattle, WA 98101",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61138,
        "lon": -122.3374
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61228,
          "lon": -122.33873
        },
        "btmRightPoint": {
          "lat": 47.61048,
          "lon": -122.33607
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61134,
            "lon": -122.33737
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/9222534",
      "score": 5.663,
      "dist": 1101.6849025777728,
      "info": "search:ta:840539001760125-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-4533785",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "315",
        "streetName": "E Pine St",
        "municipalitySubdivision": "Seattle, Broadway",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98122",
        "extendedPostalCode": "9812200",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "315 E Pine St, Seattle, WA 98122",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61518,
        "lon": -122.32768
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61608,
          "lon": -122.32901
        },
        "btmRightPoint": {
          "lat": 47.61428,
          "lon": -122.32635
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61523,
            "lon": -122.32768
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/9133689",
      "score": 5.659,
      "dist": 2649.8700791555398,
      "info": "search:ta:840539001339220-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-2820651",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "604",
        "streetName": "1st Ave N",
        "municipalitySubdivision": "Seattle, Lower Queen Anne",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98109",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "604 1st Ave N, Seattle, WA 98109",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6247,
        "lon": -122.35533
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6256,
          "lon": -122.35666
        },
        "btmRightPoint": {
          "lat": 47.6238,
          "lon": -122.354
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6247,
            "lon": -122.3554
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/9131285",
      "score": 5.646,
      "dist": 5097.757019046541,
      "info": "search:ta:840539001743255-US",
      "poi": {
        "name": "Custom Smoothie & Sports Nutrition",
        "phone": "+(1)-(206)-5475522",
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.customsmoothie.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "462",
        "streetName": "N 34th St",
        "municipalitySubdivision": "Seattle, Fremont",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98103",
        "extendedPostalCode": "981038600",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "462 N 34th St, Seattle, WA 98103",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.65016,
        "lon": -122.35182
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.65106,
          "lon": -122.35315
        },
        "btmRightPoint": {
          "lat": 47.64926,
          "lon": -122.35049
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.64991,
            "lon": -122.3519
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/9228250",
      "score": 5.637,
      "dist": 6235.798481758295,
      "info": "search:ta:840531000416784-US",
      "poi": {
        "name": "Jamba Juice",
        "phone": "+(1)-(206)-6322060",
        "brands": [
          {
            "name": "Jamba Juice"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.jambajuice.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "4555",
        "streetName": "Stone Way N",
        "municipalitySubdivision": "Wallingford, Seattle",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98103",
        "extendedPostalCode": "981036600",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.66179,
        "lon": -122.34233
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.66269,
          "lon": -122.34367
        },
        "btmRightPoint": {
          "lat": 47.66089,
          "lon": -122.34099
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.66188,
            "lon": -122.34211
          }
        }
      ]
    }
  ]
}

定義

名稱	Description
Address	結果的位址
AddressRanges	描述街道兩邊的位址範圍，以取得搜尋結果。 包含位址範圍的開始和結束位置座標。
BoundingBox	檢視區，涵蓋檢視區左上角和右下角座標所代表的結果。
BoundingBoxCompassNotation	位置的周框方塊。
Brand	與 POI 相關聯的品牌
Classification	所傳回POI的分類
ClassificationName	分類的名稱
DataSources	選擇性章節。 與 Get 搜尋 Polygon API 搭配使用的參考標識碼。
ElectricVehicleConnector	以逗號分隔的連接器類型清單，可用來將結果限製為支援特定連接器類型的電車站。 項目順序並不重要。 提供多個連接器類型時，只會傳回至少) 其中一個提供清單 (屬於 (的結果。 可用的連接器類型包括： StandardHouseholdCountrySpecific - 這些是特定區域的標準家庭連接器。 它們全都是 AC 單階段和標準電壓和標準 Amperage。 另請參閱： 外掛程式 & 套接字類型 - 世界標準。 IEC62196Type1 - 輸入 1 連接器，如 IEC 62196-2 標準中所定義。 在原始製造商或 SAE J1772 最初發行標準之後，也稱為 Yazaki。 大部分都與 120V 單階段或最多 240V 單階段基礎結構搭配使用。 IEC62196Type1CCS - 輸入 1 型組合連接器，如 IEC 62196-3 標準中所定義。 連接器是以類型 1 連接器為基礎，如 IEC 62196-2 標準所定義，另外還有兩個直接目前 (DC) 聯繫人，以允許 DC 快速充電。 IEC62196Type2CableAttached - 輸入 2 連接器，如 IEC 62196-2 標準中所定義。 提供為連接到充電點的纜線和插接。 IEC62196Type2Outlet - 輸入 2 連接器，如 IEC 62196-2 標準中所定義。 以套接字集的形式提供至充電點。 IEC62196Type2CCS - 輸入 2 型組合連接器，如 IEC 62196-3 標準中所定義。 連接器是以類型 2 連接器為基礎，如 IEC 62196-2 標準所定義，另外還有兩個直接目前 (DC) 聯繫人，以允許 DC 快速充電。 IEC62196Type3 - 輸入 3 連接器，如 IEC 62196-2 標準中所定義。 在原始製造商之後也稱為詐騙。 大部分都與最多 240V 單一階段或最多 420V 三階段基礎結構搭配使用。 Chademo - 由東京電力公司與產業合作夥伴構成的關聯所命名的 CHAdeMO 連接器。 因此也稱為TEPCO的連接器。 它支援快速DC充電。 IEC60309AC1PhaseBlue - 工業藍色連接器是 IEC 60309 標準中定義的連接器。 它有時稱為標準、色彩和單一階段連接器的事實組合。 連接器通常具有 「P+N+E， 6h」 組態。 IEC60309DCWhite - 工業白色連接器是 IEC 60309 標準中定義的 DC 連接器。 Tesla - Tesla 連接器是地區特定的 Tesla Supercharger 連接器。 亦即，它是指 Tesla 的專屬連接器，有時稱為 Tesla 埠，通常僅限於 北美洲 或修改的類型 2 (DC，) 歐洲的類型 2。 使用範例： connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached
Entity	周框方塊的實體類型來源。 針對反向地理編碼，這一律等於位置。
EntryPoint	要傳回之 POI 的進入點。
EntryPointType	進入點的類型。 值可以是 主要 或 次要。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GeographicEntityType	Geography 實體類型。 只有在要求 entityType 且可供使用時才存在。
Geometry	結果幾何圖形的相關信息。 只有在類型 == Geography 時才存在。
LatLongPairAbbreviated	以緯度和經度表示的位置，使用簡短名稱 『lat』 & 『lon』。
LocalizedMapView	View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。 不同的國家/地區具有這類區域的不同檢視，而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。 根據預設，View 參數會設定為 「Unified」，即使您尚未在要求中定義它也一樣。 您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。 或者，您可以選擇設定 'View=Auto'，這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務 中的 View 參數必須符合適用的法律，包括對應相關資料、地圖、影像和其他數據，以及您有權透過 Azure 地圖服務 存取的第三方內容。 範例：view=IN。 如需詳細資訊，請參閱 支援的檢視 ，並查看可用的檢視。
MatchType	反向位址搜尋作業的相符類型。
OperatingHours	POI (景點) 的上班時間。
OperatingHoursRange	POI (景點) 的作業時數。 作業時數的可用性會根據可用的數據而有所不同。 如果未通過，則不會傳回任何開啟時間資訊。 支援的值：nextSevenDays
OperatingHoursTime	表示日期和時間
OperatingHoursTimeRange	一天的開啟時間範圍
PointOfInterest	傳回 POI 的詳細數據，包括名稱、電話、URL 位址和分類等資訊。
PointOfInterestCategorySet	POI 類別
PointOfInterestExtendedPostalCodes	結果中應包含擴充郵遞區編碼的索引。 可用的索引包括： POI = 景點 值應該是 POI 或 None ，以停用延伸郵遞區號。 預設會包含延伸郵遞區號。 使用範例： extendedPostalCodesFor=POI extendedPostalCodesFor=None 延伸郵遞區編碼會以位址的 extendedPostalCode 屬性傳回。 可用性與區域相依。
QueryType	要傳回的查詢類型：NEARBY 或 NON_NEAR。
ResponseFormat	所需的回應格式。 值可以是 json 或 xml。
SearchAddressResult	此物件會從成功的呼叫 搜尋 傳回。
SearchAddressResultItem	搜尋 API 回應的結果物件。
SearchAddressResultType	值為下列其中之一： POI 街道 [地理位置] 點地址 位址範圍 交叉路口
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	子/超級城市
neighbourhood	string	一個街道是城市或城市內的地理當地語系化區域，具有獨特特性，以及各地方之間的社交互動。
postalCode	string	郵遞區區編碼/郵遞區號
routeNumbers	string[]	用來明確識別街道的代碼
street	string	街道名稱。 已淘汰，請改用 streetName。
streetName	string	街地名。
streetNameAndNumber	string	街地名和數位。
streetNumber	string	街上的建築物編號。

AddressRanges

描述街道兩邊的位址範圍，以取得搜尋結果。 包含位址範圍的開始和結束位置座標。

名稱	類型	Description
from	LatLongPairAbbreviated	以緯度和經度表示的位置，使用簡短名稱 『lat』 & 『lon』。
rangeLeft	string	街道左側的位址範圍。
rangeRight	string	街道右側的位址範圍。
to	LatLongPairAbbreviated	以緯度和經度表示的位置，使用簡短名稱 『lat』 & 『lon』。

BoundingBox

檢視區，涵蓋檢視區左上角和右下角座標所代表的結果。

名稱	類型	Description
btmRightPoint	LatLongPairAbbreviated	以緯度和經度表示的位置，使用簡短名稱 『lat』 & 『lon』。
topLeftPoint	LatLongPairAbbreviated	以緯度和經度表示的位置，使用簡短名稱 『lat』 & 『lon』。

BoundingBoxCompassNotation

位置的周框方塊。

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

Brand

與 POI 相關聯的品牌

名稱	類型	Description
name	string	品牌的名稱

Classification

所傳回POI的分類

名稱	類型	Description
code	string	Code 屬性
names	ClassificationName[]	名稱陣列

ClassificationName

分類的名稱

名稱	類型	Description
name	string	Name 屬性
nameLocale	string	Name Locale 屬性

DataSources

選擇性章節。 與 Get 搜尋 Polygon API 搭配使用的參考標識碼。

名稱	類型	Description
geometry	Geometry	結果幾何圖形的相關信息。 只有在類型 == Geography 時才存在。

ElectricVehicleConnector

以逗號分隔的連接器類型清單，可用來將結果限製為支援特定連接器類型的電車站。 項目順序並不重要。 提供多個連接器類型時，只會傳回至少) 其中一個提供清單 (屬於 (的結果。

可用的連接器類型包括：

• StandardHouseholdCountrySpecific - 這些是特定區域的標準家庭連接器。 它們全都是 AC 單階段和標準電壓和標準 Amperage。 另請參閱： 外掛程式 & 套接字類型 - 世界標準。
• IEC62196Type1 - 輸入 1 連接器，如 IEC 62196-2 標準中所定義。 在原始製造商或 SAE J1772 最初發行標準之後，也稱為 Yazaki。 大部分都與 120V 單階段或最多 240V 單階段基礎結構搭配使用。
• IEC62196Type1CCS - 輸入 1 型組合連接器，如 IEC 62196-3 標準中所定義。 連接器是以類型 1 連接器為基礎，如 IEC 62196-2 標準所定義，另外還有兩個直接目前 (DC) 聯繫人，以允許 DC 快速充電。
• IEC62196Type2CableAttached - 輸入 2 連接器，如 IEC 62196-2 標準中所定義。 提供為連接到充電點的纜線和插接。
• IEC62196Type2Outlet - 輸入 2 連接器，如 IEC 62196-2 標準中所定義。 以套接字集的形式提供至充電點。
• IEC62196Type2CCS - 輸入 2 型組合連接器，如 IEC 62196-3 標準中所定義。 連接器是以類型 2 連接器為基礎，如 IEC 62196-2 標準所定義，另外還有兩個直接目前 (DC) 聯繫人，以允許 DC 快速充電。
• IEC62196Type3 - 輸入 3 連接器，如 IEC 62196-2 標準中所定義。 在原始製造商之後也稱為詐騙。 大部分都與最多 240V 單一階段或最多 420V 三階段基礎結構搭配使用。
• Chademo - 由東京電力公司與產業合作夥伴構成的關聯所命名的 CHAdeMO 連接器。 因此也稱為TEPCO的連接器。 它支援快速DC充電。
• IEC60309AC1PhaseBlue - 工業藍色連接器是 IEC 60309 標準中定義的連接器。 它有時稱為標準、色彩和單一階段連接器的事實組合。 連接器通常具有 「P+N+E， 6h」 組態。
• IEC60309DCWhite - 工業白色連接器是 IEC 60309 標準中定義的 DC 連接器。
• Tesla - Tesla 連接器是地區特定的 Tesla Supercharger 連接器。 亦即，它是指 Tesla 的專屬連接器，有時稱為 Tesla 埠，通常僅限於 北美洲 或修改的類型 2 (DC，) 歐洲的類型 2。

使用範例：

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached

名稱	類型	Description
Chademo	string	由東京電力公司與產業合作夥伴所組成的關聯所命名的 CHAdeMO 連接器。 因此也稱為TEPCO的連接器。 它支援快速DC充電。
IEC60309AC1PhaseBlue	string	工業藍色連接器是IEC 60309標準中定義的連接器。 它有時稱為標準、色彩和單一階段連接器的事實組合。 連接器通常具有 「P+N+E， 6h」 組態。
IEC60309DCWhite	string	工業白色連接器是IEC 60309標準中定義的DC連接器。
IEC62196Type1	string	輸入 1 連接器，如 IEC 62196-2 標準中所定義。 在原始製造商或 SAE J1772 最初發行標準之後，也稱為 Yazaki。 大部分都與 120V 單階段或最多 240V 單階段基礎結構搭配使用。
IEC62196Type1CCS	string	輸入 1 型組合連接器，如 IEC 62196-3 標準中所定義。 連接器是以類型 1 連接器為基礎，如 IEC 62196-2 標準所定義，另外還有兩個直接目前 (DC) 聯繫人，以允許 DC 快速充電。
IEC62196Type2CCS	string	輸入 2 型組合連接器，如 IEC 62196-3 標準中所定義。 連接器是以類型 2 連接器為基礎，如 IEC 62196-2 標準所定義，另外還有兩個直接目前 (DC) 聯繫人，以允許 DC 快速充電。
IEC62196Type2CableAttached	string	輸入 2 連接器，如 IEC 62196-2 標準中所定義。 以纜線和插接方式提供至充電點
IEC62196Type2Outlet	string	輸入 2 連接器，如 IEC 62196-2 標準中所定義。 以套接字集的形式提供至充電點。
IEC62196Type3	string	輸入 3 連接器，如 IEC 62196-2 標準中所定義。 在原始製造商之後也稱為詐騙。 大部分都與最多 240V 單一階段或最多 420V 三階段基礎結構搭配使用。
StandardHouseholdCountrySpecific	string	這些是特定區域的標準家庭連接器。 它們全都是 AC 單階段和標準電壓和標準 Amperage。 另請參閱： 外掛程式 & 套接字類型 - 世界標準
Tesla	string	Tesla 連接器是地區特定的 Tesla Supercharger 連接器。 亦即，它是指 Tesla 的專屬連接器，有時稱為 Tesla 埠，通常僅限於 北美洲 或修改的類型 2 (DC，) 歐洲的類型 2。

Entity

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

名稱	類型	Description
position	string	位置實體

EntryPoint

要傳回之 POI 的進入點。

名稱	類型	Description
position	LatLongPairAbbreviated	以緯度和經度表示的位置，使用簡短名稱 『lat』 & 『lon』。
type	EntryPointType	進入點的類型。 值可以是 主要 或 次要。

EntryPointType

進入點的類型。 值可以是 主要 或 次要。

名稱	類型	Description
main	string
minor	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	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	OperatingHoursTimeRange[]	接下來 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	OperatingHoursTime	當指定的 POI 關閉時，接下來 7 天範圍內的點，如果範圍在範圍之前關閉，則為該範圍的開頭。
startTime	OperatingHoursTime	當指定 POI 開啟時，接下來 7 天範圍內的點，如果範圍在範圍之前開啟，則為該範圍的開頭。

PointOfInterest

傳回 POI 的詳細數據，包括名稱、電話、URL 位址和分類等資訊。

名稱	類型	Description
brands	Brand[]	品牌陣列。 所傳回POI的品牌名稱。
categories	string[]	類別陣列
categorySet	PointOfInterestCategorySet[]	最特定的 POI 類別清單
classifications	Classification[]	分類陣列
name	string	POI 屬性的名稱
openingHours	OperatingHours	POI (景點) 的上班時間。
phone	string	電話號碼屬性
url	string	網站 URL 屬性

PointOfInterestCategorySet

POI 類別

名稱	類型	Description
id	integer	類別目錄識別碼

PointOfInterestExtendedPostalCodes

結果中應包含擴充郵遞區編碼的索引。

可用的索引包括：

POI = 景點

值應該是 POI 或 None ，以停用延伸郵遞區號。

預設會包含延伸郵遞區號。

使用範例：

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

延伸郵遞區編碼會以位址的 extendedPostalCode 屬性傳回。 可用性與區域相依。

名稱	類型	Description
None	string
POI	string

QueryType

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

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

ResponseFormat

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

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

SearchAddressResult

此物件會從成功的呼叫 搜尋 傳回。

名稱	類型	Description
results	SearchAddressResultItem[]	#D24A7591E422B4C2DB646BBCCE8873688 API 結果的清單。
summary	SearchSummary	搜尋 API 回應的摘要物件

SearchAddressResultItem

搜尋 API 回應的結果物件。

名稱	類型	Description
address	Address	結果的位址
addressRanges	AddressRanges	描述街道兩邊的位址範圍，以取得搜尋結果。 包含位址範圍的開始和結束位置座標。
dataSources	DataSources	選擇性章節。 參考幾何標識符，以搭配 Get 搜尋 Polygon API 使用。
detourTime	integer	以秒為單位的導覽時間。 只會針對路由 API 的 搜尋 呼叫傳回。
dist	number	結果與地理偏差位置之間的直線距離，以公尺為單位。
entityType	GeographicEntityType	Geography 實體類型。 只有在要求 entityType 且可供使用時才存在。
entryPoints	EntryPoint[]	EntryPoints 的陣列。 這些描述位置可用的入口類型。 此類型可以是主要入口的「主要」，例如門門或大廳，以及「次要」，適用於側門和後門。
id	string	Id 屬性
info	string	Result 原始數據源的相關信息。 用於支援要求。
matchType	MatchType	相符專案類型的相關信息。 值為下列其中之一： AddressPoint HouseNumberRange 街道
poi	PointOfInterest	傳回 POI 的詳細數據，包括名稱、電話、URL 位址和分類等資訊。
position	LatLongPairAbbreviated	以緯度和經度表示的位置，使用簡短名稱 『lat』 & 『lon』。
score	number	結果集中的值，表示結果之間的相對比對分數。 您可以使用這個來判斷如果 x 的值是 y 值 2 倍，結果 x 可能與結果 y 相關兩倍。 這些值會隨著查詢而有所不同，只是做為一個結果集的相對值。
type	SearchAddressResultType	值為下列其中之一： POI 街道 [地理位置] 點地址 位址範圍 交叉路口
viewport	BoundingBox	檢視區，涵蓋檢視區左上角和右下座標所代表的結果。

SearchAddressResultType

值為下列其中之一：

• POI
• 街道
• [地理位置]
• 點地址
• 位址範圍
• 交叉路口

名稱	類型	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

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	找到的結果總數。