地图纬度自定义字段最后更新时间: 2023年09月20日

产品简介

地点资源支持管理员配置自定义字段，用于满足客户的个性化需求。

使用限制

详细的服务调用量限制可点我查阅。

使用说明

接收请求返回的数据（JSON或XML格式），参考返回参数文档解析数据。

如无特殊声明，接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。

功能使用说明

在地图内使用自定义字段，分为如下几步
1. 在地图内创建需要使用的字段（批量新增自定义字段接口）
2. 在地图内创建字段分组（自定义字段分组新增接口）
3. 查询地图内已创建的自定义字段（分页查询自定义字段接口）
4. 『创建点资源』或者『修改点资源』时，传入自定义字段分组id（dimensionId）及自定义字段相应的key-vlaue 值

1. 批量新增自定义字段

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/component/batch/create
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

特别注意：请求格式表单

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个企业一个token	string	是	无
openId	当前操作人加密串	必须是地图管理员或超管	string	是	无
workMapId	工作地图id	使用加密后的数据	string	是	无
bizSign	业务签名	签名参数：workMapId, dimensionType（参考签名规则）	string	是	无
dimensionType	新增自定义字段的功能类型	取值说明: 见附件	number	是	无
componentCreate	自定义字段信息（String）	示例： {"componentList":[{"componentType":1,"viewText":"测试下","optionList":["单选1","单选2","单选3"]}]}	string	是	无

componentCreate 说明：

componentList		自定义字段列表(JSONArray)	array	一批最多10条
	componentType	自定义字段控件类型	number	取值说明见附件，必填。
	optionList	单选和多选类型的选择项。格式： [{"id":"2","name":"单选2","allowRemark":1}] 其中，allowRemark为1表示『允许填写备注』，id字段是workMapId纬度唯一的数字编码，调用方自己生成。	array	单选和多选类型字段必填
	viewText	字段名	string	必填
	attributeList	示例： [ { "code": "1", // code为1对应高德APP地图小程序里新增字段时的『必须填写』选项 "value": "1表示必填; 0非必填。默认为0" }, { "code": "4", // code为4表示『可拍照添加图片』，只有图片类型的字段才有意义 "value": "true或false，默认为true" }, { "code": "5", // code为5表示『可相册上传图片』，只有图片类型的字段才有意义 "value": "true或false，默认为true" }, { "code": "6", // code为5表示『最少添加数量』，只有图片类型的字段才有意义 "value": "1到9之间，图片类型必填的时候默认值为1" } ]	List<Map<string, string>>	非必填

示例代码（以java为例）

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "http://restwia.amap.com/api/v1/wia/dimension/component/batch/create";
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String workMapId ="要操作的工作地图id";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    Integer dimensionType = 1;
    Map<String, Object> requestParams = new HashMap<>();
    requestParams.put("key", key);
    requestParams.put("openId", openId);
    requestParams.put("workMapId", workMapId);
    requestParams.put("bizToken", bizToken);
    String[] signArgs = new String[]{workMapId,dimensionType.toString()};
    requestParams.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    Map<String, Object> postParams = new HashMap<>();
    postParams.put("dimensionType", dimensionType);
    postParams.put("componentCreate", "{\"componentList\":[{\"viewText\":\"自定义拜访时间\",\"componentType\":4},{\"optionList\":[\"少年\",\"青年\",\"中年\",\"老年\"],\"viewText\":\"自定义多选客群\",\"componentType\":3},{\"optionList\":[\"男\",\"女\",\"保密\"],\"viewText\":\"自定义性别单选\",\"componentType\":2},{\"viewText\":\"自定义文本框1\",\"componentType\":1}]}");
    url = MyHttpUtils.attachParamsToUrl(url, requestParams);
    String response = MyHttpUtils.postFormUrlencoded(url, postParams);
    System.out.println(response);
}

返回参数

返回字段			含义	参数类型	规则说明
data			数据体	object
	componentList		生成的自定义字段信息列表(JSONArray)	array
		componentId	新增自定义字段的控件id	string
		itemIdList	新增自定义字段的控件itemId集合	array
		componentType	新增自定义字段的控件类型	number
code			返回结果编码	number	0表示成功
message			返回状态说明	string	成功时返回OK，否则返回错误原因
timestamp			时间戳	number	时间戳

返回结果示例

{
	"data": {
		"componentList": [{
			"componentId": "326002010001027",
			"componentType": 1,
			"itemIdList": ["426002011504027"]
		}, {
			"componentId": "326000001560027",
			"componentType": 2,
			"itemIdList": ["4260010001506027"]
		}, {
			"componentId": "3202010001562",
			"componentType": 3,
			"itemIdList": ["4260020100006029"]
		}, {
			"componentId": "3600210056030",
			"componentType": 4,
			"itemIdList": ["460020101500"]
		}]
	},
	"code": 1,
	"message": "Successful",
	"result": true,
	"version": "1.0",
	"timestamp": 1693213834699,
	"requestId": "1eb433b1693218866104d3ef2"
}

2. 批量修改自定义字段

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/component/batch/update
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

特别注意：请求格式表单

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个企业一个token	string	是	无
workMapId	工作地图id	使用加密之后的数据	string	是	无
openId	当前操作人加密串	必须是地图管理员或超管	string	是	无
bizSign	业务签名	签名参数：workMapId, dimensionType（参考签名规则）	string	是	无
dimensionType	修改自定义字段的功能类型	取值说明: 见附件	number	是	无
componentUpdate	自定义字段信息（String）	示例： { "componentList": [ { "componentId": "322206010000668003", "itemList": [ { "itemId": "422206010000636003", "viewText": "单选测试55", "optionList": [ { "id": "176349772722668", "name": "单选1" }, { "id": "176349772767741", "name": "单选2", "allowRemark": 1 } ], "attributeList": [ { "code": "1", "value": "1" } ] } ] } ] }	string	是	无

componentUpdate 说明：

componentList

自定义字段列表(JSONArray)

array

一批最多10条

必填

componentId

自定义字段控件id

string

必填

itemList

字段值

其中，optionList、attributeList、viewText字段的含义请参考『批量新增自定义字段』接口。

array

示例：

[

{

"itemId": "422206010000636003",

"viewText": "单选测试55",

"optionList": [

{

"id": "176349772722668",

"name": "单选1"

{

"id": "176349772767741",

"name": "单选2",

"allowRemark": 1

}

"attributeList": [

{

"code": "1",

"value": "1"

}

]

}

]

必填

返回参数

返回字段		含义	参数类型	规则说明
data		数据体	object
	result	true/fasle	boolean	true代表修改成功

code		返回结果编码	number	0表示成功
message		返回状态说明	string	成功时返回OK，否则返回错误原因
timestamp		时间戳	number	时间戳

3. 批量删除自定义字段

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/component/batch/delete
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

特别注意：请求格式 from-data

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个企业一个token	string	是	无
workMapId	工作地图id		string	是	无
openId	当前操作人加密串	必须是地图管理员或超管	string	是	无
bizSign	业务签名	签名参数：workMapId, dimensionType（参考签名规则）	string	是	无
dimensionType	修改自定义字段的功能类型	取值说明: 见附件	number	是	无
componentList	自定义字段列表	半角逗号分隔，一批最多10条	string	是	无

返回参数

返回字段		含义	参数类型	规则说明
data		数据体	object
	result	true/fasle	boolean	true代表删除成功

code		返回结果编码	number	0表示成功
message		返回状态说明	string	成功时返回OK，否则返回错误原因
timestamp		时间戳	number	时间戳

4. 分页查询自定义字段

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/component/page/query
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个企业一个token	string	是	无
workMapId	工作地图id		striing	是	无
openId	当前操作人加密串	必须是地图成员	string	是	无
bizSign	业务签名	签名参数：workMapId, dimensionType（参考签名规则）	string	是	无
dimensionType	修改自定义字段的功能类型	取值说明: 见附件	number	是	无
pageNum	页数	从1开始	number	是	无
pageSize	每页大小	每页最多10条	number	是	默认10条

示例代码（以java为例）

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "http://restwia.amap.com/api/v1/wia/dimension/component/page/query";
    Map<String, Object> params = new HashMap<>();
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String workMapId ="要操作的工作地图id";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    Integer dimensionType = 1;
    params.put("key", key);
    params.put("openId", openId);
    params.put("workMapId", workMapId);
    params.put("dimensionType", dimensionType);
    params.put("pageNum", 1);
    params.put("pageSize", 10);
    params.put("bizToken", bizToken);
    String[] signArgs = new String[]{workMapId,dimensionType.toString()};
    params.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    url = MyHttpUtils.attachParamsToUrl(url, params);
    String response = MyHttpUtils.postFormUrlencoded(url, null);
    System.out.println(response);
}

返回参数

返回字段			含义	参数类型	规则说明
data			数据体	object
	componentList		自定义字段列表（JSONArray）	array

		componentId	自定义字段控件id	string
		optionList	可选项	string	举例: JSON 字符串 [ { "allowRemark":0, "id":"1658219060893", "name":"t" }, { "allowRemark":0, "id":"1658219061945", "name":"123" } ]
		viewText	字段名	string
		itemIds	自定义信息	array	[ "1658219060893", "1658219060893" ]
		attributeList	属性数组，具体含义参考『批量新增自定义字段』接口	array	[ { "code": "1", "value": "1" } ]
		componentType	字段类型	number
	currentPageNum		当前页数	number
code			返回结果编码	number	1表示成功
message			返回状态说明	string	成功时返回OK，否则返回错误原因
timestamp			时间戳	number	时间戳

5、自定义字段指定id批量查询

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/component/listById
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
openId	高德开放用户id	必须是地图成员	string	是	无
workMapId	地图id		string	是	无
itemIds	字段id	半角逗号分隔，『批量新增自定义字段』接口返回的itemIdList字段里的值（即『自定义字段的控件itemId』）	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个组织一个token	string	是	无
bizSign	业务签名	签名参数：workMapId, openId（参考签名规则）	string	是	无

返回参数

返回字段	含义	规则说明
code	返回结果编码	1 表示成功
message	返回状态说明	成功时返回Successful，否则返回错误原因
version	版本号	字符串类型
timestamp	时间戳	Unix 时间戳，参考文档：《Unix 时间戳》
requestId	requestId是RPC链路的全局唯一标识，排查问题时需要提供	字符串格式，长度30
data	示例如下： [ { "componentId": "320020010001530001", // 自定义字段的控件id "itemIds": [ "420020010001476001" // 自定义字段的控件itemId ], "optionList": "[]", "viewText": "单选字段11", // 自定义字段的字段名称 "componentType": 2, // 自定义字段控件类型，含义请见附件。 "attributeList": [] } ] optionList、attributeList字段格式及含义参考『批量新增自定义字段』接口

附表

0、异常

1、成功

2、失败

3、参数错误

1001、权限不足：『不是地图成员』

1003、工作地图不存在

1005、工作地图已删除

6. 自定义字段分组新增

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/dimension/create
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
openId	高德开放用户id	必须是地图管理员或超管	string	是	无
workMapId	地图id		string	是	无
dimensionType	自定义字段的功能类型	取值见附件。	Integer	是	无
name	自定义字段分组的名称	长度最长40	string	是	无
componentIds	自定义字段的id	『批量新增自定义字段』接口返回的componentId字段的值（即『自定义字段的控件id』），半角逗号分隔，最多50个	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个组织一个token	string	是	无
bizSign	业务签名	签名参数：workMapId, openId（参考签名规则）	string	是	无

返回参数

返回字段	含义	规则说明
code	返回结果编码	1 表示成功
message	返回状态说明	成功时返回Successful，否则返回错误原因
version	版本号	字符串类型
timestamp	时间戳	Unix 时间戳，参考文档：《Unix 时间戳》
requestId	requestId是RPC链路的全局唯一标识，排查问题时需要提供	字符串格式，长度30
data	示例如下： { "dimensionId": "自定义字段分组id" }

附表

0、异常

1、成功

2、失败，或componentIds对应的字段全部都已删除或不存在

3、参数错误

1001、权限不足：『不是地图管理员』

1003、工作地图不存在

1005、工作地图已删除

140009、名称重复

140010、同『自定义字段的功能类型』的字段分组数量已超限（目前线上是300个）

7. 自定义字段分组修改

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/dimension/modify
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
openId	高德开放用户id	必须是地图管理员或超管	string	是	无
workMapId	地图id		string	是	无
dimensionId	自定义字段分组id	『自定义字段分组新增』接口返回的	string	是	无
name	自定义字段分组的名称	长度最长40	string	是	无
componentIds	自定义字段的id	『批量新增自定义字段』接口返回的componentId字段的值（即『自定义字段的控件id』），半角逗号分隔，最多50个	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个组织一个token	string	是	无
bizSign	业务签名	签名参数：workMapId, openId（参考签名规则）	string	是	无

返回参数

返回字段	含义	规则说明
code	返回结果编码	1 表示成功
message	返回状态说明	成功时返回Successful，否则返回错误原因
version	版本号	字符串类型
timestamp	时间戳	Unix 时间戳，参考文档：《Unix 时间戳》
requestId	requestId是RPC链路的全局唯一标识，排查问题时需要提供	字符串格式，长度30
data	示例如下： { "dimensionId": "自定义字段分组id" }

附表

0、异常

1、成功

2、失败

3、参数错误，或componentIds中存在已删除的自定义字段id，或dimensionId指定的分组id不存在或已删除

1001、权限不足：『不是地图管理员』

1003、工作地图不存在

1005、工作地图已删除

140009、名称重复

8. 自定义字段分组删除

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/dimension/delete
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
openId	高德开放用户id	必须是地图管理员或超管	string	是	无
workMapId	地图id		string	是	无
dimensionId	自定义字段分组id	『自定义字段分组新增』接口返回的	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个组织一个token	string	是	无
bizSign	业务签名	签名参数：workMapId, openId（参考签名规则）	string	是	无

返回参数

返回字段	含义	规则说明
code	返回结果编码	1 表示成功
message	返回状态说明	成功时返回Successful，否则返回错误原因
version	版本号	字符串类型
timestamp	时间戳	Unix 时间戳，参考文档：《Unix 时间戳》
requestId	requestId是RPC链路的全局唯一标识，排查问题时需要提供	字符串格式，长度30

附表

0、异常

1、成功

2、失败

3、参数错误，或dimensionId指定的分组id不存在

1001、权限不足：『不是地图管理员』

1003、工作地图不存在

1005、工作地图已删除

9. 指定id批量查询自定义字段分组

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/dimension/listById
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
openId	高德开放用户id	必须是地图成员	string	是	无
workMapId	地图id		string	是	无
dimensionIds	自定义字段分组id	『自定义字段分组新增』接口返回的分组id，半角逗号分隔，最多10个	string	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个组织一个token	string	是	无
bizSign	业务签名	签名参数：workMapId, openId（参考签名规则）	string	是	无

返回参数

返回字段	含义	规则说明
code	返回结果编码	1 表示成功
message	返回状态说明	成功时返回Successful，否则返回错误原因
version	版本号	字符串类型
timestamp	时间戳	Unix 时间戳，参考文档：《Unix 时间戳》
requestId	requestId是RPC链路的全局唯一标识，排查问题时需要提供	字符串格式，长度30
data	示例如下： { "dimensions": [ { "dimensionId": "自定义字段分组id", "dimensionType": 1, // 自定义字段的功能类型，含义见附件。 "name": "字段分组名称", "items": [ // 含义见『自定义字段指定id批量查询』接口返回的data字段的示例说明 ] } ] }

附表

0、异常

1、成功

2、失败

3、参数错误

1001、权限不足：『不是地图成员』

1003、工作地图不存在

1005、工作地图已删除

10. 分页查询自定义字段分组

请求地址

URL	http://restwia.amap.com/api/v1/wia/dimension/dimension/page/query
请求方式	POST
请求类型ContenType	application/x-www-form-urlencoded

请求参数

参数名	含义	规则说明	参数类型	是否必填	缺省值
key	请求服务权限标识	用户在高德地图官网申请Web服务API类型KEY	string	是	无
openId	高德开放用户id	必须是地图成员	string	是	无
workMapId	地图id		string	是	无
dimensionType	自定义字段的功能类型	含义请见附件。	Integer	是	无
pageNumber	页码	从1开始	Integer	是	无
pageSize	每页大小	最大50	Integer	是	无
bizToken	工作地图身份token	用户申请的工作地图身份token，一个组织一个token	string	是	无
bizSign	业务签名	签名参数：workMapId, openId（参考签名规则）	string	是	无

示例代码（以java为例）

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "http://restwia.amap.com/api/v1/wia/dimension/dimension/page/query";
    Map<String, Object> params = new HashMap<>();
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String workMapId ="要操作的工作地图id";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    params.put("key", key);
    params.put("openId", openId);
    params.put("workMapId", workMapId);
    params.put("dimensionType", 1);
    params.put("pageNumber", 1);
    params.put("pageSize", 20);
    params.put("bizToken", bizToken);
    String[] signArgs = new String[]{workMapId,openId};
    params.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    url = MyHttpUtils.attachParamsToUrl(url, params);
    String response = MyHttpUtils.postFormUrlencoded(url, null);
    System.out.println(response);
}

返回参数

返回字段	含义	规则说明
code	返回结果编码	1 表示成功
message	返回状态说明	成功时返回Successful，否则返回错误原因
version	版本号	字符串类型
timestamp	时间戳	Unix 时间戳，参考文档：《Unix 时间戳》
requestId	requestId是RPC链路的全局唯一标识，排查问题时需要提供	字符串格式，长度30
data	示例如下： { "dimensions": [ { "dimensionId": "自定义字段分组id", "dimensionType": 1, // 自定义字段的功能类型，含义见附件。 "name": "字段分组名称" } ] }

附表

0、异常

1、成功

2、失败

3、参数错误

1001、权限不足：『不是地图成员』

1003、工作地图不存在

1005、工作地图已删除

附表

附：自定义字段控件类型（componentType 取值）

1、文本

2、单选

3、多选

4、时间

5、数字

6、日期

7、链接

8、电话

9、图片

10、评星

附：新增自定义字段的功能类型（dimensionType 取值）

1、标点

2、绘制线（暂未开放）

3、绘制区域（暂未开放）

4、绘制行政区（暂未开放）

地图纬度自定义字段 最后更新时间: 2023年09月20日

产品简介

使用限制

使用说明

功能使用说明

1. 批量新增自定义字段

请求地址

请求参数

示例代码（以java为例）

返回参数

返回结果示例

2. 批量修改自定义字段

请求地址

请求参数

返回参数

3. 批量删除自定义字段

请求地址

请求参数

返回参数

4. 分页查询自定义字段

请求地址

请求参数

示例代码（以java为例）

返回参数

5、自定义字段指定id批量查询

请求地址

请求参数

返回参数

附表

6. 自定义字段分组新增

请求地址

请求参数

返回参数

附表

7. 自定义字段分组修改

请求地址

请求参数

返回参数

附表

8. 自定义字段分组删除

请求地址

请求参数

返回参数

附表

9. 指定id批量查询自定义字段分组

请求地址

请求参数

返回参数

附表

10. 分页查询自定义字段分组

请求地址

请求参数

示例代码（以java为例）

返回参数

附表

附表

地图纬度自定义字段最后更新时间: 2023年09月20日