C

提示

在接入前, 请先阅读接入前准备。

最新版本为：1.3.6

更新时间为：2022-06-22

资源下载：源代码 (opens new window)

一、集成SDK

1. 下载C SDK (opens new window)，进行解压后可将以下文件引入项目中。

./c-sdk_version/include/thinkingdata.h
./c-sdk_version/lib/libthinkingdata.a

2. 安装Logbus

我们推荐使用SDK+LogBus的形式，完成服务端数据的采集上报.您可以参考以下文档完成Logbus的安装:LogBus使用指南

二、初始化

以下是SDK初始化的示例代码:

//生成config
TAConfig *config = ta_init_config();
//配置日志路径 YOUR_LOG_PATH 需要更改为日志存储的目录
TA_ASSERT(TA_OK == ta_add_string("file_path", "LOG_DIRECTORY", strlen("LOG_DIRECTORY"), config));
//生成SDK实例
struct TAConsumer *consumer = NULL;
if (TA_OK != ta_init_logging_consumer(&consumer, config)) {
     fprintf(stderr, "Failed to initialize the consumer.");
     return 1;
 }
ta_free_properties(config);
ThinkingdataAnalytics *ta = NULL;
if (TA_OK != ta_init(consumer, &ta)) {
       fprintf(stderr, "Failed to initialize the SDK.");
       return 1;
 }

LOG_DIRECTORY为写入本地的文件夹地址。您只需将 LogBus 的监听文件夹路径设置为此处的地址，即可使用 LogBus 进行数据的监听上传。

三、常用功能

为了保证访客 ID 与账号 ID 能够顺利进行绑定，如果您的游戏中会用到访客 ID 与账号 ID，我们极力建议您同时上传这两个 ID，否则将会出现账号无法匹配的情况，导致用户重复计算，具体的 ID 绑定规则可参考用户识别规则一章。

3.1 发送事件

您可以调用track来上传事件，建议您根据先前梳理的文档来设置事件的属性以及发送信息的条件，以下是发送事件的示例代码:

// 生成自定义属性
TAProperties *properties = ta_init_properties();
// 设置用户的ip地址，TA系统会根据IP地址解析用户的地理位置信息
TA_ASSERT(TA_OK == ta_add_string("#ip", "192.168.1.1", strlen("192.168.1.1"), properties));
// 添加自定义属性
TA_ASSERT(TA_OK == ta_add_string("channel", "ta", strlen("ta"), properties));//字符串
TA_ASSERT(TA_OK == ta_add_int("age", 1, properties)); //数字
TA_ASSERT(TA_OK == ta_add_bool("is_success", true, properties));//布尔
TA_ASSERT(TA_OK == ta_add_date("birthday", time(NULL), 0, properties));//时间
//数组
TA_ASSERT(TA_OK == ta_append_array("arr", "value", strlen("value"), properties));
TA_ASSERT(TA_OK == ta_append_array("arr", "value1", strlen("value1"), properties));
//对象
TAProperties *object = ta_init_custom_properties("object");
TA_ASSERT(TA_OK == ta_add_string("key", "value", strlen("value"), object));
TA_ASSERT(TA_OK == ta_add_property(object, properties));
//对象组
TAProperties *object1 = ta_init_custom_properties("object1");
TA_ASSERT(TA_OK == ta_add_string("key", "value", strlen("value"), object1));
TA_ASSERT(TA_OK == ta_append_properties("object_arr", object1, properties));
//上报带有自定义属性的事件数据，同样account_id 和 distinct_id 必须至少设置其中一个
TA_ASSERT(TA_OK == ta_track("account_id", "distinct_id", "payment", properties, ta));
ta_free_properties(properties);

• 事件的名称是字符串类型，只能以字母开头，可包含数字，字母和下划线 "_"，长度最大为 50 个字符。
• Key 为该属性的名称，为字符串类型，规定只能以字母开头，包含数字，字母和下划线 "_"，长度最大为 50 个字符，对字母大小写不敏感,TA会统一转化为小写字母
• Value 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组

用户属性的要求与事件属性保持一致

3.2 设置用户属性

对于一般的用户属性，您可以调用 ta_user_set 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：

//此时username为TA
//account_id 和 distinct_id 必须至少设置其中一个
TAProperties *user_properties = ta_init_properties();
TA_ASSERT(TA_OK == ta_add_string("user_name", "TA", strlen("TA"), user_properties));
TA_ASSERT(TA_OK == ta_user_set(account_id, distinct_id, user_properties,ta));
ta_free_properties(user_properties);

//此时userName为TE
TAProperties *user_properties2 = ta_init_properties();
TA_ASSERT(TA_OK == ta_add_string("user_name", "TE", strlen("TE"), user_properties2));
TA_ASSERT(TA_OK == ta_user_set(account_id, distinct_id, user_properties2,ta));
ta_free_properties(user_properties2);

四、最佳实践

/**
SDK初始化
**/
TAConfig *config = ta_init_config();
//配置日志路径 YOUR_LOG_PATH 需要更改为日志存储的目录
TA_ASSERT(TA_OK == ta_add_string("file_path", "LOG_DIRECTORY", strlen("LOG_DIRECTORY"), config));
//生成SDK实例
struct TAConsumer *consumer = NULL;
if (TA_OK != ta_init_logging_consumer(&consumer, config)) {
     fprintf(stderr, "Failed to initialize the consumer.");
     return 1;
 }
ta_free_properties(config);
ThinkingdataAnalytics *ta = NULL;
if (TA_OK != ta_init(consumer, &ta)) {
       fprintf(stderr, "Failed to initialize the SDK.");
       return 1;
 }
 
//发送事件
 //生成自定义属性
TAProperties *properties = ta_init_properties();
 //设置用户的ip地址，TA系统会根据IP地址解析用户的地理位置信息
TA_ASSERT(TA_OK == ta_add_string("#ip", "192.168.1.1", strlen("192.168.1.1"), properties));
TA_ASSERT(TA_OK == ta_add_string("channel", "ta", strlen("ta"), properties));//字符串
TA_ASSERT(TA_OK == ta_add_int("age", 1, properties)); //数字
TA_ASSERT(TA_OK == ta_add_bool("is_success", true, properties));//布尔
TA_ASSERT(TA_OK == ta_add_date("birthday", time(NULL), 0, properties));//时间
//数组
TA_ASSERT(TA_OK == ta_append_array("arr", "value", strlen("value"), properties));
TA_ASSERT(TA_OK == ta_append_array("arr", "value1", strlen("value1"), properties));
//对象
TAProperties *object = ta_init_custom_properties("object");
TA_ASSERT(TA_OK == ta_add_string("key", "value", strlen("value"), object));
TA_ASSERT(TA_OK == ta_add_property(object, properties));
//对象组
TAProperties *object1 = ta_init_custom_properties("object1");
TA_ASSERT(TA_OK == ta_add_string("key", "value", strlen("value"), object1));
TA_ASSERT(TA_OK == ta_append_properties("object_arr", object1, properties));
//上报带有自定义属性的事件数据，同样account_id 和 distinct_id 必须至少设置其中一个
TA_ASSERT(TA_OK == ta_track("account_id", "distinct_id", "payment", properties, ta));
ta_free_properties(properties);

 //设置用户属性
 //account_id 和 distinct_id 必须至少设置其中一个
TAProperties *user_properties = ta_init_properties();
TA_ASSERT(TA_OK == ta_add_string("user_name", "TA", strlen("TA"), user_properties));
TA_ASSERT(TA_OK == ta_user_set(account_id, distinct_id, user_properties,ta));
ta_free_properties(user_properties);

//调用flush接口数据会立即写入文件，生产环境注意避免频繁调用flush引发IO或网络开销问题
ta_flush(ta);