腾讯广告

获取表单组件详情

开发环境

GET

/v1.3/leads_form/get

使用说明

服务的沙箱环境正在建设中，近期即将上线。

接口暂时不支持 BM 角色调用。

account_id 参数必填。

component_id 参数必填。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET '/v1.3/leads_form/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--data-urlencode 'account_id=123456' \
--data-urlencode 'component_id=111111'

响应示例

{
    "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": "下拉框提示"
            }
        ]
    }
}

请求参数

Header 参数

access_token

string

必需

以Query Parameter方式在请求路径中传递。授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节。

默认值:

<ACCESS_TOKEN>

timestamp

string

必需

以Query Parameter方式在请求路径中传递。当前的时间戳，单位为秒，允许客户端请求最大时间误差为300秒。
MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59

默认值:

nonce

string

必需

以Query Parameter方式在请求路径中传递。随机字串标识，不超过32个字符，由调用方自行生成，需保证全局唯一性。

默认值:

<NONCE>

fields

string

必需

指定返回的字段列表，为选填字段，如不填写，则根据默认值进行返回

Body 参数application/x-www-form-urlencoded

account_id

integer

必需

广告主帐号 id，直客帐号或子客帐号

示例值:

123456

component_id

string

必需

组件 id
字段长度最小 1 字节，长度最大 128 字节

示例值:

111111

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

account_id

integer

必需

广告主帐号 id，直客帐号或子客帐号

component_id

string

组件 id

必需

component_name

string

组件名称

必需

created_time

string

创建时间

必需

form_config

object

表单属性

必需

item_list

array [object {4}]

表单选项

必需

修改于 2023-11-02 09:22:57

创建表单组件

获取表单组件列表