你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称 在 必需 类型 说明
format
 path True

ResponseFormat

响应的所需格式。 值可以是 json 或 xml。
api-version
 query True

string

Azure Maps API 的版本号。
query
 query True

string

要搜索 (的 POI 名称（例如“自由女神像”、“星巴克”) ）必须经过正确的 URL 编码。
brandSet
 query

string[]

一个逗号分隔的品牌名称列表，可用于将结果限制为特定品牌。 项顺序并不重要。 当提供多个品牌时，仅返回至少) (所提供列表之一的结果。 名称中包含 “，”的品牌应放在引号中。

用法示例：

brandSet=Foo

brandSet=Foo，Bar

brandSet=“A，B，C 逗号”，条形图
btmRight
 query

string

边界框的右下位置。 例如 37.553，-122.453
categorySet
 query

integer[]

类别集 ID 的逗号分隔列表，可用于将结果限制为特定的兴趣点类别。 ID 顺序并不重要。 每个请求支持的最大值数 categorySet 为 10。 提供多个类别标识符时，仅返回至少) 所提供列表中的一个类别属于 (的 PO。 可以使用 POI 类别 API 发现支持的类别列表。 用法示例：

  • categorySet=7315 (搜索 类别餐厅) 的兴趣点

  • categorySet=7315025,7315017 (搜索 意大利或法国餐厅类别的兴趣点)

connectorSet
 query

ElectricVehicleConnector[]

连接器类型的逗号分隔列表，可用于将结果限制为支持特定连接器类型的电动汽车站。 项顺序并不重要。 如果提供了多个连接器类型，则仅返回至少) (所提供列表之一的结果。

可用的连接器类型包括：

  • StandardHouseholdCountrySpecific - 这些是特定区域的标准家用连接器。 它们都是交流单相以及标准电压和标准安培。 另请参阅： 插头 & 插座类型 - 世界标准。
  • IEC62196Type1 - IEC 62196-2 标准中定义的类型 1 连接器。 也称为 Yazaki 后的原始制造商或 SAE J1772 标准后，首次发布它。 主要与 120V 单相或高达 240V 单相基础结构结合使用。
  • IEC62196Type1CCS - IEC 62196-3 标准中定义的基于类型 1 的组合连接器。 该连接器基于 IEC 62196-2 标准中定义的类型 1 连接器，另外还有两个直流 (DC) 触点，允许 DC 快速充电。
  • IEC62196Type2CableAttached - IEC 62196-2 标准中定义的类型 2 连接器。 作为连接到充电点的电缆和插头提供。
  • IEC62196Type2Outlet - IEC 62196-2 标准中定义的类型 2 连接器。 以插座的形式提供给充电点。
  • IEC62196Type2CCS - IEC 62196-3 标准中定义的基于类型 2 的组合连接器。 该连接器基于类型 2 连接器（如 IEC 62196-2 标准中所述），另外还有两个直流 (DC) 触点，允许 DC 快速充电。
  • IEC62196Type3 - IEC 62196-2 标准中定义的类型 3 连接器。 也被称为骗子后的原始制造商。 主要与高达 240V 单相或高达 420V 的三相基础结构结合使用。
  • Chademo - CHAdeMO 连接器以东京电力公司和工业合作伙伴组成的协会命名。 因此，也称为 TEPCO 的连接器。 它支持快速 DC 充电。
  • IEC60309AC1PhaseBlue - 工业蓝色连接器是 IEC 60309 标准中定义的连接器。 它有时被标准、颜色和单相连接器的某种组合称为 。 连接器通常具有“P+N+E，6h”配置。
  • IEC60309DCWhite - 工业白色连接器是 IEC 60309 标准中定义的 DC 连接器。
  • Tesla - Tesla 连接器是特定于区域的 Tesla 增压器连接器。 也就是说，它指的是特斯拉的专有连接器，有时被称为特斯拉端口主要限于北美或修改的2型 (DC超过2型) 在欧洲。

用法示例：

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 Maps 中的 View 参数的使用必须符合适用法律，包括有关地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区的法律。 示例：view=IN。

有关详细信息，请参阅 支持的视图 ，并查看可用的视图。

请求头

名称 必需 类型 说明
x-ms-client-id

string

指定要与Microsoft Entra ID安全模型一起使用的帐户。 它表示Azure Maps帐户的唯一 ID，可以从Azure Maps管理平面帐户 API 检索。 若要在 Azure Maps 中使用Microsoft Entra ID安全性，请参阅以下文章以获取指导。

响应

名称 类型 说明
200 OK

SearchAddressResult

确定
Other Status Codes

ErrorResponse

发生了意外错误。

安全性

AADToken

这些是 OAuth 2.0 流Microsoft Entra。 与 Azure 基于角色的访问控制配对后，它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。 可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体访问权限，以Azure Maps REST API。

若要实现方案，建议查看 身份验证概念。 总之，此安全定义提供了一个解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

注意

  • 此安全定义需要使用x-ms-client-id 标头来指示应用程序请求访问哪个Azure Maps资源。 这可以从 地图管理 API 获取。
  • Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 URL 和Microsoft Entra ID配置。
  • Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。
  • 使用 Azure Maps Web SDK 可以针对多个用例对应用程序进行基于配置的设置。
  • 有关Microsoft 标识平台的详细信息，请参阅Microsoft 标识平台概述。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

这是在Azure 门户或使用 PowerShell、CLI、Azure SDK 或 REST API 创建Azure Maps帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。 换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

这是一个共享访问签名令牌，通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API，通过 Azure 管理平面在Azure Maps资源上列出 SAS 操作创建。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 Map 帐户资源 上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results

示例请求

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

定义

名称 说明
Address

结果的地址
AddressRanges

描述街道两侧的搜索结果的地址范围。 包括地址范围的开始和结束位置的坐标。
BoundingBox

涵盖视区左上角和右下角坐标表示的结果的视区。
BoundingBoxCompassNotation

位置的边界框。
Brand

与 POI 关联的品牌
Classification

要返回的 POI 的分类
ClassificationName

分类的名称
DataSources

可选节。 用于 Get 搜索 Polygon API 的引用 ID。
ElectricVehicleConnector

连接器类型的逗号分隔列表，可用于将结果限制为支持特定连接器类型的电动汽车站。 项顺序并不重要。 提供多个连接器类型时，将仅返回至少) (列表之一的结果。

可用的连接器类型包括：

  • StandardHouseholdCountrySpecific - 这些是特定区域的标准家用连接器。 它们都是交流单相以及标准电压和标准安培。 另请参阅： 插头 & 插槽类型 - 世界标准。
  • IEC62196Type1 - IEC 62196-2 标准中定义的类型 1 连接器。 也称为 Yazaki 之后的原始制造商或 SAE J1772 标准后，首次发布它。 主要与 120V 单相或高达 240V 单相基础结构结合使用。
  • IEC62196Type1CCS - IEC 62196-3 标准中定义的基于类型 1 的组合连接器。 该连接器基于类型 1 连接器（如 IEC 62196-2 标准所定义），另外还有两个直流 (DC) 触点，允许 DC 快速充电。
  • IEC62196Type2CableAttached - IEC 62196-2 标准中定义的类型 2 连接器。 作为连接到充电点的电缆和插头提供。
  • IEC62196Type2Outlet - IEC 62196-2 标准中定义的类型 2 连接器。 作为一个插座提供给充电点。
  • IEC62196Type2CCS - IEC 62196-3 标准中定义的基于类型 2 的组合连接器。 该连接器基于类型 2 连接器（如 IEC 62196-2 标准所定义），另外还有两个直流 (DC) 触点，允许 DC 快速充电。
  • IEC62196Type3 - IEC 62196-2 标准中定义的类型 3 连接器。 在原始制造商之后也称为“骗子”。 主要与高达 240V 的单相或高达 420V 的三相基础结构结合使用。
  • Chademo - CHAdeMO 连接器以东京电力公司和工业合作伙伴组成的协会命名。 因此，也称为 TEPCO 的连接器。 它支持快速 DC 充电。
  • IEC60309AC1PhaseBlue - 工业蓝连接器是 IEC 60309 标准中定义的连接器。 它有时称为标准、颜色和单相连接器的某种组合。 连接器通常具有“P+N+E，6h”配置。
  • IEC60309DCWhite - 工业白色连接器是 IEC 60309 标准中定义的 DC 连接器。
  • Tesla - Tesla 连接器是特定于区域的特斯拉增压器连接器。 也就是说，它指的是特斯拉的专有连接器，有时称为特斯拉端口，主要限于北美或修改后的 Type 2 (DC 超过类型 2 在欧洲) 。

用法示例：

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached
Entity

边界框的实体类型源。 对于反向地理编码，这始终等于位置。
EntryPoint

要返回的 POI 的入口点。
EntryPointType

入口点的类型。 值可以是main或次要值。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
GeographicEntityType

Geography 实体类型。 仅在请求 entityType 且可用时显示。
Geometry

有关结果的几何形状的信息。 仅当类型 == Geography 时才存在。
LatLongPairAbbreviated

使用短名称“lat”&“lon”表示为纬度和经度的位置。
LocalizedMapView

View 参数 (也称为“用户区域”参数，) 允许您为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图，并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下，View 参数设置为“Unified”，即使你尚未在请求中定义它。 你有责任确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用法律，包括有关地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区的法律。 示例：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 响应的摘要对象。

Address

结果的地址

名称 类型 说明
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 Scotland 和 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

描述街道两侧的搜索结果的地址范围。 包括地址范围的开始和结束位置的坐标。

名称 类型 说明
from

LatLongPairAbbreviated

使用短名称“lat”&“lon”表示为纬度和经度的位置。
rangeLeft

string

街道左侧的地址范围。
rangeRight

string

街道右侧的地址范围。
to

LatLongPairAbbreviated

使用短名称“lat”&“lon”表示为纬度和经度的位置。

BoundingBox

涵盖视区左上角和右下角坐标表示的结果的视区。

名称 类型 说明
btmRightPoint

LatLongPairAbbreviated

使用短名称“lat”&“lon”表示为纬度和经度的位置。
topLeftPoint

LatLongPairAbbreviated

使用短名称“lat”&“lon”表示为纬度和经度的位置。

BoundingBoxCompassNotation

位置的边界框。

名称 类型 说明
entity

Entity

边界框的实体类型源。 对于反向地理编码，这始终等于位置。
northEast

string

以逗号分隔的浮点为边界框的东北纬度、经度坐标
southWest

string

以逗号分隔的浮点形式的边界框的西南-西纬度、经度坐标

Brand

与 POI 关联的品牌

名称 类型 说明
name

string

品牌名称

Classification

要返回的 POI 的分类

名称 类型 说明
code

string

Code 属性
names

ClassificationName[]

名称数组

ClassificationName

分类的名称

名称 类型 说明
name

string

Name 属性
nameLocale

string

Name Locale 属性

DataSources

可选节。 用于 Get 搜索 Polygon API 的引用 ID。

名称 类型 说明
geometry

Geometry

有关结果的几何形状的信息。 仅当类型 == Geography 时才存在。

ElectricVehicleConnector

连接器类型的逗号分隔列表，可用于将结果限制为支持特定连接器类型的电动汽车站。 项顺序并不重要。 提供多个连接器类型时，将仅返回至少) (列表之一的结果。

可用的连接器类型包括：

  • StandardHouseholdCountrySpecific - 这些是特定区域的标准家用连接器。 它们都是交流单相以及标准电压和标准安培。 另请参阅： 插头 & 插槽类型 - 世界标准。
  • IEC62196Type1 - IEC 62196-2 标准中定义的类型 1 连接器。 也称为 Yazaki 之后的原始制造商或 SAE J1772 标准后，首次发布它。 主要与 120V 单相或高达 240V 单相基础结构结合使用。
  • IEC62196Type1CCS - IEC 62196-3 标准中定义的基于类型 1 的组合连接器。 该连接器基于类型 1 连接器（如 IEC 62196-2 标准所定义），另外还有两个直流 (DC) 触点，允许 DC 快速充电。
  • IEC62196Type2CableAttached - IEC 62196-2 标准中定义的类型 2 连接器。 作为连接到充电点的电缆和插头提供。
  • IEC62196Type2Outlet - IEC 62196-2 标准中定义的类型 2 连接器。 作为一个插座提供给充电点。
  • IEC62196Type2CCS - IEC 62196-3 标准中定义的基于类型 2 的组合连接器。 该连接器基于类型 2 连接器（如 IEC 62196-2 标准所定义），另外还有两个直流 (DC) 触点，允许 DC 快速充电。
  • IEC62196Type3 - IEC 62196-2 标准中定义的类型 3 连接器。 在原始制造商之后也称为“骗子”。 主要与高达 240V 的单相或高达 420V 的三相基础结构结合使用。
  • Chademo - CHAdeMO 连接器以东京电力公司和工业合作伙伴组成的协会命名。 因此，也称为 TEPCO 的连接器。 它支持快速 DC 充电。
  • IEC60309AC1PhaseBlue - 工业蓝连接器是 IEC 60309 标准中定义的连接器。 它有时称为标准、颜色和单相连接器的某种组合。 连接器通常具有“P+N+E，6h”配置。
  • IEC60309DCWhite - 工业白色连接器是 IEC 60309 标准中定义的 DC 连接器。
  • Tesla - Tesla 连接器是特定于区域的特斯拉增压器连接器。 也就是说，它指的是特斯拉的专有连接器，有时称为特斯拉端口，主要限于北美或修改后的 Type 2 (DC 超过类型 2 在欧洲) 。

用法示例：

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached

名称 类型 说明
Chademo

string

CHAdeMO 连接器以东京电力公司和工业合作伙伴组成的协会命名。 因此，也称为 TEPCO 的连接器。 它支持快速 DC 充电。
IEC60309AC1PhaseBlue

string

工业蓝连接器是 IEC 60309 标准中定义的连接器。 它有时称为标准、颜色和单相连接器的某种组合。 连接器通常具有“P+N+E，6h”配置。
IEC60309DCWhite

string

工业白色连接器是 IEC 60309 标准中定义的 DC 连接器。
IEC62196Type1

string

IEC 62196-2 标准中定义的类型 1 连接器。 也称为 Yazaki 之后的原始制造商或 SAE J1772 标准后，首次发布它。 主要与 120V 单相或高达 240V 单相基础结构结合使用。
IEC62196Type1CCS

string

IEC 62196-3 标准中定义的基于类型 1 的组合连接器。 该连接器基于类型 1 连接器（如 IEC 62196-2 标准所定义），另外还有两个直流 (DC) 触点，允许 DC 快速充电。
IEC62196Type2CCS

string

IEC 62196-3 标准中定义的基于类型 2 的组合连接器。 该连接器基于类型 2 连接器（如 IEC 62196-2 标准所定义），另外还有两个直流 (DC) 触点，允许 DC 快速充电。
IEC62196Type2CableAttached

string

IEC 62196-2 标准中定义的类型 2 连接器。 作为连接到充电点的电缆和插头提供
IEC62196Type2Outlet

string

IEC 62196-2 标准中定义的类型 2 连接器。 作为一个插座提供给充电点。
IEC62196Type3

string

IEC 62196-2 标准中定义的类型 3 连接器。 在原始制造商之后也称为“骗子”。 主要与高达 240V 的单相或高达 420V 的三相基础结构结合使用。
StandardHouseholdCountrySpecific

string

这些是特定区域的标准家用连接器。 它们都是交流单相以及标准电压和标准安培。

另请参阅： 插头 & 插槽类型 - 世界标准
Tesla

string

Tesla 连接器是特定于区域的特斯拉增压器连接器。 也就是说，它指的是特斯拉的专有连接器，有时称为特斯拉端口，主要限于北美或修改后的 Type 2 (DC 超过类型 2 在欧洲) 。

Entity

边界框的实体类型源。 对于反向地理编码，这始终等于位置。

名称 类型 说明
position

string

位置实体

EntryPoint

要返回的 POI 的入口点。

名称 类型 说明
position

LatLongPairAbbreviated

使用短名称“lat”&“lon”表示为纬度和经度的位置。
type

EntryPointType

入口点的类型。 值可以是main或次要值。

EntryPointType

入口点的类型。 值可以是main或次要值。

名称 类型 说明
main

string

minor

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

GeographicEntityType

Geography 实体类型。 仅在请求 entityType 且可用时显示。

名称 类型 说明
Country

string

国家/地区名称
CountrySecondarySubdivision

string

县
CountrySubdivision

string

省/市/自治区
CountryTertiarySubdivision

string

命名区域
Municipality

string

城市/城镇
MunicipalitySubdivision

string

亚/超级城市
Neighbourhood

string

附近
PostalCodeArea

string

邮政编码/邮政编码

Geometry

有关结果的几何形状的信息。 仅当类型 == Geography 时才存在。

名称 类型 说明
id

string

将此作为 geometryId 传递给 Get 搜索 Polygon API，以获取此结果的几何信息。

LatLongPairAbbreviated

使用短名称“lat”&“lon”表示为纬度和经度的位置。

名称 类型 说明
lat

number

Latitude 属性
lon

number

Longitude 属性

LocalizedMapView

View 参数 (也称为“用户区域”参数，) 允许您为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图，并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下，View 参数设置为“Unified”，即使你尚未在请求中定义它。 你有责任确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用法律，包括有关地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区的法律。 示例：view=IN。

有关详细信息，请参阅 支持的视图 ，并查看可用的视图。

名称 类型 说明
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

反向地址搜索操作的匹配类型。

名称 类型 说明
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

POI (兴趣点) 的营业时间。

名称 类型 说明
mode

string

请求中使用的值：none 或“nextSevenDays”
timeRanges

OperatingHoursTimeRange[]

未来 7 天的时间范围列表

OperatingHoursRange

POI (兴趣点) 的运营时间。 操作小时数的可用性因可用数据而异。 如果未通过，则不会返回营业时间信息。 支持的值：nextSevenDays

名称 类型 说明
nextSevenDays

string

显示下周的运行时间，从 POI 本地时间的当天开始。

OperatingHoursTime

表示日期和时间

名称 类型 说明
date

string

表示 POI 时区中的当前日历日期，例如“2019-02-07”。
hour

integer

小时采用 POI 本地时间的 24 小时格式;可能的值为 0 - 23。
minute

integer

分钟以 POI 的本地时间表示;可能的值为 0 - 59。

OperatingHoursTimeRange

一天的开放时间范围

名称 类型 说明
endTime

OperatingHoursTime

当给定 POI 处于关闭状态时，接下来 7 天范围内的点;如果某个 POI 在范围之前关闭，则为范围的开始点。
startTime

OperatingHoursTime

打开给定 POI 时，接下来 7 天范围内的点;如果范围在范围之前打开，则为范围的开头。

PointOfInterest

返回的 POI 的详细信息，包括姓名、电话、URL 地址和分类等信息。

名称 类型 说明
brands

Brand[]

品牌数组。 要返回的 POI 的品牌名称。
categories

string[]

Categories 数组
categorySet

PointOfInterestCategorySet[]

最具体的 POI 类别的列表
classifications

Classification[]

分类数组
name

string

POI 属性的名称
openingHours

OperatingHours

POI (兴趣点) 的营业时间。
phone

string

电话号码属性
url

string

网站 URL 属性

PointOfInterestCategorySet

POI 类别

名称 类型 说明
id

integer

类别 ID

PointOfInterestExtendedPostalCodes

结果中应包含扩展邮政编码的索引。

可用索引包括：

POI = 兴趣点

值应为 POI 或 None ，以禁用扩展邮政编码。

默认情况下，包括扩展邮政编码。

用法示例：

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性依赖于区域。

名称 类型 说明
None

string

POI

string

QueryType

返回的查询类型：NEARBY 或 NON_NEAR。

名称 类型 说明
NEARBY

string

搜索围绕定义的半径的特定纬度和经度执行
NON_NEAR

string

搜索是全局执行的，没有偏差到特定的纬度和经度，也没有定义的半径

ResponseFormat

响应的所需格式。 值可以是 json 或 xml。

名称 类型 说明
json

string

JavaScript 对象表示法数据交换格式
xml

string

可扩展标记语言

SearchAddressResult

此对象从成功的搜索调用中返回。

名称 类型 说明
results

SearchAddressResultItem[]

搜索 API 结果的列表。
summary

SearchSummary

搜索 API 响应的摘要对象

SearchAddressResultItem

搜索 API 响应的结果对象。

名称 类型 说明
address

Address

结果的地址
addressRanges

AddressRanges

描述搜索结果街道两侧的地址范围。 包括地址范围的开始和结束位置的坐标。
dataSources

DataSources

可选节。 与 Get 搜索 Polygon API 一起使用的引用几何图形 ID。
detourTime

integer

绕行时间（以秒为单位）。 仅对沿路由 API 的搜索调用返回。
dist

number

结果与地理偏差位置之间的直线距离（以米为单位）。
entityType

GeographicEntityType

Geography 实体类型。 仅在请求 entityType 且可用时显示。
entryPoints

EntryPoint[]

EntryPoint 数组。 这些说明该地点可用的入口类型。 对于前门或大厅等main入口，类型可以是“main”，对于侧门和后门，类型可以是“次要”。
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 相关的可能性是结果 y 的两倍。 这些值因查询而异，仅作为一个结果集的相对值。
type

SearchAddressResultType

下列其中一项：

  • POI
  • 街道
  • 地理位置
  • 点地址
  • 地址范围
  • 十字路口
viewport

BoundingBox

覆盖视区左上坐标和右下坐标表示的结果的视区。

SearchAddressResultType

下列其中一项：

  • POI
  • 街道
  • 地理位置
  • 点地址
  • 地址范围
  • 十字路口
名称 类型 说明
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchSummary

搜索 API 响应的摘要对象。

名称 类型 说明
fuzzyLevel

integer

提供结果所需的最大模糊级别。
geoBias

LatLongPairAbbreviated

指示内部搜索引擎应用地理空间偏差以提高结果排名。 在某些方法中，这可以通过设置 lat 和 lon 参数（如果可用）而受到影响。 在其他情况下，它纯粹是内部的。
limit

integer

将返回的最大响应数
numResults

integer

响应中的结果数。
offset

integer

完整结果集中返回的 Results 的起始偏移量。
query

string

用于生成这些搜索结果的查询参数。
queryTime

integer

解析查询所用的时间（以毫秒为单位）。
queryType

QueryType

返回的查询类型：NEARBY 或 NON_NEAR。
totalResults

integer

找到的结果总数。