@thinkingai/ae-cli 1.0.28 → 6.0.16-1

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/game-engine/unreal.md

@@ -0,0 +1,190 @@
+---
+code: unreal_sdk_installation
+name: "Unreal"
+wikiToken: Tjh7wx7FYinevfkG0mwcLxsSnea
+parentWikiToken: FgrswqlHEiE45HkQve4cU0NFnbd
+updateTime: 1774251975000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=unreal_sdk_installation
+---
+
+::: tip
+Before  you begin, please read [<text color="purple" underline="true">Preparation before Data Ingestion</text>](https://thinkingdata.feishu.cn/wiki/OhD8we9iai6Xk5kM1QNc8ITRnQe)<text color="purple" underline="true">.</text>
+TE Unreal  SDK supports Unreal Engine's built-in TE service and also supports reporting data directly through the C++  API.
+Supports platforms : Android, iOS, Windows, MacOS .
+ :::
+**Latest version:** v3.0.3
+**Update time:** October 11, 2025
+**Resource download: **[SDK](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FUnreal%2Fta_unreal_sdk_v3.0.3.zip)、[Source Code](https%3A%2F%2Fgithub.com%2FThinkingDataAnalytics%2Funreal-sdk%2Ftags)
+::: warning Notice 
+The current documentation applies to v2.0.0 and later versions. For historical versions, please refer to the [Data Ingestion Guide - Unreal (V1)](https%3A%2F%2Fdocs.thinkingdata.cn%2Fta-manual%2Fv4.1%2Fen%2Finstallation%2Finstallation_menu%2Fclient_sdk%2Fgame_engine_sdk_installation%2Funreal_sdk_installation%2Funreal_sdk_installation.html), [SDK Download (v1.6.0)](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FUnreal%2Fta_unreal_sdk_v1.6.0.zip). 
+:::
+## **1. ****SDK**** Integration**
+### **1.1 ****Integrate ThinkingAnalytics Plugin**
+Download the [Unreal SDK](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FUnreal%2Fta_unreal_sdk_v3.0.3.zip), unzip it and add `TDAnalytics` into the `Plugins` directory of your project; if the `Plugins` directory does not exist, first create a Plugins directory under the project root directory, and then put the `TDAnalytics` directory into it.
+
+### **1.2 ****Activate**** ThinkingAnalytics ****Plugin**
+In order to enable the ThinkingAnalytics plugin, you need to perform the following steps:
+- Restart Unreal Editor
+- Open Edit > Plugins, under the Project `Analytics` category, enable `TDAnalytics`
+- If you use Blueprint, enable the `Analytics` Blueprint Library under the Built-in Analytics category
+- Restart Unreal Editor again
+- Open `Edit>Project` Settings, under the Plugins category, set the ThinkingAnalytics parameters:
+  - Server Url: Required receiver URL , need to use https type address
+  - App ID: Required APP ID of your project can be viewed on the TE background project management page
+  - TimeZone: Optional, if you need to align the time zone, please fill in the canonical TimeZone ID, such as "Asia/Shanghai", "UTC". If you do not need to align the time zone, you do not need to fill in
+  - Enable Encrypt: enable data encryption. The default is false. After enabling, the data will be encrypted and uploaded to TE
+  - EncryptPublicKey:  Optional, if not filled, the default configuration will be used to encrypt the public key
+  - EncryptVersion: Optional, if not filled, the default configuration will be used, the key version
+  - SymmetricEncryption: Optional, if not filled, the default configuration will be used, symmetric key
+  - AsymmetricEncryption: Optional, if not filled, the default configuration will be used, asymmetric key
+<quote-container>
+ Note: Windows/MacOS does not currently support time zone alignment.
+</quote-container>
+
+
+- Add the following to the `DefaultEngine.ini `file in the `Config` directory:
+```cpp
+[Analytics]
+ProviderModuleName=TDAnalytics
+```
+
+- If you want to use the `TDAnalytics` API directly in your C++ code, you need to add the following to your project's` *.Build.cs `file:
+```cpp
+PrivateDependencyModuleNames.AddRange(new string[] { "TDAnalytics" });
+PrivateIncludePathModuleNames.AddRange(new string[] { "TDAnalytics" });
+```
+
+Also, reference the `TDAnalytics.h` header file in the files you wish to use the SDK with:
+```cpp
+#include "TDAnalytics.h"
+```
+
+## **2. Initialization**
+```cpp
+UTDAnalytics::Initialize();
+```
+
+## **3. Common Features**
+We suggested that you read [User Identification Rules](https://thinkingdata.feishu.cn/wiki/Pov9wECdsi2QQsk4NN9cEPsvnyc) before using common features; SDK would generate a random number that would be used as the distinct ID, and save the ID locally. Before the user logs in, the distinct ID would be used as the identification ID.   Note: The distinct ID would change after the user reinstalled the App or used the APP with a new device.
+### **3.1 Login**
+When the users log in , `Login` could be called to set the account ID of the user. TE would use the account ID as the identification ID, and this ID would be saved before `Logout` is called. The previous account ID would be replaced if `Login` has been called multiple times.
+```cpp
+// The login unique identifier of the user, corresponding to the #account_id in data tracking. #Account_id now is TE
+UTDAnalytics::Login("TE");
+```
+
+<quote-container>
+**Login events wouldn't be uploaded in this method.**
+</quote-container>
+
+### 3.2 **Super Properties**
+Super Properties refer to properties that each event might have. You can call `SetSuperProperties` to set Super Properties. It is recommended that you set Super Properties first before sending data. Some important properties (e.g., the membership class of users, source channels, etc.) should be set in each event. At this time, you can set these properties as Super Properties.
+```cpp
+    TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
+    Properties->SetStringField("channel", "TE");//string
+    Properties->SetNumberField("age", 1);//number
+    Properties->SetBoolField("isSuccess", true);//boolean
+    FDateTime DateTime = FDateTime::Now();
+    Properties->SetStringField("birthday", FDateTime::FromUnixTimestamp(DateTime.ToUnixTimestamp()).ToString(TEXT("%Y-%m-%d %H:%M:%S.")) += *FString::Printf(TEXT("%03d"), DateTime.GetMillisecond()));//time
+
+    TSharedPtr<FJsonObject> ItemProperties = MakeShareable(new FJsonObject);
+    ItemProperties->SetStringField("itemChannel", "item");
+    Properties->SetObjectField("object", ItemProperties);//object
+
+    TArray< TSharedPtr<FJsonValue> > DataObjectArray;
+    TSharedPtr<FJsonObject> ArrayItemProperties = MakeShareable(new FJsonObject);
+    ArrayItemProperties->SetStringField("arrayItemChannel", "array_item");
+    TSharedPtr<FJsonValueObject> DataObjectValue = MakeShareable(new FJsonValueObject(ArrayItemProperties));
+    DataObjectArray.Add(DataObjectValue);
+    Properties->SetArrayField("object_arr", DataObjectArray);//array object
+
+    TArray< TSharedPtr<FJsonValue> > DataArray;
+    TSharedPtr<FJsonValueString> DataValue = MakeShareable(new FJsonValueString("data_value"));
+    DataArray.Add(DataValue);
+    Properties->SetArrayField("arr", DataArray);//array 
+
+    UTDAnalytics::SetSuperProperties(Properties, AppID);
+```
+
+- Super Properties will be saved in local storage, and will not need to be called every time the App is opened. If the Super Properties set previously are uploaded after calling `SetSuperProperties`, previous properties would be replaced. 
+- Key is the name of the property and refers to the string type. It must start with a character, and contain numbers, characters (insensitive to case, and upper cases would be transformed into lower cases by TE) and underscores "_", with a maximum length of 50 characters. 
+- Value, the value of the property, supports string, numbers, Boolean, time, object, array object, and array
+<quote-container>
+- **The requirements for event properties and user properties are the same with that for Super Properties**
+</quote-container>
+
+### **3.3 Automatically Track Events**
+The following code is an example of tracking installation, open_app and close_app events. To get more information about the automatic tracking of SDK, please refer to the [Detailed introduction of automatic tracking function](https://thinkingdata.feishu.cn/wiki/D7ykw75weigcIfk3ZoichHbKnuv)
+```cpp
+UTDAnalytics::EnableAutoTrack();
+```
+
+### **3.4 Sending Events**
+You can call `Tack` to upload events. It is suggested that you set event properties based on the data tracking plan drafted previously. Here is an example of a user buying an item:
+```cpp
+TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
+Properties->SetStringField("product_name", "product name");
+UTDAnalytics::Track("product_buy", Properties);
+```
+
+The event name is string type. It could only start with a character and could contain figures, characters, and an underline "_", with a maximum length of 50 characters.
+### **3.5 User Properties**
+You can set general user properties by calling `UserSet` API. The original properties would be replaced by the properties uploaded via this API. The data type of newly-created user properties must be the same as the uploaded properties. User name setting is taken as the example here: 
+```cpp
+ //the username now is TA
+TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
+Properties->SetStringField("username", "TA");
+UTDAnalytics::UserSet(Properties);
+//the username now is TE
+TSharedPtr<FJsonObject> NewProperties = MakeShareable(new FJsonObject);
+NewProperties->SetStringField("username", "TE");
+UTDAnalytics::UserSet(NewProperties);
+```
+
+## **4. Best Practice**
+The following sample code covers all the above-mentioned operations. It is recommended that the SDK be used in the following steps:
+```cpp
+#include "TDAnalytics.h"
+if (privacy policy is authorized) {
+   
+   UTDAnalytics::Initialize();
+   
+   //if the user has logged in, the account ID of the user could be set as the unique identifier 
+   UTDAnalytics::Login("TE");
+   
+    //After setting Super Properties, each event would have Super Properties
+   TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
+   Properties->SetStringField("channel", "TE");//string
+   Properties->SetNumberField("age", 1);//number
+   Properties->SetBoolField("isSuccess", true);//boolean
+   FDateTime DateTime = FDateTime::Now();
+   Properties->SetStringField("birthday", FDateTime::FromUnixTimestamp(DateTime.ToUnixTimestamp()).ToString(TEXT("%Y-%m-%d %H:%M:%S.")) += *FString::Printf(TEXT("%03d"), DateTime.GetMillisecond()));//time
+
+   TSharedPtr<FJsonObject> ItemProperties = MakeShareable(new FJsonObject);
+   ItemProperties->SetStringField("itemChannel", "item");
+   Properties->SetObjectField("object", ItemProperties);//object
+
+   TArray< TSharedPtr<FJsonValue> > DataObjectArray;
+   TSharedPtr<FJsonObject> ArrayItemProperties = MakeShareable(new FJsonObject);
+   ArrayItemProperties->SetStringField("arrayItemChannel", "array_item");
+   TSharedPtr<FJsonValueObject> DataObjectValue = MakeShareable(new FJsonValueObject(ArrayItemProperties));
+   DataObjectArray.Add(DataObjectValue);
+   Properties->SetArrayField("object_arr", DataObjectArray);//array object
+
+   TArray< TSharedPtr<FJsonValue> > DataArray;
+   TSharedPtr<FJsonValueString> DataValue = MakeShareable(new FJsonValueString("data_value"));
+   DataArray.Add(DataValue);
+   Properties->SetArrayField("arr", DataArray);//array
+   UTDAnalytics::SetSuperProperties(Properties, AppID);
+   //Enable auto-tracking
+   UTDAnalytics::EnableAutoTrack();
+   //upload events
+   TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
+   Properties->SetStringField("product_name", "product name");
+   UTDAnalytics::Track("product_buy", Properties);
+   //Set user properties
+   TSharedPtr<FJsonObject> UserProperties = MakeShareable(new FJsonObject);
+   UserProperties->SetStringField("username", "TE");
+   UTDAnalytics::UserSet(Proper);
+}
+```

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/game-engine.md

@@ -0,0 +1,14 @@
+---
+code: game_engine_sdk_installation
+name: "Game Engine"
+wikiToken: FgrswqlHEiE45HkQve4cU0NFnbd
+parentWikiToken: KaFCwNeV3iRxjNkpT3QcDMg3n5V
+updateTime: 1774251971000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=game_engine_sdk_installation
+---
+
+- [Unity](https://thinkingdata.feishu.cn/wiki/NaFYwOKI1iN5mgkTPQwcZY0tnRg)
+- [Unreal](https://thinkingdata.feishu.cn/wiki/Tjh7wx7FYinevfkG0mwcLxsSnea)
+- [Cocos2d-x](https://thinkingdata.feishu.cn/wiki/D4l8wlZzuifeHUkWUXbcnUuYnM6)
+- [CocosCreator](https://thinkingdata.feishu.cn/wiki/AL6VwEXmiiAgK7kXq97c8YXNnLc)
+- [Corona](https://thinkingdata.feishu.cn/wiki/QjOXwKuZFiw4JLk477Fcuzmnnnb)

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/h5-and-app-sdk-connection.md

@@ -0,0 +1,147 @@
+---
+code: h5_app_integrate
+name: "H5 and APP SDK Connection"
+wikiToken: FOFZwGHJii1Jm2ke88DcFrrJnUb
+parentWikiToken: KaFCwNeV3iRxjNkpT3QcDMg3n5V
+updateTime: 1774249226000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=h5_app_integrate
+---
+
+## **1. Introduction of Scheme**
+In the APP, there might be some screens that are constructed by H5 screen. In this case, APP SDK could not perform data tracking against the H5 screen, and JavaScript SDK needs to be used to track the user's behavior on the H5 screen.  To ensure the consistency between JavaScript SDK data and APP SDK data, the data connection function is newly added for the SDK of the new version.
+The H5 screen uses JavaScript SDK for data tracking, and would not send the data tracked directly but send the data to the server through APP SDK (e.g., Android SDK and iOS SDK). The APP SDK would adjust the data tracked by JavaScript SDK. The rules are as follows:
+1. Save the `#time` uploaded by JavaScript SDK, that is, the time when data tracking is triggered shall be regarded as the event time
+2. Use the `#account_id` and `#distinct_id` of  APP SDK, and the user maintained by APP SDK shall prevail.
+3. Add the preset properties of APP SDK. If such properties conflict with the preset properties of JavaScript, the preset properties of APP SDK would overwrite the conflict value. For instance, the value of APP SDK in the `#lib` field would overwrite the value of JavaScript SDK
+4. The public properties of APP SDK: if such public properties conflict with the properties imported by JavaScript, the native public property value should be abandoned; if JavaScript SDK does not have the property, the property should be added into the reported data. 
+5. The `timeEvent` interface in APP SDK could become valid for the event tracked by JavaScript SDK
+6. If the login, logout, and identify the interface in JavaScript SDK could not modify the user ID in APP SDK, the user ID of the data could not be modified through the above-mentioned interface.
+7. When the switch of H5 and APP SDK connection is enabled, if APP SDK does not exist in the operating environment, JavaScript SDK would perform data tracking directly, which is equivalent to the state when the connection is not enabled. 
+## **2. Usage Method**
+If it is necessary to enable the H5 and APP SDK connection function, we need to perform the following configuration for JavaScript SDK and APP SDK. **Please**** pay attention to the applicable version of SDK**. It is recommended that users using historical versions upgrade to the latest version.
+### 2.1 **Android SDK usage method**
+Call  `setJsBridge` during `WebView` initialization：
+```java
+ThinkingAnalyticsSDK.sharedInstance(getApplicationContext()).setJsBridge(WebView webView);
+```
+
+If it is necessary to support the `X5Webview` of Tencent, call `setJsBridgeForX5WebView`:
+```java
+ThinkingAnalyticsSDK.sharedInstance(context, appId).setJsBridgeForX5WebView(webView);
+```
+
+### 2.2 **iOS SDK usage method**
+#### WKWebView
+The customUserAgent property of WKWebView should be set as follows:
+```objectivec
+    WKWebViewConfiguration *config = [[WKWebViewConfiguration alloc] init];
+    config.applicationNameForUserAgent = [NSString stringWithFormat:@"%@ %@", config.applicationNameForUserAgent ?: @"", @"/td-sdk-ios"];
+```
+
+If there is a self-contained UA, please splice the " /td-sdk-ios" and add the following codes into decidePolicyForNavigationAction
+```objectivec
+
+- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
+    if ([TDAnalytics showUpWebView:webView withRequest:navigationAction.request]) {
+        decisionHandler(WKNavigationActionPolicyCancel);
+        return;
+    }
+    // add your logic code here
+    decisionHandler(WKNavigationActionPolicyAllow);
+}
+```
+
+#### UIWebView
+1. Call `addWebViewUserAgent` after SDK initialization:
+```objectivec
+   [TDAnalytics addWebViewUserAgent];
+```
+
+The following calls should be performed based on the types of `WebView` during `WebView` initialization:
+```objectivec
+
+- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
+    if ([TDAnalytics showUpWebView:webView withRequest:request]) {
+        return NO;
+    }
+     // add your logic code here
+    return YES;
+}
+```
+
+
+### 2.3 **Flutter**** SDK usage method**
+Call addJavaScriptChannel when initializing WebView, and call TDAnalytics.h5ClickHandler() in the onMessageReceived method.
+```java
+controller = WebViewController();
+controller.addJavaScriptChannel("ThinkingData_APP_Flutter_Bridge", onMessageReceived: (JavaScriptMessage message){
+    TDAnalytics.h5ClickHandler(message.message);
+});
+```
+
+### 2.4 **ReactNative**** SDK usage method**
+Call the injectedJavaScript method to inject JS when initializing WebView, and call TDAnalytics.h5ClickHandler() in the onMessage method.
+```java
+<WebView
+  ref={webViewRef}
+  source={localHtmlFile}
+  onMessage={ event => {
+    console.log(event.nativeEvent.data);
+    TDAnalytics.h5ClickHandler(event.nativeEvent.data);
+  }}
+  javaScriptEnabled={true}
+  injectedJavaScript='window.ThinkingData_APP_ReactNative_Bridge = function(data) { window.ReactNativeWebView.postMessage(data); };'
+/>
+```
+
+### 2.5 **JavaScript ****SDK**** Usage Method**
+**JavaScript ****SDK**** Usage Method**
+- Add `useAppTrack: true` during parameter initialization, the example is as follows:
+```javascript
+  (function(param) {
+  var p = param.sdkUrl,
+    n = param.name,
+    w = window,
+    d = document,
+    s = "script",
+    x = null,
+    y = null;
+  w["ThinkingDataAnalyticalTool"] = n;
+  w[n] =
+    w[n] ""
+    function(a) {
+      return function() {
+        (w[n]._q = w[n]._q "" []).push([a, arguments]);
+      };
+    };
+  var methods = [
+    "track",
+    "quick",
+    "login",
+    "logout",
+    "trackLink",
+    "userSet",
+    "userSetOnce",
+    "userAdd",
+    "userDel",
+    "setPageProperty"
+  ];
+  for (var i = 0; i < methods.length; i++) {
+    w[n][methods[i]] = w[n].call(null, methods[i]);
+  }
+  if (!w[n]._t) {
+    (x = d.createElement(s)), (y = d.getElementsByTagName(s)[0]);
+    x.async = 1;
+    x.src = p;
+    y.parentNode.insertBefore(x, y);
+    w[n].param = param;
+  }
+})({
+  appId: "APP_ID", //APPID allocated by the system ID
+  name: "ta", //The global call variable name can be set arbitrarily and used in subsequent calls. 
+  sdkUrl: "http://www.a.com/thinkingdata.js", //record script URL
+  serverUrl: "https://global-receiver-ta.thinkingdata.cn:9080/sync_js", //data upload URL
+  send_method: "image", //data upload URL
+  useAppTrack: true // connect APP and H5
+});
+```

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/instant-app-and-game.md

@@ -0,0 +1,24 @@
+---
+code: instant_app_and_game
+name: "Instant App and Game"
+wikiToken: Uw3QwLfI8i2oamk1Ut5csOWWnQg
+parentWikiToken: KaFCwNeV3iRxjNkpT3QcDMg3n5V
+updateTime: 1774252004000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=instant_app_and_game
+---
+
+<callout emoji="bulb" background-color="light-green" border-color="light-green">
+Before you begin, please read [<text color="purple" underline="true">Preparation before Data Ingestion</text>](https://thinkingdata.feishu.cn/wiki/OhD8we9iai6Xk5kM1QNc8ITRnQe)
+</callout>
+
+# 1. Facebook Instant Games
+For details, view [JavaScript SDK](https://thinkingdata.feishu.cn/wiki/HwzHwHeb5iFceqk6Eylcd03UnMh)
+# 2. Google Play Instant Games
+## 2.1 Unity
+For details, view [Unity SDK](https://thinkingdata.feishu.cn/wiki/NaFYwOKI1iN5mgkTPQwcZY0tnRg)
+## 2.2 Cocos2d
+For details, view [Cocos2d-X SDK](https://thinkingdata.feishu.cn/wiki/D4l8wlZzuifeHUkWUXbcnUuYnM6)
+## 2.3 Android Studio
+For details, view [Android SDK](https://thinkingdata.feishu.cn/wiki/Sis2weaL2iJOOWklkX1cZAtcnVc)
+# 3. Line Mini App
+For details, view [JavaScript SDK](https://thinkingdata.feishu.cn/wiki/HwzHwHeb5iFceqk6Eylcd03UnMh)

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/ios/compliance.md

@@ -0,0 +1,24 @@
+---
+code: ios_sdk_compliance
+name: "Compliance"
+wikiToken: UInGw9XUHiWN2nkNl5pcOLUWnAd
+parentWikiToken: Wxc7wQj3FitXYVkTuW5cAAtPnCc
+updateTime: 1774249068000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=ios_sdk_compliance
+---
+
+## **1. ****Filling out SDK-related Contents in The Privacy Policy**
+### **1.1 ****Collecting and Acquiring Data**
+The following content is suggested to fill out  in accordance with the actual conditions in the column of collecting and acquiring your personal data in the *Privacy Policy*. 
+When you activate and use the APP, we would collect information about your device (including IDFV, AndroidID, OS, device model, device manufacturer, system version, application process information, etc.) through ThinkingAnalytics-SDK to analyze the effect you achieved by using the App via statistics.
+### **1.2 ****Sharing with authorized partners**
+The following content is suggested to fill out in accordance with the actual conditions in the column of sharing with authorized partners in the *Privacy Policy*.
+ThinkingAnalytics-SDK: collect information about your device (including IDFV, AndroidID, OS, device model, device manufacturer, system version, application process information, etc.) and your network information to perform data analysis ,so as to improve our products and services
+## **2. ****SDK**** Compliance Steps**
+ThinkingData SDK needs to be initialized after the user agrees with the *Privacy Policy.*
+```objectivec
+// determine whether to enable data tracking according to the Privacy Policy
+if (authorized) {
+    [TDAnalytics startAnalyticsWithAppId:appid serverUrl:url];
+}
+```