@thinkingai/ae-cli 1.0.30 → 6.0.16

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

@@ -0,0 +1,374 @@
+---
+code: cocoscreator_sdk_advanced
+name: "CocosCreator-Advance"
+wikiToken: DHMrw6JkgiGcwxkzyPKc55VJn0c
+parentWikiToken: AL6VwEXmiiAgK7kXq97c8YXNnLc
+updateTime: 1774251982000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocoscreator_sdk_advanced
+---
+
+## 1**. Managing User Identity**
+SDK instances would use random UUID as the default distinct ID of each user by default, which would be used as the identity identification ID of users under an unlogged-in state. It should be noted that the distinct ID would change after the user reinstalled the App or use the APP with a new device.
+### **1.1. Identify**
+::: tip
+Generally speaking, you do not need to customize a distinct ID. Please ensure that you understand [User Identification Rules](https://thinkingdata.feishu.cn/wiki/Pov9wECdsi2QQsk4NN9cEPsvnyc)<text color="purple"> </text>before setting a distinct ID. 
+If you need to change the distinct ID, please call the api immediately after SDK is initialized. To avoid the generation of useless accounts, please do not call such a process multiple times.
+:::
+If your App has its own distinct ID management system for each user, you can call `setDistinctId` to set the distinct ID:
+```java
+// set distinct ID as Thinker
+TDAnalytics.setDistinctId("Thinker");
+```
+
+If you need to get the current distinct ID, please call `getDistinctId`:
+```java
+//返回访客ID
+let distinctId = TDAnalytics.getDistinctId();
+```
+
+### **1.2 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 identity identification ID, and the account ID that has been set would be saved before `logout` is called. The previous account ID would be replaced if `login` has been called multiple times.
+```javascript
+// 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>
+Note: Login events wouldn't be uploaded in this method.
+</quote-container>
+
+### **1.3 Removing Account ID**
+After the user logs out, `logout` could be called to remove the account ID. The distinct ID would be used as the identity identification ID before the next time `login` is called. 
+```javascript
+TDAnalytics.logout();
+```
+
+It is recommended that you call logout upon explicit logout event. For example, call `logout` when the user commits the behavior of canceling an account; do not call such a process when the App is closed.
+<quote-container>
+Note: Logout events wouldn't be uploaded in this method.
+</quote-container>
+
+## **2.** **Sending Events**
+After SDK is initialized, you can track user behaviour data. In general, ordinary events could meet business requirements. You can also use the First/Updatable Event based on your own business requirements.
+### **2.1 Ordinary 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:
+```javascript
+TDAnalytics.track({
+    eventName: "product_buy", // event name
+    properties: { product_name: "product name" } // properties
+});
+```
+
+### **2.2 First Events**
+The First Events refers to events that would only be recorded once for the ID of a certain device or other dimensions. For example, under certain scenarios, you may want to record the activation event on a certain device. In this case, you can perform data tracking with the First Event.
+```javascript
+TDAnalytics.trackFirst({
+    eventName: "device_activation",
+    properties: { key: "value" }
+});
+```
+
+If you want to judge whether an event is the First Event from other dimensions, you can define a first_check_id for the First Event:
+```javascript
+//set the user ID as the first_check_id of the first event to track the first initialization event of the user.
+TDAnalytics.trackFirst({
+    eventName: "account_activation",
+    firstCheckId: "TE",
+    properties: { key: "value" }
+});
+```
+
+<quote-container>
+Note: Since the server has to check whether the event is the First Event, the First Event will be put in storage one hour later by default.
+</quote-container>
+
+### **2.3 Updatable Events**
+You can meet the requirements for event data modification under specific scenarios through Updatable Events. The ID of Updatable Events should be specified and uploaded when the objects of Updatable Events are created. TE would determine the data to be updated according to the event name and event ID.
+```javascript
+ //The event property status is 3 after reporting, with the price being 100
+TDAnalytics.trackUpdate({
+    eventName: "UPDATABLE_EVENT",
+    properties: { status: 3, price: 100 },
+    eventId: "test_event_id"
+});
+
+//The event property status is 5 after reporting, with the price remaining the same
+TDAnalytics.trackUpdate({
+    eventName: "UPDATABLE_EVENT",
+    properties: { status: 5 },
+    eventId: "test_event_id"
+});
+```
+
+### **2.4 Overwritable Events**
+Despite the similarity with Updatable Events, Overwritable Events would replace all historical data with the latest data. Looking from the perspective of effect, such a process is equivalent to the behavior of deleting the previous data while putting the latest data in storage. TE would determine the data to be updated according to the event name and event ID.
+```javascript
+//The event property status is 3 after reporting, with the price being 100
+TDAnalytics.trackOverwrite({
+    eventName: "OVERWRITE_EVENT",
+    properties: { status: 3, price: 100 },
+    eventId: "test_event_id"
+});
+
+//The event property status is 5 after reporting, with the price deleted
+TDAnalytics.trackOverwrite({
+    eventName: "OVERWRITE_EVENT",
+    properties: { status: 5 },
+    eventId: "test_event_id"
+});
+```
+
+### **2.5 Super Properties**
+Super properties refer to properties that would be uploaded by each event. Super properties could be divided into `static super properties` and `dynamic super properties`based on the update frequency. You can select different methods for super property setting according to business requirements; we recommend that you set super properties first before sending events. In the same event, when the keys of super properties, self-defined event properties, and preset properties are the same, we would assign value according to the following priority:  `self-defined properties>dynamic super properties>static super properties>preset properties`.
+#### **2.5.1 Static Super Properties**
+Static super properties are properties that all events might have and would change with a low frequency, for example, the user membership class. After setting static super properties through `setSuperProperties`, SDK would use the preset super properties as the event properties when tracking events.
+```javascript
+//set super properties
+TDAnalytics.setSuperProperties({ channel: "Apple" });
+```
+
+Static super properties would be saved in local storage, and should not be called every time the App is closed. If such properties already exist, the reset properties would replace the original properties. If such properties do not exist, properties would be newly created. In addition to property setting, we also provide other APIs to set and manage static super properties and meet general business requirements.
+```javascript
+//get all super properties
+var superProperties = TDAnalytics.getSuperProperties();
+//clear a super property named 'channel'
+TDAnalytics.unsetSuperProperty("channel");
+//clear all super properties
+TDAnalytics.clearSuperProperties();
+```
+
+#### **2.5.2 Dynamic super properties**
+Dynamic super properties that all events might have and would change with a high frequency, for example, the quantity of the gold coins the user possesses. After setting dynamic super properties through `setDynamicSuperPropertiesTracker`, SDK would obtain the properties during event tracking automatically, and add such properties to the event triggered.
+```javascript
+// set dynamic super properties
+TDAnalytics.setDynamicSuperProperties(function() {
+  var d = new Date();
+  d.setHours(10);
+  return { date: d };
+});
+```
+
+### **2.6 Timing Events**
+If you need to record the duration of a certain event, you can call `timeEvent` . Configure the name of the event you want to record. When you upload the event, `#duration` would be added to your event property automatically to record the duration of the event (unit: second). It should be noted that only one task can be timed with the same event name.
+```javascript
+//The user enters the product page and starts the timing
+TDAnalytics.timeEvent({
+    eventName: "stay_shop"
+});
+/**do someting
+    .......
+**/
+    //the timing would end when the user leaves the product page. "stay_shop" event would carry#duration, a property representing event duration. 
+TDAnalytics.track({
+    eventName: "stay_shop",
+    properties: {
+        product_name: "product name"
+    }
+});
+```
+
+## **3. User Properties**
+User property setting APIs supported by TE  include: `userSet`,  `userSetOnce`, `userAdd`, `userUnset`, `userDelete`, `userAppend`, `userUniqAppend`.
+### **3.1 UserSet**
+You can call `userSet` to set general user properties. The original properties would be replaced if the properties uploaded via the API are used. The type of newly-created user properties must conform to that of the uploaded properties. User name setting is taken as the example here:
+```javascript
+// current username is TA
+TDAnalytics.userSet({
+    properties: {
+        username: "TA" 
+    }
+});
+// current username is TE
+TDAnalytics.userSet({
+    properties: {
+        username: "TE" 
+    }
+});
+```
+
+### **3.2 UserSetOnce**
+If the user property you want to upload only needs to be set once, you can call `userSetOnce` to set the property. If such property had been set before, this message would be neglected. Let's take the setting of the first payment time as an example:
+```javascript
+//first_payment_time is '2018-01-01 01:23:45.678'
+TDAnalytics.userSetOnce({
+    properties: {
+        first_payment_time: "2018-01-01 01:23:45.678" 
+    }
+});
+//first_payment_time is '2018-01-01 01:23:45.678' as before
+TDAnalytics.userSetOnce({
+    properties: {
+        first_payment_time: "2018-12-31 01:23:45.678" 
+    }
+});
+```
+
+### **3.3 UserAdd**
+When you want to upload numeric property for cumulative operation, you can call `userAdd`.
+If the property has not been set, it would be given a value of 0 before computing. A negative value could be uploaded, which is equivalent to subtraction operation. Let's take the accumulative payment amount as an example:
+```javascript
+//current total_revenue is 30
+TDAnalytics.userAdd({
+    properties: {
+        total_revenue: 30
+    }
+});
+//current total_revenue is 678
+TDAnalytics.userAdd({
+    properties: {
+        total_revenue: 648
+    }
+});
+```
+
+<quote-container>
+The property key is a string, and the value is only allowed to be a numeric value.
+</quote-container>
+
+### **3.4 UserUnset**
+When you need to clear the user properties of users, you can call `userUnset` to clear specific properties.  `userUnset` would not create properties that have not been created in the cluster.
+```javascript
+// remove a user property named 
+TDAnalytics.userUnset({
+    property: "userPropertykey"
+});
+```
+
+### **3.5 UserDelete**
+You can call `userDelete` to delete a user. After deleting the user, you would no longer be able to inquire about its user property, but could still query the events data triggered by the user.
+```javascript
+TDAnalytics.userDelete();
+```
+
+### **3.6 UserAppend**
+You can call `userAppend` to add user properties of array type.
+```javascript
+TDAnalytics.userAppend({
+    properties: {
+        user_list: ["apple", "ball"]
+    }
+});
+```
+
+### **3.7 UserUniqAppend**
+You can call `userUniqAppend` to add user properties of array type. You can delete duplicated user property by calling `userUniqAppend` interface. If you call `userAppend` API, duplicated user property will be merged.
+```javascript
+//current user_list is ["apple"，"ball"]
+TDAnalytics.userAppend({
+    properties: {
+        user_list: ["apple", "ball"]
+    }
+});
+//current user_list is ["apple","apple","ball","cube"]
+TDAnalytics.userAppend({
+    properties: {
+        user_list: ["apple", "cube"]
+    }
+});
+//current user_list is ["apple"，"ball","cube"]
+TDAnalytics.userUniqAppend({
+    properties: {
+        user_list: ["apple", "cube"]
+    }
+});
+```
+
+## **4. Encryption**
+The SDK supports data encryption using AES+RSA. The data encryption function requires the cooperation of the client and the server. For specific usage methods, please consult customer success manager.
+```javascript
+var config = {
+  appId: "YOUR_APP_ID", // project APP ID
+  serverUrl: "YOUR_SERVER_URL", // project server URL
+  enableEncrypt: true, // enable data Encryption
+  secretKey: {
+    publicKey:'YOUR_PUBLIC_KEY', // public key
+    version:1 // key version
+   }
+};
+// initialization
+TDAnalytics.init(config);
+```
+
+## **5. Other**
+### **5.1  ****Device ID**
+You can call `getDeviceId` to obtain the device ID:
+```javascript
+//the value of device ID is Android ID
+var deviceId = TDAnalytics.getDeviceId();
+```
+
+### **5.2 Callback Function**
+For interfaces such as **track**, **userSet**, **userSetOnce**, **userAdd**, **userDelete**, the onComplete callback is supported.
+```javascript
+// the callback is a parameter
+TDAnalytics.track("test", { testkey: 123 }, new Date(), res => {
+  console.log(res);
+});
+// the callback in object
+TDAnalytics.track({
+  eventName: "test",
+  properties: { testkey: 123 },
+  time: new Date(),
+  onComplete: res => {
+    console.log(res);
+  }
+});
+```
+
+Callback parameters: code, msg
+code(in Normal mode):
+- 0: success
+- -1: data format error
+- -2: APP ID invalid
+- -3: network/server err
+code(in Debug mode):
+- 0: success
+- -1: data format error
+- 1: field error
+- 2: request data error
+- -3: network/server err
+msg is a description of code
+### 5.3 Enable Caching Event Data
+Since v2.2.0, event caching is enabled.
+```javascript
+// config TE SDK
+var config = {
+  appId: "YOUR-APP-ID", // project APP ID
+  serverUrl: "YOUR-SERVER-URL", // event data report server URL
+  enableBatch: true, // enable caching event
+  batchConfig: {
+    size: 5, // event report batch size
+    interval: 5000 // event report time interval, Ms
+  }
+};
+
+// initialization
+TDAnalytics.init(config); 
+```
+
+### 5.4 **Time Calibration**
+- SDK would use local time as the event time by default. If the user modifies the device time manually,  analysis will be affected. At this time, time calibration could be performed to ensure the accuracy of event time. 
+```typescript
+TDAnalytics.calibrateTime(1585633785954);
+```
+
+- You can also set up automatic time calibration. The SDK will then attempt to retrieve the current time from the config interface and calibrate the SDK time. If the correct result is not obtained, subsequent data will be reported using the local time.
+```typescript
+var config = {
+  appId: "YOUR_APPID",
+  serverUrl: "YOUR_SERVER_URL",
+  enableAutoCalibrated:true
+};
+TDAnalytics.init(config);
+```
+
+### 5.4 Set the default time zone
+By default, the SDK (>=3.5.0) uses the local machine time as the event occurrence time. You can also specify a time zone by setting the default time zone interface. In this way, all events will be aligned with the time zone you set. 
+```typescript
+var config = {
+  appId: "YOUR_APPID",
+  serverUrl: "YOUR_SERVER_URL",
+  zoneOffset:9
+};
+TDAnalytics.init(config);
+```

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

@@ -0,0 +1,35 @@
+---
+code: cocoscreator_sdk_compliance
+name: "Compliance"
+wikiToken: QzbywaZoWiUHjzkEtL2cKEpmnPc
+parentWikiToken: AL6VwEXmiiAgK7kXq97c8YXNnLc
+updateTime: 1774249147000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocoscreator_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.*
+```javascript
+// determine whether to enable data tracking according to the Privacy Policy
+if (authorized) {
+  // config SDK infomation
+  var config = {
+    appId: "YOUR_APPID", // project APP ID
+    serverUrl: "YOUR_SERVER_URL", // receiver URL
+    autoTrack: { // auto-tracking
+      appShow: true, // open APP
+      appHide: true // close APP
+    }
+  };
+
+  // SDK initialization
+  TDAnalytics.init(config);
+}
+```

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

@@ -0,0 +1,109 @@
+---
+code: cocoscreator_sdk_release_note
+name: "Release Notes"
+wikiToken: Ec3FwVBJmioIvhkzJPqc1y53nac
+parentWikiToken: AL6VwEXmiiAgK7kXq97c8YXNnLc
+updateTime: 1780572170000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocoscreator_sdk_release_note
+---
+
+## **v3.6.1**
+**Date:** 06/04/2026 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.6.1.zip)
+**Notes:**
+- Known issue fixes
+## **v3.5.2**
+**Date:** 03/30/2026 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.5.2.zip)
+**Notes:**
+- Known issue fixes
+## **v3.5.1**
+**Date:** 03/26/2026 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.5.1.zip)
+**Notes:**
+- Known issue fixes
+## **v3.5.0**
+**Date:** 03/09/2026 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.5.0.zip)
+**Notes:**
+- Native layer supports timestamp calibration and automatic time calibration.
+- Android and iOS support custom time zones.
+- HarmonyOS is compatible with versions 2.+ and 3.+.
+- Known issue fixes
+## **v3.4.2**
+**Date:** 12/10/2025 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.4.2.zip)
+**Notes:**
+- Supports automatically collecting events with account, visitor, and static public attributes.
+## **v3.4.1**
+**Date:** 11/20/2025 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.4.1.zip)
+**Notes:**
+- Known issues fixed
+## **v3.3.2**
+**Date:** 08/13/2025 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.3.2.zip)
+**Notes:**
+- Support the Taobao Mini Game Platform
+## **v3.3.0**
+**Date:** 06/06/2025 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.3.0.zip)
+**Notes:**
+- Support HarmonyOS
+- Fix the error when running without automatic collection configuration on the Android platform.
+## **v3.2.1**
+**Date:** 05/21/2024 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.2.1.zip)
+**Notes:**
+- Known issues fixed
+## **v3.0.3**
+**Date:** 05/13/2024 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.0.3.zip)
+**Notes:**
+- Fixed the issue of data loss in weak network conditions
+- Support custom time zone
+## **v3.0.2**
+**Date:** 02/09/2024 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.0.2.zip)
+**Notes:**
+- Refactoring batch mode to send data
+## **v3.0.1**
+**Date:** 11/24/2023 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.0.1.zip)
+**Notes:**
+- Code optimization 
+## **v3.0.0**
+**Date:** 08/28/2023 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.0.0.zip)
+**Notes:**
+- Code optimization 
+## **v2.2.4**
+**Date:** 07/28/2023 [Download](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v2.2.4.zip)
+**Notes:**
+- Code optimization 
+## **v2.2.0**
+**Date:** 08/15/2022
+**Notes:**
+- Added support for event caching
+- Code optimization 
+## **v2.1.0**
+**Date: **06/28/2022
+**Notes:**
+- Added support for deduplication and appending user attributes
+- Web platform supports ta_page_show/ta_page_hide events
+- Added support for data encryption reporting
+- Code optimization
+## **v2.0.3**
+**Date: **02/21/2022
+**Notes:**
+- Automatic collection of events supports custom attributes
+- Code optimization
+## **v2.0.2**
+**Date: **12/31/2021
+**Notes:**
+- Support fun headlines, Facebook, GooglePlay and other small games
+- Code optimization
+## **v2.0.1**
+**Date:** 11/15/2021
+**Notes:**
+- Code optimization
+- Support for complex data types
+## **v2.0.0**
+**Date:** 09/15/2021
+**Notes:**
+- Support iOS/Android Native
+- Support pause/start, stop/resume data reporting
+- Support event blacklist
+- Code optimization
+## **v1.8.2**
+**Date: **06/24/2021
+**Notes:**
+- Support prefabricated attribute acquisition
+- fix bug: When the native/web platform is running, the problem of data sending failure caused by network disconnection and reconnection

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

@@ -0,0 +1,170 @@
+---
+code: cocoscreator_sdk_installation
+name: "CocosCreator"
+wikiToken: AL6VwEXmiiAgK7kXq97c8YXNnLc
+parentWikiToken: FgrswqlHEiE45HkQve4cU0NFnbd
+updateTime: 1780572148000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=cocoscreator_sdk_installation
+---
+
+::: tip
+ Before you begin, please read [Preparations before Data Ingestion](https://thinkingdata.feishu.cn/wiki/OhD8we9iai6Xk5kM1QNc8ITRnQe)
+ CocosCreator SDK support Android, iOS, Web, Wechat Mini Game, Alipay Mini Game, Bytedance Mini Game, OPPO Quick Game, Huawei Quick Game, VIVO Quick Game, Xiaomi Quick Game, Facebook Mini Game, Google Play Instant Game.
+ :::
+**Latest version**** :** v3.6.1
+**Update time****:** 06/04/2026
+**Resource download**: [<text color="blue">SDK</text>](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.6.1.zip)<text color="blue">, </text>[Source Code](https%3A%2F%2Fgithub.com%2FThinkingDataAnalytics%2Fmp-sdk%2Ftags)
+::: warning Notice 
+The current documentation applies to v3.0.0 and later versions. For historical versions, please refer to the [Data Ingestion Guide - CocosCreator (V2)](https%3A%2F%2Fdocs.thinkingdata.cn%2Fta-manual%2Fv4.1%2Fen%2Finstallation%2Finstallation_menu%2Fclient_sdk%2Fgame_engine_sdk_installation%2Fcocoscreator_sdk_installation%2Fcocoscreator_sdk_installation.html), [SDK Download (v2.2.4)](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v2.2.4.zip). 
+:::
+## **1. ****SDK**** Integration**
+Download and unzip [CocosCreator SDK](https%3A%2F%2Fdownload.thinkingdata.cn%2Fclient%2FMPMG%2Fta_cocoscreator_sdk_v3.6.1.zip)
+:::: el-tabs
+::: el-tab-pane label=TypeScript Integration
+TypeScript project data Integration:
+1. Add file **tdanalytics.cc****.d.ts** to **assets/libs**. If libs does not exist, create libs folder
+2. Copy SDK file (**tdanalytics.mg.cocoscreator.min.js**) to **assets/Script**
+:::
+::: el-tab-pane label=JavaScript Integration
+JavaScript project data Integration:
+1. Copy SDK file (**tdanalytics.mg.cocoscreator.min.js**) to **assets/Script**
+:::
+::::
+## **2. Initialization**
+Import **TDAnalytics**, then you can use CocosCreator SDK:
+```javascript
+// config SDK infomation
+var config = {
+  appId: "YOUR_APPID", // project APP ID
+  serverUrl: "YOUR_SERVER_URL", // receiver URL
+  autoTrack: { // auto-tracking
+    appShow: true, // open APP
+    appHide: true // close APP
+  }
+};
+// SDK initialization
+TDAnalytics.init(config);
+```
+
+Parameters:
+- **appId**: The APPID of your project, which can be found on the project management page of  TE.
+- **serverUrl**: 
+  - If you are using a SaaS version, please check the receiver URL on this page
+<image token="BlxhbLmVhot19IxqgR5cW8P4nxc" width="1674" height="1318" align="center"/>
+
+- 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>
+
+- **autoTrack**: Optional, enable auto-tracking
+  - **appShow**: Enable auto-tracking APP open events
+  - **appHide**: Enable auto-tracking APP open events
+<quote-container>
+Note: Before reporting the data, please add the data receiving URL to the request list of the server domain name in the development settings of the WeChat public platform or other platforms.
+</quote-container>
+
+## **3. Common Features**
+We suggest that you read [User Identification Rules](https://thinkingdata.feishu.cn/wiki/Pov9wECdsi2QQsk4NN9cEPsvnyc) before using common functions; 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 platform 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.
+```javascript
+// 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>
+Note: 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.
+```javascript
+var superProperties = {
+    channel : "te", //string
+    age : 1,//number
+    isSuccess : true,//boolean
+    birthday :  new Date(),//time
+    object : { key : "value" },//object
+    object_arr : [ { key : "value" } ],//object array
+    arr : [ "value" ]//array
+};
+// set super properties
+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. 
+- 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>
+Note: The requirements for event properties and user properties are the same with that for super properties
+</quote-container>
+
+### **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:
+```javascript
+TDAnalytics.track({
+    eventName: "product_buy", // event name
+    properties: { 
+        product_name: "product name" 
+    } // event 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: 
+```javascript
+//current username is TA
+TDAnalytics.userSet({
+    properties: { username: "TA" }
+});
+//current username is TE
+TDAnalytics.userSet({
+    properties: { username: "TE" }
+});
+```
+
+## **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:
+```javascript
+var config = {
+  appId: "YOUR_APPID",
+  serverUrl: "YOUR_SERVER_URL",
+  autoTrack: {
+    appShow: true,
+    appHide: true
+  }
+};
+// initialization
+TDAnalytics.init(config);
+//if the user has logged in, the account ID of the user could be set as the unique identifier 
+TDAnalytics.login("TA");
+//After setting super properties, each event would have super properties
+var superProperties = {
+    channel : "te", //string
+    age : 1,//number
+    isSuccess : true,//bool
+    birthday :  new Date(),//object
+    object : { key : "value" },//object
+    object_arr : [ { key : "value" } ],//object-array
+    arr : [ "value" ]//array
+};
+TDAnalytics.setSuperProperties(superProperties);
+// upload events
+TDAnalytics.track({
+    eventName: "product_buy", // event name
+    properties: { 
+        product_name: "product name" 
+    } // event properties
+});
+// set user properties
+TDAnalytics.userSet({
+    properties: { username: "TE" }
+});
+```
+
+### 
+
+## 
+##