抖音开放平台Logo
控制台

tt.getAnalysisInfo
收藏
我的收藏

​基础库 2.99.0 开始支持本方法，低版本需做兼容处理，这是一个异步方法。 ​
获取视频、直播、个人页和 im 场景下，用户访问来源的主播/作者/发私信方/群主的抖音账号、视频、直播间标识等信息。​
范围​
小程序的品牌号、员工号、泛知识行业合作号（角色系统）​
描述​
当用户从“品牌号、员工号、泛知识行业合作号”的抖音视频/直播间/个人页/im 场景进入小程序时，开发者可以获取到用户访问来源的标识：​
    •​作者/主播/发私信方/群主的抖音号​
    •​作者/主播/发私信方/群主在小程序里的 openId ​
    •​视频/直播间 id ​
    •​私信消息 id​
    •​群 id​
​注意：非“品牌号、员工号、泛知识行业合作号”的视频/直播场景进入时，会调用失败。​
​

​语法​

JavaScript
复制
tt.getAnalysisInfo(options)
​​
​调试：暂未支持在 IDE 调试，可在彩蛋页进行调试。​
​

​参数说明​

options 为 object 类型，属性如下：​
属性名​
类型​
默认值​
必填​
说明​
最低支持版本​
success​
function​
​
否​
接口调用成功的回调函数​
2.99.0​
fail​
function​
​
否​
接口调用失败的回调函数​
2.99.0​
complete​
function​
​
否​
接口调用结束的回调函数（调用成功、失败都会执行）​
2.99.0​
​

​回调成功 ​

object 类型，属性如下： ​
属性名​
类型​
说明​
​最低支持版本 ​
​type ​
​ ​
​number ​
​ ​
场景类型： ​
1：短视频，包含短视频锚点、短视频评论区锚点​
​2.99.0 ​
​​
2：直播间，包含直播间小雪花、讲解卡、小程序优惠券​
​2.99.0 ​
3：个人页-服务 tab​
​3.12.0​
4：个人页挂载​
​3.12.0​
5：im 场景，包括私信、群聊场景​
​3.19.0​
uniqueId​
string​
主播/作者的抖音号​
​2.99.0 ​
roomId ​
​
string ​
直播间 id ​
​仅在直播间场景、个人页-服务 tab 返回，否则为空​
​2.99.0 ​
anchorId ​
string ​
主播 openId ​
​仅在直播间场景返回，否则为空​
​2.99.0 ​
postId ​
string ​
作者 openId ​
​仅在视频场景、个人页-服务 tab 和个人页挂载 3 个场景返回，否则为空​
​2.99.0 ​
itemId ​
string ​
加密视频 id ​
​仅在视频场景返回，否则为空​
​2.99.0 ​
conversationId​
string​
群 id​
​打开小程序链路涉及 im 群聊时会返回，否则为空​
​3.19.0​
awemeId​
string​
发私信方或群主的抖音号​
​打开小程序链路涉及 im 时会返回，否则为空​
​3.19.0​
formOpenId​
string​
发私信方或群主在小程序内的 openId​
​打开小程序链路涉及 im 时会返回，否则为空​
​3.19.0​
messageId​
string​
私信消息 id​
​打开小程序链路涉及 im，且和具体消息有关时会返回​
​3.19.0​
errMsg ​
string ​
"getAnalysisInfo:ok" ​
​2.99.0 ​
​

​回调失败​

object 类型，属性如下：​
属性名​
类型​
说明​
最低支持版本​
errMsg​
string​
"getAnalysisInfo:fail" + 详细错误信息​
2.99.0​
errMsg​
说明​
最低支持版本​
not support​
不支持的能力 ​
​2.99.0 ​
type is undefined​
不支持的场景​
​2.99.0 ​
awemeId not support​
对应场景入口的抖音号不在品牌号、员工号、泛知识行业合作号范畴​
​3.19.0​
request failed​
服务端请求失败​
​2.99.0​

​扫码体验​

​代码示例​

​开发者工具中预览​
JavaScript
复制
tt.getAnalysisInfo({
success: (info) => {
console.log(info);
},
fail: () => {
tt.showToast({
title: "获取流量归因参数失败",
icon: "fail",
});
},
});
​​

​Bug & Tip​

无​