@thinkingai/ae-cli 1.0.28 → 6.0.16

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/android/android-advanced/multi-instance.md

@@ -0,0 +1,66 @@
+---
+code: android_sdk_multi_instance
+name: "Multi-Instance"
+wikiToken: DznuwjigciH7BYkYzhScNVnknwc
+parentWikiToken: LqfmwtW1xi0jzwkrKpscKEzFnme
+updateTime: 1774249048000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=android_sdk_multi_instance
+---
+
+## **1. Introduction of Multi-instance**
+We support the feature of multiple Appid to create SDK instances, which we call Multi-instances for short. With the multi-instance function, you can report data to different projects.
+## **2. How to Create Multiple ****SDK**** Instances**
+Multiple SDK instances can be created by uploading different APP IDs to complete SDK initialization
+```java
+// initialize SDK
+TDAnalytics.init(this, TA_APP_ID, TA_SERVER_URL);
+TDAnalyticsAPI.track("some_event",properties, TA_APP_ID);
+
+TDAnalytics.init(this, ANOTHER_TA_APP_ID, TA_SERVER_URL);
+TDAnalyticsAPI.track("some_event",properties, ANOTHER_TA_APP_ID)
+
+TDAnalytics.init(this, TA_APP_ID, TA_SERVER_URL, NAME);
+TDAnalyticsAPI.track("some_event",properties, NAME);
+```
+
+It should be noted that the Appid of multiple SDK instances must be different. Most data between multiple instances is not the same. For detailed information, please refer to section "Data and Setting Sharing between Multiple Instances".
+## **3. Create a Light-instance**
+You can create multiple instances under the same Appid by creating light-instance
+```java
+//create an SDK instance first
+TDAnalytics.init(this, TA_APP_ID, TA_SERVER_URL);
+
+//call createLightInstance through previously-created instances to generate lightweight instances
+String uuid = TDAnalytics.lightInstance();
+TDAnalyticsAPI.login("anotherAccount",uuid);
+TDAnalyticsAPI.track("some_event",properties,uuid);
+```
+
+The Appid, receiver URL, and some settings of sub-light instances are the same as that of the parent instances, without sharing the other information. For detailed information, please refer to section 4 "Data and Settings Sharing among Multiple Instances".
+## **4. Data  Sharing among Multi-instances**
+Since most API are called by instance objects, a majority of data and settings are not shared between Multi-appid instances, Parent-instances, and Light-instances. However, some data and settings will become valid for all instances. The detailed description of whether all data and settings are shared among multiple instances is as follows
+1. Account information
+- The distinct ID `#distinct_id` generated by the system by default: shared
+- The distinct ID `#distinct_id` set by calling identify: not shared 
+- The distinct ID `#account_id` set by calling `login`: not shared
+2. Event tracking `track` and user property track `user_set`，`user_setOnce`，`user_add`，`user_delete` : not shared
+3. Super property `setSuperProperties` and dynamic super property set `setDynamicSuperPropertiesTracker`: not shared
+4. Whether SDK configuration information is shared among multiple instances:
+- Tracking policy related (i.e. the time interval of data tracking and the volume of each batch of data): shared, decided by the project data corresponding to the first instantiated Appid
+- Upload network condition `setNetworkType`: shared
+- Print uploaded data Log `EnableTrackLogging`: shared
+5. Auto-tracking event
+- It is suggested that Auto-Tracking be enabled on only one instance
+- Support reporting auto-tracking events to multiple APP IDs
+- Whether the relevant configuration of the auto-tracking event is shared by multiple instances: 
+  - Set view ID `setViewID`: not shared
+  - Self-defined view properties `setViewProperties`,etc.: not shared
+  - Ignore auto-tracking event of a certain screen `ignoreAutoTrackActivity`, etc.: not shared
+  - Ignore the click event of a certain view type `ignoreViewType`: not shared
+  - Ignore a certain view `ignoreView`: not shared
+  - All annotations: the valid instances could be specified by setting Appid parameters. If such parameters are not set, all instances should share the configuration, for example:
+```java
+@ThinkingDataIgnoreTrackAppViewScreen(Appid = "debug-Appid")
+```
+
+6. Record event duration `timeEvent`: not shared

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/android/android-advanced/preset-properties.md

@@ -0,0 +1,466 @@
+---
+code: android_sdk_preset_properties
+name: "Preset Properties"
+wikiToken: MBnZwHrO0ibkd9ksCSBc7dxEnic
+parentWikiToken: LqfmwtW1xi0jzwkrKpscKEzFnme
+updateTime: 1774251962000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=android_sdk_preset_properties
+---
+
+## **1. Preset Properties of All Events**
+All Events in Andriod SDK(including auto-tracking events) would have the following preset property.
+<sheet token="BFCzsqRI5h2w9BtGpH3cXgZOnde_pEyZdm"/>
+
+## **2. Preset Properties of Auto-tracking Event**
+The following preset properties are the properties set specially for each auto-tracking event
+- Preset properties of APP start event (ta_app_start)
+
+<lark-table rows="4" cols="4" column-widths="143,133,140,328">
+
+  <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>
+      #resume_from_background
+    </lark-td>
+    <lark-td>
+      Resume from the background or not
+    </lark-td>
+    <lark-td>
+      Bool
+    </lark-td>
+    <lark-td>
+      Indicating whether the APP is enabled by the user or resumed from the background. If the value is true, it means the APP is resumed from the background; if the value is false, it means the APP is enabled by the user directly.
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #start_reason
+    </lark-td>
+    <lark-td>
+      APP enable source
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      The content is JSON character string; when the APP is enabled by url or intent method, the `url `content and the` ``data` in intent would be recorded automatically. For the sample, please refer to:
+      `{url:"thinkingdata://","data":{}}`
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #background_duration
+    </lark-td>
+    <lark-td>
+      Background duration
+    </lark-td>
+    <lark-td>
+      Numeric value
+    </lark-td>
+    <lark-td>
+      Record the background duration of the APP in the time interval between two start events (Unit: second)
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+- Preset properties of APP end event (ta_app_end)
+
+<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>
+      Indicating the duration of the APP access (Unit: second).
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+- Preset properties of APP view screen event (ta_app_view)
+
+<lark-table rows="5" cols="4" column-widths="149,138,168,248">
+
+  <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>
+      #title
+    </lark-td>
+    <lark-td>
+      Screen title
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      The title of the Activity to which the element belongs, whose value is the value of the title property
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #screen_name
+    </lark-td>
+    <lark-td>
+      Screen name
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      The `package.class `name of the Activity to which the element belongs
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #url
+    </lark-td>
+    <lark-td>
+      Screen URL
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      The url of current screen, to be set by invoking `getScreenUrl`
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #referrer
+    </lark-td>
+    <lark-td>
+      Forward address
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      The address of the screen before skipping, to be set by invoking `getScreenUrl `
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+- Preset properties of APP element click event
+
+<lark-table rows="8" cols="4" column-widths="154,133,169,248">
+
+  <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>
+      #title
+    </lark-td>
+    <lark-td>
+      Screen title
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      The title of the Activity to which the element belongs, whose value is the value of the title property
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #screen_name
+    </lark-td>
+    <lark-td>
+      Screen name
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      The package.class name of the Activity to which the element belongs
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #element_id
+    </lark-td>
+    <lark-td>
+      Element ID
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      The ID of element, in which andriod:id is used by default, and could be set by invoking setViewID
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #element_type
+    </lark-td>
+    <lark-td>
+      Element type
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      Type of the element
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #element_selector
+    </lark-td>
+    <lark-td>
+      Element selector
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      Splicing of the viewPath of the element
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #element_position
+    </lark-td>
+    <lark-td>
+      Element position
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      Position information of element, which would only be uploaded when the element has position property
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #element_content
+    </lark-td>
+    <lark-td>
+      Element content
+    </lark-td>
+    <lark-td>
+      Text
+    </lark-td>
+    <lark-td>
+      Content on the element
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+
+- Preset properties of APP crash event (ta_app_crash)
+<sheet token="BFCzsqRI5h2w9BtGpH3cXgZOnde_V3lxuq"/>
+
+## **3. Other Preset Properties**
+In addition to the Preset properties above, some preset properties would only be recorded after corresponding API is called:
+
+<lark-table rows="3" cols="4" column-widths="138,153,153,267">
+
+  <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>
+      Timing function `timeEvent `should be invoked to record the event duration (Unit: second)
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #background_duration
+    </lark-td>
+    <lark-td>
+      Background duration
+    </lark-td>
+    <lark-td>
+      numeric value
+    </lark-td>
+    <lark-td>
+      Timing function `timeEvent` should be called to record the background duration within an event interval (Unit: second)
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+## **Getting Preset Properties**
+When some preset properties of the APP is required for the server data tracking, this method can be invoked to get the preset properties of the App side and then send them to the server. 
+```java
+   //get property objects
+   TDPresetProperties presetProperties = TDAnalytics.getPresetProperties();
+
+   //Preset properties of Event
+   JSONObject properties = presetProperties.toEventPresetProperties();
+   /*
+   {
+        "#carrier": "T-Mobile",
+        "#os": "Android",
+        "#device_id": "dd4a508df0dbff08",
+        "#screen_height": 2560,
+        "#bundle_id": "cn.thinkingdata.android.demo",
+        "#device_model": "sdk_gphone64_arm64",
+        "#screen_width": 1440,
+        "#system_language": "en",
+        "#install_time": "2022-08-19 17:31:52.398",
+        "#simulator": true,
+        "#manufacturer": "Google",
+        "#os_version": "12",
+        "#app_version": "1.0",
+        "#network_type": "3G",
+        "#zone_offset": 8,
+        "#ram": "0.8\/1.9",
+        "#disk": "0.1\/0.8",
+        "#fps": 60
+    }
+   */
+
+    //get a certain preset properties
+    String bundle_id = presetProperties.bundle_id;//package name
+    String os =  presetProperties.os;//os type, e.g., Android
+    String system_language = presetProperties.system_language;//type of mobile phone system language
+    int screen_width = presetProperties.screen_width;//screen width
+    int screen_height = presetProperties.screen_height;//screen height
+    String device_model = presetProperties.device_model;//device model
+    String device_id = presetProperties.device_id;//unique identifier of device
+    String carrier = presetProperties.carrier;//information about operator of the SIM card. Operation information of the primary card should be get under dual-card dual-standby mode 
+    String manufacture = presetProperties.manufacture;//mobile phone manufacturer, e.g., HuaWei
+    String network_type = presetProperties.network_type;//network type
+    String os_version = presetProperties.os_version;//system version number
+    String app_version = presetProperties.app_version;//app version number
+    double zone_offset = presetProperties.zone_offset;//timezone offset value
+    String ram = presetProperties.ram;//storage usage
+    String disk = presetProperties.disk;//disk usage
+    int fps = presetProperties.fps;//fps
+    String installTime = presetProperties.installTime;//app installation time
+    boolean isSimulator = presetProperties.isSimulator;//the device is a simulator or not
+    
+```
+
+<quote-container>
+IP, nation and city information are parsed and generated by the server. The client shall not provide the api to get such properties
+</quote-container>
+
+## **5. Disable Preset Property Tracking**
+Under certain scenarios, you may want to forbid tracking certain preset properties to ensure compliance and meet actual business requirements. In this case, you can add ta_public_config.xml under the res/values catalog of the engineering catalog, which would be used to configure the property array that is not allowed to be tracked.
+```java
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <!-- ThinkingAnalytics DisablePresetProperties start -->
+    <string-array name="TDDisPresetProperties">
+<!--        <item>#disk</item>-->
+<!--        <item>#fps</item>-->
+<!--        <item>#ram</item>-->
+<!--        <item>#app_version</item>-->
+<!--        <item>#os_version</item>-->
+<!--        <item>#manufacturer</item>-->
+<!--        <item>#device_model</item>-->
+<!--        <item>#screen_height</item>-->
+<!--        <item>#screen_width</item>-->
+<!--        <item>#carrier</item>-->
+<!--        <item>#device_id</item>-->
+<!--        <item>#system_language</item>-->
+<!--        <item>#lib</item>-->
+<!--        <item>#lib_version</item>-->
+<!--        <item>#os</item>-->
+<!--        <item>#bundle_id</item>-->
+<!--        <item>#install_time</item>-->
+<!--        <item>#start_reason</item>-->
+<!--        <item>#simulator</item>-->
+<!--        <item>#network_type</item>-->
+<!--        <item>#zone_offset</item>-->
+<!--        <item>#start_reason</item>-->
+<!--        <item>#resume_from_background</item>-->
+<!--        <item>#title</item>-->
+<!--        <item>#screen_name</item>-->
+<!--        <item>#url</item>-->
+<!--        <item>#referrer</item>-->
+<!--        <item>#element_type</item>-->
+<!--        <item>#element_id</item>-->
+<!--        <item>#element_position</item>-->
+<!--        <item>#element_content</item>-->
+<!--        <item>#element_selector</item>-->
+<!--        <item>#app_crashed_reason</item>-->
+<!--        <item>#background_duration</item>-->
+<!--        <item>#duration</item>-->
+    </string-array>
+    <!-- ThinkingAnalytics DisablePresetProperties end -->
+</resources>
+```
+
+<quote-container>
+As for Android ID property, we support complete isolation at the code level, that is, relevant codes used to get the property shall no longer be contained in the APP after isolation. For detailed information, please refer to the[ ](https://thinkingdata.feishu.cn/wiki/D7ykw75weigcIfk3ZoichHbKnuv)[Chapter of auto-tracking plugin configuration](https://thinkingdata.feishu.cn/wiki/D7ykw75weigcIfk3ZoichHbKnuv)
+</quote-container>

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/android/android-advanced/third-party-integration.md

@@ -0,0 +1,127 @@
+---
+code: android_sdk_thirdparty
+name: "Third-party Integration"
+wikiToken: SRalwJFiZiEuZUk6PXJc2144nse
+parentWikiToken: LqfmwtW1xi0jzwkrKpscKEzFnme
+updateTime: 1774249046000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=android_sdk_thirdparty
+---
+
+-  Third-party data plugin should be introduced:
+```groovy
+implementation 'cn.thinkingdata.android:TAThirdParty:2.0.0'
+```
+
+- The sample codes for the synchronization of multiple platform data are as follows:
+```java
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.APPS_FLYER | TDThirdPartyType.ADJUST);
+```
+
+<quote-container>
+`enableThirdPartySharing(int var1, Map<String, Object> var2)`, an API that does not support bitwise operation, can be used to add additional parameters.
+</quote-container>
+
+## AppsFlyer
+Call  this API before AppsFlyer SDK calls the Start API：
+```java
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.APPS_FLYER)
+```
+
+After the created role is registered (optional)：
+```java
+TDAnalytics.login("account_id")
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.APPS_FLYER)
+```
+
+Every time you call the `login` or `identify `, you need to call `enableThirdPartySharing` synchronously to update the user ID.
+Note: Since AppFlyer's `setAdditionalData` is called each time, the  user ID will be overwritten. You can set parameters via the` enableThirdPartySharing` API we provide:
+```java
+Map<String, Object> additionalData = new HashMap<>();
+additionalData.put("af_test_key1", "test1");
+additionalData.put("af_test_key2", "test2");
+AppsFlyerLib.getInstance().setAdditionalData(additionalData);
+```
+
+Since previous parameters would be replaced if setAdditionalData is called multiple times, the parameters could be transmitted to TE, and the TE SDK would merge the parameters.
+```java
+Map<String, Object> additionalData = new HashMap<>();
+additionalData.put("af_test_key1", "test1");
+additionalData.put("af_test_key2", "test2");
+TDAnalytics.enableThirdPartySharing(
+    TDThirdPartyType.APPS_FLYER,
+    additionalData
+)
+```
+
+## Adjust
+To be called before Adjust SDK initialization：
+```java
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.ADJUST)
+```
+
+After the created role is registered (optional)：
+```java
+TDAnalytics.login("accoount_id")
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.ADJUST)
+```
+
+## 3.Branch
+To be called before the Branch initialize the session：
+```java
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.BRANCH);
+```
+
+After the created role is registered (optional)：
+```java
+TDAnalytics.login("accoount_id")
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.BRANCH);
+```
+
+## 4.TopOn
+To be called before ATSDK.*init：*
+```java
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.TOP_ON);
+```
+
+Every time you call the `login` or `identify `, you need to call `enableThirdPartySharing` synchronously to update the user ID.
+Note: Since TopOn's `initCustomMap` is called each time, the  user ID will be overwritten. You can set parameters via the` enableThirdPartySharing` API we provide:
+```java
+Map<String, Object> customMap = new HashMap<>();
+customMap.put("key1", "value1");
+customMap.put("key2", "value2");
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.TOP_ON, customMap);
+```
+
+## 5.ReYun
+To be called after the account is registered:
+```java
+TDAnalytics.enableThirdPartySharing(TDThirdPartyShareType.TD_TRACKING)
+```
+
+## 6.TradPlus
+To be called before TradPlus SDK  initialization:
+```java
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.TRAD_PLUS);
+```
+
+## 7.IronSource
+To be called after IronSource Sdk initialization:
+```java
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.IRON_SOURCE);
+```
+
+## 8.AppLovin
+- User Revenue API
+To be called before AppLovin SDK  initialization:
+```css
+TDAnalytics.enableThirdPartySharing(TDThirdPartyType.APPLOVIN_IMPRESSION);
+```
+
+- Impression-Level User Revenue API
+If you want to achieve monetization data acquisition, you need to create a `MaxAdRevenueListener`,and rewrite the `onAdRevenuePaid`.In this method, the monetization data is obtained and the data is reported through the `enableThirdPartySharing` of the TA SDK,
+finally, the listener is passed to setRevenueListener(). The sample code is as follows:
+```java
+void onAdRevenuePaid(final MaxAd ad){
+    TDAnalytics.enableThirdPartySharing(TDThirdPartyType.APPLOVIN_USER,ad);
+}
+```