你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Search - Get Search Address Structured
用于获取非结构化或查询输入格式的街道地址的纬度和经度坐标。
Get Search Address Structured
(结构化地址地理编码) API 是一个 HTTP GET
请求,它以非结构化或查询输入格式返回街道地址的纬度和经度坐标。
地理编码搜索索引将查询街道级别数据以上的所有内容。 不会返回任何 POI。 请注意,地理编码器非常能容忍拼写错误和不完整的地址。 它还将处理从确切的街道地址或街道或交叉口以及更高级别的地理区域,如市中心,县,州等的所有内容。
GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&countryCode={countryCode}
GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&language={language}&countryCode={countryCode}&limit={limit}&ofs={ofs}&streetNumber={streetNumber}&streetName={streetName}&crossStreet={crossStreet}&municipality={municipality}&municipalitySubdivision={municipalitySubdivision}&countryTertiarySubdivision={countryTertiarySubdivision}&countrySecondarySubdivision={countrySecondarySubdivision}&countrySubdivision={countrySubdivision}&postalCode={postalCode}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 值可以是 json 或 xml。 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
country
|
query | True |
string |
地址 ISO3166-1 国家/地区代码部分的 2 或 3 个字母。 例如美国。 |
country
|
query |
string |
结构化地址的国家/地区 |
|
country
|
query |
string |
地址的国家/地区细分部分 |
|
country
|
query |
string |
结构化地址的命名区域 |
|
cross
|
query |
string |
结构化地址的十字路口名称 |
|
entity
|
query |
指定对地理区域执行的筛选级别。 缩小对指定地域实体类型的搜索范围,例如仅返回市政当局。 生成的响应将包含地理 ID 以及匹配的实体类型。 如果以逗号分隔的列表的形式提供多个实体,终结点将返回“可用最小实体”。 返回的几何图形 ID 可用于通过 Get 搜索 Polygon API 获取该地理位置的几何图形。 设置 entityType 时,将忽略以下参数:
|
||
extended
|
query |
结果中应包含扩展邮政编码的索引。 可用索引包括: Addr = 地址范围 地理位置 = 地理位置 PAD = 点地址 POI = 兴趣点 Str = 街道 XStr = 十字路口 (十字路口) 值应为以逗号分隔的索引类型列表, (以任何顺序) 或 None (对于无索引)。 默认情况下,除 Geo 之外的所有索引都包含扩展邮政编码。 地理位置的扩展邮政编码列表可能很长,因此必须在需要时显式请求它们。 用法示例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性取决于区域。 |
||
language
|
query |
string |
返回搜索结果时应采用的语言。 应是受支持的 IETF 语言标记之一,不区分大小写。 当指定语言的数据不适用于特定字段时,将使用默认语言。 有关详细信息,请参阅 支持的语言 。 |
|
limit
|
query |
integer |
将返回的最大响应数。 默认值:10,最小值:1,最大值:100 |
|
municipality
|
query |
string |
地址的市政当局部分 |
|
municipality
|
query |
string |
城市细分 (结构化地址的子/超级城市) |
|
ofs
|
query |
integer |
完整结果集中返回结果的起始偏移量。 默认值:0 |
|
postal
|
query |
string |
地址的邮政编码部分 |
|
street
|
query |
string |
地址的街道名称部分 |
|
street
|
query |
string |
地址的街道号部分 |
|
view
|
query |
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 |
确定 |
|
Other Status Codes |
发生了意外错误。 |
安全性
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
示例
Search address in Redmond, WA in structured form
示例请求
GET https://atlas.microsoft.com/search/address/structured/json?api-version=1.0&countryCode=US&streetNumber=15127&streetName=NE%2024th%20Street&municipality=Redmond&postalCode=98052
示例响应
{
"summary": {
"query": "15127 98052 ne redmond wa",
"queryType": "NON_NEAR",
"queryTime": 57,
"numResults": 1,
"offset": 0,
"totalResults": 34,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.30129317913035,
"lon": -120.88247999999997
}
},
"results": [
{
"type": "Point Address",
"id": "US/PAD/p0/37974392",
"score": 8.074,
"dist": 101274.64693865852,
"address": {
"streetNumber": "15127",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525544",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "15127 NE 24th St, Redmond, WA 98052",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6308,
"lon": -122.1385
},
"viewport": {
"topLeftPoint": {
"lat": 47.6317,
"lon": -122.13983
},
"btmRightPoint": {
"lat": 47.6299,
"lon": -122.13717
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6315,
"lon": -122.13852
}
}
]
}
]
}
定义
名称 | 说明 |
---|---|
Address |
结果的地址 |
Address |
描述街道两侧的搜索结果的地址范围。 包括地址范围的开始和结束位置的坐标。 |
Bounding |
涵盖视区左上角和右下角坐标表示的结果的视区。 |
Bounding |
位置的边界框。 |
Brand |
与 POI 关联的品牌 |
Classification |
要返回的 POI 的分类 |
Classification |
分类的名称 |
Data |
可选节。 用于 Get 搜索 Polygon API 的引用 ID。 |
Entity |
边界框的实体类型源。 对于反向地理编码,这始终等于位置。 |
Entry |
要返回的 POI 的入口点。 |
Entry |
入口点的类型。 值可以是main或次要值。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Geographic |
Geography 实体类型。 仅在请求 entityType 且可用时显示。 |
Geometry |
有关结果的几何形状的信息。 仅当类型 == Geography 时才存在。 |
Lat |
使用短名称“lat”&“lon”表示为纬度和经度的位置。 |
Localized |
View 参数 (也称为“用户区域”参数) 允许你为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图,并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下,View 参数设置为“Unified”,即使尚未在请求中定义它。 由你负责确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用的法律,包括与地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区相关的法律。 示例:view=IN。 有关详细信息和可用的 视图 ,请参阅支持的视图。 |
Match |
反向地址搜索操作的匹配类型。 |
Operating |
POI (兴趣点) 的营业时间。 |
Operating |
表示日期和时间 |
Operating |
一天的开放时间范围 |
Point |
返回的 POI 的详细信息,包括姓名、电话、URL 地址和分类等信息。 |
Point |
POI 类别 |
Query |
返回的查询类型:“附近”或“NON_NEAR”。 |
Response |
响应的所需格式。 值可以是 json 或 xml。 |
Search |
此对象从成功的搜索调用中返回。 |
Search |
搜索 API 响应的结果对象。 |
Search |
下列其中一项:
|
Search |
结果中应包含扩展邮政编码的索引。 可用索引包括: Addr = 地址范围 地理位置 = 地理位置 PAD = 点地址 POI = 兴趣点 Str = 街道 XStr = 十字路口 (十字路口) 值应为以逗号分隔的索引类型列表, (以任何顺序) 或 None (对于无索引)。 默认情况下,除 Geo 之外的所有索引都包含扩展邮政编码。 地理位置的扩展邮政编码列表可能很长,因此必须在需要时显式请求它们。 用法示例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性取决于区域。 |
Search |
搜索 API 响应的摘要对象。 |
Address
结果的地址
名称 | 类型 | 说明 |
---|---|---|
boundingBox |
位置的边界框。 |
|
buildingNumber |
string |
街上的建筑号。 已弃用,请改用 streetNumber。 |
country |
string |
国家/地区名称 |
countryCode |
string |
国家/地区 (注意:这是一个双字母代码,而不是国家/地区名称。) |
countryCodeISO3 |
string |
ISO alpha-3 国家/地区代码 |
countrySecondarySubdivision |
string |
县 |
countrySubdivision |
string |
省/市/自治区 |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
国家/地区管理层次结构的第一个级别的全名。 仅当 countrySubdivision 以缩写形式显示时,才会显示此字段。 仅支持美国、加拿大和英国。 |
countryTertiarySubdivision |
string |
命名区域 |
crossStreet |
string |
要交叉的街道的名称。 |
extendedPostalCode |
string |
扩展邮政编码 (可用性取决于区域) 。 |
freeformAddress |
string |
根据结果所在国家/地区/地区的格式规则设置格式的地址行,如果是国家/地区,则为完整的国家/地区名称。 |
localName |
string |
一个地址组件,表示地理区域或位置的名称,该地理区域或位置将多个可寻址对象分组用于寻址目的,而不作为管理单元。 此字段用于生成 |
municipality |
string |
市/镇 |
municipalitySubdivision |
string |
Sub/Super City |
neighbourhood |
string |
邻里是城市或城镇内的地理局部区域,具有鲜明的特点和居民之间的社会互动。 |
postalCode |
string |
邮政编码/邮政编码 |
routeNumbers |
string[] |
用于明确标识街道的代码 |
street |
string |
街道名称。 已弃用,请改用 streetName。 |
streetName |
string |
街道名称。 |
streetNameAndNumber |
string |
街道名称和编号。 |
streetNumber |
string |
街上的建筑号。 |
AddressRanges
描述街道两侧的搜索结果的地址范围。 包括地址范围的开始和结束位置的坐标。
名称 | 类型 | 说明 |
---|---|---|
from |
使用短名称“lat”&“lon”表示为纬度和经度的位置。 |
|
rangeLeft |
string |
街道左侧的地址范围。 |
rangeRight |
string |
街道右侧的地址范围。 |
to |
使用短名称“lat”&“lon”表示为纬度和经度的位置。 |
BoundingBox
涵盖视区左上角和右下角坐标表示的结果的视区。
名称 | 类型 | 说明 |
---|---|---|
btmRightPoint |
使用短名称“lat”&“lon”表示为纬度和经度的位置。 |
|
topLeftPoint |
使用短名称“lat”&“lon”表示为纬度和经度的位置。 |
BoundingBoxCompassNotation
位置的边界框。
名称 | 类型 | 说明 |
---|---|---|
entity |
边界框的实体类型源。 对于反向地理编码,这始终等于位置。 |
|
northEast |
string |
以逗号分隔浮点分隔的边界框的东北纬度、经度坐标 |
southWest |
string |
以逗号分隔的浮点为边界框的西南纬度、经度坐标 |
Brand
与 POI 关联的品牌
名称 | 类型 | 说明 |
---|---|---|
name |
string |
品牌名称 |
Classification
要返回的 POI 的分类
名称 | 类型 | 说明 |
---|---|---|
code |
string |
Code 属性 |
names |
名称数组 |
ClassificationName
分类的名称
名称 | 类型 | 说明 |
---|---|---|
name |
string |
Name 属性 |
nameLocale |
string |
名称区域设置属性 |
DataSources
可选节。 用于 Get 搜索 Polygon API 的引用 ID。
名称 | 类型 | 说明 |
---|---|---|
geometry |
有关结果的几何形状的信息。 仅当类型 == Geography 时才存在。 |
Entity
边界框的实体类型源。 对于反向地理编码,这始终等于位置。
名称 | 类型 | 说明 |
---|---|---|
position |
string |
位置实体 |
EntryPoint
要返回的 POI 的入口点。
名称 | 类型 | 说明 |
---|---|---|
position |
使用短名称“lat”&“lon”表示为纬度和经度的位置。 |
|
type |
入口点的类型。 值可以是main或次要值。 |
EntryPointType
入口点的类型。 值可以是main或次要值。
名称 | 类型 | 说明 |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
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 |
未来 7 天的时间范围列表 |
OperatingHoursTime
表示日期和时间
名称 | 类型 | 说明 |
---|---|---|
date |
string |
表示 POI 时区的当前日历日期,例如“2019-02-07”。 |
hour |
integer |
小时采用 POI 本地时间的 24 小时格式;可能的值为 0 - 23。 |
minute |
integer |
分钟以 POI 的本地时间表示;可能的值为 0 - 59。 |
OperatingHoursTimeRange
一天的开放时间范围
名称 | 类型 | 说明 |
---|---|---|
endTime |
给定 POI 关闭时在接下来的 7 天内的点;如果给定 POI 在范围之前关闭,则为范围的开始点。 |
|
startTime |
打开给定 POI 时在接下来的 7 天内的点;如果该范围在范围之前打开,则为范围的开头。 |
PointOfInterest
返回的 POI 的详细信息,包括姓名、电话、URL 地址和分类等信息。
名称 | 类型 | 说明 |
---|---|---|
brands |
Brand[] |
品牌数组。 返回的 POI 的品牌名称。 |
categories |
string[] |
Categories 数组 |
categorySet |
最具体的 POI 类别列表 |
|
classifications |
分类数组 |
|
name |
string |
POI 属性的名称 |
openingHours |
POI (兴趣点) 的营业时间。 |
|
phone |
string |
电话号码属性 |
url |
string |
网站 URL 属性 |
PointOfInterestCategorySet
POI 类别
名称 | 类型 | 说明 |
---|---|---|
id |
integer |
类别 ID |
QueryType
返回的查询类型:“附近”或“NON_NEAR”。
名称 | 类型 | 说明 |
---|---|---|
NEARBY |
string |
搜索是在具有定义半径的特定纬度和经度周围执行的 |
NON_NEAR |
string |
搜索是全局执行的,没有偏向于特定的纬度和经度,也没有定义的半径 |
ResponseFormat
响应的所需格式。 值可以是 json 或 xml。
名称 | 类型 | 说明 |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
此对象从成功的搜索调用中返回。
名称 | 类型 | 说明 |
---|---|---|
results |
搜索 API 结果的列表。 |
|
summary |
搜索 API 响应的摘要对象 |
SearchAddressResultItem
搜索 API 响应的结果对象。
名称 | 类型 | 说明 |
---|---|---|
address |
结果的地址 |
|
addressRanges |
描述搜索结果街道两侧的地址范围。 包括地址范围的开始和结束位置的坐标。 |
|
dataSources |
可选节。 用于获取搜索多边形 API 的引用几何 ID。 |
|
detourTime |
integer |
绕行时间(以秒为单位)。 仅对沿路由 API 的搜索调用返回。 |
dist |
number |
结果与地理偏差位置之间的直线距离(以米为单位)。 |
entityType |
Geography 实体类型。 仅在请求 entityType 且可用时显示。 |
|
entryPoints |
EntryPoint 数组。 这些说明该地点可用的入口类型。 对于前门或大厅等main入口,类型可以是“main”,对于侧门和后门,类型可以是“次要”。 |
|
id |
string |
Id 属性 |
info |
string |
有关 Result 的原始数据源的信息。 用于支持请求。 |
matchType |
有关匹配类型的信息。 下列其中一项:
|
|
poi |
返回的 POI 的详细信息,包括姓名、电话、URL 地址和分类等信息。 |
|
position |
使用短名称“lat”&“lon”表示为纬度和经度的位置。 |
|
score |
number |
结果集中的值,用于指示结果之间的相对匹配分数。 如果 x 的值是 y 值的 2 倍,则可以使用它来确定结果 x 与结果 y 相关的可能性是结果 y 的两倍。 这些值因查询而异,仅作为一个结果集的相对值。 |
type |
下列其中一项:
|
|
viewport |
覆盖视区左上坐标和右下坐标表示的结果的视区。 |
SearchAddressResultType
下列其中一项:
- POI
- 街道
- 地理位置
- 点地址
- 地址范围
- 十字路口
名称 | 类型 | 说明 |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchIndexes
结果中应包含扩展邮政编码的索引。
可用索引包括:
Addr = 地址范围
地理位置 = 地理位置
PAD = 点地址
POI = 兴趣点
Str = 街道
XStr = 十字路口 (十字路口)
值应为以逗号分隔的索引类型列表, (以任何顺序) 或 None (对于无索引)。
默认情况下,除 Geo 之外的所有索引都包含扩展邮政编码。 地理位置的扩展邮政编码列表可能很长,因此必须在需要时显式请求它们。
用法示例:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性取决于区域。
名称 | 类型 | 说明 |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
SearchSummary
搜索 API 响应的摘要对象。
名称 | 类型 | 说明 |
---|---|---|
fuzzyLevel |
integer |
提供结果所需的最大模糊级别。 |
geoBias |
指示内部搜索引擎应用地理空间偏差以提高结果排名。 在某些方法中,这可以通过设置 lat 和 lon 参数(如果可用)而受到影响。 在其他情况下,它纯粹是内部的。 |
|
limit |
integer |
将返回的最大响应数 |
numResults |
integer |
响应中的结果数。 |
offset |
integer |
完整结果集中返回的 Results 的起始偏移量。 |
query |
string |
用于生成这些搜索结果的查询参数。 |
queryTime |
integer |
解析查询所用的时间(以毫秒为单位)。 |
queryType |
返回的查询类型:NEARBY 或 NON_NEAR。 |
|
totalResults |
integer |
找到的结果总数。 |