抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • OpenAPI 简介
  • 通用参数
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 联合授权
  • 视频能力
  • 线索组件
  • 接口调用凭证
  • 登录
  • Web 化接入
  • 隐私协议
  • 流量主
  • 小程序码与小程序链接
  • 用户信息
  • 抖音号绑定
  • 小程序推广计划
  • 短视频任务
  • 创建任务-v2
  • 重新提交任务基础信息-v2
  • 更新任务状态-v2
  • 查询小程序任务台任务 ID-v2
  • 查询任务详情-v2
  • 查询任务台任务投稿视频数据(明细)-v2
  • 查询任务台任务投稿视频数据-v2
  • 更新专属任务达人
  • 查询推广视频数据下载链接
  • 查询视频任务相关实时汇总数据
  • 直播间任务
  • 内容安全
  • 任务能力
  • 分享
  • 客服
  • 小程序券
  • 触达与营销
  • 支付
  • 运营
  • 生活服务
  • 垂直行业
  • 其它
  • 接口说明

    该接口用于小程序任务台任务编辑。

    使用限制

    无。

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/api/match/v2/taskbox/update_task/
    HTTP Method
    POST
    Scope
    match_taskbox.default.plan_permission
    权限要求

    服务商代调用场景下,需商家授予小程序推广计划-任务管理权限。

    请求参数

    请求头
    access-token必填String
    当非服务商时,调用https://open.douyin.com/oauth/client_token/生成的token
    当服务商时,调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
    content-type必填String
    示例:application/json

    固定值"application/json"

    Body展开全部子属性
    start_page必填String
    示例:page/detail/detail?id=1
    • 小程序页面地址,包含path和query,path不得以 "/" 开头。
    • 任务页面类型为达人自选页面时无需填写。
    task_desc必填String

    产品介绍30-100字;任务要求<200字,条数不限。

    举例

    1. 产品介绍:该产品是一个XX类型的小程序,可以XXX。
    2. 达人视频内需添加与小程序页面相关的内容,杜绝生硬植入。
    3. 达人视频内容表现积极向上,禁止出现恶俗、违背公序良俗类内容或品牌负面
    4. 视频原创,拒绝拼接,搬运,虚假骗互动内容。


    注意:

    1.任务台的方案 只能计算小程序内收入,如果是iOS虚拟支付的,走了小店的那部分无法计费,需要开发者在产品说明中明确写出来,如:「请注意:该小程序内iOS端的订单收入不计入分成收入,仅计算安卓端订单收入。」

    2.仅支持纯文本输入,不可包含html标签

    task_end_time必填Int64

    任务结束时间,秒级时间戳。开始时间与结束时间相差要求大于30天

    task_icon必填String
    • 尺寸为512*512的当前任务图标,大小不超过200KB,支持PNG,JPG格式
    • 不允许出现留边的情况,图片必须铺满
    task_id必填Int64
    示例:1234

    任务ID,创建接口返回

    task_name必填String
    • 任务名称
    • 长度:限制在17个字以内
    • 不得包含特殊字符,除[、,、。、!、?、“、”、《、》「、」、]以外
    • 不得包含敏感字符,例如“全网第一”
    • 任务名称请勿包含公司名称!
    • 任务标题相同,任务时间重叠。即为重复上传任务,不支持上传
    • 同一个小程序,上传相似标题、相同页面地址的任务,会审核不通过
    task_settle_type必填Int32
    • 结算方式,类型包含:1-广告分成、2-支付分成(基础)、3-支付分成(绑定)、7-广告分成+支付分成(基础)、8-广告分成+支付分成(绑定)
    • 支付CPS必须接入小程序担保交易,且需另外配置最长可退款时间和分佣比例
    task_start_time必填Int64

    任务开始时间,秒级时间戳

    task_tags必填Array<String>
    • 任务标签
    • 开发者勾选两个维度的标签:形态+内容,成为数组的两个元素
    • 见本文档开头任务标签字段说明
    • 必须按表里的填,不要自己命名!
    anchor_titleString
    • 上传的锚点标题,最多14个字。
    • 任务页面类型为达人自选页面时无需填写。
    page_typeEnum
    示例:1

    任务页面类型:0或不填-开发者指定任务的小程序页面地址,1-达人自选页面。

    展开子属性
    refer_gidsArray<Int64>

    示例视频的gid数组,当传了 refer_videos 字段时,会自动使用 refer_videos 的视频作为示例视频,本字段无效

    refer_ma_capturesArray<String>

    小程序落地页截图。单个图片大小上限为2M,可上传0-3张,尺寸为312*444,支持PNG和JPG格式

    refer_videosArray<String>
    • 示例视频
    • 0-5个,校验是可以打开的视频,如被删除或其他原因则不展示
    • 会审核视频内容、视频锚点与任务的相关性,低质/无意义/录屏/不含小程序锚点会审核不通过
    • 从移动端复制视频链接,正确格式为:https//v.Douyin.com/xxxxx
    • 视频需包含任务对应的小程序锚点!
    请求示例
    curl --location --request POST 'https://open.douyin.com/api/match/v2/taskbox/update_task/' \ --header 'content-type: application/json' \ --header 'access-token: 080112****a356a6' \ --data '{ "task_id": 12333, "task_name": "测试12333", "task_settle_type": 1, "start_page": "xxx", "anchor_title": "测试锚点标", "task_icon": "xxx", "task_start_time": 1618285226, "task_end_time": 1620963626, "task_desc": "1. sss <br>2.sss2", "refer_videos": [ "http://boe.v.douyin.com/Z0JRdbe/", "http://boe.v.douyin.com/Z0JFXvp/" ], "task_tags": ["测试类", "心理"], "refer_ma_captures": [ "https://static.runoob.com/images/demo/demo1.jpg", "https://static.runoob.com/images/demo/demo2.jpg" ] }'

    响应参数

    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": { "task_id": 720992698146361 } }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    2000
    请求操作成功
    2005401
    没有支付分成比例或者最大退款周期
    2005402
    参考视频截图数量不合法
    2005403
    小程序落地页参考视频截图数量不合法
    2005404
    任务描述长度不合法
    2005405
    任务开始与结束时间必须大于 30 天
    2005406
    小程序落地页截图数量不合法
    2005408
    锚点标题长度不合法
    2005409
    任务标签长度不合法
    2005411
    传入的 appid 不是小程序
    2005412
    最大退款周期不合法
    2005413
    支付分成比例不合法
    2005414
    传入图片的宽高不合法
    2005415
    图片大小不合法
    2005410
    任务名称长度不合法
    2005416
    无效的图片链接
    2005417
    任务 id 传入的数量太多
    2005418
    找不到对应的小程序
    2005419
    找不到 gid 列表
    2005420
    gid 找不到对应的视频
    2005421
    gid 数量过多
    2005422
    超时相关的问题
    2005423
    没有支付分成比例或者最大退款周期
    2005424
    找不到相应的结算模式
    2005425
    非法视频,请检查视频
    2005426
    重复任务
    2005427
    该小程序已经达到当天上传任务的次数限制
    2005428
    图片解析错误
    2005429
    当前小程序无配置,请联系相关人员添加任务相关配置
    2005430
    当前小程序无短视频挂载能力
    2005431
    当日灰度名额已满
    2005432
    未满足达到发布此类任务门槛
    2005433
    小程序未开启任务台
    2005434
    小程序已加任务台黑名单
    2005435
    小程序已下架
    2005436
    小程序已经开启任务台
    2005437
    小程序类别限制
    2005438
    小程序未上线
    2005439
    不支持修改非当前APPID 任务
    2005440
    不支持修改任务类型
    2004001015
    1.Request Paramter Error 2.已上线任务不支持修改任务佣金比例 3.html标签不可用,任务介绍仅支持纯文本输入
    1.请检查参数是否正确 2.请检查task_desc是否包含html标签
    2005442
    任务状态非已驳回或已上线不支持修改
    2005504
    任务更新,taskID必传
    2005507
    该任务状态为审核中,不允许编辑,请耐心等待审核结果
    2005508
    该任务已下线,不允许编辑,请重新创建任务
    2005481
    不得包含特殊字符
    2005482
    不得包含敏感字符“${敏感字符}”
    2005483
    任务标签不合法
    2005515
    调用者无权限
    请服务商前往「服务商平台-能力-代商家管理能力-小程序推广计划」完成协议签署
    2005516
    调用者无权限
    请服务商前往「服务商平台-设置-权限设置」申请该小程序的「小程序推广计划-任务管理」权限
    2005517
    该小程序暂未完成撮合平台协议的签署
    请开发者前往「开发者平台-运营-小程序推广计划」完成协议
    20028001018
    应用未获得该能力
    请服务商前往「服务商平台-设置-权限设置」申请该小程序的「小程序推广计划-任务管理」权限