Search - Post Search Inside Geometry

參考

服務:: Maps

API 版本:: 1.0

使用在一個以上的幾何內執行自由格式搜尋。

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. To send the geometry you will use a POSTrequest where the request body will contain thegeometryobject represented as aGeoJSONtype and theContent-Typeheader will be set toapplication/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** Thegeometrycan be represented as aGeoJSON FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. TheFeatureCollectionobjects. Eachcan contain a max of 50GeoJSON 功能object should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>A功能object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>A特徵object for the Circle geometry is composed of a _center_ represented using aGeoJSON 點type 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> Please see the Examples section below for a sampleFeatureCollectionrepresentation. </li><li>**GeoJSON GeometryCollection** Thegeometrycan be represented as aGeoJSON GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. TheGeometryCollectioncan contain a max of 50GeoJSON Polygonobjects. EachPolygonobject can have a max of 50 coordinates. Please see the Examples section below for a sampleGeometryCollectionrepresentation. </li><li>**GeoJSON Polygon** ThegeometryCollectioncan be represented as aGeoJSON Polygonobject. This is the recommended option if the geometry contains a single Polygon. ThePolygonobject can have a max of 50 coordinates. Please see the Examples section below for a samplePolygon 表示法。

.

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	ResponseFormat	回應所需的格式。值可以是 json 或 xml。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
query	query	True	string	要搜尋的 POI 名稱（例如“自由雕像”、“星巴克”、“披薩”）。必須正確編碼 URL。
categorySet	query		integer[]	類別集標識碼的逗號分隔清單，可用來將結果限製為特定的景點類別。標識符順序並不重要。每個要求支援的 `categorySet` 值上限為 10。提供多個類別標識碼時，只會傳回屬於所提供清單中其中一個類別的 POIS。您可以使用 POI 類別 API 來探索支援的類別清單。使用範例： categorySet=7315 （從類別餐廳搜尋景點） categorySet=7315025,7315017（義大利或法國餐廳等類別的搜尋景點）
extendedPostalCodesFor	query		SearchIndexes[]	結果中應包含延伸郵遞區編碼的索引。可用的索引如下： Addr = 位址範圍地理 = 地理位置 PAD = 點位址 POI = 景點 Str = 街道 XStr = 十字街（十字路口）值應該是索引類型的逗號分隔清單（依任何順序）或無索引 None。根據預設，除了 Geo 之外，所有索引都會包含延伸郵遞區號。地理位置的延伸郵遞區號清單可能相當長，因此必須在需要時明確要求。使用範例： extendedPostalCodesFor=POI extendedPostalCodesFor=PAD，Addr，POI extendedPostalCodesFor=None 延伸郵遞區編碼會以位址的 extendedPostalCode 屬性傳回。可用性是區域相依的。
idxSet	query		SearchIndexes[]	應用於搜尋的索引逗號分隔清單。項目順序並不重要。可用的索引包括：Addr = 位址範圍插補、地理位置 = 地理位置、PAD = 點位址、POI = 景點、Str = 街道、Xstr = 跨街（交集）
language	query		string	應該傳回搜尋結果的語言。應該是其中一個支援的 IETF 語言標記，不區分大小寫。當特定欄位無法使用指定語言的數據時，會使用預設語言。如需詳細資訊，請參閱支援的語言。
limit	query		integer minimum: 1 maximum: 100	將傳回的回應數目上限。默認值：10，最小值：1，最大值：100
openingHours	query		OperatingHoursRange	POI（景點）的運行時間。作業時數的可用性會根據可用的數據而有所不同。如果未通過，則不會傳回任何上班時間資訊。支援的值：nextSevenDays
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
geometry	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	有效的 `GeoJSON` 物件。如需詳細資訊，請參閱 RFC 7946。

回應

名稱	類型	Description
200 OK	SearchAddressResult	還行
Other Status Codes	ErrorResponse	發生未預期的錯誤。

安全性

AADToken

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

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

備註

此安全性定義需要使用 x-ms-client-id 標頭來指出應用程式要求存取的 Azure 地圖服務資源。這可以從地圖管理 API 取得。
Authorization URL 專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL，Microsoft Entra ID 設定。
Azure 角色型訪問控制是從 azure 管理平面設定，透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API。
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 for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

範例要求

HTTP

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
            ]
          ]
        ]
      }
    ]
  }
}

範例回覆

狀態碼:: 200

{
  "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

範例要求

HTTP

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
        }
      }
    ]
  }
}

範例回覆

狀態碼:: 200

{
  "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

範例要求

HTTP

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
        ]
      ]
    ]
  }
}

範例回覆

狀態碼:: 200

{
  "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	結果的位址
AddressRanges	描述街道兩側的位址範圍，以取得搜尋結果。位址範圍的開始和結束位置座標都包含在內。
BoundingBox	涵蓋檢視區左上角和右下座標所代表結果的檢視區。
BoundingBoxCompassNotation	位置的周框方塊。
Brand	與 POI 相關聯的品牌
Classification	所傳回POI的分類
ClassificationName	分類的名稱
DataSources	選擇性區段。與取得搜尋多邊形 API 搭配使用的參考標識碼。
Entity	周框方塊的實體類型來源。針對反向地理編碼，這一律等於位置。
EntryPoint	要傳回POI的進入點。
EntryPointType	進入點的類型。值可以是主要或次要。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GeographicEntityType	Geography 實體類型。只有在要求 entityType 且可供使用時才存在。
GeoJsonFeature	有效的 `GeoJSON Feature` 物件類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonFeatureCollection	有效的 `GeoJSON FeatureCollection` 物件類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonGeometry	有效的 `GeoJSON` geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946。
GeoJsonGeometryCollection	有效的 `GeoJSON GeometryCollection` 物件類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonLineString	有效的 `GeoJSON LineString` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonMultiLineString	有效的 `GeoJSON MultiLineString` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonMultiPoint	有效的 `GeoJSON MultiPoint` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonMultiPolygon	有效的 `GeoJSON MultiPolygon` 物件類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonPoint	有效的 `GeoJSON Point` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonPolygon	有效的 `GeoJSON Polygon` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
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 類別
QueryType	要傳回的查詢類型：NEARBY 或 NON_NEAR。
ResponseFormat	回應所需的格式。值可以是 json 或 xml。
SearchAddressResult	此物件會從成功的搜尋呼叫傳回。
SearchAddressResultItem	搜尋 API 回應的結果物件。
SearchAddressResultType	其中之一： POI 街道地理點地址位址範圍交叉路口
SearchIndexes	結果中應包含延伸郵遞區編碼的索引。可用的索引如下： Addr = 位址範圍地理 = 地理位置 PAD = 點位址 POI = 景點 Str = 街道 XStr = 十字街（十字路口）值應該是索引類型的逗號分隔清單（依任何順序）或無索引 None。根據預設，除了 Geo 之外，所有索引都會包含延伸郵遞區號。地理位置的延伸郵遞區號清單可能相當長，因此必須在需要時明確要求。使用範例： extendedPostalCodesFor=POI extendedPostalCodesFor=PAD，Addr，POI extendedPostalCodesFor=None 延伸郵遞區編碼會以位址的 extendedPostalCode 屬性傳回。可用性是區域相依的。
SearchInsideGeometryRequest	此類型代表搜尋內部幾何服務的要求本文。
SearchSummary	搜尋 API 回應的 Summary 物件。

Address

Object

結果的位址

名稱	類型	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 蘇格蘭和 ON for On for On。
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	街上的建築編號。

AddressRanges

Object

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

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

BoundingBox

Object

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

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

BoundingBoxCompassNotation

Object

位置的周框方塊。

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

Brand

Object

與 POI 相關聯的品牌

名稱	類型	Description
name	string	品牌名稱

Classification

Object

所傳回POI的分類

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

ClassificationName

Object

分類的名稱

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

DataSources

Object

選擇性區段。與取得搜尋多邊形 API 搭配使用的參考標識碼。

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

Entity

列舉型別

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

值	Description
position	位置實體

EntryPoint

Object

要傳回POI的進入點。

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

EntryPointType

列舉型別

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

值	Description
main
minor

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

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

ErrorDetail

Object

錯誤詳細數據。

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

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GeographicEntityType

列舉型別

Geography 實體類型。只有在要求 entityType 且可供使用時才存在。

值	Description
Country	國家/地區名稱
CountrySecondarySubdivision	縣
CountrySubdivision	州或省
CountryTertiarySubdivision	具名區域
Municipality	城市/城鎮
MunicipalitySubdivision	Sub / Super City
Neighbourhood	附近
PostalCodeArea	郵遞區編碼 /郵遞區號

GeoJsonFeature

Object

有效的 GeoJSON Feature 物件類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
featureType	string	功能的類型。值取決於目前功能所屬的數據模型。某些數據模型可能有空白值。
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	有效的 `GeoJSON` geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946。
id	string	功能的標識碼。
type	string: Feature	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonFeatureCollection

Object

有效的 GeoJSON FeatureCollection 物件類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
features	GeoJsonFeature[]	包含有效的 `GeoJSON Feature` 物件清單。
type	string: FeatureCollection	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometry

Object

有效的 GeoJSON geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
type	GeoJsonObjectType	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

Object

有效的 GeoJSON GeometryCollection 物件類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	包含有效的 `GeoJSON` geometry 物件清單。注意 GeoJSON 中的座標以 x、y 順序（經度、緯度）為單位。
type	string: GeometryCollection	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

Object

有效的 GeoJSON LineString 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson LineString` 幾何座標。
type	string: LineString	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

Object

有效的 GeoJSON MultiLineString 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson MultiLineString` 幾何座標。
type	string: MultiLineString	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

Object

有效的 GeoJSON MultiPoint 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson MultiPoint` 幾何座標。
type	string: MultiPoint	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

Object

有效的 GeoJSON MultiPolygon 物件類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	包含有效的 `GeoJSON Polygon` 物件清單。注意 GeoJSON 中的座標以 x、y 順序（經度、緯度）為單位。
type	string: MultiPolygon	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPoint

Object

有效的 GeoJSON Point 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`Position` 是具有兩個或多個元素的數字數位數位數位。前兩個元素是經度和緯度，確切地依該順序排列。高度/高度是選擇性的第三個專案。如需詳細資訊，請參閱 RFC 7946。
type	string: Point	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

Object

有效的 GeoJSON Polygon 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson Polygon` 幾何類型的座標。
type	string: Polygon	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

Geometry

Object

結果幾何形狀的相關信息。只有在類型 == Geography 時才存在。

名稱	類型	Description
id	string	將此當做 geometryId 傳遞至取得搜尋多邊形 API，以擷取此結果的幾何資訊。

LatLongPairAbbreviated

Object

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

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

LocalizedMapView

列舉型別

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

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

值	Description
AE	阿拉伯聯合大國（阿拉伯視圖）
AR	阿根廷（阿根廷觀點）
Auto	根據要求的IP位址傳回地圖數據。
BH	巴林（阿拉伯檢視）
IN	印度（印度觀點）
IQ	伊拉克（阿拉伯文檢視）
JO	約旦（阿拉伯文檢視）
KW	科威特（阿拉伯文視圖）
LB	黎巴嫩（阿拉伯文檢視）
MA	摩洛哥（摩洛哥檢視）
OM	阿曼（阿拉伯文視圖）
PK	巴基斯坦（巴基斯坦觀點）
PS	巴勒斯坦權力機構（阿拉伯文視圖）
QA	卡達（阿拉伯文檢視）
SA	沙烏地阿拉伯（阿拉伯文視圖）
SY	敘利亞（阿拉伯文檢視）
Unified	統一檢視（其他）
YE	葉門（阿拉伯文檢視）

MatchType

列舉型別

反向位址搜尋作業的比對類型。

值	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

POI（景點）的上班時間。

名稱	類型	Description
mode	string	要求中使用的值：none 或 “nextSevenDays”
timeRanges	OperatingHoursTimeRange[]	未來 7 天的時間範圍清單

OperatingHoursRange

列舉型別

POI（景點）的運行時間。作業時數的可用性會根據可用的數據而有所不同。如果未通過，則不會傳回任何上班時間資訊。支援的值：nextSevenDays

值	Description
nextSevenDays	顯示下周的作業時數，從 POI 當地時間的目前日期開始。

OperatingHoursTime

Object

表示日期和時間

名稱	類型	Description
date	string	代表 POI 時區中的目前行事曆日期，例如 “2019-02-07”。
hour	integer	小時是 POI 當地時間的 24 小時格式：可能的值為 0 - 23。
minute	integer	分鐘是在 POI 的當地時間;可能的值為 0 - 59。

OperatingHoursTimeRange

Object

一天的開啟時間範圍

名稱	類型	Description
endTime	OperatingHoursTime	當指定的 POI 關閉時，未來 7 天範圍內的點，如果範圍在範圍之前關閉，則為範圍的開頭。
startTime	OperatingHoursTime	當指定的 POI 正在開啟時，接下來 7 天範圍內的點，如果範圍在範圍之前開啟，則為範圍的開頭。

PointOfInterest

Object

傳回 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

Object

POI 類別

名稱	類型	Description
id	integer	類別標識碼

QueryType

列舉型別

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

值	Description
NEARBY	搜尋是在具有定義半徑的特定緯度和經度周圍執行
NON_NEAR	搜尋是在全域執行，而不會偏向特定緯度和經度，也沒有定義的半徑

ResponseFormat

列舉型別

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

值	Description
json	JavaScript 物件表示法數據交換格式
xml	可延伸標記語言

SearchAddressResult

Object

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

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

SearchAddressResultItem

Object

搜尋 API 回應的結果物件。

名稱	類型	Description
address	Address	結果的位址
addressRanges	AddressRanges	描述街道兩側的位址範圍，以取得搜尋結果。位址範圍的開始和結束位置座標都包含在內。
dataSources	DataSources	選擇性區段。參考幾何標識碼，以搭配取得搜尋多邊形 API 使用。
detourTime	integer	繞道時間以秒為單位。僅針對對沿路由 API 搜尋的呼叫傳回。
dist	number (double)	結果與地理位置之間的直線距離，以公尺為單位。
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 (double)	結果集中的值，表示結果之間的相對比對分數。您可以使用這個值來判斷如果 x 的值是 y 值 2 倍，則結果 x 可能與結果 y 相同。這些值會隨著查詢而有所不同，只表示做為一個結果集的相對值。
type	SearchAddressResultType	其中之一： POI 街道地理點地址位址範圍交叉路口
viewport	BoundingBox	涵蓋檢視區左上角和右下座標所代表結果的檢視區。

SearchAddressResultType

列舉型別

其中之一：

POI
街道
地理
點地址
位址範圍
交叉路口

值	Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

列舉型別

結果中應包含延伸郵遞區編碼的索引。

可用的索引如下：

Addr = 位址範圍

地理 = 地理位置

PAD = 點位址

POI = 景點

Str = 街道

XStr = 十字街（十字路口）

值應該是索引類型的逗號分隔清單（依任何順序）或無索引 None。

根據預設，除了 Geo 之外，所有索引都會包含延伸郵遞區號。地理位置的延伸郵遞區號清單可能相當長，因此必須在需要時明確要求。

使用範例：

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD，Addr，POI

extendedPostalCodesFor=None

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

值	Description
Addr
Geo
PAD
POI
Str
Xstr

SearchInsideGeometryRequest

Object

此類型代表搜尋內部幾何服務的要求本文。

名稱	類型	Description
geometry	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	有效的 `GeoJSON` 物件。如需詳細資訊，請參閱 RFC 7946。

SearchSummary

Object

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

共用方式為

Search - Post Search Inside Geometry

URI 參數

要求標頭

要求本文

回應

安全性

AADToken

範圍

subscription-key

SAS Token

範例

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

範例要求

範例回覆

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

範例要求

範例回覆

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

範例要求

範例回覆

定義

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursRange

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchInsideGeometryRequest

SearchSummary

其他資源