# content-tracer-vv

> ## SDK 集成

Latest version **1.1.0-beta.15** (published 2022-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install content-tracer-vv
pnpm add content-tracer-vv
yarn add content-tracer-vv
bun add content-tracer-vv
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0-beta.15 |
| Published | 2022-06-01 |
| First published | 2022-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 585.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | fuxuewei |
| Maintainers | jereau |

## Links

- npm: https://www.npmjs.com/package/content-tracer-vv
- Homepage: http:
- npm.io page: https://npm.io/package/content-tracer-vv

## Dependencies (4)

- [dayjs](https://npm.io/package/dayjs.md) ^1.11.2
- [platform](https://npm.io/package/platform.md) ^1.3.6
- [js-cookie](https://npm.io/package/js-cookie.md) ^3.0.1
- [@types/platform](https://npm.io/package/@types/platform.md) ^1.3.4

## Recent versions

- 1.1.0-beta.15 (latest) — 2022-06-01
- 1.1.0-beta.14 — 2022-06-01
- 1.1.0-beta.13 — 2022-06-01
- 1.1.0-beta.12 — 2022-06-01
- 1.1.0-beta.10 — 2022-06-01
- 1.1.0-beta.9 — 2022-06-01
- 1.1.0-beta.8 — 2022-06-01
- 1.1.0-beta.7 — 2022-05-31
- 1.1.0-beta.6 — 2022-05-31
- 1.1.0-beta.5 — 2022-05-30
- 1.1.0-beta.4 — 2022-05-30
- 1.1.0-beta.3 — 2022-05-30
- 1.1.0-beta.2 — 2022-05-30
- 1.1.0-beta.1 — 2022-05-30
- 1.1.0-beta.0 — 2022-05-30
- … 6 more at https://npm.io/package/content-tracer-vv/versions

## README

# 使用说明

## SDK 集成

要正常采集内容相关数据并发送给特赞，需要引入 sdk，并初始化配置

1. 方式 1 ：同步载入

```html
<script charset="UTF-8" src="tezign-content-sdk.min.js"></script>
<script>
  const TZContentTracker = window['TZContentTracker'];
  const tracker = new TZContentSensors({
    env: 'development', // 运行环境，非必填，默认 development
    tenant_id: 't2', // 租户id, 必填
    user_id: 'user_1234', // 用户id，非必填，可以在登录后调用setUserId进行设置
    is_track_single_page: true, // 单页面配置，默认开启，若页面中有锚点设计，需要将该配置删除，否则触发锚点会多触发 $pageview 事件
    is_track_viewDepth: false, // 浏览深度配置，默认关闭
    is_track_timeOnPage: false, // 浏览时长配置，默认关闭
    is_track_trackerKeyDom: false, // 是否开启约定拥有属性值为'tracker-key'的dom的点击事件自动上报，默认关闭
  });

  tracker.setUserId('9527');
</script>
```

2. 方式 2 ：模块化加载
   从 npm 获取 sdk ， npm install tezign-content-track

```js
import TZContentTracker from 'tezign-content-sdk';

const tracker = new TZContentTracker({
  env: 'development', // 运行环境，非必填，默认 development
  tenant_id: 't2', // 租户id, 必填
  user_id: 'user_1234', // 用户id，非必填，可以在登录后调用setUserId进行设置
  is_track_single_page: true, // 单页面配置，默认开启，若页面中有锚点设计，需要将该配置删除，否则触发锚点会多触发 $pageview 事件
  is_track_viewDepth: false, // 浏览深度配置，默认关闭
  is_track_timeOnPage: false, // 浏览时长配置，默认关闭
  is_track_trackerKeyDom: false, // 是否开启约定拥有属性值为'tracker-key'的dom的点击事件自动上报，默认关闭
});

tracker.setUserId('9527');
```

## SDK 基本配置

### 初始化参数

| 名称                   | 类型    | 必填 | 描述                                                                                          |
| ---------------------- | ------- | ---- | --------------------------------------------------------------------------------------------- |
| env                    | String  |      | 运行环境 'production' ｜ 'development'，默认'development'                                     |
| tenant_id              | String  | Y    | 租户 id                                                                                       |
| user_id                | String  |      | 用户身份标识，当前系统唯一用户 id                                                             |
| is_track_single_page   | boolean |      | 单页面配置，默认开启，若页面有锚点设计，需要将该配置删除，否则触发锚点会多触发 $pageview 事件 |
| is_track_viewDepth     | boolean |      | 是否开启统计浏览深度，默认不开启                                                              |
| is_track_timeOnPage    | boolean |      | 是否开启统计停留时长，默认不开启                                                              |
| is_track_trackerKeyDom | boolean |      | 是否开启约定拥有属性值为'tracker-key'的 dom 的点击事件自动上报，默认不开启                    |

### 设置用户 id

```js
tracker.setUserID('user1212112');
```

---
_Source: https://npm.io/package/content-tracer-vv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._