目前仅支持Arm64位和x86 64位的MacOS平台。
在开始集成前,首先需要在集团中拥有一个应用,进行SDK集成前,您需要获取对应应用的appid信息。
私有化部署版本需要获取数据上送地址 reportURL
。
如您不清楚此地址,请联系您的项目经理或客户成功经理。
请前往MacOS C++ SDK包下载页面获取对应版本的SDK包。
说明
macos-
版本号
.zip
格式。例如:macos-1.2.4.zip
,其中1.2.4为SDK版本号。x86_64
下的SDK包arm64
下的SDK包下载后取对应平台的SDK文件,其中包含:
将下载的SDK文件复制到项目中,需要注意平台架构的文件放在项目的对应平台构建目录中。
在TARGETS的General中的Framworks, Libraries, and Embeded Content添加一个Framework,弹出框中选择SDK的libapplogrs.dylib文件即可。
在TARGETS的Build Settings中的Header Search Paths中加入SDK的applogrs.hpp文件所在的目录
在需要调用SDK的代码文件(比如Swift Bridge Header文件)头部,显示的引入applogrs.hpp
头文件:
#include "applogrs.hpp"
说明:
初始化SDK后会采集系统的部分设备信息,包括设备序列号、操作系统软件版本等。
SDK会缓存埋点等数据,为保障数据不丢失,需要将数据持久化到本地磁盘中。需要提前准备可以写入数据的文件目录(SDK不会自动创建目录)。
// 1. 设置数据缓存目录,需要已经存在的有访问和写入数据权限的文件目录 applog::setDbDir("/xx/xx"); // 2. 设置域名reportURL,支持私有化部署, SaaS环境请勿修改 char* domain = "https://xxx.xxx.xxx"; applog::setCustomDomain(domain); // 服务域名 // 3. 初始化SDK,需要提前准备好appId和appChannel(appChannel一般为发布的渠道名) applog::init_rangers(appId, appChannel);
在应用打开和应用即将被关闭时,需要手动触发SDK的应用启动接口和SDK的应用退出接口。只有触发了应用启动和应用退出才会上报日活数据。
applog::launch(); // 应用启动
applog::terminate(); // 应用退出
支持在任意位置采集埋点,埋点内容包含埋点名称和埋点参数两部分,接口示例:
// 这里采集一个埋点 // 参数说明: // 参数1:埋点名称,不能为空 // 参数2:参数的json字符串,不能为空,且必须为合法的json字符串 applog::onEvent("my_click", "{\"my_param\": 1}");
如需在每个事件中都包括某属性,可通过公共属性设置,无需在每个事件中重复设置。公共属性只需设置一次,即可包括在所有代码埋点事件中。
// 添加公共属性 // 参数说明: // 参数1:属性名 // 参数2:属性值(仅支持字符串) applog::addCustomHeader("header", "value");
// 移除公共属性 // 参数说明: // 参数1:属性名 applog::removeCustomHeader("header");
如您的产品中有账户体系,请在用户登录后立即设置 uuid,以保证用户登录前后口径一致性。
// 设置用户的uuid applog::setUserUniqueId("your_user_unique_id");
如果需要查看SDK内部运行日志,需要调用日志开关接口切换日志打印:
// 配置日志开关 // 参数说明: // 参数1:1-开启日志打印 0-关闭日志打印 applog::setLogEnabled(1);