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/nodejs//350/277/233/351/230/266/346/214/207/345/215/227.md

@@ -0,0 +1,263 @@
+---
+code: nodejs_sdk_advanced
+name: "进阶指南"
+wikiToken: OFCMwMXkFiF39KkPZPAcUPx0nLc
+parentWikiToken: EfbBwX7fOiKXBvkOzGDcHKK8nBc
+updateTime: 1745309903000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=nodejs_sdk_advanced
+---
+# 进阶指南
+
+### 一、发送事件
+
+在 SDK 初始化完成之后，您就可以进行数据埋点，收集用户的的行为信息。一般情况下普通事件即可满足业务场景需求，您也可以根据自己的实际业务场景使用首次、可更新等事件。
+
+#### 1.1 普通事件
+
+您可以调用 `track` 来上传事件，建议您根据先前梳理的文档来设置事件的属性以及发送事件的条件，此处以用户购买某商品作为范例：
+
+```
+let trackEvent = {
+    accountId: '2222',
+    distinctId: '1111',
+    event: 'test_event',
+    time: new ***Date***(),
+    ip: '202.38.64.1',
+    properties: {
+        prop_double: 134.1,
+    },
+    callback(e) {
+        if (e) {
+            ***console***.log(e);
+        }
+    }
+};
+
+teSDK.track(trackEvent)
+```
+
+#### 1.2 首次事件
+
+首次事件是指针对某个设备或者其他维度的 ID，只会记录一次的事件。例如在一些场景下，您可能希望记录在某个设备上的激活事件，则可以用首次事件来上报数据。
+
+```
+let trackFirstEvent = {
+    accountId: '2222',
+    distinctId: '1111',
+    event: 'test_event',
+    firstCheckId: 'first_check_id',
+    time: new ***Date***(),
+    properties: {
+        prop_date: new ***Date***(),
+        prop_double: 134.1,
+        prop_string: 'hello world',
+        prop_int: 67,
+    },
+    callback(e) {
+        if (e) {
+            ***console***.log(e);
+        }
+    }
+};
+
+teSDK.trackFirst(trackFirstEvent);
+```
+
+<!-- unsupported block: 34 -->
+
+注意：由于在服务端完成对是否首次的校验，首次事件默认会延时 1 小时入库。
+
+#### 1.3 可更新事件
+
+您可以通过可更新事件实现特定场景下需要修改事件数据的需求。可更新事件需要指定标识该事件的 ID，并在创建可更新事件对象时传入。AE 后台将根据事件名和事件 ID 来确定需要更新的数据。
+
+```
+let trackUpdateEvent = {
+    accountId: '2222',
+    distinctId: '1111',
+    event: 'test_event',
+    eventId: 'event_id',
+    time: new ***Date***(),
+    properties: {
+        prop_date: new ***Date***(),
+        prop_double: 134.1,
+        prop_string: 'hello world',
+        prop_int: 67,
+    },
+    callback(e) {
+        if (e) {
+            ***console***.log(e);
+        }
+    }
+};
+
+teSDK.trackUpdate(trackUpdateEvent);
+```
+
+#### 1.4 可重写事件
+
+可重写事件与可更新事件类似，区别在于可重写事件会用最新的数据完全覆盖历史数据，从效果上看相当于删除前一条数据，并入库最新的数据。AE 后台将根据事件名和事件 ID 来确定需要更新的数据。
+
+```
+let trackOverwriteEvent = {
+    accountId: '2222',
+    distinctId: '1111',
+    event: 'test_event',
+    eventId: 'event_id',
+    time: new ***Date***(),
+    properties: {
+        prop_date: new ***Date***(),
+        prop_double: 134.1,
+        prop_string: 'hello world',
+        prop_int: 67,
+    },
+    callback(e) {
+        if (e) {
+            ***console***.log(e);
+        }
+    }
+};
+
+teSDK.trackOverWrite(trackOverwriteEvent);
+```
+
+### 二、用户属性
+
+AE 平台支持的用户属性设置API有: `userSet`、`userSetOnce`、`userAdd`、
+
+`userUnset`、`userDel`、`userAppend`、`userUniqAppend`。
+
+#### 2.1 userSet
+
+对于一般的用户属性，您可以调用 `userSet` 来进行设置。使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：
+
+```
+let userSetData = {
+    accountId: 'node_test',
+    properties: {
+        prop_date: new ***Date***(),
+        prop_double: 134.12,
+        prop_string: 'hello',
+        prop_int: 666,
+        prop_array: ['str1', 'str2'],
+    },
+    callback(e) {
+        if (e) {
+            ***console***.log(e);
+        }
+    }
+};
+
+teSDK.userSet(userSetData);
+```
+
+#### 2.2 userSetOnce
+
+如果您要上传的用户属性只要设置一次，则可以调用`userSetOnce`来进行设置，当该属性之前已经有值的时候，将会忽略这条信息，再以设置用户名为例：
+
+```
+teSDK.userSetOnce({
+    accountId: 'node_test',
+    properties: {
+        setOnceProperty: "set_once",
+    }
+});
+```
+
+#### 2.3 userAdd
+
+当您要上传数值型的属性时，您可以调用`userAdd`来对该属性进行累加操作，如果该属性还未被设置，则会赋值 0 后再进行计算，可传入负值，等同于相减操作。此处以累计付费金额为例：
+
+```
+teSDK.userAdd({
+    accountId: 'node_test',
+    properties: {
+        prop_double: 0.6,
+        prop_int: 222,
+    }
+});
+```
+
+<!-- unsupported block: 34 -->
+
+设置的属性key为字符串，Value 只允许为数值。
+
+#### 2.4 userAppend
+
+您可以调用 `userAppend` 对数组类型的用户属性进行追加操作。
+
+```
+teSDK.userAppend({
+    accountId: 'node_test',
+    properties: {
+        prop_array: ['str3', 'str4']
+    }
+});
+```
+
+#### 2.5 userUniqAppend
+
+您可以调用 `userUniqAppend` 对 数组类型的用户属性进行追加操作。调用 `userUniqAppend` 接口会对追加的用户属性进行去重， `userAppend` 接口不做去重，用户属性可存在重复。
+
+```
+teSDK.userUniqAppend({
+    accountId: 'node_test',
+    properties: {
+        prop_array: ['str3', 'str4']
+    }
+});
+```
+
+#### 2.6 userUnset
+
+当您要清空用户的用户属性值时，您可以调用`userUnset`来对指定属性进行清空操作，如果该属性还未在集群中被创建，则`userUnset`不会创建该属性
+
+```
+teSDK.userUnset({
+    accountId: 'node_test',
+    property: 'set_once_property'
+});
+```
+
+<!-- unsupported block: 34 -->
+
+UserUnset: 的传入值为被清空属性的 Key 值。
+
+#### 2.7 userDel
+
+如果您要删除某个用户，可以调用`userDel`将这名用户删除，您将无法再查询该名用户的用户属性，但该用户产生的事件仍然可以被查询到，该操作可能产生不可逆的后果，请慎用
+
+```
+teSDK.userDel({
+  // 账号 ID （可选)
+  accountId: "node_test",
+  // 访客 ID （可选)，账号 ID 和访客 ID 不可以都为空
+  distinctId: "node_distinct_id"
+});
+```
+
+### 三、其他功能
+
+#### 3.1 BatchMode
+
+::: warning 注意
+
+当数据量过大或者网络异常时，有数据丢失的风险，不建议在正式环境中使用
+
+:::
+
+批量实时地向 AE 服务器传输数据，不需要搭配传输工具。
+
+```
+let teSDK = ThinkingData.initWithBatchMode('APP_ID', 'SERVER_URL', {
+    batchSize: 2,
+    compress: false // enable compress or not, default true
+});
+```
+
+参数说明:
+
+- `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/nodejs.md

@@ -0,0 +1,161 @@
+---
+code: nodejs_sdk_installation
+name: "Node.js"
+wikiToken: EfbBwX7fOiKXBvkOzGDcHKK8nBc
+parentWikiToken: O3YxwgHGiiEnvYkHCcIcX51inkf
+updateTime: 1745310927000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=nodejs_sdk_installation
+---
+# Node.js
+
+本指南将会为您介绍如何使用 Node.js SDK 接入您的项目。
+
+**最新版本为**：v1.5.0
+
+**更新时间为**：2024-03-26
+
+**资源下载:**源代码
+
+### 一、集成SDK
+
+1. 请使用`npm`获取 Node.js SDK：
+```
+# 获取 SDK
+npm install thinkingdata-node --save
+
+# 更新 SDK
+npm i thinkingdata-node@{版本号}
+```
+
+1.  安装Logbus
+我们推荐使用SDK+LogBus的形式，完成服务端数据的采集上报。您可以参考以下文档完成Logbus的安装:LogBus使用指南
+
+### 二、初始化
+
+以下是SDK初始化的示例代码:
+
+```
+const ThinkingData = *require*('thinkingdata-node');
+
+let teSDK = ThinkingData.initWithLoggingMode('LOG_DIRECTORY', {
+    filePrefix: 'test',
+    rotateHourly: true
+});
+```
+
+`LOG_DIRECTORY`为写入本地的文件夹地址。您只需将 LogBus 的监听文件夹地址设置为此处的地址，即可使用 LogBus 进行数据的监听上传。**本 SDK 在 ****loggingMode ****模式不支持多实例写入文件**。
+
+### 三、常用功能
+
+为了保证访客 ID 与账号 ID 能够顺利进行绑定，如果您的游戏中会用到访客 ID 与账号 ID，我们极力建议您同时上传这两个 ID，否则将会出现账号无法匹配的情况，导致用户重复计算，具体的 ID 绑定规则可参考用户识别规则一章。
+
+#### 3.1 发送事件
+
+您可以调用`track`来上传事件，建议您根据先前梳理的文档来设置事件的属性以及发送信息的条件，以下是发送事件的示例代码:
+
+```
+let trackEvent = {
+    accountId: '2222',
+    distinctId: '1111',
+    event: 'test_event',
+    time: new Date(),
+    ip: '202.38.64.1',
+    properties: {
+        prop_double: 134.1,
+    },
+    callback(e) {
+        if (e) {
+            console.log(e);
+        }
+    }
+};
+
+teSDK.track(trackEvent)
+```
+
+- 事件的名称是字符串类型，只能以字母开头，可包含数字，字母和下划线 "_"，长度最大为 50 个字符。
+- Key 为该属性的名称，为字符串类型，规定只能以字母开头，包含数字，字母和下划线 "_"，长度最大为 50 个字符，对字母大小写不敏感,TE会统一转化为小写字母
+- Value 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组
+<!-- unsupported block: 34 -->
+
+**用户属性的要求与事件属性保持一致**
+
+#### 3.2 设置用户属性
+
+对于一般的用户属性，您可以调用 `userSet` 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：
+
+```
+let userSetData = {
+    accountId: 'node_test',
+    properties: {
+        prop_date: new Date(),
+        prop_double: 134.12,
+        prop_string: 'hello',
+        prop_int: 666,
+        prop_array: ['str1', 'str2'],
+    },
+    callback(e) {
+        if (e) {
+            console.log(e);
+        }
+    }
+};
+
+teSDK.userSet(userSetData);
+```
+
+#### 3.3 数据上报
+
+使用 TDLoggingConsumer 时，SDK 会实时的将采集到的数据写入磁盘，无需调用`flush()`方法。
+
+#### 3.4 关闭SDK
+
+```
+teSDK.close();
+```
+
+<!-- unsupported block: 34 -->
+
+关闭并退出 sdk，请在关闭服务器前调用本接口，以避免缓存内的数据丢失
+
+### 四、最佳实践
+
+以下示例代码包含以上所有操作，我们推荐按照如下步骤使用:
+
+```
+var teSDK = ThinkingData.initWithLoggingMode('LOG_DIRECTORY');
+let trackEvent = {
+    accountId: '2222',
+    distinctId: '1111',
+    event: 'test_event',
+    time: new Date(),
+    ip: '202.38.64.1',
+    properties: {
+        prop_double: 134.1,
+    },
+    callback(e) {
+        if (e) {
+            console.log(e);
+        }
+    }
+};
+
+teSDK.track(trackEvent)
+let userSetData = {
+    accountId: 'node_test',
+    properties: {
+        prop_date: new Date(),
+        prop_double: 134.12,
+        prop_string: 'hello',
+        prop_int: 666,
+        prop_array: ['str1', 'str2'],
+    },
+    callback(e) {
+        if (e) {
+            console.log(e);
+        }
+    }
+};
+
+teSDK.userSet(userSetData);
+```

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//346/233/264/346/226/260/346/227/245/345/277/227.md

@@ -0,0 +1,86 @@
+---
+code: php_sdk_release_note
+name: "更新日志"
+wikiToken: TvDJwY6Z0izg93ksUQscj5XQnCb
+parentWikiToken: XjWfwdvmliurf5k9Tr7cevp3nhc
+updateTime: 1745309914000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=php_sdk_release_note
+---
+# 更新日志
+
+### **v3.1.1**
+
+**更新时间：2024/07/24**
+
+**更新内容：**
+
+- 支持自定义日志文件权限
+### **v3.0.0**
+
+**更新时间：2023/10/08**
+
+**更新内容：**
+
+- 启用新的API，类名添加 TD 前缀
+- 命名空间修改为 ThinkingData
+- 旧 API 标注过期
+### **v2.2.1**
+
+**更新时间：2023/04/11**
+
+**更新内容：**
+
+- 释放文件 handler
+### **v2.2.0**
+
+**更新时间：2023/04/10**
+
+**更新内容：**
+
+- 添加 namespace
+- 添加数据 buffer
+### **v2.1.1**
+
+**更新时间：2022/11/10**
+
+**更新内容：**
+
+- 支持 debug 模式
+### **v2.1.0**
+
+**更新时间：2022/10/25**
+
+**更新内容：**
+
+- 新增日志开关
+### **v2.0.0** 
+
+**更新时间****：****2022/05/09**
+
+**更新内容****：**
+
+- 新增支持动态公共属性 
+- 新增首次事件接口 
+- 新增 user_uniq_append 去重追加用户属性 
+### **v1.8.0**
+
+**更新时间: 2021/11/09**
+
+**更新内容：**
+
+- 增加支持复杂结构类型 
+### **v1.7.0** 
+
+**更新时间: 2021/06/01**
+
+**更新内容:**
+
+- 修复公共属性覆盖的bug
+- 修复user_del()方法无法调用的问题
+### **v1.6.0** 
+
+**更新时间: 2021/03/12**
+
+**更新内容:**
+
+- BatchConsumer 增加上传失败缓存

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//345/256/236/346/227/266/350/260/203/350/257/225.md

@@ -0,0 +1,48 @@
+---
+code: php_sdk_debug
+name: "实时调试"
+wikiToken: PRmPwFUgSiAOoUkw54IcrMKkngL
+parentWikiToken: XK7Fw4spoiDXdokeievcRH5FnTd
+updateTime: 1745309911000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=php_sdk_debug
+---
+# 实时调试
+
+::: warning 注意
+
+SDK Debug 模式仅供接入调试时使用，严禁应用在生产环境。
+
+:::
+
+### 打印日志
+
+```
+TDLog::*$enable *= true;
+```
+
+### 实时调试
+
+在SDK接入过程中，您可以通过使用TE的Debug功能，进行实时调试。使用Debug功能需要如下两步操作:
+
+1. 使用TDDebugConsumer
+以下使用TDDebugConsumer的示例代码:
+
+```
+try {
+    // 和TE后台设置的测试设备id一致
+    $deviceId = "123";
+    $debugConsumer = new TDDebugConsumer("SERVER_URL", "APP_ID", 1000, $deviceId);
+    // 测试数据是否写入TE库,true-写入，false-不写入。默认值为true
+    $debugConsumer->setDebugOnly(false);
+    $te = new TDAnalytics($debugConsumer);
+} catch (Exception $e) {
+    echo $e;
+}
+```
+
+1. TE后台添加Debug设备
+为了避免 Debug 模式在生产环境上线，规定只有指定的设备才能开启 Debug 模式。只有在客户端开启了 Debug 模式，并且设备 ID 在 AE 后台的"埋点管理"页的"Debug 数据"板块中配置了的设备才能开启 Debug 模式。
+
+<!-- unsupported block: 34 -->
+
+Debug 模式可能会影响数据采集质量和 App 的稳定性，只用于集成阶段数据验证，不要在线上环境使用。

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//351/242/204/347/275/256/345/261/236/346/200/247.md

@@ -0,0 +1,75 @@
+---
+code: php_sdk_preset_properties
+name: "预置属性"
+wikiToken: LbIYw4j2OiMStWkjbpLcipxPnFh
+parentWikiToken: XK7Fw4spoiDXdokeievcRH5FnTd
+updateTime: 1745309913000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=php_sdk_preset_properties
+---
+# 预置属性
+
+以下预置属性，是 PHP SDK 中所有事件都会带有的预置属性。
+
+**属性名**
+
+**中文名**
+
+**属性类型**
+
+**说明**
+
+#ip
+
+IP 地址
+
+文本
+
+用户的 IP 地址，需要进行手动设置，AE 将以此获取用户的地理位置信息
+
+#country
+
+国家
+
+文本
+
+用户所在国家，根据 IP 地址生成
+
+#country_code
+
+国家代码
+
+文本
+
+用户所在国家的国家代码(ISO 3166-1 alpha-2，即两位大写英文字母)，根据 IP 地址生成
+
+#province
+
+省份
+
+文本
+
+用户所在省份，根据 IP 地址生成
+
+#city
+
+城市
+
+文本
+
+用户所在城市，根据 IP 地址生成
+
+#lib
+
+SDK 类型
+
+文本
+
+您接入 SDK 的类型，如 Java 等
+
+#lib_version
+
+SDK 版本
+
+文本
+
+您接入  SDK 的版本