查询任务台任务投稿视频数据-v2
收藏建议接入账单接口：查询推广视频数据下载链接
本接口后续不再维护，请在2024年3月27日前接入上述接口。
接口说明
开发者在小程序推广计划中创建推广任务后，可查询相应任务的投稿视频数据。
使用限制
开发者只能查询当前账号有权限的任务数据。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/match/v2/taskbox/query_task_video_data/ |
| HTTP Method | POST |
| Scope | match_taskbox.default.data_permission |
| 权限要求 | 服务商代调用场景下，需商家授予数据分析权限。 任务台 |
请求参数
请求头
access-token必填String
当非服务商时，调用https://open.douyin.com/oauth/client_token/生成的token
当服务商时，调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
当服务商时，调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
content-type必填String
示例：application/json
固定值"application/json"
Body
page_num必填Int32
示例：10
页大小，大小不能超过10000
page_size必填Int32
示例：1
页号
task_ids必填Array<Int64>
示例：[1129795595081908261,1129795595081908262]
查询的任务ID数组，单次最多查询个数小于等于 5
video_publish_end_time必填Int64
示例：1658073600
- 任务创建终止时间，秒级时间戳
- 时间参数限制：create_end_time > create_start_time 且 (create_end_time - create_start_time) <= 30 天
video_publish_start_time必填Int64
示例：1657728000
任务创建起始时间，秒级时间戳
请求示例
curl --location --request POST 'https://open.douyin.com/api/match/v2/taskbox/query_task_video_data/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data ' { "task_ids": [ 1129795595081908261 ], "video_publish_start_time": 1660114780, "video_publish_end_time": 1660492800, "page_size": 10, "page_no": 1 } '
响应参数
Body展开全部子属性
err_msg必填String
示例：success
错误信息
err_no必填Int32
示例：0
错误码，0 是成功，其它为异常
log_id必填String
示例：202008121419360101980821035705926A
标识请求的唯一id，在接口异常时用于问题排查
dataStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "success", "log_id": "202008121419360101980821035705926A", "data": { "video_sum_data_list": [ { "comments": 0, "clicks": 1, "likes": 0, "expected_profit": 12, "date": "2023-08-25", "billing_gmv_td": 70, "micro_app_title": "行TC", "publish_time": 1692878009, "task_id": 7270785152253244, "shares": 0, "billing_refund_gmv_td": 0, "video_link": "https://www.iesdouyin.com/share/video/2708533246754/?region=CN&mid=7270853079609", "refund_gmv_td": 0, "video_title": "hello", "feed_ad_share_cost_td": 0, "task_name": "小程序B的支付分成绑定任务R4", "douyin_id": "316ac424566", "author": "nice1", "video_id": 2708533246754, "gmv_td": 70, "client_name": "撮合网站应用015", "active_cnt_td": 0, "ad_share_cost_td": 0, "video_views": 0 } ] } }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 5422 | 请求超时或系统异常，请重试 | 重新发起请求，尝试重试 |
| 200 | 5509 | 无 app_id 或 task_id 查询权限 | 检查 access_token 对应的 app_id、task_id 是否有相应权限 |
| 200 | 5510 | 查询时间条件不合法 | 检查请求参数中时间起始值是否合法 |
| 200 | 5511 | 查询条件TaskID不合法 | 检查 task_id 类型及数量是否合法 |
| 200 | 5515 | 调用者无权限 | 请服务商前往「服务商平台-能力-代商家管理能力-小程序推广计划」完成协议签署 |
| 200 | 5517 | 该小程序暂未完成撮合平台协议的签署 | 请开发者前往「开发者平台-运营-小程序推广计划」完成协议签署 |
| 200 | 5519 | 调用者无权限 | 请服务商前往「服务商平台-设置-权限设置」申请该小程序的「数据分析」权限 |
| 200 | 28001018 | 应用未获得该能力 | 请服务商前往「服务商平台-设置-权限设置」申请该小程序的「小程序推广计划-任务管理」权限 |
