npm - @thinkingai/ae-cli - Versions diffs - 1.0.28 → 6.0.16 - Mend

@thinkingai/ae-cli 1.0.28 → 6.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (360) hide show

package/wiki/te-docs/raw//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/egret.md ADDED Viewed

@@ -0,0 +1,166 @@
+---
+code: egret_sdk_installation
+name: "Egret "
+wikiToken: TwNbwKODFiQ8UGkdWC5cyx7anZQ
+parentWikiToken: G5xvwevvSi8u93kR0RwcN52MnFc
+updateTime: 1776262608000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=zh-CN&code=egret_sdk_installation
+---
+::: tip 提示
+ 在接入前, 请先阅读[<text color="purple" underline="true">接入前准备</text>](https://thinkingdata.feishu.cn/wiki/OvpawZlw1idmxzkwiJWcxlfNnNc)。
+Egret SDK 支持平台：HTML5、iOS、Android、微信小游戏、百度小游戏、小米快游戏、OPPO小游戏、vivo小游戏、QQ小游戏、360小游戏、字节跳动小游戏、华为快游戏、支付宝小游戏、淘宝创意互动小程序、Facebook。
+ :::
+**最新版本:** v3.0.2
+**更新时间:** 2024-02-09
+**资源下载:**** **[源码](https%3A%2F%2Fgithub.com%2FThinkingDataAnalytics%2Fmp-sdk%2Ftags)、[SDK下载](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2Frelease%2Fta_egret_sdk.zip)
+::: warning 注意
+当前文档适用于 v3.0.0 及以后的版本，历史版本请参考 [Egret 接入指南（V2）](https%3A%2F%2Fdocs.thinkingdata.cn%2Fta-manual%2Fv4.1%2Finstallation%2Finstallation_menu%2Fclient_sdk%2Fgame_engine_sdk_installation%2Fegret_sdk_installation%2Fegret_sdk_installation.html)，[SDK下载（v2.2.4）](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_egret_sdk_v2.2.4.zip)
+:::
+## 一、集成SDK
+下载并解压 [Egret SDK](https://download.thinkingdata.cn/client/release/ta_egret_sdk.zip).
+引入 SDK 库与引入其他第三方库过程相同，在 egretProperties.json 中引入该库并编译引擎。
+```json
+{
+     "name": "ta_egret_sdk",
+     "path": "./libs/ta_egret_sdk"
+}
+```
+引入到项目中之后编译引擎即可使用 SDK 库。
+## 二、初始化
+引入 AE SDK 后，您可以在代码中使用 TDAnalytics:
+```javascript
+// TE 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 列表中.
+ :::
+## 三、常用功能
+在使用常用功能之前，建议你先了解[用户识别规则](https://thinkingdata.feishu.cn/wiki/AUyiw6XZsiF9EMk2fBScKjzunjd)；SDK默认会生成随机数作为访客ID，并持久化存储访客ID在本地；用户未登录之前，会以访客ID作为身份识别ID。注意:访客 ID 在用户清理缓存 以及更换设备时将会变更。
+### 3.1 设置账号ID
+在用户进行登录时，可调用 `login` 来设置用户的账号 ID， AE 平台将会以账号 ID 作为身份识别 ID，并且设置的账号 ID 将会在调用 `logout` 之前一直保留。多次调用 `login` 将覆盖先前的账号 ID 。
+```javascript
+// 用户的登录唯一标识，此数据对应上报数据里的#account_id，此时#account_id的值为TA
+TDAnalytics.login("TA");
+```
+<quote-container>
+**该方法不会上传登录事件**
+</quote-container>
+### 3.2 设置公共事件属性
+公共事件属性指的就是每个事件都会带有的属性，您可以调用 `setSuperProperties` 来设置公共事件属性，我们推荐您在发送事件前，先设置公共事件属性。对于一些重要的属性，譬如用户的会员等级、来源渠道等，这些属性需要设置在每个事件中，此时您可以将这些属性设置为公共事件属性。
+```javascript
+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 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组
+<quote-container>
+**事件属性、用户属性的要求与公共事件属性保持一致**
+</quote-container>
+### 3.3 发送事件
+您可以调用 `track` 来上传事件，建议您根据先前梳理的埋点文档来设置事件的属性以及发送信息的条件，此处以用户购买某商品作为范例：
+```javascript
+TDAnalytics.track({
+    eventName: "product_buy", // 事件名称
+    properties: {
+        product_name: "商品名"
+    } //事件属性
+});
+```
+事件的名称是字符串类型，只能以字母开头，可包含数字，字母和下划线 "_"，长度最大为 50 个字符。
+### 3.4 设置用户属性
+对于一般的用户属性，您可以调用 `userSet` 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：
+```javascript
+//此时username为TA
+TDAnalytics.userSet({
+    properties: {
+        username: "TA"
+    }
+});
+//此时userName为AE
+TDAnalytics.userSet({
+    properties: {
+        username: "TE"
+    }
+});
+```
+## 四、最佳实践
+以下示例代码包含以上所有操作，我们推荐按照如下步骤使用:
+```javascript
+var TDAnalytics = require("./tdanalytics.egert.min.js");
+var config = {
+  appId: "YOU-APP-ID", // 项目的 APP ID
+  serverUrl: "https://youserverurl.com", // 数据上报地址
+  autoTrack: {
+    appLaunch: true, // 自动采集 ta_mp_launch
+    appShow: true, // 自动采集 ta_mp_show
+    appHide: true, // 自动采集 ta_mp_hide
+    pageShow: true, // 自动采集 ta_mp_view
+    pageShare: true // 自动采集 ta_mp_share
+  }
+};
+// 初始化
+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//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/layaair//346/233/264/346/226/260/346/227/245/345/277/227.md ADDED Viewed

@@ -0,0 +1,87 @@
+---
+code: laya_sdk_release_note
+name: "更新日志"
+wikiToken: YD5iwD7RtiXWxEkOcc4c34crnBd
+parentWikiToken: DwgQwnSQpibhLEkcrR8cQbaHnKg
+updateTime: 1780571723000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=zh-CN&code=laya_sdk_release_note
+---
+## v3.6.1
+**更新时间:  2026/06/04 **[**下载**](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_laya_sdk_v3.6.1.zip)
+**更新内容：**
+- 修复已知问题
+## v3.0.2
+**更新时间:  2024/02/09 **[**下载**](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_laya_sdk_v3.0.2.zip)
+**更新内容：**
+- 重构batch模式发送数据
+## v3.0.1
+**更新时间:  2023/11/24 **[**下载**](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_laya_sdk_v3.0.1.zip)
+**更新内容：**
+- 代码优化
+## v3.0.0
+**更新时间:  2023/08/28 **[**下载**](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_laya_sdk_v3.0.0.zip)
+**更新内容：**
+- 代码优化
+## v2.2.4
+**更新时间:  2023/07/28 **[**下载**](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_laya_sdk_v2.2.4.zip)
+**更新内容：**
+- 代码优化
+## v2.2.0
+**更新时间:  2022/08/15**
+**更新内容：**
+- 新增支持事件缓存
+- 代码优化
+## v2.1.0
+**更新时间:  2022/06/28**
+**更新内容：**
+- 新增支持去重追加用户属性
+- Web平台支持ta_page_show/ta_page_hide事件
+- 新增支持数据加密上报
+- 代码优化
+## v2.0.3
+**更新时间:  2022/02/21**
+**更新内容：**
+- 自动采集事件支持自定义属性
+- 代码优化
+## v2.0.2
+**更新时间:  2021/12/31**
+**更新内容：**
+- 支持趣头条、Facebook、GooglePlay等小游戏
+- 代码优化
+## v2.0.1
+**更新时间:  2021/11/15**
+**更新内容：**
+- 代码优化
+- 支持复杂数据类型
+## v2.0.0
+**更新时间:  2021/09/15**
+**更新内容：**
+- 支持 iOS/Android Native
+- 支持暂停/开始、停止/恢复数据上报
+- 支持事件黑名单
+- 代码优化
+## v1.8.2
+**更新时间:  2021/06/24**
+**更新内容：**
+- 支持预置属性获取
+- fix bug:原生/web平台运行时，断网重连导致的数据发送失败问题
+## v1.8.0
+**更新时间:  2020/11/20**
+**更新内容：**
+- 新增哔哩哔哩小游戏支持
+- 完善游戏引擎支持：支持 ts 项目接入
+- 完善游戏引擎支持：支持常见小游戏、快游戏平台(华为、小米、OPPO、VIVO)、H5 游戏
+- 其他代码细节层面的优化
+## v1.7.0
+**更新时间:  2020/08/24**
+**更新内容：**支持首次事件，可更新事件，可重写事件
+## v1.6.0
+**更新时间:  2020/06/10**
+**更新内容:**支持 debug 模式
+## v1.5.1
+**更新时间:  2020/03/21**
+**更新内容:**
+- 支持白鹭引擎小游戏平台：微信小游戏、百度小游戏、QQ 小游戏、VIVO 小游戏、OPPO 小游戏
+- 支持 LAYABOX 引擎小游戏平台：微信小游戏、百度小游戏、QQ 小游戏、VIVO 小游戏、OPPO 小游戏
+- 支持 CocosCreator 引擎小游戏平台：微信小游戏、百度小游戏、VIVO 小游戏、OPPO 小游戏

package/wiki/te-docs/raw//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/layaair//350/277/233/351/230/266/346/214/207/345/215/227/native/346/224/257/346/214/201.md ADDED Viewed

@@ -0,0 +1,71 @@
+---
+code: laya_sdk_native
+name: "Native支持"
+wikiToken: JQaWwYpaXimQlwkmQHgcZTRUnXc
+parentWikiToken: UGaFwQQPEi69XukGdVocvRTSnjh
+updateTime: 1774247996000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=zh-CN&code=laya_sdk_native
+---
+## 一、 iOS Native 支持
+### 1.1 构建iOS项目
+- 构建准备
+  - 发布 Web 平台应用，记录发布文件路径
+- 构建配置
+  - 打开`菜单`-`工具`-`app构建`界面
+  - 项目类型选择 `XCode iOS`，勾选`单机版`
+  - 资源路径选择 Web 平台应用的发布路径
+### **1.2 配置 iOS 工程**
+- 添加 iOS 工程依赖文件
+  - `LayaProxyApi.h`
+  - `LayaProxyApi.mm`
+  - `ThinkingSDK.framework`
+- Build Settings 设置
+  - `Other Linker Flags` 添加 `-ObjC`
+## 二、 Android Native 支持
+### 2.1 构建Android项目
+- 构建准备
+  - 发布 Web 平台应用，记录发布文件路径
+- 构建配置
+  - 打开`菜单 - 工具 - app构建`界面
+  - 项目类型选择 `Android studio`，勾选`单机版`
+  - 资源路径选择 Web 平台应用的发布路径
+### **2.2 配置 Android 工程**
+- 在 Adnroid 显示模式的 app 工程中，把依赖文件 `LayaProxyApi.java` 加入到 `demo` 中，如下图
+- 在项目的 `app/libs` 目录下，将 `ThinkingSDK.aar` 拷贝到其中
+- 在 `Module` 下的 `build.gradle` 文件中添加依赖项
+```groovy
+dependencies {
+    ...
+    implementation fileTree(dir: 'libs', include: ['*.aar'])
+}
+```
+## 三、 开启 Native 支持
+初始化 SDK 时，在 `config` 中加入 `enableNative: true`，即可开启 Native 支持。
+```javascript
+// TA SDK 配置对象
+var config = {
+  appId: "YOUR_APPID", // 项目 APP ID
+  serverUrl: "YOUR_SERVER_URL", // 上报地址
+  enableNative: true, // 允许调用 Native 代码
+  autoTrack: {
+    appShow: true, // 自动采集 启动事件
+    appHide: true, // 自动采集 关闭事件
+    appClick: true, // 自动采集 点击事件（仅 native 生效）
+    appView: true, // 自动采集 浏览事件（仅 native 生效）
+    appCrash: true, // 自动采集 崩溃事件（仅 native 生效）
+    appInstall: true // 自动采集 安装事件（仅 native 生效）
+  }
+};
+// 初始化
+TDAnalytics.init(config);
+// 上报一个简单事件, 事件名为 test_event
+TDAnalytics.track({
+    eventName: "test_event"
+});
+```

@@ -0,0 +1,54 @@
+---
+code: laya_sdk_debug
+name: "实时调试"
+wikiToken: F3VOwjFJiiHJk0kmCvDcMB1Znrc
+parentWikiToken: UGaFwQQPEi69XukGdVocvRTSnjh
+updateTime: 1776262599000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=zh-CN&code=laya_sdk_debug
+---
+在SDK接入过程中，您可以通过查看SDK在IDE控制台中的日志或者使用 AE 的 Debug 功能，进行实时调试。
+### 一、打印SDK日志
+```javascript
+var config = {
+    appId: "xxx",
+    serverUrl: "xxx",
+    enableLog:true
+};
+TDAnalytics.init(config);
+```
+<quote-container>
+打开日志后，可以在IDE中过滤 ThinkingAnalytics 相关的日志来观察 SDK 的数据上报。
+</quote-container>
+### 二、开启 Debug 模式
+开启Debug模式需要如下两步操作:
+1. 客户端开启Debug模式
+以下是客户端开启Debug模式的示例代码:
+```java
+/*
+设置运行模式为 Debug 模式
+none:数据会存入缓存，并依据一定的缓存策略上报,默认为NORMAL模式；建议在线上环境使用
+debug:数据逐条上报。当出现问题时会以日志和异常的方式提示用户；不建议在线上环境使用
+debugOnly:只对数据做校验，不会入库；不建议在线上环境使用
+ */
+var config = {
+  appid: "YOUR_APPID",
+  server_url: "YOUR_SERVER_URL",
+  debugMode: "debug"
+};
+TDAnalytics.init(config);
+```
+2. AE 后台添加Debug设备
+为了避免 Debug 模式在生产环境上线，规定只有指定的设备才能开启 Debug 模式。只有在客户端开启了 Debug 模式，并且设备 ID 在 AE 后台的"埋点管理"页的"Debug 数据"板块中配置了的设备才能开启 Debug 模式。
+<image token="CblAbjlXJoSpL1x3xStcXS5nnD3" width="2309" height="857" align="center"/>
+设备 ID 可以通过以下三种方式获取：
+- AE 平台中事件数据中的 #device_id 属性
+- 客户端日志：SDK 初始化完成后会打印设备 DeviceId
+- 通过实例接口调用：[<text color="purple" underline="true">获取设备ID</text>](https://thinkingdata.feishu.cn/wiki/UGaFwQQPEi69XukGdVocvRTSnjh)
+<quote-container>
+Debug 模式可能会影响数据采集质量和 App 的稳定性，只用于集成阶段数据验证，不要在线上环境使用。
+</quote-container>

@@ -0,0 +1,61 @@
+---
+code: laya_sdk_autotrack
+name: "自动采集"
+wikiToken: GOP3wbRF9ipjArkyv34cMrWfnhf
+parentWikiToken: UGaFwQQPEi69XukGdVocvRTSnjh
+updateTime: 1774247991000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=zh-CN&code=laya_sdk_autotrack
+---
+在创建实例的 config 中开启您需要自动采集的事件，SDK 将会自动采集小游戏的一些行为，现在主要有以下几种事件支持自动采集：
+现在支持的自动化收集数据有：
+1. 小游戏回到前台的事件
+2. 小游戏调入后台，并记录本次访问（启动至调入后台）的时间
+接下来将会详细介绍每种数据的采集方法
+## 一、 开启自动采集事件
+在 config 中，参数 `autoTrack` 中的元素表示每个自动采集事件的开关，设置为 `true` 为开启自动采集：
+```javascript
+var config = {
+    appid: "YOUR_APPID",
+    server_url: "YOUR_SERVER_URL",
+    autoTrack: {
+         appLaunch: true, // 自动采集 ta_mg_launch
+         appShow: true, // 自动采集 ta_mg_show
+         appHide: true, // 自动采集 ta_mg_hide
+         properties: { // 自动采集自定义属性staticKey: 'staticValue'},
+         callback: (eventType:any) =>{ // 自动采集回调
+           if (eventType === 'appShow')
+           {
+            return { appShowKey: 'appShowValue' };
+           }
+           else if (eventType === 'appHide')
+           {
+            return { appHideKey: 'appHideValue' };
+           }
+           else {
+             return {};
+           }
+         }
+     }
+};
+```
+- appLaunch：自动采集小程序初始化
+- appShow：自动采集小游戏启动，或从后台进入前台
+- appHide：自动采集小游戏从前台进入后台
+- properties：自动采集自定义属性（支持appShow/appHide）
+- callback：自动采集回调（支持appShow/appHide）
+## 二、 自动采集事件详解
+### 2.1 小游戏启动
+小游戏启动将会在小游戏被启动、或小游戏被从后台调回前台时触发，详细的事件介绍如下：
+- 事件名：ta_mg_show
+- 自动采集属性：
+- `#scene`，场景值，取自微信提供的场景值
+小游戏启动由于会受到调出前后台的影响（条数较多），因此不太适合直接进行分析，但是可以在行为路径中标识用户的一次使用，可以作为用户行为路径的初始行为
+### 2.2 小游戏隐藏
+小游戏隐藏将会在小游戏被调入后台时触发，并记录本次使用的时长，详细的事件介绍如下：
+- 事件名：ta_mg_hide
+- 自动采集属性：
+  - `#scene`，场景值，取自微信提供的场景值
+  - `#duration`，数值型，表示本次启动（ta_mg_show）到隐藏的持续时长
+小游戏隐藏事件会记录使用时长（单位为秒），因此可以直接计算用户使用总时长以及人均时长，也可以除以初始化次数计算单次使用时长。