正在跳转至目标页,请稍后…
概述
用于获取输入关键字的补完与提示,帮助用户快速输入。本接口为纯HTTP数据接口,需配合前端程序实现Autocomplete(自动完成)的效果。
Head |
---|
请求URL
该请求为GET请求
请求参数
名称 | 必填 | 说明 | 示例 |
---|---|---|---|
key | 是 | 开发密钥(Key) | key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-***** |
keyword | 是 | 用户输入的关键词(希望获取后续提示的关键词) | keyword=南方 |
范围限制条件 | |||
region | 否 | 限制城市范围:根据城市名称限制地域范围, 如,仅获取“广州市”范围内的提示内容; 缺省时则进行全国范围搜索; |
region=广州 |
region_fix | 否 | 0:[默认] 不限制当前城市,会召回其他城市的poi1:仅限制在当前城市 | region_fix=1 |
location | 否 | 定位坐标,传入后,若用户搜索关键词为类别词(如酒店、餐馆时),与此坐标距离近的地点将靠前显示,格式: location=lat,lng | location=39.11457,116.55332 |
get_subpois | 否 | 是否返回子地点,如大厦停车场、出入口等取值:0 [默认]不返回1 返回 | get_subpois=1 |
get_ad | 否 | 是否返回区划结果 0 [默认]不返回1 返回 | get_ad=1 |
policy | 否 | 检索策略,目前支持:policy=0:默认,常规策略policy=1:本策略主要用于收货地址、上门服务地址的填写,提高了小区类、商务楼宇、大学等分类的排序,过滤行政区、道路等分类(如海淀大街、朝阳区等),排序策略引入真实用户对输入提示的点击热度,使之更为符合此类应用场景,体验更为舒适policy=10:出行场景(网约车) – 起点查询policy=11:出行场景(网约车) – 终点查询 | policy=1 |
filter | 否 | 筛选条件:基本语法:columnName<筛选列>=value<列值>;目前支持按POI分类筛选(例:category=分类词),若指定多个分类用英文逗号分隔,最多支持五个分类,支持的分类词可参考:附录:腾讯地图POI分类关键词 | 搜索指定分类filter=category=公交站搜索多个分类filter=category=大学,中学(注意参数值要进行url编码) |
added_fields | 否 | 返回指定标准附加字段,取值支持: category_code - poi分类编码 |
added_fields=category_code |
address_format | 否 | 可选值:short返回“不带行政区划的”短地址 | address_format=short |
page_index | 否 | 页码,从1开始,最大页码需通过count进行计算,必须与page_size同时使用 | page_index=1 |
page_size | 否 | 每页条数,取值范围1-20,必须与page_index 同时使用 | page_size=10 |
output | 否 | 返回格式:支持JSON/JSONP,默认JSON | output=json |
callback | 否 | JSONP方式回调函数 | callback=function1 |
响应结果
名称 | 类型 | 必有 | 说明 | ||
---|---|---|---|---|---|
status | number | 是 | 状态码,0为正常,其它为异常,详细请参阅状态码说明 | ||
message | string | 是 | 状态说明 | ||
count | number | 是 | 结果总数(注:本服务一个查询条件最多返回100条结果) | ||
data | array | 是 | 提示词数组,每项为一个POI对象 | ||
id | string | 是 | POI唯一标识 | ||
title | string | 是 | 提示文字 | ||
address | string | 是 | 地址 | ||
category | string | 是 | POI(地点)分类 | ||
category_code | number | 否 | POI(地点)分类编码,设置added_fields=category_code时返回 | ||
type | number | 是 | POI类型,值说明:0:普通POI / 1:公交车站 / 2:地铁站 / 3:公交线路 / 4:行政区划 | ||
_distance | number | 否 | 传入location(定位坐标)参数时,返回定位坐标到各POI的距离 | ||
location | object | 是 | 提示所述位置坐标 | ||
lat | number | 是 | 纬度 | ||
lng | number | 是 | 经度 | ||
adcode | number | 是 | 行政区划代码 | ||
province | string | 是 | 省 | ||
city | string | 是 | 市 | ||
district | string | 是 | 区/县,当type(POI类型)为3(公交线路)时,district由city补全 | ||
sub_pois | array | 否 | 子地点列表,仅在输入参数get_subpois=1时返回 | ||
parent_id | string | 是 | 主地点ID,对应data中的地点ID | ||
id | string | 是 | 地点唯一标识 | ||
title | string | 是 | 地点名称 | ||
address | string | 是 | 地址 | ||
category | string | 是 | POI(地点)分类 | ||
location | object | 是 | 坐标 | ||
lat | number | 是 | 纬度 | ||
lng | number | 是 | 经度 | ||
adcode | number | 是 | 行政区划代码 | ||
city | string | 是 | 地点所在城市名称 |
调用示例
//GET请求示例,注意参数值要进行URL编码 https://apis.map.qq.com/ws/place/v1/suggestion/?region=北京&keyword=美食&key=[你的key]
在线测试
这篇文章对您解决问题是否有帮助?
已解决
未解决