神策数据官方 Web JavaScript 埋点 SDK 使用教程

1. 项目的目录结构及介绍

sa-sdk-javascript/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── dist/
│   ├── heatmap.min.js
│   ├── sensorsdata.amd.min.js
│   ├── sensorsdata.es6.min.js
│   ├── sensorsdata.min.d.ts
│   ├── sensorsdata.min.js
│   ├── vapph5define.min.js
│   ├── version.js
│   └── vtrack.min.js
├── package.json
└── src/
    ├── core/
    ├── heatmap/
    ├── sensorsdata.js
    └── vtrack/

目录结构说明

• CHANGELOG.md: 记录项目的更新日志。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• dist/: 存放编译后的 JavaScript 文件，包括不同模块化的版本（如 AMD、ES6 等）以及热力图和触达图的实现文件。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• src/: 源代码目录，包含核心逻辑、热力图实现、触达图实现等。

2. 项目的启动文件介绍

项目的启动文件主要是 dist/sensorsdata.min.js，这是编译后的最小化 JavaScript 文件，用于在 Web 端和 H5 端进行数据采集埋点。

使用方法

在 HTML 文件中引入 sensorsdata.min.js：

<script src="path/to/sensorsdata.min.js"></script>

引入后，可以通过全局变量 sensorsAnalytics 来调用 SDK 提供的各种方法，例如初始化、埋点等。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的元数据、依赖、脚本等信息。

package.json 文件内容

{
  "name": "sa-sdk-javascript",
  "version": "1.26.3",
  "description": "神策数据官方 Web JavaScript 埋点 SDK",
  "main": "dist/sensorsdata.min.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/sensorsdata/sa-sdk-javascript.git"
  },
  "keywords": [
    "sensorsdata",
    "analytics",
    "tracking"
  ],
  "author": "Sensors Data Inc.",
  "license": "Apache-2.0",
  "bugs": {
    "url": "https://github.com/sensorsdata/sa-sdk-javascript/issues"
  },
  "homepage": "https://github.com/sensorsdata/sa-sdk-javascript#readme"
}

配置文件说明

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• main: 项目的入口文件，即 dist/sensorsdata.min.js。
• scripts: 定义了一些脚本命令，如测试命令。
• repository: 项目的 Git 仓库地址。
• keywords: 项目的关键词，便于在 npm 上搜索。
• author: 项目的作者。
• license: 项目的开源许可证。
• bugs: 项目的问题追踪地址。
• homepage: 项目的主页地址。

通过以上配置文件，可以了解项目的版本、依赖、入口文件等信息，方便开发者进行项目的构建和部署。