产品服务
解决方案
文档与支持
定价
登录
地点输入提示
下载开发文档
接口说明

地点输入提示服务(又名Place Suggestion API)是一类Web API接口服务。

匹配用户输入内容,提供输入提示功能。常与地点检索服务搭配使用。也可作为轻量级地点检索服务单独使用(不支持复杂检索场景)。

用户可通过该服务,匹配用户输入关键词的地点推荐列表。

使用说明

在应用方面,可将地点推荐列表展示给用户,用户可通过点击等交互方式,结合地点检索服务,检索用户点击的POI信息,实现地点详情检索功能。

通过关键词和检索城市限制,可满足轻量级地点检索需求,获取地点基础数据。

API服务地址

https://api.map.baidu.com/place/v2/suggestion?query=天安门&region=北京&city_limit=true&output=json&ak=你的ak
//GET请求

请求参数
参数名称参数含义示例默认值字段类型必选
q(query)输入建议关键字(支持拼音)上地、天安、中关、shanghaistring(45)
region

支持城市及对应百度编码(Citycode)。(指定的区域的返回结果加权,可能返回其他城市高权重结果。若要对返回结果区域严格限制,请使用city_limit参数)

北京市、上海市等string(50)
ak开发者访问密钥,必选。E4805d16**********707cdc962045string(50)
city_limit取值为"true",仅返回region中指定城市检索结果'false'or'true'falsestring(50)
location传入location参数后,是综合各种相关性排序的,location参数只是其中一个因素,但不会严格按距离排序决定最终的排序40.047857537164,116.31353434477object
coord_type传入的坐标类型,可选参数,用于标注请求中「location」参数使用的坐标类型

坐标类型:
1(WGS84ll即GPS经纬度)
2(GCJ02ll即国测局经纬度坐标)
3(BD09ll即百度经纬度坐标)
4(BD09mc即百度米制坐标)
坐标详细说明

3int
ret_coordtype

返回的坐标类型,可选参数,添加后POI返回国测局经纬度坐标
若不传该参数,返回结果默认bd09ll(百度经纬度)

gcj02ll 坐标详细说明

string(50)
output返回数据格式,可选json、xml两种json、xmlxmlstring(50)
sn用户的权限签名

sn校验说明

string(50)
timestamp设置sn后该值必选string(50)
language

en

指定输入参数和召回参数的语言类型,可支持的语言类型为英文
注意:该功能为高级付费功能,您可提交工单咨询

string(50)
返回参数
返回参数类型备注
statusInt本次API访问状态,如果成功返回0,如果失败返回其他数字。(见服务状态码
messagestring对API访问状态值的英文说明,如果成功返回ok,并返回结果字段,如果失败返回错误说明。
result返回的结果
namestringpoi名称,单次请求最多返回10条结果
locationobjectpoi经纬度坐标
latfloat纬度值
lngfloat经度值
uidstringpoi的唯一标识,ID
provincestring所属省份
citystring所属城市
cityidint百度城市编码 详情见资源下载citycode编码
districtstring区县
adcodeint行政区划代码
businessstring商圈
tagstringpoi分类
addressstringpoi地址
childrenpoi子点
uidstringpoi子点ID,可用于poi详情检索
show_namestringpoi子点简称
namestringpoi子点名称
如您需要获取POI图片及POI营业状态,请点击获取POI图片获取POI营业状态
服务状态码
返回码英文描述定义常见原因
0ok正常服务请求正常召回
1服务器内部错误该服务响应超时或系统内部错误,请留下联系方式
2Parameter Invalid请求参数非法必要参数拼写错误或漏传(如query和tag请求中均未传入)
3Verify Failure权限校验失败
4Quota Failure配额校验失败服务当日调用次数已超限,请前往API控制台提升(请优先进行)开发者认证
5AK Failureak不存在或者非法未传入ak参数;ak已被删除(可前往回收站恢复);
8Parse Proto Failure数据解析失败一般是query输入有误导致,如query输入特殊字符,全角符号。
9Permission Denied高级权限校验失败
101AK参数不存在请求消息没有携带AK参数
200APP不存在,AK有误请检查再重试根据请求的ak,找不到对应的APP
201APP被用户自己禁用,请在控制台解禁
202APP被管理员删除恶意APP被管理员删除
203APP类型错误当前API控制台支持Server(类型1), Mobile(类型2, 新版控制台区分为Mobile_Android(类型21)及Mobile_IPhone(类型22))及Browser(类型3),除此之外其他类型认为是APP类型错误
210APP IP校验失败在申请SERVER类型应用的时候选择IP校验,需要填写IP白名单,如果当前请求的IP地址不在IP白名单或者不是0.0.0.0/0就认为IP校验失败
211APP SN校验失败SERVER类型APP有两种校验方式IP校验和SN校验,当用户请求的SN和服务端计算出来的SN不相等的时候提示SN校验失败
240APP 服务被禁用用户在API控制台中创建或设置某APP的时候禁用了某项服务,若需开通权限,可进入API控制台为AK勾选对应服务
250用户不存在根据请求的user_id, 数据库中找不到该用户的信息,请携带正确的user_id
251用户被自己删除该用户处于未激活状态
252用户被管理员删除恶意用户被加入黑名单
260服务不存在服务器解析不到用户请求的服务名称
261服务被禁用该服务已下线
302天配额超限,限制访问配额超限,如果想增加配额请联系我们
401当前并发量已经超过约定并发配额,限制访问并发控制超限,请控制并发量或联系我们

上一篇

地点详情检索

下一篇

获取POI图片

本篇文章对您是否有帮助?