Windows SDK 集成与埋点

1.1 版本支持须知

目前仅支持32位和64位的Windows平台。

1.2 获取appid

在开始集成前，首先需要在集团中拥有一个应用，请参考：（如何创建应用）。
「应用列表」-> 接入应用的「详情」->「应用ID」中可查看您的APP ID。

1.3 获取数据上送地址

私有化部署版本需要获取数据上送地址 reportURL。
如您不清楚此地址，请联系您的项目经理或客户成功经理。

2.1 下载SDK

注：点击下方链接可直接下载到本地，推荐使用Chrome浏览器进行下载，部分其他浏览器下载可能会失败，如果下载失败可切换使用Chrome浏览器重新尝试下载操作。

WindowsSDK（32位）	x86.zip 未知大小	1.2.4
WindowsSDK（64位）	x64.zip 未知大小	1.2.4

2.2 SDK文件说明

请下载对应平台的SDK文件压缩包，解压后会出现applogrs.hpp、applogrs.dll、applogrs.dll.lib三个文件：

• applogrs.hpp：公开的接口头文件。
• applogrs.dll：动态链接库的运行时加载的dll文件。
• applogrs.dll.lib：applogrs.dll文件对应的函数导出声明文件。

2.3 集成

将下载的SDK文件复制到项目中，需要注意平台架构的文件放在项目的对应平台构建目录中。

2.3.1 添加附加库目录

修改项目属性-配置属性-连接器-常规-附加库目录，增加applogrs.dll文件所在的目录。

2.3.2 添加函数导出文件

修改项目属性-配置属性-连接器-常规-附加依赖项，增加文本内容applogrs.dll.lib。

2.3.3 添加头文件

修改项目属性-配置属性-C/C++-附加包含目录，增加applogrs.hpp文件所在的目录。

2.3.4 代码中引入头文件

在需要调用SDK的代码文件头部，显示的引入applogrs.hpp头文件：

#include "applogrs.hpp"

说明：
初始化SDK后会采集系统的部分设备信息，包括设备序列号、操作系统软件版本等。

3.1 初始化SDK

SDK会缓存埋点等数据，为保障数据不丢失，需要将数据持久化到本地磁盘中。需要提前准备可以写入数据的文件目录（SDK不会自动创建目录）。

// 1. 设置数据缓存目录，需要已经存在的有访问和写入数据权限的文件目录
applog::setDbDir("/xx/xx");
// 2. 设置域名，支持私有化部署
char* domain = "https://xxx.xxx.xxx"
applog::setRegisterDomain(domain); // 设备注册服务域名
applog::setActiveDomain(domain); // 设备激活服务域名
applog::setReportDomain(domain); // 埋点上报域名
applog::setRealtimeReportDomain(domain); // 埋点实时上报域名
applog::setSettingsDomain(domain); // 服务配置域名
// 3. 初始化SDK，需要提前准备好appId和appChannel（appChannel一般为发布的渠道名）
applog::init_rangers(appId, appChannel);

4.1 统计日活

在应用打开和应用即将被关闭时，需要手动触发SDK的应用启动接口和SDK的应用退出接口。只有触发了应用启动和应用退出才会上报日活数据。

• 在应用打开后调用：

applog::launch(); // 应用启动

• 在应用关闭时调用：

applog::terminate(); // 应用退出

4.2 上报埋点

支持在任意位置采集埋点，埋点内容包含埋点名称和埋点参数两部分，接口示例：

// 这里采集一个埋点
// 参数说明：
// 参数1：埋点名称，不能为空
// 参数2：参数的json字符串，不能为空，且必须为合法的json字符串
applog::onEvent("my_click", "{\"my_param\": 1}");

4.3 公共属性

如需在每个事件中都包括某属性，可通过公共属性设置，无需在每个事件中重复设置。公共属性只需设置一次，即可包括在所有代码埋点事件中。

• 设置公共属性：

// 添加公共属性
// 参数说明：
// 参数1：属性名
// 参数2：属性值（仅支持字符串）
applog::addCustomHeader("header", "value");

• 移除公共属性：

// 移除公共属性
// 参数说明：
// 参数1：属性名
applog::removeCustomHeader("header");

如您的产品中有账户体系，请在用户登录后立即设置 uuid，以保证用户登录前后口径一致性。

// 设置用户的uuid
applog::setUserUniqueId("your_user_unique_id");

6.1 打印日志

如果需要查看SDK内部运行日志，需要调用日志开关接口切换日志打印：

// 配置日志开关
// 参数说明：
// 参数1：1-开启日志打印 0-关闭日志打印
applog::setLogEnabled(1);