通用佣金计划查询达人带货详情
通用佣金计划查询达人带货详情
Scope: poi.cps.common 需要申请权限 不需要用户授权
该接口用于查询指定达人在某计划的详细带货数据,返回每个短视频/直播间下达人的带货 GMV、已核销 GMV、达人分佣金额、观看人数。
使用限制
- 仅可查询小程序商品(小程序商品定义见下)关联的通用佣金计划
- 仅当调用接口的应用与计划关联的商品存在以下关系时允许应用查询该计划的相关信息 应用是商品的创建者 应用是商品所属的小程序
接口说明
小程序商品:通过/poi/v2/spu/sync/
接口同步 SPU 时,entry_info.entry_type
为 2 且填充了entry_info.entry_miniApp
参数的商品为小程序商品。其中entry_info.entry_miniApp.app_id
为商品所属的小程序。
通用佣金计划:原「CPS 商品佣金设置」升级为「通用佣金计划」,支持以下能力:
- 设置商品通用分佣率,所有达人都可以带货该商品
- 设置支持的带货场景(直播/短视频/均可)
- 查询计划关联的带货信息
基本信息
HTTP URL | https://open.douyin.com/poi/common/plan/talent/media/list/ | |||
---|---|---|---|---|
HTTP Method | POST | |||
Scope | poi.cps.common | |||
权限要求 |
|
请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值 application/json |
access-token | string | 是 | 调用 |
请求参数
Query 请求
无
Body 请求
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
plan_id | int | 是 | 7089334664648722476 | 通用佣金计划ID |
page_no | int | 是 | 1 | 分页参数:页码,从1开始计数 |
page_size | int | 是 | 10 | 分页参数:数量,1<=page_size<=100 |
douyin_id | string | 是 | dyvvvvvv | 达人抖音号 |
content_type | int | 是 | 1 | 带货场景,可选值:
|
请求示例
curl --location --request POST 'http://open.douyin.com/poi/common/plan/talent/media/list/' \
--header 'access-token: clt.d75720fc7f0681c6c9903b5e2446b13dt8pj2svletlW3ev1YEaAPvK6lfTF' \
--header 'Content-Type: application/json' \
--data-raw '{
"plan_id": 7089053269443495980,
"douyin_id": "dyvvvvvv",
"content_type": 3,
"page_no": 90,
"page_size": 11
}'
响应参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
page_count | int | 总页数 | 10 |
total | int | 短视频/直播间总数 | 100 |
date | string | 数据产出日期 | 2022-04-25 |
data | []obejct | 达人短视频/直播间带货信息列表 | [ { "content_open_id": "@+mBxWHj2nqdRjxo4Vh4B70Qyt+dfT/I7a0KvRQTPaX+4Cjr/veNDY8kZYHy167jB", "content_type": 2, "gmv": 495980, "play_cnt": 980, "talent_commission": 95980, "used_gmv": 5980 } ] |
gmv | int | 短视频/直播间的带货GMV | 722476 |
content_type | int | 带货场景,可选值:
| 2 |
content_open_id | string | 加密过的短视频/直播间ID | @+mBxWHj2nqdRjxo4Vh4B70Qyt+dfT/I7a0KvRQTPaX+4Cjr/veNDY8kZYHy167jB |
play_cnt | int | 短视频/直播间的观看人数 | 159375 |
talent_commission | int | 达人在该段视频/直播间的佣金 | 32375 |
used_gmv | int | 短视频/直播间已核销的GMV | 19830157 |
响应示例
正常示例
{
"data": {
"total": 980,
"error_code": 0,
"description": "",
"data": [
{
"content_open_id": "@+mBxWHj2nqdRjxo4Vh4B70Qyt+dfT/I7a0KvRQTPaX+4Cjr/veNDY8kZYHy167jB",
"content_type": 2,
"gmv": 495980,
"play_cnt": 980,
"talent_commission": 95980,
"used_gmv": 5980
}
],
"date": "2022-04-26",
"page_count": 90
},
"extra": {
"error_code": 0,
"logid": "202204262133240102252431180E5376DA",
"now": 1650980005,
"sub_description": "",
"sub_error_code": 0,
"description": ""
}
}
异常示例
{
"data": {
"error_code": 2100007,
"description": "无权限操作"
},
"extra": {
"description": "无权限操作",
"error_code": 2100007,
"logid": "20220426180719010225142142054AC378",
"now": 1650967640,
"sub_description": "没有发布/修改通用佣金计划的权限",
"sub_error_code": 110003
}
}
错误码
进入状态码排查工具,输入 API 名称和状态码,查询调用结果。