• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 登录
  • 用户信息
  • 广告
  • 支付
  • 分享
  • 小程序跳转
  • 抖音视频能力
  • 收货地址
  • 设置
  • 授权
  • 评价能力
  • 数据分析
  • 视频拍摄器
  • 引导关注
  • 订阅消息
  • 电商插件能力(即将废弃)
  • AI/AR能力
  • 转发和挂载
  • 直播能力
  • 流量来源识别
  • tt.getAnalysisInfo
  • 侧边栏能力
  • 隐私信息授权
  • web化
  • 安全能力
  • 行业开放
  • 第三方平台
  • 其它
  • tt.getAnalysisInfo
    收藏
    我的收藏

    基础库 2.99.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。,这是一个异步方法。

    获取视频、直播、个人页场景下,用户访问来源的主播/作者的抖音账号、视频、直播间标识等信息。

    范围

    小程序的品牌号员工号

    描述

    当用户从“品牌号、员工号”的抖音视频/直播间/个人页场景进入小程序时,开发者可以获取到用户访问来源的标识:

    • 作者/主播的抖音号
    • 作者/主播在小程序里的 openId
    • 视频/直播间 id

    注意:非“品牌号、员工号”的视频/直播场景进入时,会调用失败。

    前提条件
    业务背景
    使用限制
    注意事项

    真机可使用彩蛋页进行调试。

    IDE 模拟器调试可使用“归因”工具模拟返回信息。

    支持沙盒
    相关教程

    语法

    tt.getAnalysisInfo(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    successfunction
    接口调用成功的回调函数
    2.99.0
    failfunction
    接口调用失败的回调函数
    2.99.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    2.99.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    typenumber

    场景类型:

    1:短视频,包含短视频锚点、短视频评论区锚点

    2:直播间,包含直播间小雪花、讲解卡、小程序优惠券

    3:个人页-服务 tab

    4:个人页挂载

    6: 群聊活动场景,分享时传入了group_activity_id参数

    2.99.0
    errMsgstring
    "getAnalysisInfo:ok"
    2.99.0
    roomIdstring

    直播间 id

    仅在直播间场景、个人页-服务 tab 返回,否则为空

    2.99.0
    anchorIdstring

    主播 openId

    仅在直播间场景返回,否则为空

    2.99.0
    postIdstring

    作者 openId

    仅在视频场景、个人页-服务 tab个人页挂载 3 个场景返回,否则为空

    2.99.0
    itemIdstring

    加密视频 id

    仅在视频场景返回,否则为空

    2.99.0
    uniqueIdstring

    主播/作者的抖音号

    2.99.0
    group_activity_idstring

    群聊分享传入的参数,透传

    仅在群聊场景返回,否则为空

    2.99.0
    group_idstring

    群聊id,从群聊打开的小程序对应的群聊id

    仅在群聊场景返回,否则为空

    2.99.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "getAnalysisInfo:fail" + 详细错误信息
    2.99.0

    errMsg 参数说明

    errMsg

    说明

    最低支持版本

    not support

    不支持的能力

    2.99.0

    type is undefined

    不支持的场景

    2.99.0

    awemeId not support

    对应场景入口的抖音号不在品牌号员工号范畴

    3.19.0

    request failed

    服务端请求失败

    2.99.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    171904getAnalysisInfo:fail aweme_id not supportD
    抖音号未绑定bc

    检查抖音号bc关系

    2.99.0
    171901getAnalysisInfo:fail type is undefinedD
    type未定义

    在正确的场景调用

    2.99.0
    171905getAnalysisInfo:fail request failed,Code:28005007,Message:该小程序不支持IM场景D
    不支持im场景

    当前小程序不支持im场景

    2.99.0
    171902getAnalysisInfo:fail request failed,Code:%d,Message:%sF
    小程序框架内部错误,有需要请创建工单咨询
    2.99.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例