Skip to content

Web 追踪器 SDK 参考 ​

在 SDK 加载并初始化后使用本参考。先注册,再按发生顺序追踪下游动作,以便更清晰的归因。

事件上报 API ​

trackRegister ​

绑定首个唯一用户标识符;之后所有事件将关联到此账户。

js
tracker.trackRegister('user_123', {
  identifier: 'hashed_email_or_phone'
});
参数类型必填说明
user_idstring是唯一用户 ID。
identifierstring否用于去重的哈希邮箱或手机号。

trackDeposit ​

记录资金流入,用于转化和风险分析。

js
tracker.trackDeposit('user_123', {
  currency: 'USDT',
  network: 'TRON',
  amount: 100
});
参数类型必填说明
user_idstring是唯一用户 ID。
currencystring是货币代码,如 USDT。
networkstring是支付通道或链,如 TRON。
amountnumber是金额。

trackEnterGame ​

捕获用户开始核心体验(游戏或关键流程)时。

js
tracker.trackEnterGame('user_123', {
  currency: 'USDT',
  game_provider: 'provider_xyz',
  game_id: 'gamer_123',
  game_name: 'My Awesome Game'
});
参数类型必填说明
user_idstring是唯一用户 ID。
currencystring是所选面额。
game_providerstring是提供商或合作伙伴名称。
game_idstring是内部游戏或功能 ID。
game_namestring是游戏或体验显示名称。

trackLogin ​

确认回访用户并继续同一账户会话。

js
tracker.trackLogin('user_123');
参数类型必填说明
user_idstring是唯一用户 ID。

trackDownloadClick ​

标记用户从页面触发下载或跳转应用商店时。

js
tracker.trackDownloadClick('user_123', {
  store_type: 'App Store'
});
参数类型必填说明
user_idstring否唯一用户 ID。
store_typestring否下载渠道,如 App Store 或 Play Store。
targetstring否本次点击把用户带去哪里,如 af(AppsFlyer 点击链接)或 fallback(你自己的商店/落地链接),便于与 MMP 的点击数对账。未传则事件中不含该字段。需 SDK 1.4.5 及以上。

trackDownloadClickRegister ​

标记用户在注册流程中触发下载或跳转应用商店时。

js
tracker.trackDownloadClickRegister('user_123', {
  store_type: 'App Store',
  identifier: 'hashed_email_or_phone'
});
参数类型必填说明
user_idstring否唯一用户 ID。
store_typestring否下载渠道,如 App Store 或 Play Store。
identifierstring否哈希后的邮箱或电话号码。
targetstring否本次点击把用户带去哪里,如 af(AppsFlyer 点击链接)或 fallback(你自己的商店/落地链接),便于与 MMP 的点击数对账。未传则事件中不含该字段。需 SDK 1.4.5 及以上。

trackCustomEvent ​

添加业务特定事件,如任务完成或物品购买。

js
tracker.trackCustomEvent('custom_event_type', {
  event_detail: 'value'
});
参数类型必填说明
event_typestring是自定义事件名称。
payloadobject否事件的键值对载荷。

工具参考 ​

getClickid() ​

返回 UTM 数据中存储的 clickid。若 URL 包含 ?clickid=...,SDK 会自动提取并保存。

点击 ID 保存在第一方 cookie 中,有效期 30 天,与归因窗口一致。在 iOS / Safari 上,受 ITP 限制,它可能更早被清除。请在用户注册时调用此方法,并把返回值保存到该用户的记录上 —— 参见在注册时保存点击 ID。

js
const clickid = tracker.getClickid();
if (clickid) {
  console.log('Click ID:', clickid);
}

返回:string | null

getVersion() ​

返回当前 SDK 版本字符串。

js
const version = tracker.getVersion();
console.log('SDK Version:', version);

返回:string