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

Search - Get Search Address Reverse Batch

服务:: Maps

API 版本:: 1.0

用于在单个异步请求中将一批查询发送到搜索地址反向 API。

Get Search Address Reverse Batch API 是一个 HTTP GET 请求，在单个异步 API 调用中将查询批处理发送到搜索地址反向 API。可以调用 Get Search Address Reverse Batch API 以异步（异步）或同步（同步）运行。异步 API 允许调用方对多达 10,000 个 查询进行批处理，并将 API 同步到 100 个 查询。

提交同步批处理请求

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

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

提交异步批处理请求

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

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

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

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

客户端将搜索地址反向批处理 POST 请求发送到 Azure Maps。

POST https://atlas.microsoft.com/search/address/reverse/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/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

客户端在 GET 步骤 3 中发出请求来下载批处理结果。

批处理请求的 POST 正文

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

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

批处理中的 搜索地址反向 查询只是部分 URL ，无需 协议、基 URL、路径、api 版本和订阅密钥。它可以接受任何受支持的 搜索地址反向URI 参数。 搜索地址反向 查询中的字符串值必须正确转义（例如“字符应使用 \ 进行转义），并且还应正确编码 URL。

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

下载异步批处理结果

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

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

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

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

HTTP 202 Accepted - 已接受 Batch 请求，但仍正在处理。请在一段时间后重试。

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

批处理响应模型

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

SearchAddressReverseResponse - 如果查询成功完成。
Error - 如果查询失败。在这种情况下，响应将包含 code 和 message。

下面是一个示例 Batch 响应，其中 2 个成功,1 个失败结果：

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "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/reverse/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 管理平面帐户 API 获取 Azure Maps 帐户的唯一 ID。有关在 Azure Maps 中使用 Microsoft Entra ID 安全性的详细信息，请参阅在 Azure Maps 中管理身份验证。

响应

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

名称

类型

说明

200 OK

ReverseSearchAddressBatchProcessResult

还行

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 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

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

类型: apiKey
在: header

示例

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

状态代码:: 202

定义

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

Address

对象

结果的地址。

名称	类型	说明
boundingBox	BoundingBoxCompassNotation	定义位置的边界框。此属性仅由搜索地址反向 API 返回。所有其他搜索 API 都会返回 `viewport` 对象 `SearchAddressResultItem` 的属性。
buildingNumber	string	街上的建筑号。重要提示：此属性已弃用。请改用 `streetNumber`。
country	string	国家/地区名称。
countryCode	string	由ISO 3166-1 Alpha-2标准定义的两字母字母代码，用于表示国家/地区及其附属领土。
countryCodeISO3	string	由 ISO 3166-1 Alpha-3 标准定义的三字母字母代码，用于表示国家/地区及属属领土。
countrySecondarySubdivision	string	国家/地区内的二级行政区划。它指的是位于主级细分之下的细分，如州或省，但高于较小单位如市镇或社区的细分。例如美国的 County 和英国的 District 。
countrySubdivision	string	一个国家内的主要行政区划，如州、省。它用于代表低于国家层级的第一级细分。
countrySubdivisionCode	string	`countrySubdivisionCode` 以 `countryCode`（countryCode-countrySubdivisionCode）和连字符作为前缀，构成 ISO 3166-2 代码。示例：TX for Texas、SCT for 苏格兰和 ON for On on for On。该属性在和 `Get Search Nearby` API 中不可用`Get Search POI`。
countrySubdivisionName	string	表示国家或地区内第一级行政区划（如州、省或地区）的全名。只有当 `countrySubdivision` 该值以缩写形式提供时，这一属性才被包含在内。目前支持美国、加拿大和英国。
countryTertiarySubdivision	string	国家/地区内的第三级行政区划。它比次级细分（如县或区）更细致。例如市政当局，如城市、镇、村庄、自治市镇或镇区，以及市政当局内较小的非正式地理区域，如国会山、绿湖和西雅图的沃林福德。
crossStreet	string	要交叉的街道的名称。该属性仅在 `Get Search Address Reverse Cross Street` API 中提供。
extendedPostalCode	string	扩展邮政编码指的是一种超越标准数字集以提供更高定位精度的邮政编码格式。它常用于其他国家/地区的系统，如U.S. ZIP+4代码或类似的扩展格式。供应情况取决于地区。 API里没有。`Get Search Address Reverse Cross Street`
freeformAddress	string	地址行按照结果的国家/地区格式规则格式化，或者在国家/地区的情况下，使用其完整的国家/地区名称。
localName	string	一个地址组件，表示地理区域或区域的名称，用于对多个可寻址对象进行分组以实现寻址目的，而不用作管理单元。此字段用于生成 `freeformAddress` 属性。 `localName` 表示邮政城市。根据位置，`localName` 是城市或城镇的已知名称。对于城市或城镇的已知名称，请使用 `localName` 而不是 `municipality`。
municipality	string	城市/城镇注意：`municipality` 表示住宅城市。根据位置，`municipality` 值可能与城市或城镇的已知名称不同。对于城市或城镇的常见名称，建议 `localName` 使用“价值”代替 `municipality` “价值”。
municipalitySubdivision	string	市镇内的一个分区。它代表城市、镇或其他市政实体内较小的行政或地理单位。
neighbourhood	string	邻里是城市或城镇的地理本地化区域，具有鲜明的特点和居民之间的社会互动。
postalCode	string	在地址上添加一系列数字或字母（或两者）以帮助识别特定的地理区域。邮政编码是美国版本的邮政编码，其他国家/地区则使用邮编、邮政编码和PLZ等格式。
routeNumbers	string[]	用于明确标识街道的代码。仅适用于搜索地址反向 API。
street	string	街道名称。重要提示：此属性已弃用。请改用 `streetName`。
streetName	string	街道名称。
streetNameAndNumber	string	街道名称和编号。仅适用于搜索地址反向 API。
streetNumber	string	街上的建筑号。 API里没有。`Get Search Address Reverse Cross Street`

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

对象

可选节。用于获取搜索多边形 API 的引用 ID。

名称	类型	说明
geometry	Geometry	有关结果几何形状的信息。仅当类型 == Geography 时才存在。

Entity

枚举

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

值	说明
position	位置实体

EntryPoint

对象

要返回的 POI 的入口点。

名称	类型	说明
position	LatLongPairAbbreviated	用短名称“lat”&“lon”表示为纬度和经度的位置。
type	EntryPointType	入口点的类型。值可以是主，也可以是次要。

EntryPointType

枚举

入口点的类型。值可以是主，也可以是次要。

值	说明
main
minor

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

GeographicEntityType

枚举

地理实体类型。仅当请求了 entityType 且可用时才存在。

值	说明
Country	国家/地区名称
CountrySubdivision	州或省
CountrySecondarySubdivision	县
CountryTertiarySubdivision	命名区域
Municipality	城市/城镇
MunicipalitySubdivision	Sub /Super City
Neighbourhood	附近
PostalCodeArea	邮政编码/邮政编码

Geometry

对象

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

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

LatLongPairAbbreviated

对象

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

名称	类型	说明
lat	number (double)	Latitude 属性
lon	number (double)	经度属性

MatchType

枚举

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

值	说明
AddressPoint
HouseNumberRange
Street

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 天内的点，或者在范围之前关闭该范围时的起始点。
startTime	OperatingHoursTime	当给定的 POI 处于打开状态时，在接下来的 7 天内的点，或者在范围之前打开范围时的起始点。

PointOfInterest

对象

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

名称	类型	说明
brands	Brand[]	品牌数组。要返回的 POI 的品牌名称。
categories	string[]	类别数组
categorySet	PointOfInterestCategorySet[]	最具体的 POI 类别列表
classifications	Classification[]	分类数组
name	string	POI 属性的名称
openingHours	OperatingHours	POI（兴趣点）的营业时间。
phone	string	电话号码属性
url	string	网站 URL 属性

PointOfInterestCategorySet

对象

POI 类别

名称	类型	说明
id	integer	类别 ID

QueryType

枚举

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

重要提示：该属性已废弃，可在回复中省略。

值	说明
NEARBY	搜索在特定纬度和经度附近进行，并设定一定半径。
NON_NEAR	搜索全局执行，不偏向特定纬度和经度，且未定义半径

Response

对象

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

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

ReverseSearchAddressBatchItem

对象

从搜索地址反向批处理服务调用返回的项。

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

ReverseSearchAddressBatchProcessResult

对象

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

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

SearchAddressResultItem

对象

搜索 API 响应的结果对象。

名称	类型	说明
address	Address	结果的地址。
addressRanges	AddressRanges	描述街道两侧的地址范围，以获取搜索结果。包括地址范围的开始位置和结束位置的坐标。
dataSources	DataSources	可选节。引用用于 “获取搜索多边形” API 的几何图形 ID。
detourTime	integer	绕行时间（以秒为单位）。仅返回对沿路由 API 搜索的调用。
dist	number (double)	结果与地理位置之间的直线距离（以米为单位）。
entityType	GeographicEntityType	地理实体类型。仅当请求了 entityType 且可用时才存在。
entryPoints	EntryPoint[]	EntryPoints 数组。这些描述地点可用的入口类型。类型可以是主入口的“主”，如前门或大厅，以及侧门和后门的“次要”。
id	string	Id 属性
info	string	有关结果的原始数据源的信息。用于支持请求。
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
街道
地理
点地址
地址范围
十字路口

值	说明
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchSummary

对象

搜索 API 响应的摘要对象。

名称	类型	说明
fuzzyLevel	integer	提供结果所需的最大模糊级别。
geoBias	LatLongPairAbbreviated	指示内部搜索引擎何时应用地理空间偏差来提高结果排名。在某些方法中，这可以通过设置 lat 和 lon 参数（如果可用）而受到影响。在其他情况下，它纯粹是内部的。
limit	integer	将返回的最大响应数
numResults	integer	响应中的结果数。
offset	integer	完整结果集中返回的结果的起始偏移量。
query	string	用于生成这些搜索结果的查询参数。
queryTime	integer	解析查询所用的时间（以毫秒为单位）。
queryType	QueryType	要返回的查询类型：NEARBY 或 NON_NEAR。重要提示：该属性已废弃，可在回复中省略。
totalResults	integer	找到的结果总数。

Summary

对象

批处理请求结果摘要

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