云存储API - 使用指南 - 地点云

表（结构）查询接口

请求url

https://apis.map.qq.com/place_cloud/table/list // GET请求

请求参数(Get请求)

参数名	必填	备注	示例
table_id	否	表ID，表的唯一标识，缺省则返回所有有权访问的表信息（table_id在表创建后由系统自动生成，可在地点云数据管理台查询得到）	table_id=5d3581dc6ce89813ed0b2cbd
key	是	开发者key：您可在控制台Key管理界面自行创建，且需要开启WebServiceAPI功能 Key须具备对目标表的数据读取权限，权限在地点云数据管理台中进行设置	key=RO834-SSROY-R8TRQ-....
output	否	数据返回格式，支持：json和jsonp	output=jsonp
callback	否	指定 jsonp的回调函数名，必须与output=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，可参考：地址解析服务文档），未达到这一标准的结果将无法创建成功。

请求示例 响应结果（json格式）

修改数据（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须具备对目标表的写入权限，权限在地点云数据管理台中进行设置

请求示例
响应结果（json格式）

删除（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须具备对目标表的写入权限，权限在地点云数据管理台中进行设置

请求示例
响应结果（json格式）

数据列表（list）接口

本接口访问地点云存储中的数据，通过翻页可遍历全表数据，可用于显示数据列表或数据导出。
注：与地点云搜索不同，地点云搜索因生成索引需要一定耗时，刚刚存入的数据一般不会马上可搜索到，而本接口直接访问云存储内容，存入数据即时可见，但本接口不提供搜索与筛选条件。

请求URL

https://apis.map.qq.com/place_cloud/data/list // GET请求

请求参数(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	output=jsonp
callback	否	Jsonp回调函数名，与output=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 desc&page_index=1&page_size=20&key=开发Key