@thinkingai/ae-cli 1.0.28 → 6.0.16

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

@@ -0,0 +1,281 @@
+---
+code: cocos2d-x_sdk_installation
+name: "Cocos2d-x"
+wikiToken: D4l8wlZzuifeHUkWUXbcnUuYnM6
+parentWikiToken: FgrswqlHEiE45HkQve4cU0NFnbd
+updateTime: 1774251978000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocos2d-x_sdk_installation
+---
+
+::: tip
+Before you begin, please read [<text color="purple" underline="true">Preparation before Data Ingestion</text>](https://thinkingdata.feishu.cn/wiki/OhD8we9iai6Xk5kM1QNc8ITRnQe)
+Supports platforms : Android, iOS, Windows, MacOS . and the size is about 6.8 M
+ :::
+**Latest version: **v2.0.4
+**Update time:** 02/04, 2025
+**Resource download: **[SDK](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FCocos2d-x%2Fta_cocos2dx_sdk_v2.0.4.zip), [Source Code](https%3A%2F%2Fgithub.com%2FThinkingDataAnalytics%2Fcocos2dx-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 - Cocos2d-x (V1)](https%3A%2F%2Fdocs.thinkingdata.cn%2Fta-manual%2Fv4.1%2Fen%2Finstallation%2Finstallation_menu%2Fclient_sdk%2Fgame_engine_sdk_installation%2Fcocos2d-x_sdk_installation%2Fcocos2d-x_sdk_installation.html), [SDK Download (v1.3.5)](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FCocos2d-x%2Fta_cocos2dx_sdk_v1.3.5.zip). 
+:::
+## **1. ****SDK**** Integration**
+1. Download and unzip the [Cocos2d-x SDK](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2Frelease%2Fta_cocos2dx_sdk.zip) Source Code,  Add `ThinkingAnalytics` files into your project `Classes` folder
+2. Add the following configuration to `CMakeLists.txt`
+```cpp
+list(APPEND GAME_SOURCE
+     Classes/ThinkingAnalytics/Common/TDJSONObject.cpp
+     )
+list(APPEND GAME_HEADER
+     Classes/ThinkingAnalytics/Common/TDJSONObject.h
+     Classes/ThinkingAnalytics/Common/TDAnalytics.h
+     )
+if(ANDROID)
+    list(APPEND GAME_SOURCE
+         Classes/ThinkingAnalytics/Android/TDAnalytics.cpp
+         )
+elseif(WINDOWS)
+    list(APPEND GAME_HEADER
+         Classes/ThinkingAnalytics/Other/ThinkingSDKObject.h
+         )
+    list(APPEND GAME_SOURCE
+         Classes/ThinkingAnalytics/Other/TDAnalytics.cpp
+         )
+elseif(MACOSX)
+        list(APPEND GAME_HEADER
+            Classes/ThinkingAnalytics/Other/ThinkingSDKObject.h
+            )
+        list(APPEND GAME_SOURCE
+            Classes/ThinkingAnalytics/Other/TDAnalytics.cpp
+            ）
+```
+
+3. Configuration for Android 
+- Add the `libs` folder to your project directory in `proj.android`, and add **TDAnalytics.aar**、**TDCore.aar**、**TDThirdparty.aar** into the `libs` folder
+- Add the following configuration to `build.gradle` in your project directory in `proj.android`
+```cpp
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar','*.aar'])
+}
+```
+
+<image token="CDPnbOv4moAvFmxBZWncuUM3nxe" width="1544" height="860" align="center"/>
+
+4. Configuration for iOS 
+Compile the iOS project using the ios.toolchain.cmake tool.
+- Add iOS-related configurations to CMakeLists.txt
+```typescript
+list(APPEND GAME_SOURCE
+     Classes/ThinkingAnalytics/Common/TDJSONObject.cpp
+     )
+list(APPEND GAME_HEADER
+     Classes/ThinkingAnalytics/Common/TDJSONObject.h
+     Classes/ThinkingAnalytics/Common/TDAnalytics.h
+     )
+if(ANDROID)
+    list(APPEND GAME_SOURCE
+         Classes/ThinkingAnalytics/Android/TDAnalytics.cpp
+         )
+elseif(WINDOWS)
+    list(APPEND GAME_HEADER
+         Classes/ThinkingAnalytics/Other/ThinkingSDKObject.h
+         )
+    list(APPEND GAME_SOURCE
+         Classes/ThinkingAnalytics/Other/TDAnalytics.cpp
+         )
+elseif(IOS)
+    //iOS configuration
+    list(APPEND GAME_HEADER
+         Classes/ThinkingAnalytics/iOS/TDAnalyticsCocosAPI.h
+         )
+    list(APPEND GAME_SOURCE
+         Classes/ThinkingAnalytics/iOS/TDAnalytics.mm
+         Classes/ThinkingAnalytics/iOS/TDAnalyticsCocosAPI.m
+         )    
+elseif(MACOSX)
+    list(APPEND GAME_HEADER
+        Classes/ThinkingAnalytics/Other/ThinkingSDKObject.h
+        )
+    list(APPEND GAME_SOURCE
+        Classes/ThinkingAnalytics/Other/TDAnalytics.cpp
+        )
+        
+if(IOS)
+    //iOS configuration
+    set(CMAKE_EXE_LINKER_FLAGS -ObjC)
+endif()       
+```
+
+- Open the iOS project in Xcode, and drag and drop the `ThinkingSDK.framework` and `TAThirdParty.framework` files from the iOS folder under ThinkingAnalytics into the Classes/ThinkingAnalytics/iOS directory of your Xcode project, as shown in the image below.
+<image token="XloUbOXwwopBzvxm8BxcORponmb" width="1280" height="605" align="center"/>
+
+- Configuration complete. If your version is lower than 2.0.2, you need to manually modify the header file of Classes/ThinkingAnalytics/iOS/TDAnalyticsCocosAPI.m to include it.
+```typescript
+#import "ThinkingAnalyticsSDK.h"
+//Change to the following
+#import <ThinkingSDK/ThinkingSDK.h>
+```
+
+Open the Xcode project  in proj.ios_mac
+- Open the iOS project in Xcode, and drag and drop the Common and iOS folders from the ThinkingAnalytics folder into the Classes directory of your Xcode project, as shown in the image below.
+<image token="QgHubSgALogac5xRUnNcsIhqnQf" width="1280" height="612" align="center"/>
+
+- Add -ObjC in Build Settings -> Other Linker Flags
+<image token="W0pVbOS17ocss5xbwZTcdL0nnbg" width="1075" height="368" align="center"/>
+
+- Add in Build Setting - Framework Search Paths "$(SRCROOT)/../Classes/ThinkingAnalytics/iOS"
+<image token="Sy9lbem73onzWLxDsg2cQoM2npd" width="1280" height="901" align="center"/>
+
+- Build Phases - Link Binary With Libraries
+WebKit.framework, GameController.framework, MediaPlayer.framework
+<image token="M3g7bhvBvo10tIxBoFUcs5tQnCg" width="1280" height="901" align="center"/>
+
+- Configuration complete. If your version is lower than 2.0.2, you need to manually modify the header file of Classes/ThinkingAnalytics/iOS/TDAnalyticsCocosAPI.m to include it.
+```typescript
+#import "ThinkingAnalyticsSDK.h"
+//Change to the following
+#import <ThinkingSDK/ThinkingSDK.h>
+```
+
+## **2. Initialization**
+```cpp
+#include "./ThinkingAnalytics/Common/TDAnalytics.h"
+using namespace thinkingdata::analytics;
+//Initialize SDK in the main thread 
+//Method 1
+TDAnalytics::init(TE_APP_ID, TE_SERVER_URL);
+//Method 2
+TDConfig config(TE_APP_ID, TE_SERVER_URL);
+TDAnalytics::init(config);
+```
+
+Instruction on parameters:
+- `APPID`: The APPID of your project, which can be found on the project management page of  TE.
+- `SERVER_URL`: 
+  - If you are using a SaaS version, please check the receiver URL on this page
+  - If you use the private deployment version, you can customize the data tracking URL .
+<quote-container>
+Since Android 9.0+ restricts HTTP requests by default, please use HTTPS protocol only.
+</quote-container>
+
+## **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
+TDAnalytics::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
+TDJSONObject superProperties;
+superProperties.setString("channel", "TE");//string
+superProperties.setNumber("age",1);//number
+superProperties.setBool("isSuccess",true);//boolean
+superProperties.setDateTime("birthday","2020-01-02 10:52:52.290");//time
+
+TDJSONObject object;
+object.setString("key", "value");
+superProperties.setJsonObject("object", object);// object
+
+TDJSONObject object1;
+object1.setString("key", "value");
+vector<TDJSONObject> arr;  
+arr.push_back(object1);
+superProperties.setList("object_arr", arr); // array object
+
+vector<string> arr1;
+arr1.push_back("value");
+superProperties.setList("arr",arr1);//array
+
+TDAnalytics::setSuperProperties(superProperties);
+```
+
+Super Properties would 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. 
+- The event property is of type `TDJSONObject`.
+- 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/GC8pwAeGLiW2vlkR44WcNoJfnId)
+```cpp
+TDAnalytics::enableAutoTrack();
+```
+
+### **3.4 Sending Events**
+You can call `Track` 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
+TDJSONObject eventProperties;
+eventProperties.setString("product_name", "product name");
+TDAnalytics::track("product_buy",eventProperties);
+```
+
+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
+TDJSONObject properties;
+properties.setString("username", "TA");
+TDAnalytics::userSet(properties);
+//the username now is TE
+TDJSONObject newProperties;
+newProperties.setString("username", "TE");
+TDAnalytics::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 "./ThinkingAnalytics/Common/TDAnalytics.h"
+using namespace thinkingdata::analytics;
+if (privacy policy is authorized) {
+      TDAnalytics::init(TE_APP_ID, TE_SERVER_URL);
+      //if the user has logged in, the account ID of the user could be set as the unique identifier 
+      TDAnalytics::login("TE");
+      
+      
+      //After setting super properties, each event would have super properties
+      TDJSONObject superProperties;
+      superProperties.setString("channel", "TE");//string
+      superProperties.setNumber("age",1);//number
+      superProperties.setBool("isSuccess",true);//boolean
+      superProperties.setDateTime("birthday","2020-01-02 10:52:52.290");//time
+
+      TDJSONObject object;
+      object.setString("key", "value");
+      superProperties.setJsonObject("object", object);// object
+
+      TDJSONObject object1;
+      object1.setString("key", "value");
+      vector<TDJSONObject> arr;  
+      arr.push_back(object1);
+      superProperties.setList("object_arr", arr); // array object
+
+      vector<string> arr1;
+      arr1.push_back("value");
+      superProperties.setList("arr",arr1);//array 
+      //set super properties
+      TDAnalytics::setSuperProperties(superProperties);
+      
+      //Enable auto-tracking
+      TDAnalytics::enableAutoTrack();
+      
+      //upload events
+      TDJSONObject eventProperties;
+      eventProperties.setString("product_name", "product name");
+      TDAnalytics::track("product_buy",eventProperties);
+      
+      //Set user properties
+      TDJSONObject userProperties;
+      userProperties.setString("username", "TE");
+      TDAnalytics::userSet(userProperties);
+}
+```

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/game-engine/cocoscreator/cocoscreator-advance/automatic-event-tracking.md

@@ -0,0 +1,70 @@
+---
+code: cocoscreator_sdk_autotrack
+name: "Automatic Event Tracking"
+wikiToken: KS9vw7Yq6i5BcwkLJhdczOskn4e
+parentWikiToken: DHMrw6JkgiGcwxkzyPKc55VJn0c
+updateTime: 1774249140000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocoscreator_sdk_autotrack
+---
+
+## **1. Introduction **
+CocosCreator SDK support auto-tracking Mini Game Event:
+1. Open Mini Game, including activiting Mini Game and resuming Mini Game from the background
+2. Close Mini Game: including disabling the Mini Game
+## **2. Enable Auto-Tracking**
+Configing before SDK initialization to enable auto-tracking: 
+```javascript
+var config = {
+    appid: "YOUR_APPID",
+    server_url: "YOUR_SERVER_URL",
+    autoTrack: {
+         appShow: true, 
+         appHide: true, 
+         properties: { 
+         callback: (eventType:any) =>{ 
+           if (eventType === 'appShow')
+           {
+            return { appShowKey: 'appShowValue' };
+           } 
+           else if (eventType === 'appHide')
+           {
+            return { appHideKey: 'appHideValue' };
+           } 
+           else {
+             return {};
+           }
+         }
+     }
+};
+TDAnalytics.init(config);
+```
+
+- appShow: enable auto-tracking open Mini Game
+- appHide: enable auto-tracking close Mini Game
+- properties: auto-tracking events properties
+- callback: auto-tracking events callback
+If you need the first automatically collected event to include the account, visitor, and static public attributes, you can pass in the following configuration during initialization:
+```javascript
+TDAnalytics.init(config, () => {
+  TDAnalytics.login("TA")
+  TDAnalytics.setDistinctId("DIS_TA")
+  TDAnalytics.setSuperProperties({
+    key: "value"
+  });
+});
+```
+
+## **3. Instructions**
+### **3.1 Open Mini Game**
+Mini Game started event would be triggered when the user enables the Mini Game or resumes the Mini Game from the background. A detailed description of the start event is as follows:
+- Event Name：ta_mg_show
+- Auto-tracking Event Properties：
+  - `#scene`, game scene name
+### **2.2 Close Mini Game**
+Mini Game end event would be triggered when the user disables the Mini Game or moves the Mini Game to the background. Detailed description of the end event is as follows:
+- Event Name：ta_mg_hide
+- Auto-tracking Event Properties：
+  - `#scene`, game scene name
+  - `#duration`, numeric type, indicating the duration of each Mini Game (unit: second)
+
+  

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/game-engine/cocoscreator/cocoscreator-advance/debugging-and-logging.md

@@ -0,0 +1,57 @@
+---
+code: cocoscreator_sdk_debug
+name: "Debugging and Logging"
+wikiToken: QxtFwT2LAi8sJdk2mUEc9mo7nCb
+parentWikiToken: DHMrw6JkgiGcwxkzyPKc55VJn0c
+updateTime: 1774251983000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocoscreator_sdk_debug
+---
+
+Debugging and Logging
+During the process of SDK integration, you can perform real-time debugging by checking SDK's logs in the IDE console or using the Debug feature of TE.
+## **1. Printing Log**
+```java
+var config = {
+  appId: "YOUR_APPID",
+  serverUrl: "YOUR_SERVER_URL",
+  enableLog:true//enable printing logs, default is false
+};
+TDAnalytics.init(config);
+```
+
+<quote-container>
+After opening the log, you can check data tracking of SDK by filtering logs related to ThinkingAnalytics in IDE.
+</quote-container>
+
+## **2. Debugging**
+You need to follow the following two steps to enable the Debug mode:
+1. Enable the debug mode at the client side
+The sample code for enabling the Debug mode on the client side is as follows:
+```java
+/*
+Set the operation mode as the Debug mode
+none mode: the data would be saved in caches and reported according to relevant cache policies under the NORMAL mode by default. It is recommended to use the mode in an online environment
+debug mode: report data item by item. If problems occur, the user would be notified with logs and anomalies. It is recommended to use the Debug mode in an online environment
+debugOnly mode: data would be verified without being stored; it is not recommended to use the DebugOnly mode in an online environment
+ */
+var config = {
+  appId: "YOUR_APPID",
+  serverUrl: "YOUR_SERVER_URL",
+  debugMode: "debug" // set debug mode
+};
+// initialize SDK
+TDAnalytics.init(config);
+```
+
+2. Add Device
+To avoid launching the Debug mode in the production environment, it is required that only specified device can enable Debug mode. The Debug mode can only be enabled for devices whose IDs have been configured in the "Debugger"sector on the "Tracking Management" page of TE when the client side has enabled the Debug mode.
+<image token="BEWEbHQVVogmtuxJFJTcYbCgnOd" width="2782" height="1284" align="left"/>
+
+
+Device ID could be obtained by the following three means:
+- #Device_id property in the event data of TE
+- Client-side log: DeviceID would be printed as log after SDK is initialized
+- Call API：[Device ID](https://thinkingdata.feishu.cn/wiki/DHMrw6JkgiGcwxkzyPKc55VJn0c)
+<quote-container>
+The Debug mode may undermine the data tracking quality and stability of the App. It could only be used for data verification at the integration stage, and should not be used in the online environment.
+</quote-container>

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

@@ -0,0 +1,104 @@
+---
+code: cocoscreator_sdk_native_support
+name: "Native Support"
+wikiToken: XykzwwmelizphXkdA8Yc98pYnUe
+parentWikiToken: DHMrw6JkgiGcwxkzyPKc55VJn0c
+updateTime: 1774249145000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocoscreator_sdk_native_support
+---
+
+## **1. ****iOS**** Native Support**
+Building the iOS project for the first time, it will create native project file to ./build/ios/ and ./native/engine/ios/, and then you can start configuring the iOS project.
+### **1.1 Manual Configuration**
+- Add iOS project files
+  - `CocosCreatorProxyApi.h`
+  - `CocosCreatorProxyApi.mm`
+  - `ThinkingSDK.framework`
+  - `ThinkingDataCore.framework`
+- Build Phases 
+  - Add `ThinkingSDK.framework` to `Link Binary With Libraries`
+- Build Settings 
+  - Add `ThinkingSDK.framework` path, e.g. `"$(SRCROOT)/../Classes"`, to `Framework Search Paths`
+  - Add `-ObjC` to `Other Linker Flags`
+### **1.2 CMakeList Configuration**
+<quote-container>
+1. `CMakeList` file path is `./native/engine/ios/CMakeLists.txt`
+2. The `CMakeList` file will be created after the iOS project is built for the first time, and it will take effect when it is built again after configuration
+3. Copy iOS files to project, e.g. `./native/engine/common/Classes/ThinkingAnalytics/ios/`, and config `CMakeList` 
+</quote-container>
+
+- Add iOS project files
+```c
+# find the following code 
+set(PROJ_COMMON_SOURCES
+    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/Game.h
+    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/Game.cpp
+    # add the following code
+    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/ThinkingAnalytics/ios/CocosCreatorProxyApi.h
+    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/ThinkingAnalytics/ios/CocosCreatorProxyApi.mm
+    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/ThinkingAnalytics/ios/ThinkingSDK.framework
+    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/ThinkingAnalytics/ios/ThinkingDataCore.framework
+)
+```
+
+- Build Phases
+```c
+# find the following code 
+target_link_libraries(${LIB_NAME} cocos2d)
+# add the following code
+target_link_libraries(${LIB_NAME} ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/ThinkingAnalytics/ios/ThinkingSDK.framework)
+target_link_libraries(${LIB_NAME} ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/ThinkingAnalytics/ios/ThinkingDataCore.framework)
+```
+
+- Build Settings
+```c
+# find the following code 
+set(PRODUCT_NAME ${APP_NAME})
+# add the following code
+set(CMAKE_EXE_LINKER_FLAGS -ObjC)
+```
+
+<quote-container>
+Cocos Creator v2.x does not support the CMake configuration mode, and needs to be configured manually.
+</quote-container>
+
+## **2.  Android Native Support**
+Build and config the Android project.
+- Open Android project with Android Studio and switch to Android mode. Add  `CocosCreatorProxyApi.java` to `com.cocos.game` , like this: 
+<grid cols="2">
+  <column width="37">
+    <image token="T0UKbNL5Gotpljxuet8c1ABVnhg" width="440" height="397" align="center"/>
+
+  </column>
+  <column width="62">
+    <image token="HXnZbUTJJoRFQHxzLDCcrXRGnrc" width="953" height="517" align="center"/>
+
+  </column>
+</grid>
+
+- Find the file proguard-rules.pro in `/app`, and add obfuscated code
+```plaintext
+-keep public class com.cocos.game.CocosCreatorProxyApi {*;}
+```
+
+- Create a directory named libs, and copy `TDAnalytics.aar`、`TDCore.aar` to libs
+- Add code to `build.gradle` of `Module`
+```plaintext
+dependencies {
+    ...
+    implementation fileTree(dir: 'libs', include: ['*.aar'])
+}
+```
+
+## **3. Enable Native Support**
+When initializing the SDK, add **enableNative: true** to enable Native support
+```javascript
+// SDK config object
+var config = {
+   appId: "YOUR_APPID", // APP ID
+   serverUrl: "YOUR_SERVER_URL", // server URL
+   enableNative: true// enable call Native code
+};
+
+TDAnalytics.init(config);
+```

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

@@ -0,0 +1,91 @@
+---
+code: cocoscreator_sdk_preset_properties
+name: "Preset Properties"
+wikiToken: A8nOwRZOfizsfHk3MUvcwifEnuh
+parentWikiToken: DHMrw6JkgiGcwxkzyPKc55VJn0c
+updateTime: 1774251983000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocoscreator_sdk_preset_properties
+---
+
+<quote-container>
+Preset Properties will have differences on different platforms, for details: [Android](https://thinkingdata.feishu.cn/wiki/MBnZwHrO0ibkd9ksCSBc7dxEnic), [iOS](https://thinkingdata.feishu.cn/wiki/Ny61w1VIbi5Qeok94fRcJhulned). 
+</quote-container>
+
+## **1. Preset Properties of All Events**
+All Events in CocosCreator SDK(including auto-tracking events) would have the following preset property.
+<sheet token="ZZxTsxoqIhrEtrtbnY5cBMHknhc_Wzqqhd"/>
+
+## **2. Preset Properties of Auto-tracking Event**
+The following preset properties are the properties set specially for each auto-tracking event
+- Preset properties of Mini Game end event (tg_mg_hide)
+
+<lark-table rows="2" cols="4" column-widths="143,137,138,335">
+
+  <lark-tr>
+    <lark-td>
+      ** Property name **
+    </lark-td>
+    <lark-td>
+      ** Display name **
+    </lark-td>
+    <lark-td>
+      ** Property type **
+    </lark-td>
+    <lark-td>
+      ** Instruction **
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #duration
+    </lark-td>
+    <lark-td>
+      Event duration
+    </lark-td>
+    <lark-td>
+      Numeric value
+    </lark-td>
+    <lark-td>
+      Indicates the duration from starting(ta_mg_show) to hiding (ta_mg_hide) this time, in seconds
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+## **3.** **Getting Preset Properties**
+If you need to use the preset properties of the client SDK when tracking events on the server, then you can use `getPresetProperties` to get these properties and upload them to the server.
+```javascript
+   //get preset properties object
+   var presetProperties = TDAnalytics.getPresetProperties();
+
+   //get all preset properties
+   var properties = presetProperties.toEventPresetProperties();
+   /*
+      {
+         "#device_model":"iPhone 5",
+         "#device_id":"3204487163-1624513721217",
+         "#screen_width":320,
+         "#screen_height":568,
+         "#os":"iOS",
+         "#os_version":"10.0.1",
+         "#network_type":"wifi",
+         "#zone_offset":8,
+         "#manufacturer":"Apple"
+       }
+   */
+
+    //get a preset property
+    var os =  presetProperties.os;//os name, e.g. Android
+    var osVersion = presetProperties.osVersion;//os version
+    var networkType = presetProperties.networkType;//network type
+    var manufacture = presetProperties.manufacture;//device manufacture name
+    var deviceModel= presetProperties.deviceModel;//device mode
+    var screenWidth = presetProperties.screenWidth;//screen width
+    var screenHeight = presetProperties.screenHeight;//screen height
+    var deviceId = presetProperties.deviceId;//device ID
+    var zoneOffset = presetProperties.zoneOffset;//time zone offset
+    
+```
+
+<quote-container>
+IP, nation and city information are parsed and generated by the server. The client shall not provide the interface to get such properties
+</quote-container>