抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 开发教程与代码示例
  • 入门
  • 小程序框架
  • 小程序运行时
  • 自定义组件
  • 基础教程
  • 能力教程
  • 流量入口
  • 通用能力
  • 推广变现
  • 接入线索组件
  • 接入广告能力
  • 经营能力
  • 行业能力
  • AI/AR 能力
  • 性能优化
  • 安全
  • 接入线索组件

    收藏
    我的收藏

    背景知识

    能力介绍

    线索组件是抖音开放平台提供给线索类小程序的核心经营能力,帮助经营者高效获取手机号等线索,提升流量分发精准性。通过接入线索组件可实现。
      进阶能力获取基础库 3.3.0 及之后版本,获得线索组件权限的小程序可在 form 表单中无门槛使用获取手机号能力(进阶能力)。
      分发扶持:帮助经营者将服务类目、服务区域等信息透传给抖音开放平台,从而帮助小程序在直播等场景获得更精准的流量分发,提升线索获取效率。
      数据披露:接入线索组件后,线索相关的详细业务数据可在后台分析统计、可通过接口获取,包括从视频/直播观看量到线索量中的层层数据漏斗,并实现线索量归因、直播间实时展现。
      权益挂钩:抖音开放平台对线索类小程序的权益激励,均与通过线索组件获取的线索量挂钩。

    准入条件

    线上类目包括线索类目的小程序均可接入线索组件,建议在小程序上线前将线索组件接入完成。

    分发扶持

    将接入线索组件的小程序挂载在直播间,抖音开放平台通过感知经营者提供的信息,辅助直播间流量精准分发。挂载页面(即用户点击小雪花/讲解卡进入的页面)推荐为包含 form 组件的留资页面,缩短用户留资步长从而提升效率,挂载步骤详见绑定抖音号直播挂载

    数据披露

    数据查看路径为控制台-数据-能力-留资分发配置,可得数据包括:
    数据
    示意图
    线索组件整体使用情况
    组件交互与线索的流量来源
    短视频与直播间的线索转化详情
    不同线索业务的线索转化详情

    线索组件开放类目

    一级类目
    二级类目
    三级类目
    线索组件接入要求
    汽车
    二手车
    二手车线下零售
    汽车
    二手车
    二手车服务平台
    政务
    政务民生
    人力资源
    政务
    政务民生
    教育
    IT 科技
    IT 科技
    虚拟运营商及代理商
    IT 科技
    IT 科技
    基础电信运营商
    IT 科技
    IT 科技
    电信业务代理商
    IT 科技
    IT 科技
    软件服务提供商
    金融
    金融业
    股票信息服务平台
    金融
    金融业
    新三板信息服务平台
    金融
    金融业
    保险中介公司
    金融
    金融业
    保险公司
    金融
    金融业
    公募基金
    金融
    金融业
    私募基金
    金融
    金融业
    信托
    金融
    金融业
    银行
    商业服务
    商业服务
    工业品供应商
    商业服务
    商业服务
    出国移民
    商业服务
    商业服务
    工商/税务/财务代理
    商业服务
    商业服务
    一般财务服务
    商业服务
    商业服务
    农林牧渔
    商业服务
    商业服务
    公共印章刻制
    商业服务
    商业服务
    典当
    商业服务
    商业服务
    亲子/司法鉴定
    商业服务
    商业服务
    司法拍卖
    商业服务
    商业服务
    文物拍卖公司
    商业服务
    商业服务
    拍卖公司(非文物)
    商业服务
    商业服务
    会展服务
    商业服务
    商业服务
    广告/设计
    商业服务
    商业服务
    法律服务
    商业服务
    商业服务
    第三方人力资源服务
    必接
    商业服务
    商业服务
    税务师事务所
    商业服务
    商业服务
    会计师事务所
    商业服务
    商业服务
    专利/商标代理
    商业服务
    商业服务
    招聘/求职(中介)
    必接
    商业服务
    商业服务
    公证
    商业服务
    商业服务
    律师事务所
    商业服务
    商业服务
    企业自招工
    房地产
    房地产
    房地产资讯
    房地产
    房地产
    商品房预售
    房地产
    房地产
    房地产开发商
    房地产
    房地产
    房屋中介

    准备工作

    接入流程

    操作步骤
    示意图
    说明
      1.申请开通能力
    申请路径:控制台-能力-页面及信息-用户能力-线索组件
      2.配置线索组件
    一个线索组件对应一个具体的线索业务(区域及类目),配置完成后获取组件 ID
      3.实现前端页面
      1.调用 form表单组件实现小程序线索页面设计。
      2.在 form 表单组件中设置线索组件 ID线索组件基础用法
      3.调用获取手机号开放能力快速获取线索。
    注意
    获取手机号能力仅支持在配置线索组件 ID 的 form 表单页面使用。
      4.联调测试
    非必要环节,但建议联调,通过联调可以确认线索组件可用、数据上报无误

    代码示例

    相关的组件能力

    form 表单

    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    conversion-target
    number
    0
    用于分发目的。取值:0 或 1,其中 0 表示默认,1 表示留资目标,需要和线索组件一起使用,详情见线索组件配置
    2.88.0
    clue-component-id
    string
    ""
    用于分发目的。开发者在【小程序开发者后台 -> 进入目标小程序 -> 能力 -> 用户数据能力 -> 身份数据 -> 线索组件】申请能力后复制创建的配置 ID,需要和线索组件一起使用,详情见线索组件配置
    2.88.0
    bindsubmit
    EventHandle
    携带 form 中的数据触发 submit 事件,event.detail = {value : {'name': 'value'} , ...}。
    1.0.0
    bindreset
    EventHandle
    表单重置时会触发 reset 事件。
    1.0.0

    button 按钮

    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    form-type
    string
    用于嵌在 form 组件中,控制 submit/reset,详情见 form-type 的合法值
    1.0.0
    open-type
    string
    用于调用开放能力, 详情见 open-type 的合法值
    1.0.0
    bindgetphonenumber
    EventHandle
    获取用户手机号回调,只在 open-type="getPhoneNumber" 时有效
    1.14.0

    其他表单组件能力

    其他表单组件能力可参考文档进行使用。

    代码示例

    线索组件基础用法

    需要在 form 组件中配置 clueComponentId 和 conversionTarget 属性值,其中 clueComponentId 是在小程序后台创建的线索组件 id(给某个小程序创建的线索组件 id ,只能用于此小程序),conversionTarget 需要设置为 1。
    <!-- .ttml --> <form bindsubmit="formSubmit" bindreset="formReset" clue-component-id="{{clueComponentId}}" conversion-target="{{conversionTarget}}" > <!-- 这里可以根据需要来使用表单组件 --> <slider name="slider" value="50" show-value></slider> <switch name="switch1" /> <switch name="switch2" checked="checked" /> <button open-type="getPhoneNumber" bindgetphonenumber="getPhoneNumber"> getPhoneNumber </button> <button type="primary" form-type="submit">提交</button> <button form-type="reset">重设</button> </form>
    // .js Page({ data: { clueComponentId: "xxx", // 这里填写创建的线索组件id conversionTarget: 1, }, formSubmit(e) { console.log("formSubmit: ", e.detail); tt.showToast({ title: "提交", icon: "success", }); }, formReset() { console.log("formReset"); }, getPhoneNumber(e) { console.log(`getPhoneNumber success: `, e); }, });

    只有一个 openType="getPhoneNumber" button 的使用方式

    需要在 form 组件中配置 conversion-target 值为 1 和 clueComponentId 的属性值,同时 form 内部的 button 需要同时设置 formType="submit" 和 open-type="getPhoneNumber",其中 clueComponentId 是在小程序后台创建的线索组件 id,给某个小程序创建的线索组件 id ,只能用于此小程序。
    <!-- .ttml --> <form bindsubmit="formSubmit" bindreset="formReset" clue-component-id="{{clueComponentId}}" conversion-target="{{conversionTarget}}" > <button form-type="submit" open-type="getPhoneNumber" bindgetphonenumber="getPhoneNumber" > getPhoneNumber </button> </form>
    // .js Page({ data: { clueComponentId: "xxx", // 这里填写创建的线索组件id conversionTarget: 1, }, formSubmit(e) { console.log("formSubmit: ", e.detail); tt.showToast({ title: "提交", icon: "success", }); }, formReset() { console.log("formReset"); }, getPhoneNumber(e) { console.log(`getPhoneNumber success: `, e); }, });

    异步获取到 clueComponentId 后再使用

    需要在 form 组件中配置 conversion-target 值为 1,通过 tt:if 控制 form 组件的渲染,保证在渲染前设置好正确的 clueComponentId。clueComponentId 是在小程序后台创建的线索组件 id,给某个小程序创建的线索组件 id ,只能用于此小程序。
    <!-- .ttml --> <form tt:if="{{clueComponentId}}" conversion-target="{{conversionTarget}}" clue-component-id="{{clueComponentId}}" > <button formType="submit" open-type="getPhoneNumber" bindgetphonenumber="getPhoneNumber" > getPhoneNumber </button> </form>
    // .js Page({ data: { conversionTarget: 1, clueComponentId: undefined, }, async onLoad() { // 这里调用接口获取 clueComponentId,然后通过 setData 设置 const clueComponentId = await this.getClueComponentId(); this.setData({ clueComponentId }); }, getClueComponentId() { return new Promise((resolve) => { setTimeout(() => { resolve("xxxxx"); }, 2000); }); }, getPhoneNumber(e) { console.log(e); }, });

    注意事项

      只支持用「抖音」app 联调。
      若联调时出现有「点击」或「留资」事件,但是没有「曝光」事件,可重启抖音再联调试试看。
      需要在线索组件渲染前就设置好 clue-component-idconversion-target,线索组件渲染完之后再通过 setData 去设置,会影响线索组件的曝光、点击、留资行为上报。
      联调是提供给开发者去检测线索组件的使用方式是否正确。只要使用方式正确,不完成联调和激活,线索组件的曝光、点击、留资行为也能正常上报。