查询任务台任务投稿视频数据
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/api/apps/taskbox/query_task_video_data
使用限制
接口说明
响应参数
| 名称 | 类型 | 描述 | 示例值 | |
|---|---|---|---|---|
| error | number | 错误码，0 是成功，其它为异常 | 0 | |
| message | string | 成功为"success", 错误为具体 message | success | |
| data | array | 任务数据数组，数组元素为 Object | [] | |
| TaskId | number | 任务ID | 1127955394961539110 | |
| TaskName | string | 任务标题 | test_task_name | |
| MicroAppTitle | string | 小程序标题 | test_title | |
| DouyinID | string | 作者抖音号ID | id1234561 | |
| Author | string | 作者名称 | test_author1 | |
| PublishTime | number | 发布时间 | 秒级时间戳，1658073600 则表示 2022-07-18 00:00:00 | |
| VideoId | number | 视频ID | 1129775324556119340 | |
| VideoLink | string | 视频链接 | test_link | |
| VideoTitle | string | 视频标题 | test_title | |
| VideoViews | number | 播放量 | 10 | |
| Clicks | number | 组件点击数（延迟2天） | 10 | |
| Comments | number | 评论量 | 10 | |
| Likes | number | 点赞量 | 10 | |
| Shares | number | 分享量 | 10 | |
| ExpectedProfit | number | 预计达人收益 | 1.3 | |
| GMVTd | int64 | 否 | 从视频进入小程序产生的总交易金额，单位：分 | |
| RefundGMVTd | int64 | 否 | 从视频进入小程序产生的交易金额中，累计退款金额，单位：分 | |
| BillingGMVTd | int64 | 否 | 任务关联的交易金额，单位：分。 即根据任务计费规则可以归因到这个视频，并给达人分佣的交易金额。仅支付分成的任务视频有值 | |
| BillingRefundGMVTd | int64 | 否 | 任务关联的交易金额中，累计退款金额，单位：分。即根据任务计费规则可以归因到这个视频 ，并给达人分佣的交易金额（已退款）。仅支付分成的任务视频有值 | |
| AdShareCostTd | int64 | 否 | 从视频进入小程序产生的广告收入（平台抽成后的开发者可分成收入，未扣除买量消耗），单位：分 | |
| FeedAdShareCostTd | int64 | 否 | 从feed流看到视频，并进入小程序产生的广告收入（平台抽成后的开发者可分成收入，未扣除买量消耗），单位：分 | |
| ActiveCntTd | int64 | 否 | 任务关联的有效日活用户数。仅按日活用户计费的任务视频有值 | |
| date | string | 否 | 数据产生的截止日期 | |
| ClientName | string | 否 | 撮合中介，可归因到的撮合中介的应用名称。若不归属于任何一个撮合中介，则为空 |
错误码
| HTTP 状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 200 | 5422 | 请求超时或系统异常，请重试 | 重新发起请求，尝试重试 |
| 200 | 5501 | access_token 参数错误 | 检查 access_token 字段是否为空且合法 |
| 200 | 5502 | access_token 不合法 | 检查 access_token 字段是否为空且合法 |
| 200 | 5503 | access_token 无权限 | 检查 access_token 对应的 app_id 是否有相应权限 |
| 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 | 调用者无权限，请服务商前往「服务商平台-设置-权限设置」申请该小程序的「数据分析」权限 | 服务商申请权限 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/api/apps/taskbox/query_task_video_data' \
--header 'Content-Type: application/json' \
--data-raw '{
"access_token": "ba253642059040bc9bdf9a1334",
"appid": "abcdefgh123456",
"task_ids": [
1129795595081908261
],
"video_publish_start_time": 1660114780,
"video_publish_end_time": 1660492800,
"page_size": 10,
"page_no": 1
}'响应示例响应示例
200 - 成功示例
{
"data": [
"ActiveCntTd": 0,
"Author": "nice1",
"BillingGMVTd": 70,
"BillingRefundGMVTd": 0,
"Clicks": 1,
"ClientName": "撮合网站应用015",
"Comments": 0,
"AdShareCostTd": 0,
"FeedAdShareCostTd": 0,
"DouyinID": "31626424566",
"ExpectedProfit": 12,
"GMVTd": 70,
"Likes": 0,
"MicroAppTitle": "行业ITC",
"PublishTime": 1692878009,
"RefundGMVTd": 0,
"Shares": 0,
"TaskId": 7270785143852253244,
"TaskName": "小程序B的支付分成绑定任务R4",
"VideoId": 7270855478333246754,
"VideoLink": "https://www.iesdouyin.com/share/video/7270855478333246754/?region=CN&mid=7270855692553079609",
"VideoTitle": "hello",
"VideoViews": 0,
"date": "2023-08-25"
}
],
"error": 0,
"message": "success"
}
请求参数
Header 参数
Content-Type
string
必需
示例值:
application/json
Body 参数application/json