ae-tracking 0.1.0

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/cocoscreator.md

@@ -0,0 +1,213 @@
+---
+code: cocoscreator_sdk_installation
+name: "CocosCreator"
+wikiToken: MLL7wtab3ivQNYk3TDJcbjJRnRd
+parentWikiToken: BAU2w0eipiqGnckeUsIc0mYQnZc
+updateTime: 1773027497000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=cocoscreator_sdk_installation
+---
+# CocosCreator
+
+::: tip 提示
+
+ 在接入前, 请先阅读接入前准备。
+
+CocosCreator SDK 支持平台：Android、iOS、鸿蒙、Web、微信小游戏、支付宝小游戏、淘宝小游戏、字节跳动小游戏、OPPO小游戏、华为快游戏、vivo小游戏、小米快游戏、百度小游戏、趣头条小游戏、Facebook小游戏、Google Play小游戏。
+
+ :::
+
+**最新版本:** v3.5.0
+
+**更新时间:** 2026-03-09
+
+**资源下载**: 源码、SDK下载
+
+::: warning 注意
+
+当前文档适用于 v3.0.0 及以后的版本，历史版本请参考 CocosCreator 接入指南（V2），SDK下载（v2.2.4）
+
+::: 
+
+### 一、集成SDK
+
+下载并解压 CocosCreator SDK
+
+:::: el-tabs
+
+::: el-tab-pane label=TypeScript 集成
+
+如果您的项目是 TypeScript 工程，接入步骤如下：
+
+1. 将声明文件 tdanalytics.cc.d.ts 放入项目根目录下 assets 下级的 libs 目录，如果 libs 不存在，新建 libs 目录
+1. 将 SDK 文件 (tdanalytics.mg.cocoscreator.min.js) 放入 assets/Script 目录中
+:::
+
+::: el-tab-pane label=JavaScript 集成
+
+ 如果您的项目是 JavaScript 工程，您可以直接将 SDK 文件 (tdanalytics.mg.cocoscreator.min.js) 放入 assets/Script 目录中
+
+:::
+
+::::
+
+### 二、初始化
+
+引入 AE SDK 后，您可以在代码中使用 TDAnalytics:
+
+<!-- unsupported block: 19 -->
+
+打包淘宝小游戏平台TDAnalytics挂载在window对象上，需要使用var TDAnalytics = window['TDAnalytics']
+
+```
+// AE SDK 配置对象
+var config = {
+  appId: "YOUR_APPID", // 项目 APP ID
+  serverUrl: "YOUR_SERVER_URL", // 上报地址
+  autoTrack: {
+    appLaunch: true, // 自动采集 ta_mg_launch
+    appShow: true, // 自动采集 ta_mg_show
+    appHide: true // 自动采集 ta_mg_hide
+  }
+};
+// 初始化
+TDAnalytics.init(config);
+```
+
+AE 配置对象参数说明如下：
+
+- `appId`: 您项目的 APP ID，必需, 可以在 AE 后台项目管理页查看
+- `serverUrl`: 数据上报 URL，必需 
+- 如果您使用的是云服务，填入: https://global-receiver-ta.thinkingdata.cn
+- 如果您使用的是私有化部署的版本，请与运维同学确认上报地址
+- `autoTrack`：可选, 表示是否开启自动采集功能，每一个元素分别代表如下的自动采集事件，默认全部关闭： 
+- `appLaunch`：自动采集小游戏初始化
+- `appShow`：自动采集小游戏启动，或从后台进入前台
+- `appHide`：自动采集小游戏从前台进入后台，并记录本次访问（启动至调入后台）的时间
+::: warning 注意
+
+ 在上报数据之前，请先在微信公众平台或其他平台的开发设置中，将数据传输 URL 加入到服务器域名的 request 列表中.
+
+ :::
+
+### 三、常用功能 
+
+在使用常用功能之前，建议你先了解用户识别规则。SDK默认会生成随机数作为访客ID，并持久化存储访客ID在本地，用户未登录之前，会以访客ID作为身份识别ID。注意:访客 ID 在用户清理缓存 以及更换设备时将会变更。
+
+#### 3.1 设置账号ID
+
+在用户进行登录时，可调用 `login` 来设置用户的账号 ID， AE 平台将会以账号 ID 作为身份识别 ID，并且设置的账号 ID 将会在调用 `logout` 之前一直保留。多次调用 `login` 将覆盖先前的账号 ID 。
+
+```
+// 用户的登录唯一标识，此数据对应上报数据里的#account_id，此时#account_id的值为TA
+TDAnalytics.login("TA");
+```
+
+<!-- unsupported block: 34 -->
+
+**该方法不会上传登录事件**
+
+#### 3.2 设置公共事件属性
+
+公共事件属性指的就是每个事件都会带有的属性，您可以调用 `setSuperProperties` 来设置公共事件属性，我们推荐您在发送事件前，先设置公共事件属性。对于一些重要的属性，譬如用户的会员等级、来源渠道等，这些属性需要设置在每个事件中，此时您可以将这些属性设置为公共事件属性。
+
+```
+var superProperties = {
+    channel : "ta", //字符串
+    age : 1,//数字
+    isSuccess : true,//布尔
+    birthday :  new Date(),//对象
+    object : { key : "value" },//对象
+    object_arr : [ { key : "value" } ],//对象组
+    arr : [ "value" ]//数组
+};
+//设置公共事件属性
+TDAnalytics.setSuperProperties(superProperties);
+```
+
+公共事件属性将会被保存到缓存中，无需每次启动时调用。如果调用 `setSuperProperties` 上传了先前已设置过的公共事件属性，则会覆盖之前的属性。
+
+- Key 为该属性的名称，为字符串类型，规定只能以字母开头，包含数字，字母和下划线 "_"，长度最大为 50 个字符，对字母大小写不敏感，AE 会统一转化为小写字母
+- Value 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组
+<!-- unsupported block: 34 -->
+
+**事件属性、用户属性的要求与公共事件属性保持一致**
+
+#### 3.3 发送事件
+
+您可以调用 `track` 来上传事件，建议您根据先前梳理的埋点文档来设置事件的属性以及发送信息的条件，此处以用户购买某商品作为范例：
+
+```
+TDAnalytics.track({
+    eventName: "product_buy", // 事件名称
+    properties: { 
+        product_name: "商品名" 
+    } //事件属性
+});
+```
+
+事件的名称是字符串类型，只能以字母开头，可包含数字，字母和下划线 "_"，长度最大为 50 个字符。
+
+#### 3.4 设置用户属性
+
+对于一般的用户属性，您可以调用 `userSet` 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：
+
+```
+//此时username为TA
+TDAnalytics.userSet({
+    properties: { username: "TA" }
+});
+//此时userName为TE
+TDAnalytics.userSet({
+    properties: { username: "TE" }
+});
+```
+
+### 四、最佳实践
+
+以下示例代码包含以上所有操作，我们推荐按照如下步骤使用:
+
+```
+var config = {
+  appId: "YOUR_APPID", // 项目 APP ID
+  serverUrl: "YOUR_SERVER_URL", // 上报地址
+  autoTrack: {
+    appLaunch: true, // 自动采集 ta_mp_launch
+    appShow: true, // 自动采集 ta_mg_show
+    appHide: true // 自动采集 ta_mg_hide
+  }
+};
+//初始化
+TDAnalytics.init(config);
+// 用户的登录唯一标识，此数据对应上报数据里的#account_id，此时#account_id的值为TA
+TDAnalytics.login("TA");
+//设置公共事件属性
+var superProperties = {
+    channel : "ta", //字符串
+    age : 1,//数字
+    isSuccess : true,//布尔
+    birthday :  new Date(),//对象
+    object : { key : "value" },//对象
+    object_arr : [ { key : "value" } ],//对象组
+    arr : [ "value" ]//数组
+};
+TDAnalytics.setSuperProperties(superProperties);
+//发送事件
+TDAnalytics.track({
+    eventName: "product_buy", // 事件名称
+    properties: {
+        product_name: "商品名"
+    } //事件属性
+});
+//设置用户属性
+TDAnalytics.userSet({
+    properties: {
+        username: "TE"
+    }
+});
+```
+
+#### 
+
+### 
+
+###

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/corona//345/220/210/350/247/204/346/214/207/345/215/227.md

@@ -0,0 +1,39 @@
+---
+code: corona_sdk_compliance
+name: "合规指南"
+wikiToken: Bm8YwOEjkijXqcktILTciohUn3s
+parentWikiToken: PVJhwxxtii9DDMkg45ecpCjJnge
+updateTime: 1745309783000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=corona_sdk_compliance
+---
+# 合规指南
+
+### 一. 隐私政策中填写 SDK 相关内容
+
+#### 1.1 收集和获取
+
+在《隐私政策》中收集和获得您的个人信息栏目中根据实际情况填写以下内容。
+
+当您在激活使用时，我们会通过TDAnalytics-SDK收集您的设备信息（IDFV、AndroidID、操作系统、设备型号、设备制造商、系统版本、应用进程信息等）用于统计分析您在 App 内的使用效果。
+
+#### 1.2 与授权合作伙伴共享
+
+在《隐私政策》中的与授权合作伙伴共享栏目中根据实际情况填写以下内容。
+
+TDAnalytics-SDK：收集您的设备信息（IDFV、AndroidID、操作系统、设备型号、设备制造商、系统版本、应用进程信息等）、联网信息用于数据分析，从而改进我们的产品和服务。
+
+### 二. SDK合规步骤
+
+TDAnalytics SDK 需要您确保用户在同意 《隐私政策》后初始化SDK
+
+```
+ local TDAnalytics = require("TDAnalytics")
+-- 根据隐私协议判断是否开启数据采集
+if (授权隐私政策) {
+    local params = {
+        appId = "YOUR_APP_ID",
+        serverUrl = "YOUR_SERVER_URL"
+    }
+    TDAnalytics.init(params)
+}
+```

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/corona//346/233/264/346/226/260/346/227/245/345/277/227.md

@@ -0,0 +1,42 @@
+---
+code: corona_sdk_release_note
+name: "更新日志"
+wikiToken: NoH9w8px8iYxQWkiFwYct1g4nOd
+parentWikiToken: PVJhwxxtii9DDMkg45ecpCjJnge
+updateTime: 1745309784000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=corona_sdk_release_note
+---
+# 更新日志
+
+### v2.0.1
+
+**更新时间:  2023/11/24 ****下载**
+
+**更新内容：**
+
+- 代码优化
+### v2.0.0
+
+**更新时间:  2023/09/06 ****下载**
+
+**更新内容：**
+
+- 代码优化
+### v1.0.1
+
+**更新时间:  2023/03/21 ****下载**
+
+**更新内容：**
+
+- 部分代码优化
+### v1.0.0
+
+**更新时间:  2022/09/15**
+
+**更新内容：**
+
+- 支持 访客 ID 和 用户账号 的设置
+- 支持事件和用户属性上报
+- 支持启动 / 关闭 / 安装事件的自动上报
+- 支持公共属性接口
+- 支持 timeEvent 接口

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/corona//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,59 @@
+---
+code: corona_sdk_debug
+name: "实时调试"
+wikiToken: TOpTwBIvWiddnYktJWVcOEb1nmd
+parentWikiToken: RVJ3wFYzKihJdTkZEwSchyxNnig
+updateTime: 1745310896000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=corona_sdk_debug
+---
+# 实时调试
+
+#### 一、打印SDK日志
+
+```
+-- 开启打印日志
+local params = {
+    appId = "YOUR_APP_ID",
+    serverUrl = "YOUR_SERVER_URL",
+    enableLog = true, -- true=开启打印日志, false=关闭打印日志
+}
+TDAnalytics.init( params )
+```
+
+<!-- unsupported block: 34 -->
+
+打开日志后，可以在IDE中过滤 ThinkingData 相关的日志来观察 SDK 的数据上报。
+
+#### 二、开启 Debug 模式
+
+开启Debug模式需要如下两步操作:
+
+1. 客户端开启Debug模式
+以下是客户端开启Debug模式的示例代码:
+
+```
+--[[
+设置运行模式为 Debug 模式
+normal模式:数据会存入缓存，并依据一定的缓存策略上报,默认为NORMAL模式；建议在线上环境使用
+debug模式:数据逐条上报。当出现问题时会以日志和异常的方式提示用户；不建议在线上环境使用
+debugOnly模式:只对数据做校验，不会入库；不建议在线上环境使用
+]]--
+local params = {
+    appId = "YOUR_APP_ID",
+    serverUrl = "YOUR_SERVER_URL",
+    debugMode = "debug",  -- normal, debug, debugOnly
+}
+TDAnalytics.init( params )
+```
+
+1. AE 后台添加Debug设备
+为了避免 Debug 模式在生产环境上线，规定只有指定的设备才能开启 Debug 模式。只有在客户端开启了 Debug 模式，并且设备 ID 在 AE 后台的"埋点管理"页的"Debug 数据"板块中配置了的设备才能开启 Debug 模式。
+
+设备 ID 可以通过以下三种方式获取：
+
+- AE 平台中事件数据中的 #device_id 属性
+- 客户端日志：SDK 初始化完成后会打印设备 DeviceId
+- 通过实例接口调用：获取设备ID
+<!-- unsupported block: 34 -->
+
+Debug 模式可能会影响数据采集质量和 App 的稳定性，只用于集成阶段数据验证，不要在线上环境使用。

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/corona//350/277/233/351/230/266/346/214/207/345/215/227//350/207/252/345/212/250/351/207/207/351/233/206.md

@@ -0,0 +1,37 @@
+---
+code: corona_sdk_autotrack
+name: "自动采集"
+wikiToken: RORawLGU4iWLmdkbtWQcm3I2npf
+parentWikiToken: RVJ3wFYzKihJdTkZEwSchyxNnig
+updateTime: 1745309779000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=corona_sdk_autotrack
+---
+# 自动采集
+
+TDAnalytics SDK 提供了三种事件的自动采集：
+
+- `appInstall`: 游戏安装，当安装后首次打开游戏会采集该事件（事件名 `ta_app_install`）
+- `appStart`: 游戏进入前台的时候采集该事件（事件名 `ta_app_start`）
+- `appEnd`: 游戏退到后台的时候采集该事件（事件名 `ta_app_end`）
+通过调用配置初始化参数可以开启自动采集：
+
+```
+-- 开启自动采集 
+-- appInstall=开启自动采集安装事件
+-- appStart=开启自动采集开始事件
+-- appEnd=开启自动采集结束事件
+local params = {
+    appId = "YOUR_APP_ID",
+    serverUrl = "YOUR_SERVER_URL",
+    autoTrack = {
+        "appStart", "appEnd", "appInstall"
+    }
+}
+TDAnalytics.init( params )
+```
+
+<!-- unsupported block: 34 -->
+
+注意： 如果您需要自定义访客 ID，请务必在开启自动采集功能之前调用 `setDistinctId` 接口设置访客 ID.
+
+###

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/corona//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,50 @@
+---
+code: corona_sdk_preset_properties
+name: "预置属性"
+wikiToken: YmabwBZ9oiy2YtkDUnycJhgFnEf
+parentWikiToken: RVJ3wFYzKihJdTkZEwSchyxNnig
+updateTime: 1745310897000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=corona_sdk_preset_properties
+---
+# 预置属性
+
+#### 一、 预置属性说明
+
+<!-- unsupported block: 34 -->
+
+各个平台采集的预置属性会有一定的差异，具体可以参考如下文档: Android平台 、 iOS平台  
+
+#### 二、 获取预置属性
+
+服务端埋点需要 App 端的一些预置属性时，可以通过此方法获取 App 端的预置属性，再传给服务端。
+
+```
+-- 获取属性对象
+TDAnalytics.getPresetProperties( function (ret)
+    local presetProperties = ret
+    print( "current presetProperties = " .. presetProperties )
+end )
+--[[
+   {
+        "#carrier": "中国电信", -- 手机SIM卡运营商信息，双卡双待时，取主卡的运营商信息
+        "#os": "Android", -- 系统类型，如 Android/iOS
+        "#device_id": "abb8e87bfb5ce66c", -- 设备唯一标识
+        "#screen_height": 2264, -- 屏幕高度
+        "#bundle_id": "com.sw.thinkingdatademo", -- 包名
+        "#manufacturer": "realme", -- 手机制造商 如 HuaWei
+        "#device_model": "RMX1991", -- 设备型号
+        "#screen_width": 1080, -- 屏幕宽度
+        "#system_language": "zh", -- 手机系统语言类型
+        "#os_version": "10", -- 系统版本号
+        "#network_type": "WIFI", -- 网络类型
+        "#zone_offset": 8， -- 时区偏移值
+        "#app_version":"1.0" -- app版本号
+    }
+]]--
+```
+
+<!-- unsupported block: 34 -->
+
+IP，国家城市信息由服务端解析生成，客户端不提供接口获取这些属性
+
+###