创建评论导出任务
您可以使用本接口创建评论导出任务。
评论导出任务创建后,您可以使用/comment/task/check/查询任务状态。等任务完成后,您可以调用/comment/task/download/下载导出的评论。
评论会到导出到一个表格里。包含以下几列数据:评论内容、点赞数、回复数、评论类型、评论时间、所属推广系列名称、所属广告组名称、所属广告名称。如果评论提及另一个用户名,则这部分内容会被处理成 “@user_name”。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/comment/task/create/|/v1.3/comment/task/create/|
|请求参数类型|advertiser_id: number<br>comment_ids: number[]|advertiser_id: string<br>comment_ids`: string[]|
## 请求
**地址**
https://business-api.tiktok.com/open_api/v1.3/comment/task/create/
**方法** POST
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
|Content-Type {必填}|string|请求信息类型<br>允许格式:`application/json`。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID |
|comment_status |string[]| 评论状态。枚举值:全部 `ALL`,公开 `PUBLIC`,隐藏 `HIDDEN`,默认值:`["ALL"]`|
|comment_type |string[]| 评论类型。枚举值:全部 `ALL`,原始评论 `COMMENT`,回复评论 `REPLY`,默认值:`["ALL"]`|
|search_field |string| 搜索字段。枚举值: `ADGROUP_ID` |
|search_value |string| 搜索值 |
|comment_ids|string[]|要导出的评论 ID|
|sort_field |string| 排序字段。枚举值: `CREATE_TIME`, `LIKES`, `REPLIES` |
|sort_type |string| 排序顺序。枚举值: `ASC`,`DESC` |
|start_time |string| 请求起始时间。格式:`YYYY-MM-DD`|
|end_time |string| 请求结束时间。格式:`YYYY-MM-DD`|
|lang|string|导出文件语言。枚举值:英语 `EN`, 日语 `JA`, 中文 `ZH`,默认值:`EN`.|
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/comment/task/create/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"advertiser_id": "{{advertiser_id}}",
"search_field": "ADGROUP_ID",
"search_value": "{{search_value}}"
}'
(/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|返回数据 |
#|task_id |string| 任务 ID |
|request_id |string|请求的日志id,唯一标识一个请求 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {}
}
(/code);