86 lines
No EOL
2.4 KiB
Markdown
86 lines
No EOL
2.4 KiB
Markdown
# Tracks
|
|
|
|
适用于基于 Automattic 项目的 WooCommerce 用户事件跟踪工具。
|
|
|
|
## 安装
|
|
|
|
安装模块
|
|
|
|
```bash
|
|
pnpm install @woocommerce/tracks --save
|
|
```
|
|
|
|
## 用法
|
|
|
|
商店必须通过 `woocommerce_allow_tracking` 设置选择允许跟踪。
|
|
如果商店未选择允许，使用以下函数时将不会记录任何事件。
|
|
|
|
### recordEvent( eventName, eventProperties )
|
|
|
|
向 Tracks 记录用户事件。
|
|
|
|
```jsx
|
|
import { recordEvent } from '@woocommerce/tracks';
|
|
|
|
recordEvent( 'page_view', { path } )
|
|
```
|
|
|
|
| 参数 | 类型 | 描述 |
|
|
| --- | --- | --- |
|
|
| eventName | `字符串` | 要记录的事件名称，不要包含 `wcadmin_` 前缀 |
|
|
| eventProperties | `对象` | 事件中包含的事件属性 |
|
|
|
|
### queueRecordEvent( eventName, eventProperties )
|
|
|
|
排队一个 tracks 事件。
|
|
|
|
这允许您延迟那些可能导致竞态条件的 tracks 事件。
|
|
例如，当我们触发 `wcadmin_tasklist_appearance_continue_setup` 时，我们同时通过 `window.location` 将用户移动到新页面。
|
|
这是一个应通过将事件排队来避免的竞态条件示例，从而在下一页视图中运行它。
|
|
| 参数 | 类型 | 描述 |
|
|
| --- | --- | --- |
|
|
| eventName | `字符串` | 要记录的事件名称，不要包含 `wcadmin_` 前缀 |
|
|
| eventProperties | `对象` | 事件中包含的事件属性 |
|
|
|
|
### recordPageView( path, extraProperties )
|
|
|
|
向 Tracks 记录页面视图。
|
|
|
|
| 参数 | 类型 | 描述 |
|
|
| --- | --- | --- |
|
|
| path | `字符串` | 要记录页面视图的页面/路径 |
|
|
| extraProperties | `对象` | 事件中包含的额外事件属性 |
|
|
|
|
### bumpStat( statName, statValue )
|
|
|
|
增加一个统计或一组统计。
|
|
|
|
```typescript
|
|
import { bumpStat } from '@woocommerce/tracks';
|
|
|
|
// 增加单个统计
|
|
bumpStat( 'stat_name', 'stat_value' );
|
|
|
|
// 增加多个统计
|
|
bumpStat( {
|
|
stat1: 'value1',
|
|
stat2: 'value2'
|
|
} );
|
|
```
|
|
|
|
| 参数 | 类型 | 描述 |
|
|
| --- | --- | --- |
|
|
| statName | `字符串` 或 `对象` | 要增加的统计名称，或统计名称和值的对象 |
|
|
| statValue | `字符串` | 统计的值（仅在 statName 为字符串时使用） |
|
|
|
|
注意：统计名称会自动添加 `x_woocommerce-` 前缀。统计跟踪在开发模式下被禁用。
|
|
|
|
## 调试
|
|
|
|
当调试激活时，每个记录的 Tracks 事件的信息都会记录到浏览器控制台。
|
|
|
|
要激活，请打开浏览器控制台并添加以下内容：
|
|
|
|
```js
|
|
localStorage.setItem( 'debug', 'wc-admin:*' );
|
|
``` |
