@thinkingai/ae-cli 6.0.36 → 6.0.38
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.
- package/README.md +216 -150
- package/README.zh.md +224 -159
- package/dist/{auth-B2BRSYMS.js → auth-56Z45UVR.js} +1 -1
- package/dist/{capability-6KPXYNO7.js → capability-2H6PAOA3.js} +1 -1
- package/dist/{capability-ROKYESAP.js → capability-YPOQX6PL.js} +1 -1
- package/dist/{chunk-JTKMDN4A.js → chunk-KTYR3U6D.js} +471 -31
- package/dist/{chunk-EBPXT3TN.js → chunk-LHVM35J4.js} +1 -1
- package/dist/{chunk-RRFK2W7I.js → chunk-PVBYJWC2.js} +1 -1
- package/dist/{config-DDYJPJX3.js → config-BSSALXEN.js} +1 -1
- package/dist/index.js +44 -14
- package/dist/{metadata-2ZFRMVOL.js → metadata-AN3YFZEV.js} +2 -2
- package/dist/{metadata-ABQCKU5P.js → metadata-JIQ77HFY.js} +2 -2
- package/dist/{raw-6HXFFHLV.js → raw-XJCAT3HX.js} +1 -1
- package/dist/{sync-BF3IWYFC.js → sync-QFP4XFN3.js} +1 -1
- package/dist/{te-agent-3GJ5H2XF.js → te-agent-JHUG6DVV.js} +27 -0
- package/dist/{te-analysis-DJ6KELTU.js → te-analysis-ITKTO6JS.js} +463 -16
- package/dist/{te-analysis-PCGESPLW.js → te-analysis-RAC67YYD.js} +463 -16
- package/dist/{te-dataops-ROHUJOX5.js → te-dataops-PZQ5NQLY.js} +1 -1
- package/dist/{te-dataops-LXL5YULV.js → te-dataops-XTWVTJCA.js} +1 -1
- package/dist/{te-engage-2YDCA552.js → te-engage-E7F4HTXU.js} +2 -2
- package/dist/{te-engage-VW6NJZ5V.js → te-engage-NLZUPSBK.js} +2 -2
- package/dist/{te-team-RRZI4WRI.js → te-team-BQ3SKSZV.js} +1 -1
- package/dist/{update-ER7VFU55.js → update-DKG6UXEM.js} +44 -22
- package/package.json +5 -4
- package/skills/ae-agent/SKILL.md +2 -2
- package/skills/ae-agent/references/create-automation.md +11 -0
- package/skills/ae-agent/references/update-automation.md +11 -3
- package/skills/ae-analysis/references/command_index.md +5 -0
- package/skills/ae-analysis/references/debug_data_list.md +28 -0
- package/skills/ae-analysis/references/debug_device_add.md +23 -0
- package/skills/ae-analysis/references/debug_device_list.md +19 -0
- package/skills/ae-analysis/references/debug_device_select.md +22 -0
- package/skills/ae-analysis/references/plan_sync_display_names.md +28 -0
- package/skills/ae-generate-tracking-code/SKILL.md +27 -11
- package/skills/ae-generate-tracking-code/references/autotrack-enum.md +4 -4
- package/skills/ae-generate-tracking-code/references/client-sdk-insert.md +1 -1
- package/skills/ae-generate-tracking-code/references/debug-script.md +48 -39
- package/skills/ae-generate-tracking-code/references/logbus-config.md +1 -1
- package/skills/ae-generate-tracking-code/references/restful-call.md +1 -1
- package/skills/ae-generate-tracking-code/references/sdk-index.md +36 -36
- package/skills/ae-generate-tracking-plan/SKILL.md +26 -1
|
@@ -3,28 +3,33 @@
|
|
|
3
3
|
> **Terminology**: 校验脚本 = validation/debug script | 设备绑定 = device binding | Debug 模式 = debug mode | TDDebugConsumer = debug mode consumer (validates data format, does NOT persist to production) | 实时调试 = real-time debugging | 代表业务事件 = representative business events | SDK 日志打印 = SDK log printing
|
|
4
4
|
|
|
5
5
|
## Deliverable
|
|
6
|
+
|
|
6
7
|
`te-debug.<ext>` single file; used to quickly verify SDK configuration is correct.
|
|
7
8
|
|
|
8
9
|
---
|
|
9
10
|
|
|
10
11
|
## Debug Mode Verification
|
|
11
12
|
|
|
12
|
-
When using debug mode,
|
|
13
|
+
When using debug mode, register and select the debug device with `ae-cli` before sending events. The Agent can then query the received Debug data directly, without asking the user to return to the AE page.
|
|
13
14
|
|
|
14
15
|
### Verification Steps
|
|
15
16
|
|
|
16
|
-
| Step | Action
|
|
17
|
-
|
|
18
|
-
| 1
|
|
19
|
-
| 2
|
|
20
|
-
| 3
|
|
21
|
-
| 4
|
|
17
|
+
| Step | Action |
|
|
18
|
+
| ---- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
19
|
+
| 1 | List devices: `ae-cli tracking debug-device list --project-id <project_id>` |
|
|
20
|
+
| 2 | Add the script's device ID when missing: `ae-cli tracking debug-device add --project-id <project_id> --device-id <device_id> --device-name <name>` |
|
|
21
|
+
| 3 | Select it: `ae-cli tracking debug-device select --project-id <project_id> --device-id <device_id>` |
|
|
22
|
+
| 4 | Run the debug script to send test events |
|
|
23
|
+
| 5 | Query received data: `ae-cli tracking debug-data list --project-id <project_id> --device-id <device_id>` |
|
|
24
|
+
| 6 | If needed, filter one event with `--event-name <event_name>` or inspect it in AE at `https://<host>/#/data/debug` |
|
|
22
25
|
|
|
23
26
|
### Common Notes for Client and Server SDKs
|
|
24
27
|
|
|
25
28
|
- Both use **TDDebugConsumer** (or the platform's equivalent debug mode API)
|
|
26
|
-
- Both require
|
|
29
|
+
- Both require registering the same device ID with `ae-cli tracking debug-device add`
|
|
27
30
|
- On validation failure, the SDK prints error logs or throws exceptions (behavior varies by language)
|
|
31
|
+
- `debug-data list` defaults to the most recent hour and returns `has_data`, `event_count`, `data_count`, and the raw Debug records
|
|
32
|
+
- Treat `has_data: true` as evidence that the receiver got Debug data; also inspect each record's error fields before declaring validation successful
|
|
28
33
|
|
|
29
34
|
---
|
|
30
35
|
|
|
@@ -32,32 +37,32 @@ When using debug mode, you must add the debug device ID in AE Admin before data
|
|
|
32
37
|
|
|
33
38
|
### Client SDK
|
|
34
39
|
|
|
35
|
-
| SDK
|
|
36
|
-
|
|
37
|
-
| Unity SDK
|
|
38
|
-
| Android SDK
|
|
39
|
-
| iOS SDK
|
|
40
|
-
| JavaScript SDK
|
|
41
|
-
| Mini Program SDK | `ta.init({ appId: appId, server_url: serverUrl, debug: true });`
|
|
42
|
-
| CocosCreator
|
|
43
|
-
| Cocos2d-x
|
|
44
|
-
| Unreal SDK
|
|
45
|
-
| Flutter SDK
|
|
46
|
-
| React Native
|
|
40
|
+
| SDK | Debug Mode API | Reference Doc |
|
|
41
|
+
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
42
|
+
| Unity SDK | `TDConfig config = new TDConfig(appId, serverUrl); config.mode = TDMode.DEBUG; TDAnalytics.Init(config);` | `data-ingestion-guide/client-sdk/game-engine/unity/unity-advanced/debugging-and-logging.md` |
|
|
43
|
+
| Android SDK | `TDConfig config = new TDConfig(this, serverUrl, appId); config.setMode(TDConfig.Mode.DEBUG); TDAnalytics.init(this, config);` | `data-ingestion-guide/client-sdk/android/android-advanced/debugging-and-logging.md` |
|
|
44
|
+
| iOS SDK | `TDConfig *config = [[TDConfig alloc] initWithAppId:appId serverUrl:serverUrl]; config.mode = TDModeDebug; [TDAnalytics startWithConfig:config];` | `data-ingestion-guide/client-sdk/ios/ios-advanced/debugging-and-logging.md` |
|
|
45
|
+
| JavaScript SDK | `ta.init({ appId: appId, server_url: serverUrl, debug: true });` | `data-ingestion-guide/client-sdk/javascript/javascript-advanced/debugging-and-logging.md` |
|
|
46
|
+
| Mini Program SDK | `ta.init({ appId: appId, server_url: serverUrl, debug: true });` | `客户端-sdk/小程序小游戏/进阶指南/实时调试.md` |
|
|
47
|
+
| CocosCreator | See doc | `data-ingestion-guide/client-sdk/game-engine/cocoscreator/cocoscreator-advance/debugging-and-logging.md` |
|
|
48
|
+
| Cocos2d-x | See doc | `data-ingestion-guide/client-sdk/game-engine/cocos2d-x/cocos2d-x-advanced/debugging-and-logging.md` |
|
|
49
|
+
| Unreal SDK | See doc | `data-ingestion-guide/client-sdk/game-engine/unreal/unreal-advanced/debugging-and-logging.md` |
|
|
50
|
+
| Flutter SDK | See doc | `data-ingestion-guide/client-sdk/cross-platform/flutter/flutter-advanced/debugging-and-logging.md` |
|
|
51
|
+
| React Native | See doc | `data-ingestion-guide/client-sdk/cross-platform/react-native/reactnative-advanced/debugging-and-logging.md` |
|
|
47
52
|
|
|
48
53
|
### Server SDK
|
|
49
54
|
|
|
50
|
-
| Language | DebugConsumer API
|
|
51
|
-
|
|
52
|
-
| Java
|
|
53
|
-
| Python
|
|
54
|
-
| Go
|
|
55
|
-
| Node.js
|
|
56
|
-
| PHP
|
|
57
|
-
| Ruby
|
|
58
|
-
| Erlang
|
|
59
|
-
| Lua
|
|
60
|
-
| C
|
|
55
|
+
| Language | DebugConsumer API | Reference Doc |
|
|
56
|
+
| -------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
|
57
|
+
| Java | `new TDDebugConsumer(serverUrl, appId, deviceId)` | `data-ingestion-guide/server-sdk/java/java-advanced/debugging-and-logging.md` |
|
|
58
|
+
| Python | `TDDebugConsumer(serverUrl, appId, device_id="...")` | `data-ingestion-guide/server-sdk/python/python-advanced/debugging-and-logging.md` |
|
|
59
|
+
| Go | `NewDebugConsumerWithDeviceId(serverUrl, appId, false, deviceId)` | `data-ingestion-guide/server-sdk/golang/golang-advanced/debugging-and-logging.md` |
|
|
60
|
+
| Node.js | `ThinkingData.initWithDebugMode(appId, serverUrl, { deviceId: "..." })` | `data-ingestion-guide/server-sdk/nodejs/nodejs-advanced/debugging-and-logging.md` |
|
|
61
|
+
| PHP | `new TDDebugConsumer(serverUrl, appId, deviceId)` | `data-ingestion-guide/server-sdk/php/php-advanced/debugging-and-logging.md` |
|
|
62
|
+
| Ruby | `TDDebugConsumer.new(serverUrl, appId, deviceId)` | `data-ingestion-guide/server-sdk/ruby/ruby-advanced/debugging-and-logging.md` |
|
|
63
|
+
| Erlang | `tddebug_consumer:new(ServerUrl, AppId, DeviceId)` | `data-ingestion-guide/server-sdk/erlang/erlang-advanced/debugging-and-logging.md` |
|
|
64
|
+
| Lua | `TDDebugConsumer.new(serverUrl, appId, deviceId)` | `data-ingestion-guide/server-sdk/lua/lua-advanced/debugging-and-logging.md` |
|
|
65
|
+
| C | `td_debug_consumer_new(serverUrl, appId, deviceId)` | `data-ingestion-guide/server-sdk/c/c-advanced/debugging-and-logging.md` |
|
|
61
66
|
|
|
62
67
|
---
|
|
63
68
|
|
|
@@ -67,7 +72,7 @@ When generating a debug script, the skill must:
|
|
|
67
72
|
|
|
68
73
|
1. **First read the corresponding SDK's "Real-time Debug" doc** (see reference doc paths below) to confirm the SDK's debug mode API and usage (the table above is an index reference only; actual usage may differ)
|
|
69
74
|
2. Use the corresponding platform's **TDDebugConsumer** or debug mode API
|
|
70
|
-
3. Set `deviceId` (e.g. `
|
|
75
|
+
3. Set a stable `deviceId` (e.g. `agent-debug-<project_id>`) and register it with `ae-cli tracking debug-device add`
|
|
71
76
|
4. Read `SERVER_URL` and `appId` from plan (NOT web host)
|
|
72
77
|
5. Pick 3 representative business events from plan (if object array properties exist, construct them fully)
|
|
73
78
|
6. Recommend enabling SDK log printing (for easier troubleshooting)
|
|
@@ -76,6 +81,7 @@ When generating a debug script, the skill must:
|
|
|
76
81
|
### Post-delivery Prompt
|
|
77
82
|
|
|
78
83
|
**Platform filtering notes**:
|
|
84
|
+
|
|
79
85
|
- xlsx "Platform" column values map to `platform` field:
|
|
80
86
|
- `客户端` / `client` → `platform: "client"`
|
|
81
87
|
- `服务端` / `server` → `platform: "server"`
|
|
@@ -86,17 +92,20 @@ When generating a debug script, the skill must:
|
|
|
86
92
|
|
|
87
93
|
```
|
|
88
94
|
Verification steps:
|
|
89
|
-
1.
|
|
90
|
-
2.
|
|
91
|
-
3.
|
|
92
|
-
4.
|
|
93
|
-
5.
|
|
95
|
+
1. Run `ae-cli tracking debug-device list --project-id <project_id>`.
|
|
96
|
+
2. If needed, run `ae-cli tracking debug-device add --project-id <project_id> --device-id <device_id> --device-name <name>`.
|
|
97
|
+
3. Run `ae-cli tracking debug-device select --project-id <project_id> --device-id <device_id>`.
|
|
98
|
+
4. Run the debug script.
|
|
99
|
+
5. Run `ae-cli tracking debug-data list --project-id <project_id> --device-id <device_id>`.
|
|
100
|
+
6. Confirm `has_data` is true and inspect error fields and event property structures.
|
|
101
|
+
7. If no data appears, retry with an explicit `--start-time "YYYY-MM-DD HH:mm:ss"` and verify that the script reports the exact same device ID.
|
|
94
102
|
```
|
|
95
103
|
|
|
96
104
|
### Reference Doc Paths
|
|
97
105
|
|
|
98
106
|
All SDK debug/logging docs are located at:
|
|
99
|
-
|
|
100
|
-
- `~/.ae-cli/wiki/
|
|
107
|
+
|
|
108
|
+
- `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/<sdk>/<sdk>-advanced/debugging-and-logging.md`
|
|
109
|
+
- `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/<language>/<language>-advanced/debugging-and-logging.md`
|
|
101
110
|
|
|
102
111
|
For zh-CN only SDKs (Mini Program, LayaAir, etc.), refer to sdk-index.md for exact paths.
|
|
@@ -197,4 +197,4 @@ Note: LogBus v1 is deprecated. Please use LogBus2.
|
|
|
197
197
|
## Reference Docs
|
|
198
198
|
|
|
199
199
|
- Official docs: https://docs-v2.thinkingdata.cn/?version=latest&code=logbus2_installation&lan=en-US
|
|
200
|
-
- Wiki: `~/.ae-cli/wiki/
|
|
200
|
+
- Wiki: `~/.ae-cli/wiki/raw/data-ingestion-guide/data-import-tools/logbus2-user-guide.md` — LogBus2 official doc mirror
|
|
@@ -28,7 +28,7 @@ export async function track(event: string, props: Record<string, unknown>, disti
|
|
|
28
28
|
}
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Other languages: provide isomorphic versions. Reference `~/.ae-cli/wiki/
|
|
31
|
+
Other languages: provide isomorphic versions. Reference `~/.ae-cli/wiki/synthesis/restful-api-reference.md`.
|
|
32
32
|
|
|
33
33
|
## Generation Steps
|
|
34
34
|
1. Select template by appType; confirm endpoint/auth rules from wiki
|
|
@@ -30,32 +30,32 @@
|
|
|
30
30
|
|
|
31
31
|
| SDK | Main Doc | Advanced | Auto-track | Preset Props |
|
|
32
32
|
|---|---|---|---|---|
|
|
33
|
-
| Android | `~/.ae-cli/wiki/
|
|
34
|
-
| iOS | `~/.ae-cli/wiki/
|
|
33
|
+
| Android | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/android.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/android/android-advanced.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/android/android-advanced/automatic-event-tracking.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/android/android-advanced/preset-properties.md` |
|
|
34
|
+
| iOS | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/ios.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/ios/ios-advanced.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/ios/ios-advanced/automatic-event-tracking.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/ios/ios-advanced/preset-properties.md` |
|
|
35
35
|
|
|
36
36
|
### Web / H5
|
|
37
37
|
|
|
38
38
|
| SDK | Main Doc | Advanced | Auto-track |
|
|
39
39
|
|---|---|---|---|
|
|
40
|
-
| JavaScript | `~/.ae-cli/wiki/
|
|
40
|
+
| JavaScript | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/javascript.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/javascript/javascript-advanced.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/javascript/javascript-advanced/automatic-event-tracking.md` |
|
|
41
41
|
|
|
42
42
|
### Mini Program & Mini Game (zh-CN only)
|
|
43
43
|
|
|
44
44
|
| SDK | Main Doc | Advanced | Auto-track |
|
|
45
45
|
|---|---|---|---|
|
|
46
|
-
| 小程序小游戏 | `~/.ae-cli/wiki/
|
|
46
|
+
| 小程序小游戏 | `~/.ae-cli/wiki/raw/客户端-sdk/小程序小游戏.md` | `~/.ae-cli/wiki/raw/客户端-sdk/小程序小游戏/进阶指南.md` | `~/.ae-cli/wiki/raw/客户端-sdk/小程序小游戏/进阶指南/自动采集.md` |
|
|
47
47
|
|
|
48
48
|
### Game Engines
|
|
49
49
|
|
|
50
50
|
| SDK | Version | Main Doc | Advanced | Auto-track |
|
|
51
51
|
|---|---|---|---|---|
|
|
52
|
-
| Unity | v3.x | `~/.ae-cli/wiki/
|
|
53
|
-
| Unreal | v2.x | `~/.ae-cli/wiki/
|
|
54
|
-
| Cocos2d-x | v2.x | `~/.ae-cli/wiki/
|
|
55
|
-
| CocosCreator | v2.x | `~/.ae-cli/wiki/
|
|
56
|
-
| Cocos2d-Lua (zh-CN) | v2.x | `~/.ae-cli/wiki/
|
|
57
|
-
| LayaAir (zh-CN) | v2.x | `~/.ae-cli/wiki/
|
|
58
|
-
| Egret (zh-CN) | v2.x | `~/.ae-cli/wiki/
|
|
52
|
+
| Unity | v3.x | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/unity.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/unity/unity-advanced.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/unity/unity-advanced/automatic-event-tracking.md` |
|
|
53
|
+
| Unreal | v2.x | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/unreal.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/unreal/unreal-advanced.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/unreal/unreal-advanced/automatic-event-tracking.md` |
|
|
54
|
+
| Cocos2d-x | v2.x | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/cocos2d-x.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/cocos2d-x/cocos2d-x-advanced.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/cocos2d-x/cocos2d-x-advanced/automatic-event-tracking.md` |
|
|
55
|
+
| CocosCreator | v2.x | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/cocoscreator.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/cocoscreator/cocoscreator-advance.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/game-engine/cocoscreator/cocoscreator-advance/automatic-event-tracking.md` |
|
|
56
|
+
| Cocos2d-Lua (zh-CN) | v2.x | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/cocos2d-lua.md` | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/cocos2d-lua/进阶指南.md` | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/cocos2d-lua/进阶指南/自动采集.md` |
|
|
57
|
+
| LayaAir (zh-CN) | v2.x | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/layaair.md` | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/layaair/进阶指南.md` | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/layaair/进阶指南/自动采集.md` |
|
|
58
|
+
| Egret (zh-CN) | v2.x | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/egret.md` | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/egret/进阶指南.md` | `~/.ae-cli/wiki/raw/客户端-sdk/游戏引擎/egret/进阶指南/自动采集.md` |
|
|
59
59
|
|
|
60
60
|
**Note**: Unity SDK upgraded from v2.x to v3.x with significant API changes:
|
|
61
61
|
- v2.x API: `ThinkingAnalyticsAPI.Track()`
|
|
@@ -66,10 +66,10 @@
|
|
|
66
66
|
|
|
67
67
|
| SDK | Main Doc | Advanced |
|
|
68
68
|
|---|---|---|
|
|
69
|
-
| React Native | `~/.ae-cli/wiki/
|
|
70
|
-
| Flutter | `~/.ae-cli/wiki/
|
|
71
|
-
| uni-app | `~/.ae-cli/wiki/
|
|
72
|
-
| OpenHarmony (zh-CN) | `~/.ae-cli/wiki/
|
|
69
|
+
| React Native | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/cross-platform/react-native.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/cross-platform/react-native/reactnative-advanced.md` |
|
|
70
|
+
| Flutter | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/cross-platform/flutter.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/cross-platform/flutter/flutter-advanced.md` |
|
|
71
|
+
| uni-app | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/cross-platform/uni-app.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/client-sdk/cross-platform/uni-app/uniapp-advanced.md` |
|
|
72
|
+
| OpenHarmony (zh-CN) | `~/.ae-cli/wiki/raw/客户端-sdk/openharmony.md` | `~/.ae-cli/wiki/raw/客户端-sdk/openharmony/进阶指南.md` |
|
|
73
73
|
|
|
74
74
|
---
|
|
75
75
|
|
|
@@ -77,16 +77,16 @@
|
|
|
77
77
|
|
|
78
78
|
| Language | Main Doc | Advanced |
|
|
79
79
|
|---|---|---|
|
|
80
|
-
| Java | `~/.ae-cli/wiki/
|
|
81
|
-
| Python | `~/.ae-cli/wiki/
|
|
82
|
-
| Golang | `~/.ae-cli/wiki/
|
|
83
|
-
| Node.js | `~/.ae-cli/wiki/
|
|
84
|
-
| PHP | `~/.ae-cli/wiki/
|
|
85
|
-
| C# | `~/.ae-cli/wiki/
|
|
86
|
-
| C++ | `~/.ae-cli/wiki/
|
|
87
|
-
| Ruby | `~/.ae-cli/wiki/
|
|
88
|
-
| Lua | `~/.ae-cli/wiki/
|
|
89
|
-
| Erlang | `~/.ae-cli/wiki/
|
|
80
|
+
| Java | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/java.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/java/java-advanced.md` |
|
|
81
|
+
| Python | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/python.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/python/python-advanced.md` |
|
|
82
|
+
| Golang | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/golang.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/golang/golang-advanced.md` |
|
|
83
|
+
| Node.js | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/nodejs.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/nodejs/nodejs-advanced.md` |
|
|
84
|
+
| PHP | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/php.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/php/php-advanced.md` |
|
|
85
|
+
| C# | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/c-V2W3wv.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/c/c-advanced-IauKwI.md` |
|
|
86
|
+
| C++ | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/c-Zf9Jwl.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/c/c-advanced-YAilwk.md` |
|
|
87
|
+
| Ruby | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/ruby.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/ruby/ruby-advanced.md` |
|
|
88
|
+
| Lua | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/lua.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/lua/lua-advanced.md` |
|
|
89
|
+
| Erlang | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/erlang.md` | `~/.ae-cli/wiki/raw/data-ingestion-guide/server-sdk/erlang/erlang-advanced.md` |
|
|
90
90
|
|
|
91
91
|
---
|
|
92
92
|
|
|
@@ -94,9 +94,9 @@
|
|
|
94
94
|
|
|
95
95
|
| Tool | Doc Path | Description |
|
|
96
96
|
|---|---|---|
|
|
97
|
-
| **LogBus2** | `~/.ae-cli/wiki/
|
|
98
|
-
| DataX Writer | `~/.ae-cli/wiki/
|
|
99
|
-
| RESTful API | `~/.ae-cli/wiki/
|
|
97
|
+
| **LogBus2** | `~/.ae-cli/wiki/raw/data-ingestion-guide/data-import-tools/logbus2-user-guide.md` | Recommended, paired with LoggerConsumer |
|
|
98
|
+
| DataX Writer | `~/.ae-cli/wiki/raw/data-ingestion-guide/data-import-tools/ta-datax-writer-plugin-user-guide.md` | Database batch import |
|
|
99
|
+
| RESTful API | `~/.ae-cli/wiki/raw/data-ingestion-guide/restful-api-user-guide.md` | Direct HTTP upload |
|
|
100
100
|
|
|
101
101
|
**Note: LogBus v1 is deprecated. Use LogBus2 for all scenarios.**
|
|
102
102
|
|
|
@@ -109,9 +109,9 @@ Official docs:
|
|
|
109
109
|
|
|
110
110
|
| Doc | Path |
|
|
111
111
|
|---|---|
|
|
112
|
-
| Preset Properties & System Fields | `~/.ae-cli/wiki/
|
|
113
|
-
| User Identification Rules | `~/.ae-cli/wiki/
|
|
114
|
-
| Data Rules | `~/.ae-cli/wiki/
|
|
112
|
+
| Preset Properties & System Fields | `~/.ae-cli/wiki/raw/preparations-before-data-ingestion/preset-properties-and-system-fields.md` |
|
|
113
|
+
| User Identification Rules | `~/.ae-cli/wiki/raw/preparations-before-data-ingestion/user-identification-rules.md` |
|
|
114
|
+
| Data Rules | `~/.ae-cli/wiki/raw/preparations-before-data-ingestion/data-rules.md` |
|
|
115
115
|
|
|
116
116
|
---
|
|
117
117
|
|
|
@@ -121,8 +121,8 @@ LLM-synthesized overview docs from multiple raw sources:
|
|
|
121
121
|
|
|
122
122
|
| Synthesis Doc | Path | Description |
|
|
123
123
|
|---|---|---|
|
|
124
|
-
| Server SDK Overview | `~/.ae-cli/wiki/
|
|
125
|
-
| SDK Selection Guide | `~/.ae-cli/wiki/
|
|
126
|
-
| RESTful API Reference | `~/.ae-cli/wiki/
|
|
127
|
-
| JS SDK Cheatsheet | `~/.ae-cli/wiki/
|
|
128
|
-
| Batch Ingestion Comparison | `~/.ae-cli/wiki/
|
|
124
|
+
| Server SDK Overview | `~/.ae-cli/wiki/synthesis/server-sdk-overview.md` | Unified architecture of all server SDKs |
|
|
125
|
+
| SDK Selection Guide | `~/.ae-cli/wiki/synthesis/sdk-selection.md` | How to choose the right SDK |
|
|
126
|
+
| RESTful API Reference | `~/.ae-cli/wiki/synthesis/restful-api-reference.md` | RESTful API summary |
|
|
127
|
+
| JS SDK Cheatsheet | `~/.ae-cli/wiki/synthesis/js-sdk-cheatsheet.md` | JavaScript SDK quick reference |
|
|
128
|
+
| Batch Ingestion Comparison | `~/.ae-cli/wiki/synthesis/batch-ingest-comparison.md` | LogBus / DataX / Kafka comparison |
|
|
@@ -72,6 +72,8 @@ Phase 0 → 1 → 2 → 3 → 4, do not skip steps.
|
|
|
72
72
|
>
|
|
73
73
|
> **Language rules**: For newly generated content, user-facing fields in draft.json (`display_name`, `event_desc`, `event_tag`,
|
|
74
74
|
> property `display_name`, property `desc`, etc.) should be generated in the **user's input language**.
|
|
75
|
+
> Every event, event property, common event property, and user property must have a non-empty `display_name`.
|
|
76
|
+
> A canonical snake_case identifier is not a substitute for a user-facing display name.
|
|
75
77
|
> For imported templates, do NOT translate those fields manually. Template sheet names, headers, property type display values,
|
|
76
78
|
> CLI messages, and auto-track/i18n-owned labels must come from `src/tracking/i18n` via `AE_LANG=<user_lang>` and `draft.meta.lang`.
|
|
77
79
|
> When a localized label is needed, inspect `src/tracking/i18n` and use the existing resource key/value; do not invent translations from the model.
|
|
@@ -969,6 +971,7 @@ User ok → **immediately execute archive command**, then proceed to Phase 3.
|
|
|
969
971
|
- [ ] Do event/property names contain only letters, digits, and underscores (no Chinese, no spaces)?
|
|
970
972
|
- [ ] Are there duplicate event names or synonymous events coexisting (e.g. `order_create` and `create_order`)?
|
|
971
973
|
- [ ] Does the same property name map to multiple display names or types?
|
|
974
|
+
- [ ] Does every event, event property, common event property, and user property have a non-empty `display_name` in the user's language?
|
|
972
975
|
|
|
973
976
|
### Revenue Model Required Events Check
|
|
974
977
|
|
|
@@ -1251,6 +1254,26 @@ AE_LANG=<user_lang> ae-cli tracking plan upload --project <projectId> --xlsx .ae
|
|
|
1251
1254
|
|
|
1252
1255
|
On successful upload, prompt user to verify in AE Admin. **Provide the full URL** (tracking plan page URL format: `https://<host>/#/data/plan`).
|
|
1253
1256
|
|
|
1257
|
+
Then read the uploaded plan back through ae-cli and synchronize its display names to any event/property metadata
|
|
1258
|
+
that already exists in the project:
|
|
1259
|
+
|
|
1260
|
+
```bash
|
|
1261
|
+
AE_LANG=<user_lang> ae-cli tracking plan get --project-id <projectId> --host <host>
|
|
1262
|
+
AE_LANG=<user_lang> ae-cli tracking plan sync-display-names \
|
|
1263
|
+
--project-id <projectId> \
|
|
1264
|
+
--draft .ae-cli/draft.json \
|
|
1265
|
+
--host <host>
|
|
1266
|
+
```
|
|
1267
|
+
|
|
1268
|
+
`sync-display-names` is intentionally safe to rerun:
|
|
1269
|
+
|
|
1270
|
+
- It fills only blank event/property metadata display names.
|
|
1271
|
+
- It never overwrites a non-empty display name already maintained in AE.
|
|
1272
|
+
- `missing_in_metadata` means that the event/property has not appeared in project metadata yet; it is not an upload failure.
|
|
1273
|
+
Report those names and rerun the same command after the first Debug or production data reaches AE.
|
|
1274
|
+
- `missing_display_name_in_draft` means the generated plan is incomplete. Add the missing localized `display_name`,
|
|
1275
|
+
regenerate/validate the xlsx, and rerun the upload/synchronization flow.
|
|
1276
|
+
|
|
1254
1277
|
---
|
|
1255
1278
|
|
|
1256
1279
|
### 4.4 Upload Failure Handling and Auto-fix
|
|
@@ -1289,7 +1312,9 @@ Fixed: Fixed object array sub-property inconsistency, Fixed display name duplica
|
|
|
1289
1312
|
|
|
1290
1313
|
### 4.5 Post-success Actions
|
|
1291
1314
|
|
|
1292
|
-
After successful upload, prompt user to verify in AE Admin. **Provide the full URL**
|
|
1315
|
+
After successful upload and display-name synchronization, prompt user to verify in AE Admin. **Provide the full URL**
|
|
1316
|
+
(tracking plan page URL format: `https://<host>/#/data/plan`). Include a short synchronization summary:
|
|
1317
|
+
updated counts, preserved existing counts, and any names still missing from project metadata.
|
|
1293
1318
|
|
|
1294
1319
|
**Ask about generating tracking code**:
|
|
1295
1320
|
|