ae-tracking 0.1.0

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//346/234/215/345/212/241/347/253/257-sdk/php//350/277/233/351/230/266/346/214/207/345/215/227.md

@@ -0,0 +1,269 @@
+---
+code: php_sdk_advanced
+name: "进阶指南"
+wikiToken: XK7Fw4spoiDXdokeievcRH5FnTd
+parentWikiToken: XjWfwdvmliurf5k9Tr7cevp3nhc
+updateTime: 1745309910000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=php_sdk_advanced
+---
+# 进阶指南
+
+### 一、发送事件
+
+在 SDK 初始化完成之后，您就可以进行数据埋点，收集用户的的行为信息。一般情况下普通事件即可满足业务场景需求，您也可以根据自己的实际业务场景使用首次、可更新等事件。
+
+#### 1.1 普通事件
+
+您可以调用 `track` 来上传事件，建议您根据先前梳理的文档来设置事件的属性以及发送事件的条件，此处以用户购买某商品作为范例：
+
+```
+//设置事件属性
+$properties = array();
+$properties["product_name"] = "book";
+try {
+    $te->track("distinctId", "accountId", "productBuy", $properties);
+} catch (Exception $e) {
+    echo $e;
+}
+```
+
+#### 1.2 首次事件
+
+首次事件是指针对某个设备或者其他维度的 ID，只会记录一次的事件。例如在一些场景下，您可能希望记录在某个设备上的激活事件，则可以用首次事件来上报数据。
+
+```
+// 示例： 上报首次事件，假设事件名为 device_activation
+$properties = array();
+$properties["price"] = 100;
+$properties["status"] = 3;
+$firstCheckId = "first_flag_id";
+try {
+    $te->track_first("distinctId", "accountId", "device_activation", $firstCheckId, $properties);
+} catch (Exception $e) {
+    echo $e;
+}
+```
+
+<!-- unsupported block: 34 -->
+
+注意：由于在服务端完成对是否首次的校验，首次事件默认会延时 1 小时入库。
+
+#### 1.3 可更新事件
+
+您可以通过可更新事件实现特定场景下需要修改事件数据的需求。可更新事件需要指定标识该事件的 ID，并在创建可更新事件对象时传入。AE 后台将根据事件名和事件 ID 来确定需要更新的数据。
+
+```
+// 示例： 上报可被更新的事件，假设事件名为 eventName
+// 上报后事件属性 status 为 3, price 为 100
+$properties = array();
+$properties["price"] = 100;
+$properties["status"] = 3;
+$eventId = "eventId";
+try {
+    $te->track_update("distinctId", "accountId", "eventName", $eventId, $properties);
+} catch (Exception $e) {
+    echo $e;
+}
+
+// 上报后，事件id为：eventId 且事件名为：eventName 的事件属性 status 被更新为 5, price 不变
+$properties1 = array();
+$properties1["status"] = 5;
+try {
+    $te->track_update("distinctId", "accountId", "eventName", $eventId, $properties1);
+} catch (Exception $e) {
+    echo $e;
+}
+```
+
+#### 1.4 可重写事件
+
+可重写事件与可更新事件类似，区别在于可重写事件会用最新的数据完全覆盖历史数据，从效果上看相当于删除前一条数据，并入库最新的数据。AE 后台将根据事件名和事件 ID 来确定需要更新的数据。
+
+```
+// 示例： 上报可被更新的事件，假设事件名为 eventName
+// 上报后事件属性 status 为 3, price 为 100
+$properties = array();
+$properties["price"] = 100;
+$properties["status"] = 3;
+$eventId = "eventId";
+try {
+    $te->track_overwrite("distinctId", "accountId", "eventName", $eventId, $properties);
+} catch (Exception $e) {
+    echo $e;
+}
+
+// 上报后，事件id为：eventId 且事件名为：eventName 的事件属性 status 被更新为 5, price 属性被删除
+$properties1 = array();
+$properties1["status"] = 5;
+try {
+    $te->track_overwrite("distinctId", "accountId", "eventName", $eventId, $properties1);
+} catch (Exception $e) {
+    echo $e;
+}
+```
+
+### 二、用户属性
+
+AE 平台支持的用户属性设置API有: `user_set`、`user_setOnce`、`user_add`、
+
+`user_unset`、`user_del`、`user_append`、`user_uniqAppend`。
+
+#### 2.1 user_set
+
+对于一般的用户属性，您可以调用 `user_set` 来进行设置。使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：
+
+```
+$properties = array();
+
+//上传用户属性，新建属性"user_name"，值为"ABC"
+$properties["user_name"] = "ABC";
+try{
+    $te->user_set('distinct_id', 'account_id', $properties);
+}catch (Exception $e){
+    //异常处理
+    echo $e;
+}
+//再次上传用户属性，此时"user_name"的值会被覆盖为"XYZ"
+$properties["user_name"] = "XYZ";
+try{
+    $te->user_set('distinct_id', 'account_id', $properties);
+}catch (Exception $e){
+    //异常处理
+    echo $e;
+}
+```
+
+#### 2.2 user_setOnce
+
+如果您要上传的用户属性只要设置一次，则可以调用`user_setOnce`来进行设置，当该属性之前已经有值的时候，将会忽略这条信息，再以设置用户名为例：
+
+```
+$properties = array();
+
+//同样的，上传用户属性，新建属性"user_name"，值为"ABC"
+$properties["user_name"] = "ABC";
+try{
+    $te->user_setOnce('distinct_id', 'account_id', $properties);
+} catch (Exception $e){
+    //异常处理
+    echo $e;
+}
+
+//再次上传用户属性，此时"user_name"已存在值，因此不进行修改，仍为"ABC"；"user_age"的值为18
+$properties["user_name"] = "XYZ";
+$properties["user_age"] = 18;
+try{
+    $te->user_setOnce('distinct_id', 'account_id', $properties);
+} catch (Exception $e){
+    //异常处理
+    echo $e;
+}
+```
+
+#### 2.3 user_add
+
+当您要上传数值型的属性时，您可以调用`user_add`来对该属性进行累加操作，如果该属性还未被设置，则会赋值 0 后再进行计算，可传入负值，等同于相减操作。此处以累计付费金额为例：
+
+```
+try{
+    $properties = array();
+    $properties['level'] = 2;
+    $te->user_add($distinct_id, $account_id, $properties);
+}catch (Exception $e){
+    //handle except
+    echo $e;
+}
+```
+
+<!-- unsupported block: 34 -->
+
+设置的属性key为字符串，Value 只允许为数值。
+
+#### 2.4 user_append
+
+您可以调用 `user_append` 对数组类型的用户属性进行追加操作。
+
+```
+//user_append 追加一个用户的某一个或者多个集合
+try{
+    $properties = array();
+    $properties['arr'] = ['str3','str4'];//为集合类型追加多个值，key-array形式，array里面都是字符串类型
+    $te->user_append('distinct_id', 'account_id', $properties);
+}catch (Exception $e){
+    //handle except
+    echo $e;
+}
+```
+
+#### 2.5 user_uniq_append
+
+您可以调用 `user_uniq_append` 对 数组类型的用户属性进行追加操作。调用 `user_uniq_append` 接口会对追加的用户属性进行去重， `user_append` 接口不做去重，用户属性可存在重复。
+
+```
+//user_uniq_append 追加一个用户的某一个或者多个集合(对于重复元素进行去重处理)
+try{
+    $properties = array();
+    $properties['arr'] = ['str3','str4'];//为集合类型追加多个值，key-array形式，array里面都是字符串类型
+    $te->user_uniq_append('distinct_id', 'account_id', $properties);
+}catch (Exception $e){
+    //handle except
+    echo $e;
+}
+```
+
+#### 2.6 user_unset
+
+当您要清空用户的用户属性值时，您可以调用`user_unset`来对指定属性进行清空操作，如果该属性还未在集群中被创建，则`user_unset`不会创建该属性
+
+```
+$properties1 = array(
+    'age', "update_time"
+);
+try {
+    $te->user_unset(null, 'account_id', $properties1);
+} catch (Exception $e) {
+    //handle except
+    echo $e;
+}
+```
+
+<!-- unsupported block: 34 -->
+
+user_unset: 的传入值为被清空属性的 Key 值。
+
+#### 2.7 user_del
+
+如果您要删除某个用户，可以调用`user_del`将这名用户删除，您将无法再查询该名用户的用户属性，但该用户产生的事件仍然可以被查询到，该操作可能产生不可逆的后果，请慎用
+
+```
+try{
+    $te->user_del('distinct_id', 'account_id');
+} catch (Exception $e){
+    //异常处理
+    echo $e;
+}
+```
+
+### 三、其他功能
+
+#### 3.1 TDBatchConsumer
+
+::: warning 注意
+
+当数据量过大或者网络异常时，有数据丢失的风险，不建议在正式环境中使用
+
+:::
+
+批量实时地向 AE 服务器传输数据，不需要搭配传输工具。
+
+```
+require "TaPhpSdk.php";
+$te = new TDAnalytics(new TDBatchConsumer("SERVER_URL","APP_ID"));
+```
+
+参数说明:
+
+- `APP_ID`: 您的项目的 APP ID，可通过在 AE 后台项目管理页面获取
+- `SERVER_URL`: 数据上传的 URL
+- 如果您对接的是云服务，填入: https://global-receiver-ta.thinkingdata.cn 
+- 如果您使用私有化部署版本，请为数据采集地址绑定域名，并配置 HTTPS 证书：https://数据采集地址绑定域名

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//346/234/215/345/212/241/347/253/257-sdk/php.md

@@ -0,0 +1,206 @@
+---
+code: php_sdk_installation
+name: "PHP"
+wikiToken: XjWfwdvmliurf5k9Tr7cevp3nhc
+parentWikiToken: O3YxwgHGiiEnvYkHCcIcX51inkf
+updateTime: 1745310928000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=php_sdk_installation
+---
+# PHP
+
+::: tip 提示
+
+ 在接入前, 请先阅读接入前准备。
+
+您可以在 GitHub 获取 PHP SDK 源码。
+
+ :::
+
+**最新版本**：v3.1.1
+
+**更新时间**：2024-07-24
+
+**资源下载：**源代码
+
+::: warning 注意
+
+当前文档适用于 v3.0.0 及以后的版本，历史版本请参考 PHP SDK 接入指南（V2）
+
+::: 
+
+### 一、集成SDK
+
+1. 使用 composer 集成
+```
+{
+    "require": {
+        "thinkinggame/ta-php-sdk": "v3.1.1"
+    }
+}
+```
+
+1. 您也可以从GitHub中获取 SDK 的源码，并集成到您的项目中。只需要将 TaPhpSdk.php 放到你项目所在的目录即可。本 SDK 兼容 PHP >5.5，部分功能依赖 curl 扩展。
+1.  安装Logbus
+我们推荐使用SDK+LogBus的形式，完成服务端数据的采集上报.您可以参考以下文档完成Logbus的安装:LogBus使用指南
+
+### 二、初始化
+
+以下是SDK初始化的示例代码:
+
+```
+require_once "vendor/autoload.php";
+
+use Exception;
+use ThinkingData\TDLog;
+use ThinkingData\TDAnalytics;
+use ThinkingData\TDFileConsumer;
+use ThinkingData\TDDebugConsumer;
+use ThinkingData\TDBatchConsumer;
+use ThinkingData\ThinkingDataException;
+
+TDLog::*$enable *= true;
+
+$consumer = new TDFileConsumer("LOG_DIRECTORY", 200, true, "LOG_FILE_PREFIX");
+$teSDK = new TDAnalytics($consumer, true);
+```
+
+`LOG_DIRECTORY`为写入本地的文件夹地址。您只需将 LogBus 的监听文件夹地址设置为此处的地址，即可使用 LogBus 进行数据的监听上传。
+
+`LOG_FILE_PREFIX`为日志文件名字的前缀。
+
+### 三、常用功能
+
+为了保证访客 ID 与账号 ID 能够顺利进行绑定，如果您的游戏中会用到访客 ID 与账号 ID，我们极力建议您同时上传这两个 ID，否则将会出现账号无法匹配的情况，导致用户重复计算，具体的 ID 绑定规则可参考用户识别规则一章。
+
+#### 3.1 发送事件
+
+您可以调用`track`来上传事件，建议您根据先前梳理的文档来设置事件的属性以及发送信息的条件，以下是发送事件的示例代码:
+
+```
+$account_id = 2121;
+$distinct_id = 'SJ232d233243';
+$properties = array();
+$properties['age'] = 20;
+$properties['Product_Name'] = 'c';
+$properties['update_time'] = date('Y-m-d H:i:s', time());
+$json = array();
+$json['a'] = "a";
+$json['b'] = "b";
+$jsonArray = array();
+$jsonArray[0] = $json;
+$jsonArray[1] = $json;
+$properties['json'] = $json;
+$properties['jsonArray'] = $jsonArray;
+
+try {
+    $teSDK->track($distinct_id, $account_id, "viewPage", $properties);
+} catch (Exception $e) {
+    echo $e;
+}
+```
+
+- 事件的名称是字符串类型，只能以字母开头，可包含数字，字母和下划线 "_"，长度最大为 50 个字符。
+- Key 为该属性的名称，为字符串类型，规定只能以字母开头，包含数字，字母和下划线 "_"，长度最大为 50 个字符，对字母大小写不敏感,TE会统一转化为小写字母
+- Value 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组
+<!-- unsupported block: 34 -->
+
+**用户属性的要求与事件属性保持一致**
+
+#### 3.2 设置用户属性
+
+对于一般的用户属性，您可以调用 `user_set` 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：
+
+```
+$properties = array();
+$properties['once_key'] = 'twice';
+$properties['age'] = 10;
+$properties['money'] = 300;
+$properties['array1'] = ['str1', 'str2'];
+try {
+    $teSDK->user_set('distinct_id', 'account_id', $properties);
+} catch (Exception $e) {
+    //handle except
+    echo $e;
+}
+```
+
+#### 3.3 数据上报
+
+使用 `TDFileConsumer` 时，采集到的事件会先转成 json 字符串，然后添加到缓存数组中。当数组元素个数超出设置的容量时才会将数据写入磁盘。默认容量限制为100条数据。
+
+在某些业务场景下，如果您期望数据立即上报到TE服务器，可以通过调用`flush()`接口完成。需要注意，频繁调用`flush()`会导致服务性能下降。
+
+```
+$te->flush();
+```
+
+#### 3.4 关闭SDK
+
+```
+try{
+  $te->close();
+} catch (Exception $e){
+  //异常处理
+  echo $e;
+}
+```
+
+<!-- unsupported block: 34 -->
+
+关闭并退出 SDK，请在关闭服务器前调用本接口，以避免缓存内的数据丢失
+
+### 四、最佳实践
+
+以下示例代码包含以上所有操作，我们推荐按照如下步骤使用:
+
+```
+require_once "vendor/autoload.php";
+
+use Exception;
+use ThinkingData\TDLog;
+use ThinkingData\TDAnalytics;
+use ThinkingData\TDFileConsumer;
+use ThinkingData\TDDebugConsumer;
+use ThinkingData\TDBatchConsumer;
+use ThinkingData\ThinkingDataException;
+
+TDLog::*$enable *= true;
+
+$consumer = new TDFileConsumer("LOG_`DIRECTORY`", 200, true, "te");
+$teSDK = new TDAnalytics($consumer, true);
+
+$account_id = 2121;
+$distinct_id = 'SJ232d233243';
+$properties = array();
+$properties['age'] = 20;
+$properties['Product_Name'] = 'c';
+$properties['update_time'] = date('Y-m-d H:i:s', time());
+$json = array();
+$json['a'] = "a";
+$json['b'] = "b";
+$jsonArray = array();
+$jsonArray[0] = $json;
+$jsonArray[1] = $json;
+$properties['json'] = $json;
+$properties['jsonArray'] = $jsonArray;
+
+try {
+    $teSDK->track($distinct_id, $account_id, "viewPage", $properties);
+} catch (Exception $e) {
+    echo $e;
+}
+
+$properties = array();
+$properties['once_key'] = 'twice';
+$properties['age'] = 10;
+$properties['money'] = 300;
+$properties['array1'] = ['str1', 'str2'];
+try {
+    $teSDK->user_set($distinct_id, $account_id, $properties);
+} catch (Exception $e) {
+    //handle except
+    echo $e;
+}
+```
+
+###

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//346/234/215/345/212/241/347/253/257-sdk/python//346/233/264/346/226/260/346/227/245/345/277/227.md

@@ -0,0 +1,155 @@
+---
+code: python_sdk_release_note
+name: "更新日志"
+wikiToken: ULnnw90lWiHTi9khZFXcSZm2nLh
+parentWikiToken: HsQ2wYZDripMsZkFc2wcz2Zhn06
+updateTime: 1745309921000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=python_sdk_release_note
+---
+# 更新日志
+
+### v3.0.0
+
+**更新时间: 2023/10/08**
+
+**更新内容：**
+
+- 启用新的API，类名添加 TD 前缀
+- 不兼容旧版本 SDK
+### v2.1.3
+
+**更新时间: 2023/03/02**
+
+**更新内容：**
+
+- 支持清空动态公共属性
+### v2.1.2
+
+**更新时间: 2023/03/02**
+
+**更新内容：**
+
+- 修改版本号
+### v2.1.1
+
+**更新时间: 2023/03/01**
+
+**更新内容：**
+
+- 支持设置动态公共属性
+### v2.1.0
+
+**更新时间: 2022/12/22**
+
+**更新内容：**
+
+- 在TE后台实时调试
+### v2.0.0
+
+**更新时间: 2022/08/08**
+
+**更新内容****：**
+
+- 支持动态公共属性 
+- 支持首次事件 
+- 新增user_uniq_append事件 
+### v1.8.0 
+
+**更新时间: 2022/04/26**
+
+**更新内容：**
+
+- 支持动态公共属性 
+- 支持首次事件 
+- 新增user_uniq_append事件 
+### v1.7.0
+
+**更新时间: 2021/12/29**
+
+**更新内容：**
+
+- 增加支持复杂结构类型 
+### v1.6.2 
+
+**更新时间: 2021/08/05**
+
+**更新内容：**
+
+- 修复flush方法没有刷新文件日期的问题
+### v1.6.1
+
+**更新时间: 2021/06/04**
+
+**更新内容：**
+
+- 修改LoggingConsumer默认写文件的条件为5条数据写入一次
+- 修改BatchConsumer默认最大缓存区上限为50批次
+### v1.6.0 
+
+**更新时间: 2021/03/22**
+
+**更新内容：**
+
+- 新增网络失败重试机制
+- 增加缓存区，重试3次发送失败的数据将存入缓存区中，缓存数据超过上限将会丢弃早期数据
+- 支持 #app_id 属性
+### v1.5.0 
+
+**更新时间: 2020/11/21**
+
+**更新内容：**
+
+- LoggingConsumer 支持自动创建目录
+### v1.4.0 
+
+**更新时间: 2020/08/27**
+
+**更新内容：**
+
+- 新增 track_update 接口，支持可更新事件
+- 新增 track_overwrite 接口，支持可重写事件
+### v1.3.3 
+
+**更新时间: 2020/08/12**
+
+**更新内容：**
+
+- 修复 AsyncBatchConsumer 在特殊情况下线程不释放的问题
+### v1.3.2 
+
+**更新时间: 2020/08/03**
+
+**更新内容：**
+
+- 支持 LoggingConsumer 配置文件前缀名
+- 新增 UUID 配置开关
+### v1.3.1
+
+**更新时间: 2020/02/26**
+
+**更新内容：**
+
+- 兼容 python2 的 DebugConsumer 错误日志打印
+### v1.3.0 
+
+**更新时间: 2020/02/11**
+
+**更新内容：**
+
+- 数据类型支持 list 类型
+- 新增 user_append 接口，支持用户的数组类型的属性追加
+- 新增 user_unset 接口，支持删除用户属性
+- BatchConsumer 性能优化：支持选择是否压缩；移除 Base64 编码
+- DebugConsumer 优化: 在服务端对数据进行更完备准确地校验
+### v1.2.0 
+
+**更新时间: 2019/09/25**
+
+**更新内容：**
+
+- 支持 DebugConsumer
+- 支持日志文件按小时切分
+- BatchConsumer 支持多线程
+- 修复 AsyncBatchConsumer 批量发送不生效的问题
+- 优化数据上报返回码处理逻辑
+- LoggingConsumer: 默认不限制单个日志文件大小

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//346/234/215/345/212/241/347/253/257-sdk/python//350/277/233/351/230/266/346/214/207/345/215/227//345/256/236/346/227/266/350/260/203/350/257/225.md

@@ -0,0 +1,47 @@
+---
+code: python_sdk_debug
+name: "实时调试"
+wikiToken: GQ3swVGhriVCXRk2gJ6c4QZJncb
+parentWikiToken: Rd0mwDDUPiOCwOkyXX6cIS84nac
+updateTime: 1745309918000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=python_sdk_debug
+---
+# 实时调试
+
+::: warning 注意
+
+SDK Debug 模式仅供接入调试时使用，严禁应用在生产环境。
+
+:::
+
+在SDK接入过程中，您可以通过查看SDK在IDE控制台中的日志或者使用TE的Debug功能，进行实时调试。
+
+### 一、打印SDK日志
+
+```
+TDAnalytics.enableLog(isPrint=True)
+```
+
+### 二、实时调试
+
+在SDK接入过程中，您可以通过使用TE的Debug功能，进行实时调试。使用Debug功能需要如下两步操作:
+
+1. 使用TDDebugConsumer
+以下使用TDDebugConsumer的示例代码:
+
+```
+te = TDAnalytics(TDDebugConsumer("https://receiver-ta-demo.thinkingdata.cn", "appId", device_id="123456789"))
+distinct_id = "ABD"
+account_id = "11111"
+try:
+    te.track(account_id=account_id, event_name='event_name', properties={'level': 0})
+except Exception as e:
+    print(e)
+```
+
+1. TE后台添加Debug设备
+为了避免 Debug 模式在生产环境上线，规定只有指定的设备才能开启 Debug 模式。只有在客户端开启了 Debug 模式，并且设备 ID 在 AE 后台的"埋点管理"页的"Debug 数据"板块中配置了的设备才能开启 Debug 模式。
+
+<!-- unsupported block: 34 -->
+
+Debug 模式可能会影响数据采集质量和 App 的稳定性，只用于集成阶段数据验证，不要在线上环境使用。