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

Search - Get Search Address Batch

参考

服务:: Maps

API 版本:: 1.0

使用在单个异步请求中将一批查询发送到搜索地址 API。
Get Search Address Batch API 是一个 HTTP GET 请求，它通过单个异步 API 调用将成批的查询发送到搜索地址 API。可以调用搜索 Address Batch API 以异步 (异步) 或同步 (同步) 运行。异步 API 允许调用方批处理最多 10,000 个 查询，并同步 API 最多 100 个查询。

提交同步批处理请求

对于轻型批处理请求，建议使用同步 API。当服务收到请求时，它将在计算批处理项后立即响应，并且以后无法检索结果。如果请求花费的时间超过 60 秒，同步 API 将返回超时错误 (408 响应) 。此 API 的批处理项数限制为 100 个。

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

提交异步批处理请求

异步 API 适用于处理大量相对复杂的搜索请求

它允许在单独的调用中检索结果， () 多个下载。
异步 API 针对可靠性进行优化，预计不会遇到超时。
此 API 的批处理项数限制为 10,000 个。

使用异步请求发出请求时，默认情况下，服务会沿着响应标头的“位置”字段中的重定向 URL 返回 202 响应代码。应定期检查此 URL，直到响应数据或错误信息可用。异步响应将存储 14 天。如果过期后使用重定向 URL，则返回 404 响应。

请注意，异步批处理请求是一个长时间运行的操作。下面是一个典型的操作序列：

客户端向 Azure Maps 发送搜索 Address Batch POST 请求。

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}

服务器将使用以下项之一进行响应：

HTTP 202 Accepted - 已接受 Batch 请求。

HTTP Error - 处理 Batch 请求时出错。这可以是 400 Bad Request 或任何其他 Error 状态代码。
如果已成功接受批处理请求，则 Location 响应中的标头包含用于下载批处理请求结果的 URL。此状态 URI 如下所示：

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

客户端在步骤 3 中获取的下载 URL 上发出GET请求，以下载批处理结果。

批处理请求的 POST 正文

若要发送搜索地址查询，将使用请求POST，其中请求正文将包含格式的batchItemsjson数组，Content-Type并且标头将设置为 application/json。下面是包含 5 个 搜索地址 查询的请求正文示例：

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

批处理中的 搜索地址 查询只是部分 URL，没有协议、基 URL、路径、api-version 和 subscription-key。它可以接受任何受支持的 搜索地址URI 参数。 搜索地址查询中的字符串值必须正确转义 (例如“字符应使用 \ ) 转义，并且还应正确进行 URL 编码。

异步 API 允许调用方批处理最多 10,000 个 查询，并同步 API 最多 100 个查询，并且批处理应至少包含 1 个 查询。

下载异步批处理结果

若要下载异步批处理结果，需向批量下载终结点发出 GET 请求。可以从成功的POST批处理请求的标头获取Location此下载 URL，如下所示：

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

下面是用于下载批处理结果的典型操作序列：

客户端使用下载 URL 发送GET请求。
服务器将使用以下项之一进行响应：

HTTP 202 Accepted - 已接受批处理请求，但仍在处理中。请稍后重试。

HTTP 200 OK - 已成功处理批处理请求。响应正文包含所有批处理结果。

批处理响应模型

对于异步请求和同步请求，返回的数据内容类似。下载异步批处理请求的结果时，如果批处理已完成处理，响应正文将包含批处理响应。此批处理响应包含一个 summary 组件，该组件指示 totalRequests 是原始批处理请求的一部分， successfulRequests即已成功执行的查询。批处理响应还包括一个 batchItems 数组，其中包含批处理请求中每个查询的响应。 batchItems将包含结果的顺序与原始查询在批处理请求中的发送顺序完全相同。中的每个 batchItems 项都包含 statusCode 和 response 字段。 response中的每个 batchItems 类型为以下类型之一：

SearchAddressResult - 如果查询成功完成。
Error - 如果查询失败。在本例中，响应将包含 code 和 message 。

下面是一个示例批处理响应，结果为 2 个成功 ，1 个失败 ：

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

GET https://atlas.microsoft.com/search/address/batch/{format}?api-version=1.0

URI 参数

名称	在	必需	类型	说明
format	path	True	string	用于查询操作的批 ID。
api-version	query	True	string	Azure Maps API 的版本号。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定要与Microsoft Entra ID安全模型一起使用的帐户。它表示Azure Maps帐户的唯一 ID，可以从Azure Maps管理平面帐户 API 检索。若要在 Azure Maps 中使用Microsoft Entra ID安全性，请参阅以下文章以获取指导。

响应

名称	类型	说明
200 OK	SearchAddressBatchProcessResult	确定
202 Accepted		仅异步请求支持。请求已接受：已接受请求进行处理。请使用位置标头中的 URL 重试或访问结果。标头 Location: string
Other Status Codes	ErrorResponse	发生了意外错误。

名称

类型

说明

200 OK

SearchAddressBatchProcessResult

确定

202 Accepted

仅异步请求支持。 请求已接受：已接受请求进行处理。请使用位置标头中的 URL 重试或访问结果。

标头

Location: string

Other Status Codes

ErrorResponse

发生了意外错误。

安全性

AADToken

这些是Microsoft Entra OAuth 2.0 流。与 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

示例

An Address Geocoding Batch API GET call containing 5 Address Geocoding API queries

示例请求

HTTP

GET https://atlas.microsoft.com/search/address/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

示例响应

状态代码:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

状态代码:: 202

定义

名称	说明
Address	结果的地址
AddressRanges	描述街道两侧的搜索结果的地址范围。包括地址范围的开始和结束位置的坐标。
BoundingBox	涵盖视区左上角和右下角坐标表示的结果的视区。
BoundingBoxCompassNotation	位置的边界框。
Brand	与 POI 关联的品牌
Classification	要返回的 POI 的分类
ClassificationName	分类的名称
DataSources	可选节。用于 Get 搜索 Polygon API 的引用 ID。
Entity	边界框的实体类型源。对于反向地理编码，这始终等于位置。
EntryPoint	要返回的 POI 的入口点。
EntryPointType	入口点的类型。值可以是main或次要值。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GeographicEntityType	Geography 实体类型。仅在请求 entityType 且可用时显示。
Geometry	有关结果的几何形状的信息。仅当类型 == Geography 时才存在。
LatLongPairAbbreviated	使用短名称“lat”&“lon”表示为纬度和经度的位置。
MatchType	反向地址搜索操作的匹配类型。
OperatingHours	POI (兴趣点) 的营业时间。
OperatingHoursTime	表示日期和时间
OperatingHoursTimeRange	一天的开放时间范围
PointOfInterest	返回的 POI 的详细信息，包括姓名、电话、URL 地址和分类等信息。
PointOfInterestCategorySet	POI 类别
QueryType	返回的查询类型：“附近”或“NON_NEAR”。
Response	查询结果。如果查询成功完成，则 SearchAddressResult，否则为 ErrorResponse。
SearchAddressBatchItem	从搜索 Address Batch 服务调用返回的项。
SearchAddressBatchProcessResult	此对象是从成功的地址批处理服务调用搜索返回的。
SearchAddressResultItem	搜索 API 响应的结果对象。
SearchAddressResultType	下列其中一项： POI 街道地理位置点地址地址范围十字路口
SearchSummary	搜索 API 响应的摘要对象。
Summary	批处理请求的结果摘要

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 时才存在。

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	Sub/Super City
Neighbourhood	string	附近
PostalCodeArea	string	邮政编码/邮政编码

Geometry

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

名称	类型	说明
id	string	将此作为 geometryId 传递给 Get 搜索 Polygon API，以获取此结果的几何信息。

LatLongPairAbbreviated

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

名称	类型	说明
lat	number	Latitude 属性
lon	number	Longitude 属性

MatchType

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

名称	类型	说明
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

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

名称	类型	说明
mode	string	请求中使用的值：none 或“nextSevenDays”
timeRanges	OperatingHoursTimeRange[]	未来 7 天的时间范围列表

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

QueryType

返回的查询类型：“附近”或“NON_NEAR”。

名称	类型	说明
NEARBY	string	搜索是在具有定义半径的特定纬度和经度周围执行的
NON_NEAR	string	搜索是全局执行的，没有偏向于特定的纬度和经度，也没有定义的半径

Response

查询结果。如果查询成功完成，则 SearchAddressResult，否则为 ErrorResponse。

名称	类型	说明
error	ErrorDetail	错误对象。
results	SearchAddressResultItem[]	搜索 API 结果的列表。
summary	SearchSummary	搜索 API 响应的摘要对象

SearchAddressBatchItem

从搜索 Address Batch 服务调用返回的项。

名称	类型	说明
response	Response	查询结果。如果查询成功完成，则 SearchAddressResult，否则为 ErrorResponse。
statusCode	integer	HTTP 请求状态代码。

SearchAddressBatchProcessResult

此对象是从成功的地址批处理服务调用搜索返回的。

名称	类型	说明
batchItems	SearchAddressBatchItem[]	包含批处理结果的数组。
summary	Summary	批处理请求的结果摘要

SearchAddressResultItem

搜索 API 响应的结果对象。

名称	类型	说明
address	Address	结果的地址
addressRanges	AddressRanges	描述街道两侧的搜索结果的地址范围。包括地址范围的开始和结束位置的坐标。
dataSources	DataSources	可选节。用于获取搜索多边形 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	返回的结果在完整结果集中的起始偏移量。
query	string	用于生成这些搜索结果的查询参数。
queryTime	integer	解析查询所用的时间（以毫秒为单位）。
queryType	QueryType	返回的查询类型：“附近”或“NON_NEAR”。
totalResults	integer	找到的结果总数。

Summary

批处理请求的结果摘要

名称	类型	说明
successfulRequests	integer	批处理中成功的请求数
totalRequests	integer	批处理中的请求总数

通过

Search - Get Search Address Batch

提交同步批处理请求

提交异步批处理请求

批处理请求的 POST 正文

下载异步批处理结果

批处理响应模型

URI 参数

请求头

响应

安全性

AADToken

作用域

subscription-key

SAS Token

示例

An Address Geocoding Batch API GET call containing 5 Address Geocoding API queries

示例请求

示例响应

定义

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

其他资源