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

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

所属权限 Ads Management
请求地址 leads_form_list/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,直客帐号或子客帐号
begin_created_time
string 创建开始时间,日期格式,2020-01-01
字段长度为 10 字节
end_created_time
string 创建结束时间,日期格式,2020-01-01,大于 start_date
字段长度为 10 字节
page
integer 搜索页码,默认值:1
page_size
integer 一页显示的数据条数,默认值:50
最小值 1,最大值 100

使用说明

  1. 服务的沙箱环境正在建设中,近期即将上线。
  2. 接口暂时不支持 BM 角色调用。
  3. account_id 参数必填。
  4. start_created_time 和 end_created_time 参数为组件的创建开始时间和结束时间,格式为 yyyy-mm-dd,如果不填,默认开始时间是七天天到当前时间。
  5. page 不传,默认为 1。
  6. page_size 不传,默认为 50,最大为 100,超过 100 按照 100 查询。

请求示例


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

应答字段

名称 类型 描述
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数
list
struct[] 表单列表
component_name
string 组件名称
component_id
string 组件 id
created_time
string 创建时间

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "page_info": {
            "total_number": 1,
            "total_page": 1,
            "page_size": 10,
            "page": 1
        },
        "list": [
            {
                "component_name": "表单组件名称 1",
                "component_id": "111111",
                "created_time": "2020-08-05 18:56:42"
            }
        ]
    }
}

可视化调试工具