teleads-traffic-exchange v0.0.7

TeleadsTrafficExchange SDK

TeleadsTrafficExchange SDK 是一个用于跟踪网站流量和用户行为的轻量级工具。

安装

使用 npm 安装 SDK：

npm install teleads-traffic-exchange

使用方法

1. 加载 SDK

在您的 JavaScript 或 TypeScript 文件中导入 SDK：

import {initialize, track, identify } from 'teleads-traffic-exchange';

2. 初始化

在您的应用程序启动时，使用您的网站 ID 初始化 SDK：

initialize('YOUR_WEBSITE_ID', 'https://your-server.com')
.then(() => {
console.log('TeleadsTrafficExchange SDK 加载成功');
})
.catch((error) => {
console.error('TeleadsTrafficExchange SDK 加载失败:', error);
});

3. 跟踪事件

使用 track 函数来跟踪自定义事件：

track('button_click', { buttonId: 'submit-form' });

4. 识别用户

使用 identify 函数来设置用户属性：

identify({ userId: '12345', email: 'user@example.com' });

API 参考

initialize(websiteId: string, src?: string): Promise <void>

初始化 SDK 并加载脚本。

• websiteId: 您的网站 ID
• src: 脚本的源 URL（可选，默认为 'https://umami.0-to-inf.com'）

track(eventName: string, eventData?: any): void

跟踪自定义事件。

• eventName: 事件名称
• eventData: 与事件相关的可选数据

identify(userData: object): void

设置用户属性。

• userData: 包含用户属性的对象

在浏览器中使用

如果您直接在浏览器中使用 SDK，可以通过全局对象 window.TeleadsTrafficExchange 访问所有功能：

<script src="https://mini-exchange.teleads.ai/js/teleads-traffic-exchange.js"></script>
<script>
window.TeleadsTrafficExchange.initialize('YOUR_WEBSITE_ID')
.then(() => {
console.log('SDK 加载成功');
window.TeleadsTrafficExchange.track('page_view');
});
</script>