# C++
提示
在接入前, 请先阅读接入前准备。
最新版本:1.2.0
更新时间:2022-11-01
# 一、集成SDK
- 使用数数编译好的静态库(windows10下进行编译)
下载源代码后,进入 libs 文件夹后,拷贝 include 文件夹到工程,
如使用logcomsumer,则引入 libthinkingdata.a 文件
如使用batchcomsumer,则引入 libthinkingdata_batch.a 文件
如使用debugcomsumer,则引入 libthinkingdata_debug.a 文件
自行编译
下载 C++ SDK 源码,使用Clion、VS2019等 IDE 打开cpp文件夹。
(1)编译logcomsumer,修改cmake文件
cmake_minimum_required(VERSION 3.12)
project(cpp-server-sdk)
set(CMAKE_CXX_STANDARD 11)
include_directories(include)
# log consumer
add_library(thinkingdata src/ThinkingAnalyticsAPI.cpp src/TAUtils.cpp src/TALoggerConsumer.cpp)
add_executable(program example/program.cpp)
target_link_libraries(program thinkingdata)
运行example文件中的program.cpp,从 cmake-build 文件夹中获取 libthinkingdata.a 文件
(2)编译batch comsumer,修改cmake文件
cmake_minimum_required(VERSION 3.12)
project(cpp-server-sdk)
set(CMAKE_CXX_STANDARD 11)
include_directories(include)
# batch consumer
add_library(thinkingdata_batch src/ThinkingAnalyticsAPI.cpp src/TAUtils.cpp src/TABatchConsumer.cpp src/TANetwork.cpp)
if(WIN32)
include_directories(thirdParty/curl/include)
link_directories(thirdParty/curl/lib)
target_link_libraries(thinkingdata_batch libcurl)
else ()
target_link_libraries(thinkingdata_batch curl)
endif()
add_executable(batchConsmerDemo example/batchConsmerDemo.cpp)
target_link_libraries(batchConsmerDemo thinkingdata_batch)
运行example文件中的batchConsmerDemo.cpp,从 cmake-build 文件夹中获取libthinkingdata_batch.a 文件。
(2)编译debug comsumer,修改cmake文件
cmake_minimum_required(VERSION 3.12)
project(cpp-server-sdk)
set(CMAKE_CXX_STANDARD 11)
include_directories(include)
# debug consumer
add_library(thinkingdata_debug src/ThinkingAnalyticsAPI.cpp src/TAUtils.cpp src/TADebugConsumer.cpp src/TANetwork.cpp)
if(WIN32)
include_directories(thirdParty/curl/include)
link_directories(thirdParty/curl/lib)
target_link_libraries(thinkingdata_debug libcurl)
else ()
target_link_libraries(thinkingdata_debug curl)
endif()
add_executable(debugConsmerDemo example/debugConsumerDemo.cpp)
target_link_libraries(debugConsmerDemo thinkingdata_debug)
运行example文件中的debugConsumerDemo.cpp,从 cmake-build 文件夹中获取 libthinkingdata_debug.a 文件。
- 安装Logbus
我们推荐使用SDK+LogBus的形式,完成服务端数据的采集上报.您可以参考以下文档完成Logbus的安装:LogBus使用指南
# 二、初始化
以下是SDK初始化的示例代码:
// 导入头文件(每个平台以及IDE的路径不一样,自行适合调整)
#include "thirdPark/tacpp/include/tacpp/ThinkingDataAnalyticsSDK.h"
string LOG_DIRECTORY = "../trackLog";
TaSDK::LoggerConsumer::Config config = TaSDK::LoggerConsumer::Config(LOG_DIRECTORY);
TaSDK::LoggerConsumer logConsumer = TaSDK::LoggerConsumer(config);
TaSDK::ThinkingDataAnalytics tga = TaSDK::ThinkingDataAnalytics(logConsumer);
LOG_DIRECTORY
为写入本地的文件夹地址。您只需将 LogBus 的监听文件夹地址设置为此处的地址,即可使用 LogBus 进行数据的监听上传。
# 三、常用功能
为了保证访客 ID 与账号 ID 能够顺利进行绑定,如果您的游戏中会用到访客 ID 与账号 ID,我们极力建议您同时上传这两个 ID,否则将会出现账号无法匹配的情况,导致用户重复计算,具体的 ID 绑定规则可参考用户识别规则一章。
# 3.1 发送事件
您可以调用track
来上传事件,建议您根据先前梳理的文档来设置事件的属性以及发送信息的条件,以下是发送事件的示例代码:
TaSDK::PropertiesNode event_properties;
event_properties.SetString("name1", "XZ_debug");
event_properties.SetString("name2", "logbugs");
event_properties.SetString("name3", "name3");
event_properties.SetString("#uuid", "1234567890");
event_properties.SetNumber("test_number_int", 3);
event_properties.SetNumber("test_number_double", 3.14);
event_properties.SetBool("test_bool", true);
std::string test_string = "测试字符串1";
event_properties.SetString("test_stl_string1", test_string);
event_properties.SetDateTime("test_time1", time(nullptr), 0);
timeb t = {};
ftime(&t);
event_properties.SetDateTime("#time", t.time, t.millitm);
std::vector<std::string> test_list;
test_list.push_back("item11");
test_list.push_back("item21");
event_properties.SetList("test_list1", test_list);
// track事件
tga.track(accountId, distincId, eventName, event_properties);
- 事件的名称是字符串类型,只能以字母开头,可包含数字,字母和下划线 "_",长度最大为 50 个字符。
- Key 为该属性的名称,为字符串类型,规定只能以字母开头,包含数字,字母和下划线 "_",长度最大为 50 个字符,对字母大小写不敏感,TA会统一转化为小写字母
- Value 为该属性的值,支持字符串、数字、布尔、时间、对象、对象组、数组
用户属性的要求与事件属性保持一致
# 3.2 设置用户属性
对于一般的用户属性,您可以调用 user_set
来进行设置,使用该接口上传的属性将会覆盖原有的属性值,如果之前不存在该用户属性,则会新建该用户属性,类型与传入属性的类型一致,此处以设置用户名为例:
// user_set
TaSDK::PropertiesNode userSet_properties;
userSet_properties.SetString("userName", "test");
//上传用户属性
tga.user_set(accountId, distincId, userSet_properties);
# 四、最佳实践
以下示例代码包含以上所有操作,我们推荐按照如下步骤使用:
// 导入头文件(每个平台以及IDE的路径不一样,自行适合调整)
#include "thirdPark/tacpp/include/tacpp/ThinkingDataAnalyticsSDK.h"
string LOG_DIRECTORY = "../trackLog";
TaSDK::LoggerConsumer::Config config = TaSDK::LoggerConsumer::Config(LOG_DIRECTORY);
TaSDK::LoggerConsumer logConsumer = TaSDK::LoggerConsumer(config);
TaSDK::ThinkingDataAnalytics tga = TaSDK::ThinkingDataAnalytics(logConsumer);
//上传事件
TaSDK::PropertiesNode event_properties;
event_properties.SetString("name1", "XZ_debug");;
event_properties.SetNumber("test_number_int", 3);
event_properties.SetBool("test_bool", true);
tga.track(accountId, distincId, eventName, event_properties);
//上传用户属性
TaSDK::PropertiesNode userSet_properties;
userSet_properties.SetString("userName", "test");
tga.user_set(accountId, distincId, userSet_properties);
// 调用flush接口数据会立即写入文件,生产环境注意避免频繁调用flush引发IO或网络开销问题
tga.flush();