获取即时表单字段值
您可以使用本接口获取即时表单(线索表单)的字段值。
我们推荐您通过本接口直接获取即时表单值。您也可以使用/page/lead/mock/create/接口创建测试线索,获取即时表单字段值。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/pages/fields/get/|/v1.3/page/field/get/|
|请求参数类型 |advertiser_id: number<br>page_id: number|advertiser_id: string<br>page_id:string|
|返回参数类型|page_id: number<br>create_time: number|page_id: string<br>create_time`: datetime|
```
请求
地址 https://business-api.tiktok.com/open_api/v1.3/page/field/get/
方法 GET
Header
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌,可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
|Content-Type {必填}|string|请求消息类型。<br>允许值:`"application/json"` 。 |
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string|广告主ID。 |
|page_id {必填}|string| 即时表单ID。 |
示例
(code curl http)
curl -L -X GET 'https://business-api.tiktok.com/open_api/v1.3/page/field/get/?advertiser_id=ADVERTISER_ID&page_id=PAGE_ID' \
-H 'Access-Token: xxx' \
-H 'Content-Type: application/json'
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码。完整返回码列表及描述,可见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message |string|返回信息。更多信息可见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|data |object|返回数据。 |
#|fields|string| 即时表单字段信息。 |
#|meta_data|object| 即时表单元信息。 |
##|page_id|string| 即时表单ID。 |
##|create_time|datetime| 即时表单的创建时间。 |
##|page_name|string| 即时表单名称。 |
##|page_url|string| 即时表单URL。|
|request_id |string|请求的日志ID,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"data": {
"fields": [],
"meta_data": {}
}
}
(/code);