TOOL API

comment_task_create

Creates a task to export ad comments. After creating the task, use /comment/task/check/ to check task status, and when the task is complete, use /comment/task/download/ to download the exported file. Exported data headers are Content, Likes, Replies, Comment Type, Create Time, Campaign Name, Ad Group Name, and Ad Name. If a comment contains mentions of user names, the exported table formats them as "@user_name". In v1.3, the endpoint path is /v1.3/comment/task/create/; compared with v1.2, `advertiser_id` changed from number to string and `comment_ids` changed from number[] to string[].

ecommerceOAuth1 credits

Call information

Tool slug: tiktok-ads.comment_task_create
Provider: TikTok for Business
Average response: 0 ms
Calls in 7 days: 0

Input parameters

advertiser_idrequired

Advertiser ID.

comment_ids

Comment IDs to export. In v1.3, values must be strings; in v1.2, this field used number[].

comment_status

Comment statuses to export. Allowed values: `ALL`, `PUBLIC`, `HIDDEN`. Default: `["ALL"]`.

comment_type

Comment types to export. Allowed values: `ALL`, `COMMENT`, `REPLY`. Default: `["ALL"]`.

end_time

End date of the time range to export, in `YYYY-MM-DD` format.

lang

Language of the exported header names. Allowed values: `EN`, `JA`, `ZH`. Default: `EN`.

search_field

Field used for searching. Allowed value: `ADGROUP_ID`.

search_value

Value for the selected `search_field`. For example, when `search_field` is `ADGROUP_ID`, provide the ad group ID to search by.

sort_field

Field used to sort results. Allowed values: `CREATE_TIME`, `LIKES`, `REPLIES`.

sort_type

Sorting order. Allowed values: `ASC`, `DESC`.

start_time

Start date of the time range to export, in `YYYY-MM-DD` format.