**神策数据JavaScript SDK 技术文档**

神策数据JavaScript SDK 技术文档

sa-sdk-javascript 神策数据官方 Web JavaScript 埋点 SDK，是一款轻量级用于 Web 端和 H5 端的数据采集埋点 SDK。使用原生 JavaScript 技术实现代码埋点、全埋点、可视化全埋点、网页热力图和触达图等功能。 项目地址: https://gitcode.com/gh_mirrors/sa/sa-sdk-javascript

欢迎来到神策数据的sa-sdk-javascript项目技术文档。神策数据作为大数据分析行业的领航者，提供了强大的用户行为分析工具。本文档旨在指导您完成从安装到使用的整个过程，以便充分利用SDK进行数据采集与分析。

一、安装指南

NPM安装

对于Node.js环境，推荐使用npm安装最新版本的sa-sdk-javascript：

npm install sensors-analytics-js --save

或者，如果您偏好Yarn：

yarn add sensors-analytics-js

直接引入

在HTML文件中，可以直接通过CDN链接引入SDK：

<script src="https://cdn.jsdelivr.net/npm/sensors-analytics-js@latest/dist/sa.min.js"></script>

二、项目使用说明

在使用神策SDK之前，您需要先初始化一个实例：

// 初始化神策SDK实例
var sa = new SensorsAnalytics({
    appid: '您的应用ID',
    server_url: 'https://您的数据接收地址'
});

接着，您可以开始追踪用户的事件：

// 发送自定义事件
sa.track('用户注册', {
    username: 'exampleUser',
    source: 'invite-email'
});

对于页面视图跟踪，可以这样做：

// 页面浏览跟踪
sa.pageview('首页');

三、项目API使用文档

基础API

• init(appid, options) - 初始化SDK。
• track(event_name, properties) - 跟踪特定事件及其属性。
• pageview(view_name, properties) - 记录页面浏览。
• identify(user_id, traits) - 标识一个用户。
• flush() - 强制立即发送缓存中的数据。
• clearAll() - 清除所有缓存的数据。

高级特性

• 全埋点：利用SDK的全埋点功能，自动捕获页面上的大部分用户交互。
• 可视化全埋点：通过神策分析平台配置，无需代码即可实现事件捕获。

详细API文档请访问官方文档。

四、项目安装方式

上述安装指南已涵盖了主要的安装方式。根据您的应用场景，选择适合的方式进行安装。对于前端项目，推荐直接引入或使用npm/yarn管理依赖。后端或其他非Web环境请遵循Node.js包的常规使用流程。

---

请注意，每次更新SDK前应参考变更日志，以确保兼容性并了解新特性。若遇到问题，请随时联系神策数据的技术支持邮箱shengyonggen@sensorsdata.cn。希望本文档能助力您的数据驱动之路。

sa-sdk-javascript 神策数据官方 Web JavaScript 埋点 SDK，是一款轻量级用于 Web 端和 H5 端的数据采集埋点 SDK。使用原生 JavaScript 技术实现代码埋点、全埋点、可视化全埋点、网页热力图和触达图等功能。 项目地址: https://gitcode.com/gh_mirrors/sa/sa-sdk-javascript