开吧天目云埋点 SDK

⚠️ 重要提示：本 SDK 基于 TypeScript 开发，所有 API 参数均带有明确的必填 / 选填类型标注。使用时请务必开启 TS 类型检查或在 IDE 中查看参数提示，必填项缺失会直接提示错误，选填项可按需传入，请勿忽略类型提示以避免使用异常。

简介

@kbapp/tmuyun-tracker 是开吧天目云埋点 SDK，用于将稿件浏览数据上报至天目云平台。

安装方式 1：npm

npm i @kbapp/tmuyun-tracker

import { TmuyunTracker, TmuyunDocModel } from '@kbapp/tmuyun-tracker'

const tmuyunTracker = new TmuyunTracker({
    enableLog: true,
    onReportSuccess(data) {
        console.log('埋点上报回调')
    },
})

安装方式 2：通过 script 标签引入

使用 unpkg CDN：

<script src="https://unpkg.com/@kbapp/tmuyun-tracker@latest/dist/umd/index.js"></script>

使用 jsdelivr CDN：

<script src="https://cdn.jsdelivr.net/npm/@kbapp/tmuyun-tracker@latest/dist/umd/index.js"></script>

通过 script 标签引入后，SDK 将作为全局变量 kbTmuyunTracker 挂载在 window 对象上

<script src="https://unpkg.com/@kbapp/tmuyun-tracker@latest/dist/umd/index.js"></script>
<script>
const { TmuyunTracker } = kbTmuyunTracker

const tmuyunTracker = new TmuyunTracker({
    enableLog: true,
})
</script>

API

report

唯一的上报方法，用于上报稿件浏览数据

参数

| 参数 | 类型 | 必填 | 说明 | | ------------- | ------------------ | ---- | ------------------------------------------------ | | docId | string | 是 | 稿件 ID | | title | string | 是 | 稿件标题 | | pubTime | string \| number | 是 | 稿件发布时间，毫秒时间戳或 YYYY-MM-DD HH:mm:ss | | tmuyunModel | TmuyunDocModel | 否 | 稿件频道模型，参考 TmuyunDocModel | | source | string | 否 | 稿件来源 | | author | string | 否 | 作者 | | ref1Id | string | 否 | 原始稿件 ID，一般用于伴随埋点 |

示例代码

import { TmuyunTracker, TmuyunDocModel } from '@kbapp/tmuyun-tracker'

const tmuyunTracker = new TmuyunTracker({
    enableLog: true,
    onReportSuccess(data) {
        console.log('埋点上报回调', data)
    },
})

tmuyunTracker.report({
    docId: 'ACTIVITY_HUB-fifa_world_cup_2026-index',
    title: '活动页-FIFA世界杯2026-首页',
    pubTime: '2023-04-01 12:00:00',
    tmuyunModel: TmuyunDocModel.ACTIVITY_HUB,
})

TmuyunTracker

天目云埋点实例类

构造参数

| 参数 | 类型 | 必填 | 说明 | | ----------------- | ------------------------------------------------------- | ---- | ------------------------ | | enableLog | boolean | 否 | 是否启用日志，默认不开启 | | onReportSuccess | (params: { params: object; tmuyunPayload: object }) => void | 否 | 触发埋点上报后的回调 |

TmuyunDocModel

省宣稿件频道模型，用于定义稿件所属频道。提供以下预置常量：

| 常量 | 说明 | | ----------------------------- | -------------- | | TmuyunDocModel.NEWS | 新闻 | | TmuyunDocModel.NEWS_NEO | 新资讯 | | TmuyunDocModel.PROGRAM | 电台广播 | | TmuyunDocModel.HOT_TOPIC | 热门专题 | | TmuyunDocModel.VIDEO_LIVE | 视频直播 | | TmuyunDocModel.HOOLO | 葫芦网 | | TmuyunDocModel.ACTIVITY | 临时活动 | | TmuyunDocModel.CIRCLE | 圈子话题 | | TmuyunDocModel.EXT | 外部稿件 | | TmuyunDocModel.REVEAL_NODE | 爆料台话题节点 | | TmuyunDocModel.REVEAL_MAIN | 爆料台首页 | | TmuyunDocModel.ACT_MIX | 混合活动 | | TmuyunDocModel.APP_MAIN_PAGE| App 主页 | | TmuyunDocModel.AUDIO_LIVE | 广播页面 | | TmuyunDocModel.NEWS_NEO_GROUP_TOPIC | 资讯专题 | | TmuyunDocModel.MALL | 商城 | | TmuyunDocModel.MINI_THEATRE | 微短剧 | | TmuyunDocModel.PLAYBACK | 节目回放 | | TmuyunDocModel.NEWS_NEO_PROGRAMME | 栏目主页 | | TmuyunDocModel.WORK_ORDER | 工单 | | TmuyunDocModel.ACTIVITY_HUB | 临时活动 | | TmuyunDocModel.ART_MAP | 艺术地图 | | TmuyunDocModel.ENROLL | 报名征集 |

也可以自定义频道模型：

import { TmuyunDocModel } from '@kbapp/tmuyun-tracker'

const customModel = new TmuyunDocModel({
    editionNumber: '10086',
    editionName: '自定义频道',
    docType: '新闻',
})

getSessionId

获取天目云 SessionId（异步方法，等待 SDK 加载完成后返回）

import { getSessionId } from '@kbapp/tmuyun-tracker'

const sessionId = await getSessionId()
console.log('SessionId:', sessionId)

getDistinctId

获取天目云 DistinctId（异步方法，等待 SDK 加载完成后返回）

import { getDistinctId } from '@kbapp/tmuyun-tracker'

const distinctId = await getDistinctId()
console.log('DistinctId:', distinctId)