创建自定义参数

重要提示

该功能为 尊享版 付费功能，如未升级，请先 升级 后再使用

腾讯问卷支持在投放问卷时在链接中添加自定义参数，用来记录回答来源、用户信息等自定义内容。后台导出答案为 Excel / 数据推送 / 获取回答接口 等形式均能获取到答案以及关联自定义字段。

使用场景

主要有以下使用场景：

1. 通过 from 参数定义不同投放的渠道，进行多渠道投放、分渠道统计；
2. 如已有 APP，通过链接中传入 APP 的 userid，不同用户投放不同链接，识别每个填答用户身份。例如，游戏内传递用户信息，实现用户答题后发放奖品、记录画像信息等；
3. 如已有 会员/员工/线下门店 等系统，配置链接时可通过参数带入 会员/员工/门店 的信息，记录答题来源回传作答数据。

具体使用方式可查看帮助文档

接口概述

• 功能：创建自定义参数
• 请求方式： POST
• 请求地址：/api/surveys/{survey_id}/custom_args?appid={appid}&access_token={access_token}

请求参数

参数名	类型	必须	参数位置	描述	示例值
survey_id	integer	是	uri	问卷ID	292192
title	string	是	body	参数名，用在问卷链接上 wj.qq.com/s2/xx/xx?from=weixin	from
description	string	是	body	描述，用于区分多个自定义参数用途	来源

请求体示例

{    "title":"from",    "description":"来源"}

响应参数

参数名	类型	描述	示例值
survey_id	integer	问卷ID	734167
question_id	string	题目ID，用于后续的更新和创建	custom-arg-01
type	string	类型	text
title	string	参数名	from
description	string	描述	来源
created_at	string	创建时间	2024-08-13 19:28:54
updated_at	string	更新时间	2024-08-13 19:28:54

响应示例

• 请求成功

{    "code": "OK",    "error": {        "type": ""    },    "data": {        "survey_id": 734167,        "question_id": "custom-arg-01",        "type": "text",        "title": "from",        "description": "来源",        "created_at": "2024-08-13 19:28:54",        "updated_at": "2024-08-13 19:28:54"    },    "request_id": "5ysDN6KqOvaO63kj20240813192854"}

• 请求失败

{    "code": "InvalidArgument",    "error": {        "type": "survey_create_custom_args_validate"    },    "data": {},    "request_id": "sq0YOhA5jdeUwqZc20240813192953"}

错误码

error.type 错误代码	错误描述
permission_denied	无权限
survey_create_custom_args_validate	参数校验不通过
not_allow_system	系统限制字段
title_format_error	只允许英文数字下划线中划线，且不允许设置 Q1,q1 形式
title_exists	参数名已经存在
max_create_num	历史创建量超过阈值
num_exceed	超过创建数量（按购买版本区分）