表(结构)查询接口
请求url
请求参数(Get请求)
参数 | 必填 | 备注 | 示例 |
---|---|---|---|
table_id | 否 | 表ID,表的唯一标识,缺省则返回所有有权访问的表信息(table_id在表创建后由系统自动生成,可在地点云数据管理台查询得到) | table_id=5d3581dc6ce89813ed0b2cbd |
key | 是 | 开发者key:您可在控制台Key管理界面自行创建,且需要开启WebServiceAPI功能Key须具备对目标表的数据读取权限,权限在地点云数据管理台中进行设置 | key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77 |
output | 否 | 返回格式:支持JSON/JSONP,默认JSON | output=json |
callback | 否 | JSONP方式回调函数 | callback=function1 |
响应结果(json格式)
// GET请求地址
https://apis.map.qq.com/place_cloud/table/list?key=开发者Key&table_id=5d3581dc6ce89813ed0b2cbd
//响应示例:
{
"status": 0, //状态码,0为成功,非0为请求失败
"message": "成功", //对请求结果的描述信息
"result": {
"tables": [ //查询到的有权访问的表及其结构
{
"create_time": 1563787740, //表创建时间
"data_count": 4, //表中数据量
"table_id": "5d3581dc6ce89813ed0b2cbd", //表ID(table_id)
"table_name": "营业网点", //表名
"unique_ud_id": 1, //启用ud_id唯一性约束
"update_time": 1563789253, //表修改时间
"x": { //自定义字段
"price": { //字段price的定义
"comment": "人均消费", //字段注释(用于备忘)
"create_time": 1563789253, //字段创建时间
"default": 0, //默认值
"is_index": 0, //是否为云搜索筛选排序字段(数值型)
"type": string, //字段类型为数值
"update_time": 1563789253 //字段更新时间
}
}
}
]
}
}
创建数据(create)接口
通过本接口,可向地点云指定数据表存入一条或多条数据
请求URL
https://apis.map.qq.com/place_cloud/data/create // POST请求 // 请求头:content-type:application/json
请求参数(Post请求)
参数名 | 类型 | 必填 | 备注 |
---|---|---|---|
data | array | 必 | 每个数组项为一条数据(最多可一次请求创建20条),参见 数据(字段)定义 |
table_id | string | 必 | 表id,即表的唯一标识(table_id在表创建后由系统自动生成,可在地点云数据管理台查询得到) |
key | string | 必 | 开发者key:您可在控制台Key管理界面自行创建,且需要开启WebServiceAPI功能Key须具备对目标表的数据读取权限,权限在地点云数据管理台中进行设置 |
缺失坐标时通过地址(address)自动计算:
地点云数据中location(坐标)为必填字段,但当您的数据只有地址(address)而无location(坐标)时,服务会调用地址解析服务通过address计算坐标,为保证坐标尽可能准确,结果会取可信度与精度较高的结果(reliabylity>=7且level>=9,可参考:地址解析服务文档),未达到这一标准的结果将无法创建成功。
请求示例
// POST请求地址
https://apis.map.qq.com/place_cloud/data/create
// 请求头:content-type:application/json
//Post方法提交数据
{
"key":"开发者Key",
"table_id":"5d3581dc6ce89813ed0b2cbd",
"data":[
{//第1条数据
"ud_id":"156985",
"title":"海淀区苏州街营业部",
"location":{
"lat":39.983988,
"lng":116.307709
},
"x":{
"price":-1 //自定义字段值
}
},
{//第2条数据
"ud_id":"156966",
"title":"海淀区黄庄营业部",
"address":"北京市海淀区海淀南路24号院",
//数据中无坐标信息,系统将根据address自动解析坐标
"x":{
"price":15.6
}
}
//最多可一次创建20条数据,以下省略...
]
}
响应结果(json格式)
{
"status": 0, //状态码,0为请求成功,非常为错误
"message": "成功", //请求结果信息
"result": {
"count": 1, //创建成功的数据条数
"failure": [ //创建失败的数据信息(您可根据其错误信息进行更正)
{
"message": "自定义字段不存在或类型不匹配: price", //创建该条数据时产生的错误信息
"row_idx": 2, //该条数据在data数组中的下标位置(从0开始)
"status": 306, //错误码
"ud_id": "156966" //自定义id
}
],
"success": [ //创建成功的数据
{
"id": "5d3770b96ce89813ed5055be", //数据创建成功,返回系统生成的唯一标识(id)
"row_idx": 0, //该条数据在data数组中的下标位置(从0开始)
"ud_id": "156985" //自定义id
}
]
}
}
修改数据(update)接口
通过本接口,可对指定单条数据进行修改,也可对一组id或ud_id的数据统一修改指定字段值。
请求URL
https://apis.map.qq.com/place_cloud/data/update // POST请求 // 请求头:content-type:application/json
请求参数(Post请求)
参数名 | 类型 | 必填 | 备注 |
---|---|---|---|
data | object | 必 | 要改成的新值 ,data对象,一次可修改多个字段。结构可参见 数据(字段)定义 |
filter | string | 必 | 修改条件,目前最多一次修改20条1.目前仅只支持filter=id in(“id_string1”,“id_string2”,“id_string3”) 条件表达式2.当表ud_id启用唯一性约束后,可使用filter=ud_id in(“aaa”,“bbb”) 条件更新数据(id与ud_id为字符型字段,注意加"") |
table_id | string | 必 | 表id,即表的唯一标识(table_id在表创建后由系统自动生成,可在地点云数据管理台查询得到) |
key | string | 必 | 开发者key:您可在控制台Key管理界面自行创建,且需要开启WebServiceAPI功能Key须具备对目标表的数据读取权限,权限在地点云数据管理台中进行设置 |
请求示例
// POST请求地址
https://apis.map.qq.com/place_cloud/data/update
// 请求头:content-type:application/json
//Post body
{
"key":"开发Key",
"table_id":"5d3581dc6ce89813ed0b2cbd",
"data": {
"tel" :"010-63258661", //修改系统字段tel(电话)值
"x":{
"price":15.6 //修改自定义字段值
}
},
"filter": "ud_id in(\"100225\",\"100665\",\"P643F\")" //指定修改条件
}
响应结果(json格式)
{
"status": 0, //状态码,0代表成功,非0为失败
"message": "成功", //对status值的描述
"result": {
"count": 2 //本次请求被修改的数据条数
}
}
删除(delete)接口
通过本接口,可一次删除多条(一组id或ud_id的)数据,使用时请谨慎。
请求URL
https://apis.map.qq.com/place_cloud/data/delete // POST请求 // 请求头:content-type:application/json
请求参数(Post请求)
参数名 | 类型 | 必填 | 备注 |
---|---|---|---|
filter | string | 必 | 修改条件,目前最多一次修改20条1.目前仅只支持filter=id in(“id_string1”,“id_string2”,“id_string3”) 条件表达式2.当表ud_id启用唯一性约束后,可使用filter=ud_id in(“aaa”,“bbb”) 条件更新数据(id与ud_id为字符型字段,注意加"") |
table_id | string | 必 | 表id,即表的唯一标识(table_id在表创建后由系统自动生成,可在地点云数据管理台查询得到) |
key | string | 必 | 开发者key:您可在控制台Key管理界面自行创建,且需要开启WebServiceAPI功能Key须具备对目标表的数据读取权限,权限在地点云数据管理台中进行设置 |
请求示例
// POST请求地址
https://apis.map.qq.com/place_cloud/data/delete
// 请求头:content-type:application/json
//Postbody
{
"table_id": "5d3581dc6ce89813ed0b2cbd",
"key": "开发者key",
"filter": "id=\"5d7241bcbbad30656344ff03\""
}
响应结果(json格式)
{
"status": 0, //状态码,0代表成功,非0为失败
"message": "成功", //对status值的描述
"result": {
"count": 1 //本次请求被修改的数据条数
}
}
数据列表(list)接口
本接口访问地点云存储中的数据,通过翻页可遍历全表数据,可用于显示数据列表 或 数据导出。
注:与地点云搜索不同,地点云搜索因生成索引需要一定耗时,刚刚存入的数据一般不会马上可搜索到,而本接口直接访问云存储内容,存入数据即时可见,但本接口不提供搜索与筛选条件。
请求URL
请求参数(GET请求)
参数名 | 必填 | 说明 | 示例 |
---|---|---|---|
table_id | 是 | 表id,即表的唯一标识(table_id在表创建后由系统自动生成,可在地点云数据管理台查询得到) | table_id=5d3581dc6ce89813ed0b2cbd |
fields | 否 | 指定返回字段:返回文本数据大小对性能影响较大,建议只获取需要的字段 | fields=title,address,location,x.abc |
orderby | 否 | 设置排序规则,支持按id排序(因id与创建时间相关,可等同于按创建时间排序):升序:orderby=id降序:orderby=id desc(最新创建靠前) | orderby=id desc |
page_size | 否 | 每页条目数,最大值<=200,默认返回10条 | page_size=10 |
page_index | 否 | 第x页,默认第1页 | page_index=2 |
key | 是 | 开发者key:您可在控制台Key管理界面自行创建,且需要开启WebServiceAPI功能Key须具备对目标表的数据读取权限,权限在地点云数据管理台中进行设置 | key=EITBZ-OPYAV-*** |
output | 否 | 返回格式:支持JSON/JSONP,默认JSON | output=json |
callback | 否 | JSONP方式回调函数 | callback=function1 |
响应结果(json格式)
参数名 | 类型 | 说明 | |
---|---|---|---|
status | number | 状态码,0代表成功,非0为请求失败 | |
message | string | 对status的描述。 | |
result | object | ||
count | number | 查询结果总条数,可用于计算分页数 | |
data | array | 结果数据 |
调用示例:
// 请求示例(GET方法) https://apis.map.qq.com/place_cloud/data/list?table_id=5d3581dc6ce89813ed0b2cbd&orderby=id&page_index=1&page_size=20&key=开发Key
//响应示例:
{
"status": 0,
"message": "成功",
"result": {
"count": 3, //查询结果总条数,可用于计算分页数
"data": [
{
"adcode": 110108,
"address": "北京市海淀区北四环西路66号",
"city": "北京市",
"create_time": 1563914425,
"district": "海淀区",
"id": "5d3770b96ce89813ed5055be",
"location": {
"lat": 39.983988,
"lng": 116.307709
},
"polygon": "",
"province": "北京市",
"tel": "",
"title": "海淀区苏州街营业部",
"ud_id": "156985",
"update_time": 1563914425,
"x": {
"price": "no price"
}
},
//其它内容省略...
]
}
}