Douyin-DouPlus-API

获取DOU+预计投放效果/Get DOU+ estimated delivery results

Changed on

[中文]

用途:

  • 获取指定作品在给定推广目标、预算和投放时长下的预计投放效果
  • 适合在正式创建 DOU+ 订单前比较不同预算和时长的预估结果

参数:

  • item_ids: 作品ID,多个用逗号分隔(必填)。单作品通常使用 schema=0,多作品使用 schema=3
  • external_action: 优化动作编码,需与 target_id 对应。默认 44(NativeAction);常用值:45=点赞,46=关注, 47=评论,51=链接点击,102=多互动,181=主页访问
  • target_id: 推广目标ID,默认 31(点赞评论量)。常用值:32=粉丝量,33=主页访问,37=视频播放, 40=直播间人气,45=评论链接点击,63=粉丝展示,78=自然流量提升,81=高互动频次
  • schema: 投放场景编码。0=单作品默认(Default),3=多作品批量投放(BatchDelivery);官方前端按作品数量选择
  • is_max_cv: 是否使用 MaxCV 最大转化量模式预估;官方前端根据目标能力、素材数量、预算和手动出价状态计算
  • pay_type: 支付通道类型。0=CashDesk,1=IAP,2=Caijing,3=CgTradeCash;官方预计效果调用固定传 1
  • cost_int: 投放预算,单位为厘(人民币 1/1000 元),默认 30000(30 元)
  • duration_seconds: 投放时长,单位为秒,默认 21600(6 小时)

返回:

  • 当前预算、时长和推广目标对应的预计投放效果数据

[English]

Purpose:

  • Get estimated delivery results for specified items, promotion target, budget and duration
  • Useful for comparing budget and duration options before creating a DOU+ order

Parameters:

  • item_ids: Item id(s), comma separated (required). Normally use schema=0 for one item and schema=3 for multiple items
  • external_action: Optimization action code; must match target_id. Default 44 (NativeAction); common values: 45=like, 46=follow, 47=comment, 51=link click, 102=multiple native actions, 181=homepage visit
  • target_id: Promotion target id, default 31 (likes and comments). Common values: 32=followers, 33=homepage visits, 37=video plays, 40=live popularity, 45=comment-link clicks, 63=show to followers, 78=natural promotion, 81=high interaction frequency
  • schema: Delivery scene code. 0=single-item Default, 3=multi-item BatchDelivery; selected from the item count
  • is_max_cv: Whether to estimate in MaxCV (maximum-conversion-volume) mode; derived from target capability, item count, budget and manual-bid state by the official client
  • pay_type: Payment channel. 0=CashDesk, 1=IAP, 2=Caijing, 3=CgTradeCash; the official estimate request uses 1
  • cost_int: Delivery budget in li (CNY 1/1000), default 30000 (CNY 30)
  • duration_seconds: Delivery duration in seconds, default 21600 (6 hours)

Return:

  • Estimated delivery results for the selected budget, duration and promotion target
post/api/v1/douyin/douplus/fetch_delivery_effect_estimate

Request

  • Base URL
    https://api.tikhub.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

item_idsstring required

作品ID,多个用逗号分隔;单作品通常配合 schema=0,多作品配合 schema=3/Item id(s), comma separated; normally use schema=0 for one item and schema=3 for multiple items

external_actioninteger

优化动作编码,需与 target_id 对应,默认44(NativeAction);常用:45=点赞,46=关注,47=评论,51=链接点击,102=多互动,181=主页访问/Optimization action code; must match target_id, default 44 (NativeAction). Common values: 45=like, 46=follow, 47=comment, 51=link click, 102=multiple native actions, 181=homepage visit

target_idinteger

推广目标ID,默认31(点赞评论量);常用:32=粉丝量,33=主页访问,37=视频播放,40=直播间人气,45=评论链接点击,63=粉丝展示,78=自然流量提升,81=高互动频次/Promotion target id, default 31 (likes and comments). Common values: 32=followers, 33=homepage visits, 37=video plays, 40=live popularity, 45=comment-link clicks, 63=show to followers, 78=natural promotion, 81=high interaction frequency

schemainteger

投放场景编码:0=单作品默认(Default),3=多作品批量投放(BatchDelivery);官方前端按 item_ids 数量选择/Delivery schema: 0=single-item Default, 3=multi-item BatchDelivery; the official client selects it from the item count

is_max_cvboolean

是否使用MaxCV最大转化量模式预估;官方前端会根据优化目标能力、素材数量、预算及是否手动出价计算,默认true/Whether to estimate in MaxCV (maximum-conversion-volume) mode; the official client derives it from target capability, item count, budget and manual-bid state, default true

pay_typeinteger

支付通道类型:0=CashDesk,1=IAP,2=Caijing,3=CgTradeCash;官方预计效果调用固定传1/Payment channel: 0=CashDesk, 1=IAP, 2=Caijing, 3=CgTradeCash; the official estimate request uses 1

cost_intinteger

投放预算,单位为厘(人民币1/1000元),默认30000(30元)/Delivery budget in li (CNY 1/1000), default 30000 (CNY 30)

duration_secondsinteger

投放时长,单位为秒,默认21600(6小时)/Delivery duration in seconds, default 21600 (6 hours)

Example request

{
  "item_ids": "7677202522116819185",
  "external_action": 44,
  "target_id": 31,
  "is_max_cv": true,
  "pay_type": 1,
  "cost_int": 30000,
  "duration_seconds": 21600
}

Response

Successful Response

codeinteger

HTTP status code | HTTP状态码

request_idstring nullable

Unique request identifier | 唯一请求标识符

messagestring

Response message (EN-US) | 响应消息 (English)

message_zhstring

Response message (ZH-CN) | 响应消息 (中文)

supportstring

Support message | 支持消息

timestring

The time the response was generated | 生成响应的时间

time_stampinteger

The timestamp the response was generated | 生成响应的时间戳

time_zonestring

The timezone of the response time | 响应时间的时区

docsstring nullable

Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接

cache_messagestring nullable

Cache message (EN-US) | 缓存消息 (English)

cache_message_zhstring nullable

Cache message (ZH-CN) | 缓存消息 (中文)

cache_urlstring nullable

The URL to access the cached result | 访问缓存结果的 URL

routerstring

The endpoint that generated this response | 生成此响应的端点

paramsunknown
dataunknown

Changes