diff --git a/docs/api/other/report.md b/docs/api/other/report.md index 32d5dbffc389b788d0dd54729f4d972b43716f07..6718cc018ed4b0003f201349cd0a089ed416b0ef 100644 --- a/docs/api/other/report.md +++ b/docs/api/other/report.md @@ -1,33 +1,36 @@ -#### 统计 +## 统计 从uni-app 2.2.3起,支持uni统计。一张报表,掌握全端数据。业务介绍详见[https://tongji.dcloud.net.cn](https://tongji.dcloud.net.cn) 自定义事件是统计中不可或缺的功能。开发者可通过本API自定义上报统计数据,如统计登录、注册、点击某个按钮,我们都可以称之为自定义事件。 -##### uni.report( eventName , options) +### uni.report( eventKey , param) **参数说明** |参数 |类型 |描述 | |--- |--- |--- | -|eventName|String |事件名称,最大长度不超过 255 个字符 | -|options |String 、 Object |事件参数 | - -Tips -- eventName 为 String 类型,并且字符长度必须小于255 -- options 为 String 类型时,字符长度必须小于255 -- options 为 Object 类型时,该对象的值只能为 String 类型 +|eventKey|String |事件名称,最大长度不超过 255 个字符 | +|param |String 、 Object |事件参数 | + +::: tip 提示 +- eventKey 为 String 类型,并且字符长度必须小于255 +- param 为 String 类型时,字符长度必须小于255 +- param 为 Object 类型时,该对象的值只能为 String 类型 - 字符串支持特殊字符但不包括(英文逗号 , 英文冒号 : 点 .) -- eventName 为 `title` 时为内容标题上报,用户不能自定义。此时数据会展现在uni统计的首页-内容统计及左侧导航的内容统计中。方便查看内容页数据。 +- eventKey 为 `title` 时为内容标题上报,用户不能自定义。此时数据会展现在uni统计的首页-内容统计及左侧导航的内容统计中。方便查看内容页数据。 - 用户在使用 `uni.login()` 会执行登录事件,不携带参数。如果如需上报携带具体参数的数据,需要手动调用 `uni.report('login',{...})` - 用户在使用 `uni.share()` 或触发 `onShareAppMessage` 会执行分享事件,不携带参数。如果如需上报携带具体参数的数据,需要手动调用 `uni.report('share',{...})` - 用户在使用 `uni.requestPayment()` 会执行支付事件,不携带参数。如果如需上报携带具体参数的数据,需要手动调用 `uni.report('pay_success',{...})` 和 `uni.report('pay_fail',{...})` + + +::: **示例** ```javascript // 内容统计 -// 当 eventName 为 title 时,options 只能为 String 类型 +// 当 eventKey 为 title 时,param 只能为 String 类型 uni.report('title','首页') // 登录 @@ -76,28 +79,30 @@ uni.report('search',{ 自定义事件上报后,在统计后台的`事件和转换`栏目中,可以看到上报的事件情况。 -**TIPS:** +::: tip 提示 - 小程序平台,需将`tongji.dcloud.net.cn`配入域名白名单,[详见](https://ask.dcloud.net.cn/article/36298) -- uni统计使用教程:[https://ask.dcloud.net.cn/article/36303](https://ask.dcloud.net.cn/article/36303) - +- uni统计使用教程:[https://ask.dcloud.net.cn/article/36303](https://ask.dcloud.net.cn/article/36303) +::: + +### 非官方自定义统计 除了官方的uni统计,如果开发者还需要调用小程序平台的自定义统计,给小程序的后台上报数据,那么需使用条件编译,在各端调用此自己的API。 -##### 微信小程序平台: +#### 微信小程序平台: - 数据上报:[wx.reportMonitor](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/report/wx.reportMonitor.html) - 数据分析:[wx.reportAnalytics](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/data-analysis/wx.reportAnalytics.html) -##### 支付宝小程序平台: +#### 支付宝小程序平台: - 自定义分析数据的上报接口:[my.reportAnalytics](https://docs.alipay.com/mini/api/report) -##### 百度小程序平台: +#### 百度小程序平台: - 数据分析:[swan.reportAnalytics](https://smartprogram.baidu.com/docs/develop/api/data/#swan-reportAnalytics/) -##### 字节跳动小程序平台: +#### 字节跳动小程序平台: - [reportAnalytics](https://developer.toutiao.com/dev/cn/mini-app/develop/open-capacity/data-analysis/reportanalytics) -##### QQ小程序平台: +#### QQ小程序平台: - 数据上报:[qq.reportMonitor](https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_dataup.html) - 数据分析:[qq.reportAnalytics](https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_dataanalysis.html#qq-reportanalytics) -##### App平台的友盟统计: +#### App平台的友盟统计: - 友盟统计:[开发规范](http://www.html5plus.org/doc/zh_cn/statistic.html),[配置文档](https://ask.dcloud.net.cn/article/74) diff --git a/docs/uni-stat-v1.md b/docs/uni-stat-v1.md index 8c13a92ea7a13ba6f6ed568d2c3a0c099d71e310..90eccdae85fc6524bb3bfca5e10297ee0d14584f 100644 --- a/docs/uni-stat-v1.md +++ b/docs/uni-stat-v1.md @@ -12,7 +12,7 @@ web控制台地址:[https://tongji.dcloud.net.cn](https://tongji.dcloud.net.cn 在HBuilderX中打开manifest,选择 uni统计,如下图: -[attach]53546[/attach] +![选择 uni统计](https://img-cdn-tc.dcloud.net.cn/uploads/article/20200428/761d2dca6ce34febfc4d43c09c6fd85f.jpg) 如果不使用HBuilderX,也可在 `manifest.json` 的源码视图中手动关闭 uni统计