开发
API

小程序任务台能力

本 API 从属于小程序任务台系统,主要为开发者提供任务台任务的上传,修改等能力。

接入流程简介

使用文档所述 OpenAPI 前需要在开发者平台上开通任务台相关功能。

重要字段说明

任务标签字段说明

任务中的标签字段请选择两个维度的标签:

1. 形态:共 12 类

图片互动类/声音互动类/游戏化/图像处理类/生成转换类/计算器类/在线应用类/信息查询类/资源获取/测试类/答题类/其他

形态玩法

说明

举例

备注

图片互动类

看图片、上传图片互动或获取结果

AI 颜值评分、AI 造型屋


声音互动类

听声音、上传声音互动或获取结果

录绕口令、录歌

用户听声音答题 or 用户上传声音,都属于声音互动类

游戏化

偏游戏、未分类的互动型小程序

测手速、华容道、模拟器


图像处理类

图片的在线设计&编辑制作

漫画脸制作、表情包制作、证件照生成、名片设计、logo 设计

上传图片生成新图片,注重实用性,属于图像处理类;如果是偏娱乐性,属于图片互动类

生成转换类

文件、文案、视频的生成或转换

文件格式转换、翻译、足迹生成、对联生成


计算器类

提供对日期、数字、金额等运算的能力

BMI 计算、保质期计算、倒计时


在线应用类

实用小工具、娱乐小工具

记事本、日程表、智能检测、投票


信息查询类

获取信息或新闻

电影档期、娱乐资讯、地址查询


资源获取

获取图片、文章、视频、音频等

表情包、小说、影视、相声

注意版权问题

测试类

最终目的是获取测试结果

影视测试

答题获取测试结果,属于测试类

答题类

通过答题,最终目的是获取排名或积分

王者荣耀答题闯关

答题获取测试结果,属于测试类

其他




2. 内容:共 18 类

心理/游戏/影视综/二次元/美食/萌宠/亲子/旅游/时尚/颜值/随拍/音乐/舞蹈/体育/健身/泛知识/居家休闲/科技/财经/汽车/其他。

内容名称

说明

心理

情感、成长、职场技能

游戏

角色扮演、竞技游戏、动作游戏、射击游戏、游戏其他、解说游戏

影视综

影视剪辑、影视解说、普通综艺、脱口秀、其他综艺

二次元

二次元衍生、二次元内容、二次元资讯、二次元其他

美食

美食教程、评测、吃播、山野村食、美食知识、美食展示

萌宠

宠物猫、狗、其他动物、宠物资讯

亲子

母婴、儿童、亲子日常

旅游

旅行 vlog、旅行攻略、旅行摄影、酒店/民宿测评、导游

时尚

彩妆、护肤、穿搭、资讯

颜值随拍

帅哥、美女、人物随拍、录屏、生活记录

音乐

音乐演唱、西洋乐器、民族乐器、音乐知识

舞蹈

专业舞蹈、手势舞蹈、民族舞、广场舞

体育

竞技体育、水/雪上运动、极限运动、球类项目、体育运动文化

健身

专业健身、生活健身、健身知识

泛知识

天文科普、地理科普、植物科普、科学实验、冷知识、自然科普、数理科学 ; 文史哲、教育 ; 传统文化、人文艺术

居家休闲

装修设计、生活窍门、家具家电、园艺花艺、手工 diy、魔术、多米诺骨牌类、开箱、玩具、棋牌

科技财经

手机、电脑、电器、科技周边、行业资讯、投资理财、金融产品、财经新闻、财经知识、房产、实体经济

汽车

看车、选车、买车、用车、学车、汽车周边

其他

明星八卦、剧情演绎 ; 三农 ; 医疗 ; 时政新闻

小程序任务台任务上传

该接口用于小程序任务台创建任务。

基本信息

基本信息


HTTP URL

https://developer.toutiao.com/api/apps/taskbox/add_task

HTTP Method

POST

权限要求

请求头

名称

类型

必填

描述

Content-Type

string

application/json; charset=utf-8

请求参数

名称

类型

位置

必填

描述

任务台示例

审核注意备注

access_token

string

body

权限 token,获取接口



task_name

string

body

任务名称

长度:限制在18个字以内








任务名称请勿包含公司名称!

任务标题相同,任务时间重叠。即为重复上传任务,不支持上传

同一个小程序,上传相似标题、相同页面地址的任务,会审核不通过

task_settle_type

number

body

结算方式,类型包含:

1-广告分成

2-支付交易CPS







支付CPS必须接入小程序担保交易,且需另外配置最长可退款时间和分佣比例

appid

string

body

小程序的appid,需要app的类型为小程序



start_page

string

body

小程序页面地址,包含path和query,path不得以 "/" 开头


示例:page/detail/detail?id=1

anchor_title

string

body

上传的锚点标题,最多14个字



task_icon

string

body

尺寸为512*512的当前任务图标,大小不超过200KB,支持PNG,JPG格式

不允许出现留边的情况,图片必须铺满









task_start_time

number

body

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



task_end_time

number

body

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



task_desc

string

body

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
















举例

1.产品介绍:该产品是一个XX类型的小程序,可以XXX。

2.达人视频内需添加与小程序页面相关的内容,杜绝生硬植入。

3.达人视频内容表现积极向上,禁止出现恶俗、违背公序良俗类内容或品牌负面

4.视频原创,拒绝拼接,搬运,虚假骗互动内容。

注意:

任务台的方案 只能计算小程序内收入,如果是iOS虚拟支付的,走了小店的那部分无法计费,需要开发者在产品说明中明确写出来

如:

请注意:该小程序内iOS端的订单收入不计入分成收入,仅计算安卓端订单收入。

refer_videos

string[]

body

示例视频

1-5个,校验是可以打开的视频,如被删除或其他原因则不展示

会审核视频内容、视频锚点与任务的相关性,低质/无意义/录屏/不含小程序锚点会审核不通过








从移动端复制视频链接,正确格式为:https//v.Douyin.com /xxxxx

视频需包含任务对应的小程序锚点!

task_tags

string[]

body

任务标签

开发者勾选两个维度的标签:形态+内容,成为数组的两个元素


见标任务标签字段说明

必须按表里的填,不要自己命名!

refer_ma_captures

string[]

body

小程序截图

小程序对应页面截图2张,单个截图大小上限为2M









refer_video_captures

string[]

body

小程序锚点截图

视频带该小程序锚点的截图1张,单个截图大小上限为2M









refer_gids

number[]

body

视频的gid数组



task_refund_period

number

body

当结算方式是支付CPS的时候必填,任务最大退款周期,仅在task_settle_type为2时填写,广告分成任务不用填


不超过10天,不少于0天

payment_allocate_ratio

number

body

当结算方式是支付CPS的时候必填,百分号整数类型(仅支持整数),仅在task_settle_type为2时填写。广告分成任务不用填


90(代表90%),范围为[1,99]

请求示例

curl --location --request POST 'https://developer.toutiao.com/api/apps/taskbox/add_task' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
        "task_name":"测试12333",
        "access_token":"xxxx",
        "task_settle_type":1,
        "appid":"tt933ee5830c062fa6",
        "start_page":"xxx",
        "anchor_title":"测试锚点标",
        "task_icon":"https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fpic.soutu123.cn%2Felement_origin_min_pic%2F01%2F35%2F26%2F55573bdad4cb2f4.jpg%21%2Ffw%2F700%2Fquality%2F90%2Funsharp%2Ftrue%2Fcompress%2Ftrue&refer=http%3A%2F%2Fpic.soutu123.cn&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1621156196&t=848be9cae3f5bfb86a12d5021cbf9c1f",
        "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"],
        "refer_video_captures":["https://static.runoob.com/images/demo/demo3.jpg"]
}'

响应参数

名称

类型

描述

error

number

错误码,0 是成功,其它为异常

message

string

成功为"success", 错误为具体 message

task_id

string

任务 ID

响应示例

正确响应:

{
  "message": "success",
  "error": 0,
  "data": {
    "task_id": "12848125"
  }
}

错误响应:

{
  "message": "ErrNo_CPSSettlement",
  "error": 5401,
  "data": {}
}

注意事项

  • 发布的参考视频一定要挂任务对应的小程序锚点
  • 落地页的启动路径不得以 "/" 开头
  • 任务描述的换行符注意要匹配清晰 开发者上传示例:

错误码

当请求失败时,会返回非 0 的 error,错误信息会携带在 message 中,错误码含义如下:

Code

描述

0

请求操作成功

5401

没有支付分成比例或者最大退款周期

5402

参考视频截图数量不合法

5403

小程序落地页参考视频截图数量不合法

5404

任务描述长度不合法

5405

任务开始与结束时间必须大于 30 天

5406

小程序落地页截图数量不合法

5408

锚点标题长度不合法

5409

任务标签长度不合法

5410

任务名称长度不合法

5411

传入的 appid 不是小程序

5412

最大退款周期不合法

5413

支付分成比例不合法

5414

传入图片的宽高不合法

5415

图片大小不合法

5416

无效的图片链接

5417

任务 id 传入的数量太多

5418

找不到对应的小程序

5419

找不到 gid 列表

5420

gid 找不到对应的视频

5421

gid 数量过多

5422

超时相关的问题

5423

没有支付分成比例或者最大退款周期

5424

找不到相应的结算模式

5425

非法视频,请检查视频

5426

重复任务

5427

该小程序已经达到当天上传任务的次数限制

5428

图片解析错误

5429

当前小程序无配置,请联系相关人员添加任务相关配置

5430

当前小程序无短视频挂载能力

5431

当日灰度名额已满

5432

未满足达到发布此类任务门槛

5433

小程序未开启任务台

5434

小程序已加任务台黑名单

5435

小程序已下架

5436

小程序已经开启任务台

5437

小程序类别限制

5438

小程序未上线

点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助