集成注意事项

约 1446 字大约 5 分钟

1.基础事件的集成

在使用ClkLog作为神策SDK（如WEB JS、Android&iOS、React-Native等客户端）的数据接收端时，需注意以下几点

1.1.会话的集成

ClkLog的基础流量统计指标中的访问次数、平均访问页数、访问时长、用户画像列表都与会话有关，所以集成SDK后首先需要排查会话是否集成。

如果采集的日志中事件属性包含 $event_session_id 属性并且有值，则说明会话集成成功。

会话的集成方法：

1）直接开启：如 Android&iOS、React-Native (react-native-demo) 的 SDK 可直接enableSession。

2）集成插件：如 web js sdk 需集成 session-event (webjs-demo)。

3）自己实现：如 uni-app sdk （uni-app-deme）、 unity3d sdk (unity3d-demo)。

其他端的SDK中会话的集成请参考神策官方文档或查看SDK源码。

1.2.浏览页面事件的集成

ClkLog的基础浏览统计指标中的浏览量指标基于浏览页面事件。

由于神策不同客户端的SDK的浏览页面事件的事件名称不同，ClkLog根据神策SDK的浏览页面事件定义对各种端做了不同的统计分析处理。

神策各端SDK的浏览页面事件如下

Web：$pageview
Android&iOS：$AppViewScreen
小程序：$MPViewScreen
其他端: ClkViewScreen
- ClkViewScreen事件是ClkLog付费版中定义的除Web、Android&iOS、小程序端以外的其他端的SDK想要进行受访页面统计分析的通用事件。
- ClkViewScreen事件集成方法参考

在实际应用过程中请根据不同版本的SDK去查询相关的事件数据, 如果在ClkLog统计前端浏览量无数据请根据埋点项目所引用的SDK去排查采集到的日志记录是否有相应的浏览页面事件。

提示

以下功能目前仅在ClkLog付费版中支持

2.登录用户的集成

当用户登录时，需主动调用神策SDK的 login 接口，将用户的注册信息（一般为用户在业务系统中的唯一身份标识）传入。

Web JS用户登录接口示例：

sensors.login('login_user_id');

神策Web JS（简易用户关联（Web）参考链接

更多其他端（如Andriod、IOS、微信小程序等）用户登录集成代码接入方式请参考神策官方SDK集成文档。

3.自定义事件/用户属性集成

在集成自定义事件/用户属性之前需先在【元数据管理】处添加或导入事件、事件属性/用户属性。

3.1.元数据管理

元数据是按项目根据业务系统定义的自定义事件、神策预置事件的事件及属性（事件、用户、公共）的管理。

在集成前端自定义事件/用户属性的代码埋点之前，需要先在【元数据管理】处下载预置事件、预置属性、用户属性相关模板，并根据实际情况定义好要采集的事件（预置和自定义）、事件属性（预置和自定义）、用户属性（预置和自定义）添加或导入【ClkLog后台】-【元数据管理】相关元数据后在进行代码埋点，否则SDK全埋点相关的事件日志不会被同步至事件表，进而导致ClkLog后台的【自定义分析】功能统计的事件数量和原始采集的日志数据量不一致。