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

获取表单组件详情
全部接口
V1.1
loading

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

全局参数

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

参数名称 参数类型
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_id*
string 组件 id
字段长度最小 1 字节,长度最大 128 字节

使用说明

  1. 服务的沙箱环境正在建设中,近期即将上线。
  2. 接口暂时不支持 BM 角色调用。
  3. account_id 参数必填。
  4. component_id 参数必填。

请求示例


curl -G 'https://api.e.qq.com/v1.1/leads_form/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=123456' \
-d 'component_id=111111' 
					

应答字段

名称 类型 描述
account_id
integer 广告主帐号 id,直客帐号或子客帐号
component_id
string 组件 id
component_name
string 组件名称
created_time
string 创建时间
form_config
struct 表单属性
title
string 表单标题
sub_title
string 表单副标题
submit_text
string 按钮文案
item_list
struct[] 表单选项
item_name
string 表单项目名称
item_type
enum 表单项类型,[枚举详情]
placeholder
string 表单项提示信息
select_elements
struct[] 下拉选项
name
string 下拉框选项

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "account_id": 123456,
        "component_id": "111111",
        "component_name": "表单组件",
        "created_time": "2020-08-05 18:56:42",
        "form_config": {
            "title": "主题",
            "sub_title": "副标题",
            "submit_text": "装修估价"
        },
        "item_list": [
            {
                "item_name": "姓名",
                "item_type": "NAME",
                "select_elements": null,
                "placeholder": "请输入您的姓名"
            },
            {
                "item_name": "电话",
                "item_type": "PHONE",
                "select_elements": null,
                "placeholder": "请输入您的电话号码"
            },
            {
                "item_name": "输入框",
                "item_type": "TEXT",
                "select_elements": null,
                "placeholder": "输入框提示"
            },
            {
                "item_name": "下拉框",
                "item_type": "SELECT",
                "select_elements": [
                    {
                        "name": "下拉框内容 1"
                    },
                    {
                        "name": "下拉框内容 2"
                    }
                ],
                "placeholder": "下拉框提示"
            }
        ]
    }
}

可视化调试工具