接口文档SDK业务专题开发者工具

创建表单组件
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 leads_form/add
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于腾讯广告平台及微信公众平台。其中,标有的内容表示,该参数在微信公众平台使用时,描述不同。标有*的参数为必填项

名称 类型 描述
account_id*
integer 广告主帐号 id,直客帐号或子客帐号
component_name*
string 组件名称
字段长度最小 1 字节,长度最大 32 字节
title*
string 表单标题
字段长度最小 1 字节,长度最大 15 字节
sub_title*
string 表单副标题
字段长度最小 1 字节,长度最大 15 字节
submit_text*
string 按钮文案
字段长度最小 1 字节,长度最大 6 字节
items*
struct[] 表单选项
数组最小长度 1,最大长度 4
item_type*
enum 表单项类型,[枚举详情]
枚举列表:{ NAME, PHONE, TEXT, SELECT }
item_name*
string 表单项目名称
字段长度最小 1 字节,长度最大 4 字节
placeholder*
string 表单项提示信息
字段长度最小 1 字节,长度最大 10 字节
select_elements
string[] 下拉框选项
数组最小长度 1,最大长度 10
字段长度最小 1 字节,长度最大 10 字节

使用说明

  1. 服务的沙箱环境正在建设中,近期即将上线。
  2. POST 请求,Content-Type: application/json。
  3. account_id 参数必填。
  4. component_name 参数必填,不能和已有的组件名称重复,长度 1-32。
  5. 参数 title 必填,长度为 1-15。
  6. 参数 sub_title 必填,长度为 1-15。
  7. 参数 submit_text 必填,长度为 1-6。
  8. 表单项参数 items item_type 数值有 NAME,PHONE,TEXT,SELECT ;分别代表姓名,电话,输入框,下拉框。
  9. 表单项参数 items item_type=NAME,item_name 必须为姓名; item_type=PHONE,item_name 必须为电话,并且两项都必须各有一个。
  10. 表单项参数 items item_type=TEXT,item_name 长度为 1-4。
  11. 表单项参数 items item_type=SELECT,item_name 长度为 1-4,select_elements 元素不能重复,长度为 1-10,最多 10 个选项。
  12. 表单项参数 items 为数组,最多是 4 个。
  13. 表单项参数 items placeholder 长度为 1-10。

请求示例


curl 'https://api.e.qq.com/v1.1/leads_form/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-H 'Content-Type: application/json' \
-d '{
    "account_id": 123456,
    "component_name": "表单组件",
    "title": "主标题",
    "sub_title": "副标题",
    "submit_text": "在线报名",
    "items": [
        {
            "item_type": "NAME",
            "item_name": "姓名",
            "placeholder": "请输入您的姓名"
        },
        {
            "item_type": "PHONE",
            "item_name": "电话",
            "placeholder": "请输入您的电话号码"
        },
        {
            "item_type": "TEXT",
            "item_name": "输入框",
            "placeholder": "输入框提示"
        },
        {
            "item_type": "SELECT",
            "item_name": "下拉框",
            "placeholder": "下拉框提示",
            "select_elements": [
                "下拉框内容 1",
                "下拉框内容 2"
            ]
        }
    ]
}'
					

应答字段

名称 类型 描述
component_id
string 组件 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "component_id": "111111"
    }
}

可视化调试工具