小程序指南

小程序介绍

产品定位

字节小程序是基于字节跳动全产品矩阵开发,不需用户进行下载,即点即用的全新应用。

内容分发

小程序由于无需下载、实现简单等属性,与图文、视频等场景有着天然的搭配性。字节跳动全产品矩阵以内容分发为核心,能够通过内容带动小程序分发,由内容为小程序带量以及裂变。

方便快捷

相较于 APP,小程序开发周期短,开发成本低等特性让更多的开发者能够轻松、快速的参与到开发过程中,实现快速上线,快速起量。

小程序接入流程

注册账号

开发者平台中点击右上角的【快捷登录】进行帐号注册。

注册帐号成功后,系统会自动提示进行小程序申请。点击自动弹出的【申请】按钮,即可进入小程序申请页面。(若此次未申请,之后可通过页面中的【进入开发者平台】进入)

在该页面的【选择类型】条目下选择【小程序】类型,后续内容根据具体情况各自补充。

切记: 注册后该账号就是后续提交小程序的账号,手机号等信息请如实填写

需注意:

1)在必填信息中, 申请注册的公司主体信息请填写完整 ,请勿填写简称,小程序简介尽量与产品功能相关(后续可修改)

2)在选填信息中, 尽量不要空白 ,如实填写相关情况

小程序申请发出后,字节小程序将在两个工作日内通过您注册时的 手机号 以及 邮箱 给予您答复。若您收到邀请信息,说明您的产品已经通过,可以在后台进行接入。

创建小程序

再次进入开发者平台,登录您的对应帐号后点击图片中间的【进入开发者平台】,点击【创建一个小程序】

在新页面中创建小程序,并填入小程序对应的基础信息。分类请如实填写,将影响小游戏的推荐精准度。

请如实填写相关信息, 注:小程序服务类型请如实填写,相对应的类型需上传不同的服务资格证明

小程序资质信息,对于企业开发者,必须提交管理员姓名、身份证号、身份证照片、企业名、统一社会信用代码、企业执照照片

填写完成后,系统会自动发验证码至申请该帐号的手机号上,输入后来到管理后台。

添加协作者/管理员


进入协作栏,点击添加按钮即可添加管理员/协作者,点击添加之后会出现邀请页面,没有注册过的用户可通过邮箱邀请,通过以下权限管理选择给其添加的权限,点击完成则添加成功,受邀者邮箱会收到信息,从邮箱点击进行操作即可。

获取 Appid、AppSecret

  • 登录头条开发者平台 —— 选择需要获得的小程序;进入对应的小程序【开发】栏——选择开发;

设置服务器域名

进入小程序页面,点击开发栏,即可看到服务器域名配置区域

  1. request 合法域名
  2. socket 合法域名
  3. uploadFile 合法域名
  4. downloadFile 合法域名

企业资质的开发者可以开通 webview 域名「必须通过域名校验

开通支付

登录开发者平台,进入小程序详情页,点击【支付】,企业资质通过后可申请开通支付。

审核流程

登录开发者平台,进入小程序详情页,点击【发布】,选择【测试版本】中的【更新】按钮,填写当前版本信息并上传三张小程序内容截图、zip 格式的小程序应用包,点击【确认】后进行编译。 版本号应符合字节跳动小程序 字节跳动小程序运营审核规范

在平台或 IDE 上完成上传后,可以在小程序详情页的【开发】中查看到上传的测试版本。当测试完成,小程序的功能和体验都较为完整,选择要提审的测试版本,点击【提审】,即可提交版本信息及小程序内容,审核将会在 1-2 个工作日完成。

可以在【审核版本】中看到正在审核的小程序版本及审核状态,若审核不通过,会显示未通过原因「蓝字为相关截屏和截图信息」。审核状态显示通过后,方可发布小程序上线。

重点:

具体接入文档参照字节跳动小程序技术接入文档:小程序开发文档

上传程序包成功后即可开始调试,调试完成后,开发者点击 提审 ,即进入审核流程。

特别提醒:小程序在提审前会有自测环节,为了保证通过率,请开发者提审前通过自测环节进行自查。

在审核过程中,开发者请遵循后台中的提示进行操作补全对应信息。

审核通过后,发布按钮亮起,开发者点击发布,小程序即可入线上版本。

重点:小程序首次上线前的审核都需进行 qa 回归,预计在 1-2 个工作日

当小程序提审后,务必于后台配置"安全域名",不然将影响小程序上线。安全域名必须为 https://

目前的审核是基于双端审核,即头条端和抖音端,若只需上线一端,请在更新日志中备注清楚,方便加快审核速度。

设置搜索关键词与分享

当发布未配置搜索关键词与分享内容版本时,会弹出提示与跳转地址,点击【前往配置】。

如果已有搜索关键词和分享内容,想要查看或进行修改,可以在小程序详情页中的【设置】进行相应的配置。 配置搜索关键词:提交的搜索关键词应符合 小程序关键词搜索

通过审核并且配置过搜索关键词与分享内容的版本,在【审核版本】中点击发布即可将小程序发布至线上。

可以在小程序列表中看到相应小程序线上的版本号。

真机调试

请直接使用小程序开发者工具,最新版下载地址:开发者工具下载

有问题请在论坛中查询及反馈:字节跳动开放社区

调试流程

当小程序更新完成后,将会生成对应的二维码;

  1. 手机重新安装今日头条线上最新版,kill 掉进程重启,打开 App 左右滑动 tab 页,正常浏览 app 几秒。

  2. 使用安装测试 App 的手机扫码(测试某个应用,则使用对应的应用扫码),扫码后 Android 下使用 Chrome、iOS 使用 Safair 打开对应网址,点击打开小程序即可唤起,请务必使用 Chorme 和 Safair ,不然不能正常唤起;

  3. 如果打不开小程序,请 kill 掉进程,重启 app 再试一次,若还有问题,请去开放社区反馈;

  4. 如果显示 App 版本不支持建议确认 App 版本,手机内是否有多个头条 App。建议全部卸载后重新安装

  5. 如果提示系统版本不支持,检查手机系统版本,安卓大于等于 5.0,iOS 高于 9.0;

登录 & 获取用户信息

  1. 如果需要获取用户信息(getUserinfo 文档:获取已登录用户的相关信息),调用之前那请务必使用 login(文档:获取临时登录凭证);

  2. 由于头条用户存在未登录情况,所以使用 login 及 getUserinfo,需要兼容未登录用户的情况,避免出现未登录用户反复弹出登录框,不能进入小程序的情况;

  3. 以及请依据你的小程序设计需要来合理选择是否调用获取 getUserinfo ;

初次的上线流程如图:

目前审核都将进行双端测试,分别是头条端(安卓,IOS),抖音端(仅安卓),请务必在提审前参照后台的自测选项在双端进行自测,审核通过后请点击发布按钮发布上线,审核周期预计 1-2 个工作日;

注:若只需测试一端,请在更新日志中备注,可加快审核速度

部分功能接入说明:(详见开发者文档)

  1. 内容安全检测(有评论等功能的小程序开发者请重视)

  2. 小程序内录屏功能(可参考录屏分享参考规范)

  3. 游客登录功能(开场调用登录行为时,force 传 false 将不会调起登录框)

后续小程序接入

已经有小程序通过审核的开发者,后续小程序的接入直接在后台创建并上传即可。当一个账号的创建名额满后,申请新帐号需重走后台申请流程。

小程序注意事项

小程序质量规范

小程序流量入口

名词解释:

  1. 隶属功能入口:所填写的功能在哪个入口能看到?例如:搜索入口、feed 流、小程序中心等;

  2. 功能说明介绍:所填写的功能的端上截图+功能描述。截图可以多张,体现出操作步骤;功能描述中需要包括:

    • 功能以用户的角度如何操作找到;
  3. 功能获取方式:所填写的功能开发者如何获取,例如:需要配置 or 需要申请 or 自动生效。

    • 需要配置:需要说明配置需要填写哪些内容,并且需要说明配置时候是否有前置条件,例如:

      • 无需前置条件

      • 需要前置条件:小程序需要发布上线;XXXX 功能需先开通;

    • 需要申请:需要说明申请时填写的信息,例如:feed 需要提供:内容形式、每日可上传数量等

    • 自动生效:无需配置申请,小程序上线后直接生效

  4. 文档链接说明:所填写的功能或者功能涉及的接口的文档链接地址。

1.自然搜索结果:

隶属功能入口:

搜索入口

功能说明介绍:

截图:

说明:

小程序通过审核,并发布上线后,可以在 自然搜索结果 中获得展示。

当小程序名称或配置的搜索标签词被用户检索到,会根据算法匹配,在搜索结果里展示相应的小程序用户可以点击该条搜索结果,直接打开小程序。

功能获取方式:

小程序名称搜索结果自动获取。

搜索标签词需要进行配置,配置地址:点击配置;配置内容:标签词文字。

需要前置条件:小程序需发布上线。

文档链接说明:

点击查看搜索标签词配置规范及说明

2.我的小程序

隶属功能入口:

我的-小程序

功能说明介绍:

截图:

说明:

小程序通过审核,并发布上线后,可以在 我的小程序 搜索结果中获得展示。

当小程序名称及近似名称被用户检索到,会根据算法匹配,在 搜索结果 里展示相应的小程序。

小程序通过审核,并发布上线后,将有运营进行多维度的筛选,通过筛选的游戏将获得 首屏 banner、大家都在用、编辑精选、新品速递 数个展示位。

小程序通过审核,并发布上线后,将通过算法对游戏进行排序,在 猜你喜欢 展示算法对游戏的排序结果。

功能获取方式:

小程序名称搜索结果自动获取。

需要前置条件:小程序需发布上线。

文档链接说明:

3.搜索面板的头条小程序

隶属功能入口:

搜索面板-头条小程序

功能说明介绍:

截图:

说明:

小程序通过审核,并发布上线后,将根据用户的使用顺序,由近及远的于 竖杠前 排序。

小程序通过审核,并发布上线后,将通过算法对小程序进行排序,排序的小程序将在 竖杠后 展现。

功能获取方式:

运营配置

需要前置条件:小程序需发布上线

文档链接说明:

4.feed 流推荐卡片位置

隶属功能入口:

头条 feed 流

功能说明介绍:

截图:

说明:

小程序通过审核,并发布上线后,可将小程序中的内容分发至头条 feed 流中展示。

注:想要该场景需通过邮箱进行申请:申请邮箱

包括但不限于的标准:

  1. 小程序功能完备

  2. 无用户体验 bug,

  3. 小程序具备内容

功能获取方式:

算法筛选

需要前置条件:小程序需发布上线,于开发者后台-流量-推广卡片中上传图片并审核通过

文档链接说明:

5.文章详情页入口

隶属功能入口:

头条号

功能说明介绍:

截图:

说明:

小程序通过审核,并发布上线后,相关官号或合作 kol 可自行再文章中插入小程序卡片,卡片共分为两种样式,一是普通样式,二是图文样式。

功能获取方式:

文章中插入小程序卡片有以下两种获取方式:

1.插入小程序首先需要绑定小程序,后可自行在发布文章时进行插入:

  • 创作者可通过头条号后台「今日头条-功能实验室-小程序」进入小程序管理页;
  • 点击右上角「新增绑定」,输入正确的头条小程序 ID 后,点击「确定绑定」;
  • 经小程序开发者和平台审核通过后,绑定成功。

    绑定成功后,创作者可在头条号后台「图文-发表文章」页面,点击编辑器菜单栏的「插入小程序」,选择已绑定的小程序插入;点击「高级设置」,即可修改小程序的介绍文案、设置落地地址。

2.通过机器自动插入:将头条号 mid、小程序 appid 发送至邮件组 bytedance_microapp@bytedance.com,说明许可将该头条号发布的所有文章都自动在文末加上小程序卡片,经审核后配置。

文档链接说明:

https://www.toutiao.com/i6692697263837282823/

6.个人主页入口

隶属功能入口:

头条号

功能说明介绍:

截图:

功能获取方式:

1.需要先进行绑定,操作路径与文章相同:

  • 创作者可通过头条号后台「今日头条-功能实验室-小程序」进入小程序管理页;
  • 点击右上角「新增绑定」,输入正确的头条小程序 ID 后,点击「确定绑定」;
  • 经小程序开发者和平台审核通过后,绑定成功。

2.绑定成功后,创作者可在头条号后台「个人中心 - 帐号设置 - 自定义菜单」页面,选择「选择小程序」,并设置落地地址。

文档链接说明:

https://www.toutiao.com/i6692697263837282823/

7.微头条入口

隶属功能入口:

微头条

使用范围:

小程序&小游戏通用

功能说明介绍:

截图:

说明:
微头条有以上两种样式:一是直接分享微头条卡片,二是通过小程序内的「发头条」入口发布,点击可进入.

功能获取方式:

该入口为自然入口,在小程序发布上线后即可使用,点击右上方按钮,选择分享/发头条,即可编辑内容并发布。

文档链接说明: