{"data":{"id":"942813","string_id":"zZb2Tz0p","status":"1","parent_id":"60654","slug":"zZb2Tz0p","order":"8","name":"Mini Program & Mini Game SDK","type":"1","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","author":"xinru","published_time":"0","add_time":"1789637561","update_time":"1789972060","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","tags":[],"parent_name":"Data Access","parent_type":"1","parent_slug":"SwPOLu","child":[{"id":"940602","string_id":"1PFbzmv7","status":"1","parent_id":"942813","slug":"WeChat-Mini-Program-SDK","order":"10","name":"WeChat Mini Program SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789550172","add_time":"1789546244","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"940602","content":"

1. SDK Basic Information<\/h1>
SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p>
Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p>

<\/p>

2. Before you start<\/span><\/h1>
2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>
2.2. Get AppKey<\/h2>
Access Path<\/strong>: Asset Management - App Management - AppKey<\/p>
$\"\"$ <\/p>
2.3. Obtain SDK<\/h2>
Download SDK (UMD and ES packages provided) :<\/p>
https:\/\/sdk.solar-engine.com\/MiniWx\/SolarEngine-MiniWx-CN-SDK-1.3.2.zip<\/a> <\/span><\/p>
2.4. Configure Weixin Official Accounts Platform<\/h2>
Get AppID and AppSecret<\/strong><\/span><\/li><\/ul>
Log in to\u300cWeixin Official Accounts Platform\u300dand go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u8005ID. Then copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SE dashboard.<\/p>
$\"\"$ $\"\"$ <\/p>
Server Domain Configuration<\/strong><\/span><\/li><\/ul>
Log in to\u300cWeixin Official Accounts Platform\u300d, go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):<\/p>
https:\/\/api-receiver.detailroi.com<\/li>
https:\/\/rule.detailroi.com<\/li><\/ul>
$\"\"$ <\/p>
IP Whitelist Configuration<\/strong><\/span><\/li><\/ul>
Log in to\u300cWeixin Official Accounts Platform\u300d, go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u8005ID > IP\u767d\u540d\u5355<\/p>
If the IP whitelist protection is not enabled, there is no need to configure the SE fixed IPs.<\/li>
If the IP whitelist protection is already enabled, you need to add the following SE fixed IPs:<\/li>
71.132.0.102<\/span><\/li>
52.81.1.45<\/span><\/li>
52.54.188.146<\/span><\/li>
34.196.30.48<\/span><\/li><\/ul><\/ul>
$\"\"$ <\/p>
3. Initialize the SDK<\/span><\/h1>
3.1. SDK initialization<\/span><\/h2>
It is recommended to import the SDK in the app.js<\/code> file of your Mini Program project, and initialize it within onLaunch<\/code> (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p>
Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use in other parts of the project.<\/p>
Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ app.js\nimport SESDK from '.\/miniwx-cn-sesdk-umd.js';\n\n\/\/ If your build environment enforces ES Modules, please import the ES format file. \n\/\/ import SESDK from '.\/miniwx-cn-sesdk-es.js' \n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/miniwx-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey'); \n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere\n globalThis.SESDK = SESDK;\n },\n});<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> unionid<\/td> string<\/td> No<\/td> Mini Program Union ID<\/td><\/tr> openid<\/td> string<\/td> No<\/td> Mini Program Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret<\/span> on SE dashboard following 2.4.)<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> NO<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> NO<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> SESDK.prevInit('6666666'); \nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre>3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. mpInstall mpStart mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre>3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101<\/td> openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 3.8. Get Attribution Results<\/span><\/h2>3.8.1. Set Attribution Callback Listener<\/h3> Developers can set a callback listener for attribution results. This method can only be called once<\/strong> and returns a Promise object.<\/p> SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})<\/code><\/pre>3.8.2. Actively Retrieve Attribution Results<\/h3> Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.<\/p> SESDK.getAttribution().then(res => { \n \/\/ res.result\n})<\/code><\/pre>Attribution Results Example<\/span><\/h3>Re-engagement attribution results will be displayed in \"re_data\".<\/p> {\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }<\/code><\/pre>attributionData<\/strong> parameter description:<\/p> Parameter<\/th> Example<\/th> Description<\/th><\/tr> attribution_touch_type<\/td> click, impression<\/td> Attribution touchpoint type<\/td><\/tr> ry_touchpoint_ts<\/td> Attribution display or click time (YYYY-MM-DD HH:MM:SS)<\/td> Attribution touchpoint time<\/td><\/tr> install_time<\/td> Device activation time (YYYY-MM-DD HH:MM:SS)<\/td> Activation time<\/td><\/tr> attribution_time<\/td> 2022\/5\/11 15:00:03<\/td> Attribution time<\/td><\/tr> turl_campaign_id<\/td> 3e0a9bad8455d685eaaf91bad71bdeb2<\/td> Tracking link ID<\/td><\/tr> turl_campaign_name<\/td> Mintegral_tracking<\/td> Tracking link name<\/td><\/tr> turl_id<\/td> UfeE7za<\/td> Short link ID<\/td><\/tr> channel_id<\/td> 1234<\/td> Channel ID<\/td><\/tr> channel_name<\/td> mintegral<\/td> Attribution channel name<\/td><\/tr> attribution_type<\/td> ua<\/td> UA (indicates new user acquisition)<\/td><\/tr> account_id<\/td> ,<\/td> Channel promotion account ID<\/td><\/tr> adgroup_id<\/td> ,<\/td> Channel promotion ad group ID<\/td><\/tr> adgroup_name<\/td> ,<\/td> Channel promotion ad group name<\/td><\/tr> adplan_id<\/td> ,<\/td> Channel promotion plan ID<\/td><\/tr> adplan_name<\/td> ,<\/td> Channel promotion plan name<\/td><\/tr> adcreative_id<\/td> ,<\/td> Channel promotion creative ID<\/td><\/tr> adcreative_name<\/td> ,<\/td> Channel promotion creative name<\/td><\/tr> adcreative_type<\/td> ,<\/td> Channel promotion creative type<\/td><\/tr> site_id<\/td> ,<\/td> Sub-channel ID<\/td><\/tr> site_name<\/td> ,<\/td> Sub-channel name<\/td><\/tr> ad_type<\/td> ,<\/td> Channel promotion ad type<\/td><\/tr> placement_id<\/td> ,<\/td> Channel promotion ad placement ID<\/td><\/tr> conversion_id<\/td> ,<\/td> Ad placement ID<\/td><\/tr> click_id<\/td> ,<\/td> Channel promotion unique click ID<\/td><\/tr> impression_id<\/td> ,<\/td> Channel promotion unique impression ID<\/td><\/tr> request_id<\/td> ,<\/td> Ad request ID<\/td><\/tr> callback_id<\/td> EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxM TI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==,<\/td> Callback ID<\/td><\/tr> custom_params_1<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_2<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_3<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_4<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_5<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_6<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_7<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_8<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_9<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_10<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr><\/tbody><\/table> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> <\/strong><\/span> The event name supports uppercase and lowercase English characters, numbers, and underscores. The length cannot exceed 40 characters.<\/span><\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Program is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 4.2.1. Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.2. Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.3. In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderId<\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.4. Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>4.2.5. In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.6. Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> registerType<\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.7. Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre><\/h2> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> Changelog<\/h1>2025-02-02 1.3.2<\/strong><\/p> Optimized event reporting logic.<\/span><\/li><\/ul> <\/p> 2025-03-14 1.3.0<\/strong><\/p> Optimized event reporting logic.<\/span><\/li><\/ul> <\/p> 2025-03-13 1.2.9<\/strong><\/p> Optimized event reporting logic.<\/span><\/li><\/ul> <\/p> 2025-02-13 1.2.8<\/strong><\/p> Optimized in-app purchase event reporting.<\/span><\/li><\/ul> <\/p> 2025-01-03 1.2.7<\/strong><\/p> Optimized in-app purchase event reporting.<\/span><\/li><\/ul> <\/p> 2024-12-31 1.2.6<\/strong><\/p> Optimized internal initialization logic.<\/span><\/li><\/ul> <\/p> 2024-12-10 1.2.4<\/strong><\/p> Optimized reporting logic.<\/span><\/li><\/ul> <\/p> 2024-11-29 1.2.3<\/strong><\/p> Optimized initialization logic.<\/span><\/li> Adjusted the data structure of attribution results.<\/span><\/li><\/ul> <\/p> 2024-11-11 1.2.2<\/strong><\/p> Optimized event reporting logic.<\/span><\/li><\/ul> <\/p> 2024-10-31 1.2.1<\/strong><\/p> Added internal SDK log reporting.<\/span><\/li><\/ul> <\/p> 2024-08-14 1.1.9<\/strong><\/p> Changed the data type of the <\/span>_launch_scene<\/code><\/span> parameter from numeric to string.<\/span><\/li><\/ul> <\/p> 2024-05-22 1.1.8<\/strong><\/p> Optimized install event reporting.<\/span><\/li><\/ul> <\/p> 2024-04-22 1.1.7<\/strong><\/p> Optimized event reporting logic.<\/span><\/li><\/ul> <\/p> 2024-04-16 1.1.6<\/strong><\/p> Optimized event reporting logic.<\/span><\/li><\/ul> <\/p> 2024-04-01 1.1.5<\/strong><\/p> Fixed an issue where reported events could not be deleted in extreme scenarios.<\/span><\/li> Optimized the trigger timing of the <\/span>ready<\/code><\/span> hook in Mini Programs.<\/span><\/li><\/ul> <\/p> 2024-03-15 1.1.4<\/strong><\/p> Added new parameters to the A\/B testing request.<\/span><\/li><\/ul> <\/p> 2024-03-01 1.1.3<\/strong><\/p> Fixed an issue with A\/B testing initialization parameters.<\/span><\/li><\/ul> <\/p> 2024-01-22 1.1.2<\/strong><\/p> Fixed an issue with internal log reporting.<\/span><\/li><\/ul> <\/p> 2023-12-06 1.1.1<\/strong><\/p> Added the <\/span>getDistinct<\/code><\/span> method to retrieve <\/span>distinct_id<\/code><\/span> and <\/span>distinct_id_type<\/code><\/span>.<\/span><\/li> Added the <\/span>setOnAttributionListener<\/code><\/span> method to set a callback for attribution results.<\/span><\/li> Added the <\/span>getAttribution<\/code><\/span> method to actively retrieve attribution results.<\/span><\/li> Added the <\/span>unionid<\/code><\/span> parameter to the <\/span>init<\/code><\/span> method.<\/span><\/li> Added signature verification for event reporting.<\/span><\/li><\/ul> <\/p> 2023-11-02 1.1.0<\/strong><\/p> Added pre-initialization.<\/span><\/li> Supported passing <\/span>openid<\/code><\/span> during SDK initialization; if not provided, the SDK will obtain it internally.<\/span><\/li> Removed the <\/span>setXcxOpenid<\/code><\/span> method.<\/span><\/li><\/ul> <\/p> 2023-10-16 1.0.7<\/strong><\/p> Supported automatic data collection in uni-app development mode.<\/span><\/li><\/ul> <\/p> 2023-08-16 1.0.6<\/strong><\/p> Removed signature verification for event reporting.<\/span><\/li><\/ul> <\/p> 2023-08-08 1.0.5<\/strong><\/p> Optimized the plugin loading mechanism.<\/span><\/li><\/ul> <\/p> 2023-07-31 1.0.4<\/strong><\/p> Optimized initialization logic.<\/span><\/li><\/ul> <\/p> 2023-06-01 1.0.3<\/strong><\/p> Added the Setting service.<\/span><\/li> Supported both domestic and international SDKs.<\/span><\/li> Optimized the logic for successful SDK data reporting.<\/span><\/li><\/ul> <\/p> 2023-04-26 1.0.2<\/strong><\/p> Optimized the SDK <\/span>UserDelete<\/code><\/span> operation.<\/span><\/li><\/ul> <\/p> 2023-03-30 1.0.1<\/strong><\/p> Added <\/span>debugModel<\/code><\/span> debug mode to the SDK.<\/span><\/li><\/ul> <\/p> 2023-03-20 1.0.0<\/strong><\/p> Initial release of the SolarEngine WeChat Mini Program SDK.<\/span><\/li> Supported setting preset and custom properties.<\/span><\/li> Supported reporting preset and custom events.<\/span><\/li> Supported setting user properties.<\/span><\/li> Supported parameter dispatch plugins.<\/span><\/li> Supported automatic event tracking.<\/span><\/li><\/ul> <\/p>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/MiniWx\/SolarEngine-MiniWx-CN-SDK-1.3.2.zip \u00a0 \u00a0 \u00a02.4. Configure Weixin Official Accounts PlatformGet AppID and AppSecret \u00a0 \u00a0 \u00a0Log in to\u300cWeixin Official Accounts Platform\u300dand go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u8005ID. Then copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SE dashboard.Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300cWeixin Official Accounts Platform\u300d, go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):https:\/\/api-receiver.detailroi.comhttps:\/\/rule.detailroi.comIP Whitelist Configuration \u00a0 \u00a0 \u00a0Log in to\u300cWeixin Official Accounts Platform\u300d, go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u8005ID > IP\u767d\u540d\u5355If the IP whitelist protection is not enabled, there is no need to configure the SE fixed IPs.If the IP whitelist protection is already enabled, you need to add the following SE fixed IPs:71.132.0.10252.81.1.4552.54.188.14634.196.30.483. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0 \u00a0It is recommended to import the SDK in the app.js file of your Mini Program project, and initialize it within onLaunch (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0 \u00a0Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use in other parts of the project.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ app.js\nimport SESDK from '.\/miniwx-cn-sesdk-umd.js';\n\n\/\/ If your build environment enforces ES Modules, please import the ES format file. \n\/\/ import SESDK from '.\/miniwx-cn-sesdk-es.js' \n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/miniwx-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey'); \n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere\n globalThis.SESDK = SESDK;\n },\n});initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above unionid string No Mini Program Union ID openid string No Mini Program Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SE dashboard following 2.4.) config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean NO Whether to enable the debugging mode (Default false) logEnabled boolean NO Whether the console prints SDK logs (Default false)Sample CodeSESDK.prevInit('6666666'); \nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g.mpInstallmpStartmpEndall (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1103 uuid Note: openid > uuid3.8. Get Attribution Results3.8.1. Set Attribution Callback Listener \u00a0 \u00a0 \u00a0 \u00a0Developers can set a callback listener for attribution results. This method can only be called once and returns a Promise object.SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})3.8.2. Actively Retrieve Attribution Results \u00a0 \u00a0 \u00a0 \u00a0Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.SESDK.getAttribution().then(res => { \n \/\/ res.result\n})Attribution Results ExampleRe-engagement attribution results will be displayed in \"re_data\".{\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }attributionData parameter description: Parameter Example Description attribution_touch_type click, impression Attribution touchpoint type ry_touchpoint_ts Attribution display or click time (YYYY-MM-DD HH:MM:SS) Attribution touchpoint time install_time Device activation time (YYYY-MM-DD HH:MM:SS) Activation time attribution_time 2022\/5\/11 15:00:03 Attribution time turl_campaign_id 3e0a9bad8455d685eaaf91bad71bdeb2 Tracking link ID turl_campaign_name Mintegral_tracking Tracking link name turl_id UfeE7za Short link ID channel_id 1234 Channel ID channel_name mintegral Attribution channel name attribution_type ua UA (indicates new user acquisition) account_id , Channel promotion account ID adgroup_id , Channel promotion ad group ID adgroup_name , Channel promotion ad group name adplan_id , Channel promotion plan ID adplan_name , Channel promotion plan name adcreative_id , Channel promotion creative ID adcreative_name , Channel promotion creative name adcreative_type , Channel promotion creative type site_id , Sub-channel ID site_name , Sub-channel name ad_type , Channel promotion ad type placement_id , Channel promotion ad placement ID conversion_id , Ad placement ID click_id , Channel promotion unique click ID impression_id , Channel promotion unique impression ID request_id , Ad request ID callback_id EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==, Callback ID custom_params_1 Predefined tracking link parameter 1-10 custom_params_2 Predefined tracking link parameter 1-10 custom_params_3 Predefined tracking link parameter 1-10 custom_params_4 Predefined tracking link parameter 1-10 custom_params_5 Predefined tracking link parameter 1-10 custom_params_6 Predefined tracking link parameter 1-10 custom_params_7 Predefined tracking link parameter 1-10 custom_params_8 Predefined tracking link parameter 1-10 custom_params_9 Predefined tracking link parameter 1-10 custom_params_10 Predefined tracking link parameter 1-104. Event Reporting \u00a0 After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: \u00a0 The event name supports uppercase and lowercase English characters, numbers, and underscores. The length cannot exceed 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events4.2.1. Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})4.2.2. Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})4.2.3. In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4.2.4. Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})4.2.5. In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})4.2.6. Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.2.7. Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID YesChangelog2025-02-02 1.3.2Optimized event reporting logic.2025-03-14 1.3.0Optimized event reporting logic.2025-03-13 1.2.9Optimized event reporting logic.2025-02-13 1.2.8Optimized in-app purchase event reporting.2025-01-03 1.2.7Optimized in-app purchase event reporting.2024-12-31 1.2.6Optimized internal initialization logic.2024-12-10 1.2.4Optimized reporting logic.2024-11-29 1.2.3Optimized initialization logic.Adjusted the data structure of attribution results.2024-11-11 1.2.2Optimized event reporting logic.2024-10-31 1.2.1Added internal SDK log reporting.2024-08-14 1.1.9Changed the data type of the _launch_scene parameter from numeric to string.2024-05-22 1.1.8Optimized install event reporting.2024-04-22 1.1.7Optimized event reporting logic.2024-04-16 1.1.6Optimized event reporting logic.2024-04-01 1.1.5Fixed an issue where reported events could not be deleted in extreme scenarios.Optimized the trigger timing of the ready hook in Mini Programs.2024-03-15 1.1.4Added new parameters to the A\/B testing request.2024-03-01 1.1.3Fixed an issue with A\/B testing initialization parameters.2024-01-22 1.1.2Fixed an issue with internal log reporting.2023-12-06 1.1.1Added the getDistinct method to retrieve distinct_id and distinct_id_type.Added the setOnAttributionListener method to set a callback for attribution results.Added the getAttribution method to actively retrieve attribution results.Added the unionid parameter to the init method.Added signature verification for event reporting.2023-11-02 1.1.0Added pre-initialization.Supported passing openid during SDK initialization; if not provided, the SDK will obtain it internally.Removed the setXcxOpenid method.2023-10-16 1.0.7Supported automatic data collection in uni-app development mode.2023-08-16 1.0.6Removed signature verification for event reporting.2023-08-08 1.0.5Optimized the plugin loading mechanism.2023-07-31 1.0.4Optimized initialization logic.2023-06-01 1.0.3Added the Setting service.Supported both domestic and international SDKs.Optimized the logic for successful SDK data reporting.2023-04-26 1.0.2Optimized the SDK UserDelete operation.2023-03-30 1.0.1Added debugModel debug mode to the SDK.2023-03-20 1.0.0Initial release of the SolarEngine WeChat Mini Program SDK.Supported setting preset and custom properties.Supported reporting preset and custom events.Supported setting user properties.Supported parameter dispatch plugins.Supported automatic event tracking.","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789546244","update_time":"1789893377"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"},{"id":"940874","string_id":"sO87nxZa","status":"1","parent_id":"942813","slug":"WeChat-Mini-Game-SDK","order":"9","name":"WeChat Mini Game SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789554490","add_time":"1789552777","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"940874","content":" 1. SDK Basic Information<\/h1>SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p> Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p> <\/p> 2. Before you start<\/span><\/h1>2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p> <\/p>2.2. Get AppKey<\/h2> Access Path<\/strong>: Asset Management - App Management - AppKey<\/p> <\/p>2.3. Obtain SDK<\/h2>Download SDK (UMD and ES packages provided) :<\/p> https:\/\/sdk.solar-engine.com\/MiniWx\/SolarEngine-MiniWx-CN-SDK-1.3.5.zip<\/a> <\/p> 2.4. Configure Weixin Official Accounts Platform<\/h2>Get AppID and AppSecret<\/strong><\/span><\/li><\/ul> Log in to\u300cWeixin Official Accounts Platform\u300dand go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u8005ID. Then copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SE dashboard.<\/p> <\/p>Server Domain Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300cWeixin Official Accounts Platform\u300d, go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):<\/p>https:\/\/api-receiver.detailroi.com<\/li>https:\/\/rule.detailroi.com<\/li><\/ul><\/p>IP Whitelist Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300cWeixin Official Accounts Platform\u300d, go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u8005ID > IP\u767d\u540d\u5355<\/p> If the IP whitelist protection is not enabled, there is no need to configure the SE fixed IPs.<\/li> If the IP whitelist protection is already enabled, you need to add the following SE fixed IPs:<\/li>71.132.0.102<\/span><\/li> 52.81.1.45<\/span><\/li> 52.54.188.146<\/span><\/li> 34.196.30.48<\/span><\/li><\/ul><\/ul><\/p> If you need to integrate Tencent Mini Game Ads SDK, please refer to the configuration of 3.1. in documentation<\/a>.<\/li><\/ul>3. Initialize the SDK<\/span><\/h1>3.1. SDK initialization<\/span><\/h2> It is recommended to import and initialize SDK in the entry JS file of your Mini Game project to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p> Note: The SDK should only be imported once in one Mini Game. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere.<\/p> Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ game.js\nimport SESDK from '.\/miniwx-cn-sesdk-umd.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/miniwx-cn-sesdk-umd.js')\n\n\/\/ Pre-initialization\nSESDK.prevInit('appKey'); \n\/\/ Initialization\nSESDK.init(initParams);\n\/\/ Mount to global (e.g. globalThis) for use elsewhere\nglobalThis.SESDK = SESDK;<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> unionid<\/td> string<\/td> No<\/td> Mini Game Union ID<\/td><\/tr> openid<\/td> string<\/td> No<\/td> Mini Game Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret<\/span> on SE dashboard following 2.4.)<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> No<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> No<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr> isInitTencentAdvertisingGameSDK<\/td> boolean<\/td> No<\/td> Whether to initialize Tencent Mini Game Ads SDK (Default false)<\/td><\/tr> tencentAdvertisingGameSDK<\/td> function<\/td> No<\/td> Reference to the Tencent Mini Game Ads SDK class. Download it according to the Tencent Mini Game Ads SDK integration guide<\/a>. If you are developing a Mini Game on the Cocos Creator platform, manually download and import the UMD build (Download Link<\/a>).<\/td><\/tr> reportingToTencentSdk<\/td> number<\/td> No<\/td> Whether to report the launch event to Tencent. Default 3. 1: Report all data to Tencent 2: Report partial data to Tencent 3: Do not report to Tencent<\/td><\/tr> tencentAdvertisingGameSDKInitParams<\/td> tencentSDKInitParams<\/td> No<\/td> Required parameters for initializing the Tencent Mini Game Ads SDK.<\/td><\/tr> tencentSdkIsAutoTrack<\/td> boolean<\/td> No<\/td> Whether the Tencent SDK automatically collects data. Default true.<\/td><\/tr><\/tbody><\/table>tencentSDKInitParams <\/strong>parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> user_action_set_id<\/td> number<\/td> YES<\/td> Data source ID<\/td><\/tr> secret_key<\/td> string<\/td> YES<\/td> Encryped key<\/td><\/tr> appid<\/td> string<\/td> YES<\/td> WeChat Mini Game AppID; start with \"wx\"<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> \/\/ Load Tencent Mini Game Ads SDK\nimport { SDK } from '.\/dn-sdk-minigame\/index.js';\n\nSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n isInitTencentAdvertisingGameSDK: true,\n tencentAdvertisingGameSDK: SDK,\n tencentAdvertisingGameSDKInitParams: {\n user_action_set_id: 'xxx',\n secret_key: 'xxx',\n appid: 'xxx'\n }\n },\n});\n\n\/\/ Import with CocosCreator platform\nimport TencentSDK from '.\/dn-sdk-minigame\/index.umd.js';\nSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n isInitTencentAdvertisingGameSDK: true,\n tencentAdvertisingGameSDK: TencentSDK.SDK,\n tencentAdvertisingGameSDKInitParams: { \n user_action_set_id: 'xxx', \n secret_key: 'xxx', \n appid: 'xxx'\n } \n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre>3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. _mpInstall _mpStart _mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre>3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101<\/td> openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 3.8. Get Attribution Results<\/span><\/h2>3.8.1. Set Attribution Callback Listener<\/h3> Developers can set a callback listener for attribution results. This method can only be called once<\/strong> and returns a Promise object.<\/p> SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})<\/code><\/pre>3.8.2. Actively Retrieve Attribution Results<\/h3> Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.<\/p> SESDK.getAttribution().then(res => { \n \/\/ res.result\n})<\/code><\/pre>Attribution Results Example<\/span><\/h3>Re-engagement attribution results will be displayed in \"re_data\".<\/p> {\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }<\/code><\/pre>attributionData<\/strong> parameter description:<\/p> Parameter<\/th> Example<\/th> Description<\/th><\/tr> attribution_touch_type<\/td> click, impression<\/td> Attribution touchpoint type<\/td><\/tr> ry_touchpoint_ts<\/td> Attribution display or click time (YYYY-MM-DD HH:MM:SS)<\/td> Attribution touchpoint time<\/td><\/tr> install_time<\/td> Device activation time (YYYY-MM-DD HH:MM:SS)<\/td> Activation time<\/td><\/tr> attribution_time<\/td> 2022\/5\/11 15:00:03<\/td> Attribution time<\/td><\/tr> turl_campaign_id<\/td> 3e0a9bad8455d685eaaf91bad71bdeb2<\/td> Tracking link ID<\/td><\/tr> turl_campaign_name<\/td> Mintegral_tracking<\/td> Tracking link name<\/td><\/tr> turl_id<\/td> UfeE7za<\/td> Short link ID<\/td><\/tr> channel_id<\/td> 1234<\/td> Channel ID<\/td><\/tr> channel_name<\/td> mintegral<\/td> Attribution channel name<\/td><\/tr> attribution_type<\/td> ua<\/td> UA (indicates new user acquisition)<\/td><\/tr> account_id<\/td> ,<\/td> Channel promotion account ID<\/td><\/tr> adgroup_id<\/td> ,<\/td> Channel promotion ad group ID<\/td><\/tr> adgroup_name<\/td> ,<\/td> Channel promotion ad group name<\/td><\/tr> adplan_id<\/td> ,<\/td> Channel promotion plan ID<\/td><\/tr> adplan_name<\/td> ,<\/td> Channel promotion plan name<\/td><\/tr> adcreative_id<\/td> ,<\/td> Channel promotion creative ID<\/td><\/tr> adcreative_name<\/td> ,<\/td> Channel promotion creative name<\/td><\/tr> adcreative_type<\/td> ,<\/td> Channel promotion creative type<\/td><\/tr> site_id<\/td> ,<\/td> Sub-channel ID<\/td><\/tr> site_name<\/td> ,<\/td> Sub-channel name<\/td><\/tr> ad_type<\/td> ,<\/td> Channel promotion ad type<\/td><\/tr> placement_id<\/td> ,<\/td> Channel promotion ad placement ID<\/td><\/tr> conversion_id<\/td> ,<\/td> Ad placement ID<\/td><\/tr> click_id<\/td> ,<\/td> Channel promotion unique click ID<\/td><\/tr> impression_id<\/td> ,<\/td> Channel promotion unique impression ID<\/td><\/tr> request_id<\/td> ,<\/td> Ad request ID<\/td><\/tr> callback_id<\/td> EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxM TI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==,<\/td> Callback ID<\/td><\/tr> custom_params_1<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_2<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_3<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_4<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_5<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_6<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_7<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_8<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_9<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_10<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr><\/tbody><\/table> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> <\/strong><\/span> The event name supports uppercase and lowercase English characters, numbers, and underscores. The length cannot exceed 40 characters.<\/span><\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Game. (If a user deletes the Mini Game and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Game is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 1) Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>2) Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>3) In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting<\/td> number<\/td> yes<\/td><\/tr> orderId <\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4) Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>5) In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>6) Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting<\/td> number<\/td> Yes<\/td><\/tr> registerType <\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>7) Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>8) Reactivation event<\/h3> Triggered when a previously registered Mini Game user returns after becoming inactive. The recommended inactivity thresholds are 7, 14, or 30 days. However, any custom N (days) is supported. The corresponding _event_name is _mpReActive.<\/p> SESDK.trackReActive(data)<\/code><\/pre>data<\/code>: object. See parameters below:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting<\/td> number<\/td> Yes<\/td><\/tr> backFlowDay<\/td> Reactivation cycle (days)<\/td> number<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/p> SESDK.trackReActive({\n reportingToTencentSdk: 1,\n backFlowDay: 7,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>9) Add Mini Game to Wishlist<\/h3> Triggered when a user adds a Mini Game to their wishlist, including adding to favorites, adding to \"My Mini Games,\" adding to the home screen, or any custom wishlist logic defined by developers. The _event_name is _mpAddToWishlist.<\/p> SESDK.trackAddToWishlist(data)<\/code><\/pre>data<\/code>: object. See parameters below:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting<\/td> number<\/td> Yes<\/td><\/tr> addToWishlistType<\/td> Wishlist Type (Enum values): \u00b7 Regular Favorite (default) \u00b7 Add to My Mini Programs (my) \u00b7 Add to Home Screen (desktop) \u00b7 Others (others)<\/td> string<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/p> SESDK.trackAddToWishlist({\n reportingToTencentSdk: 1,\n addToWishlistType: 'default',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>10) Share Mini Game<\/h3> Triggered when a user shares a Mini Game. Distinguish between \"Share to Friend\" and \"Share to Moments.\" The _event_name is _mpShare.<\/p> SESDK.trackShare(data)<\/code><\/pre>data<\/code>: object. See parameters below:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting<\/td> number<\/td> Yes<\/td><\/tr> mpShareTarget<\/td> Share Type (Enum values): \u00b7 Forward to Friend (APP_MESSAGE) \u00b7 Share to Moments (TIME_LINE)<\/td> string<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/p> \/\/ 1\u3001Share to Friend \nwx.onShareAppMessage(() => {\n \/\/ sdk.track('SHARE', {\n \/\/ target: 'APP_MESSAGE'\n \/\/ });\n SESDK.trackShare({\n reportingToTencentSdk: 1,\n mpShareTarget: 'APP_MESSAGE',\n customProperties: {\n one: '1',\n }\n })\n});\n\n\/\/ 2\u3001Share to Moments\nwx.onShareTimeline(() => {\n \/\/ sdk.track('SHARE', {\n \/\/ target: 'TIME_LINE'\n \/\/ });\n SESDK.trackShare({\n reportingToTencentSdk: 1,\n mpShareTarget: 'TIME_LINE',\n customProperties: {\n one: '1',\n }\n })\n});\n\n\/\/ 3\u3001Report a share event when it's proactively triggered (report first, then invoke the share interface for higher success rate).\n\/\/ sdk.track('SHARE', {\n\/\/ target: 'APP_MESSAGE'\n\/\/ });\nSESDK.trackShare({\n reportingToTencentSdk: 1,\n mpShareTarget: 'APP_MESSAGE',\n customProperties: {\n one: '1',\n }\n})\nwx.shareAppMessage();\n<\/code><\/pre>11) Create Role<\/h3> Triggered when a user successfully creates a role in the Mini Game. The _event_name is _mpCreateRole.<\/p> SESDK.trackCreateRole(data)<\/code><\/pre>data<\/code>: object. See parameters below:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting<\/td> number<\/td> Yes<\/td><\/tr> mpRoleName<\/td> Role Name<\/td> string<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/p> SESDK.trackCreateRole({\n reportingToTencentSdk: 1,\n mpRoleName: 'Role Name',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>12) Tutorial Finish <\/h3> Triggered when a user completes the game's new user tutorial. The _event_name is _mpTutorialFinish.<\/p> SESDK.trackTutorialFinish(data)<\/code><\/pre>data<\/code>: object. See parameters below:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting<\/td> number<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/p> SESDK.trackTutorialFinish({\n reportingToTencentSdk: 1,\n customProperties: { \n one: '1',\n }\n})<\/code><\/pre>13) Update Level<\/h3> Triggered when a user levels up in the Mini Game. The _event_name is _mpUpdateLevel.<\/p> SESDK.trackTutorialFinish(data)<\/code><\/pre>data<\/code>: object. See parameters below:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting<\/td> number<\/td> Yes<\/td><\/tr> beforeUpgrade<\/td> Level before upgrade<\/td> number<\/td> Yes<\/td><\/tr> afterUpgrade<\/td> Level after upgrade<\/td> number<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/p> SESDK.trackUpdateLevel({\n reportingToTencentSdk: 1,\n beforeUpgrade:1,\n afterUpgrade:2,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>14) View Mall<\/h3> Triggered when a user browses the in-game mall page. The _event_name is _mpViewContentMall.<\/p> SESDK.trackViewContentMall(data)<\/code><\/pre>data<\/code>: object. See parameters below:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting <\/td> number<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/p> SESDK.trackViewContentMall({\n reportingToTencentSdk: 1,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>15) View Activity<\/h3> Triggered when a user browses the in-game activity page. The _event_name is _mpViewContentActivity.<\/p> SESDK.trackViewContentActivity(data)<\/code><\/pre>data<\/code>: object. See parameters below:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> reportingToTencentSdk<\/td> Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting <\/td> number<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/p> SESDK.trackViewContentActivity({\n reportingToTencentSdk: 1,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre><\/h2> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> 6. Channel SDK Compatibility Guide<\/h1> 6.1. Tencent Ads<\/h2>Overview: After integrating the SE_SDK, you need to introduce the Tencent Ads SDK. Once you complete the SE initialization method, the system will automatically trigger the initialization of Tencent Ads SDK. When you report key events such as registration and purchase, the system will automatically send this event information to Tencent Ads based on your configuration to complete attribution analysis and data postback.<\/li> Operation Overview:<\/li><\/ul>Load the Tencent Mini Game Ads SDK: import { SDK } from '.\/dn-sdk-minigame\/index.js';<\/li> Pass the Tencent Ads SDK to SE (tencentAdvertisingGameSDK)<\/li> Enable initialization of the Tencent Ads SDK (isInitTencentAdvertisingGameSDK)<\/li> Fill in the necessary parameters for initializing the Tencent Ads SDK (tencentAdvertisingGameSDKInitParams)<\/li> Select the data type for the current event to be reported to Tencent (reportingToTencentSdk).<\/li> In the initialization method, add new parameters to the Config (see code example in 3.1 SDK Initialization<\/a>)<\/li><\/ol>Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> isInitTencentAdvertisingGameSDK<\/td> boolean<\/td> No<\/td> Whether to initialize the Tencent Mini Game Ads SDK. Default is false<\/code>.<\/td><\/tr> tencentAdvertisingGameSDK<\/td> function<\/td> No<\/td> The reference class for the Tencent Mini Game Ads SDK. Download it by referring to the Tencent Mini Game Ads SDK Integration Document<\/a>.<\/td><\/tr> reportingToTencentSdk<\/td> number<\/td> No<\/td> Whether to report the launch event to Tencent. Default is 3<\/code>. 1: Report all to Tencent 2: Report partially to Tencent 3: Do not report to Tencent<\/td><\/tr> tencentAdvertisingGameSDKInitParams<\/td> tencentSDKInitParams<\/td> No<\/td> Required parameters for initializing the Tencent Mini Game Ads SDK.<\/td><\/tr> tencentSdkIsAutoTrack<\/td> boolean<\/td> No<\/td> Whether the Tencent SDK automatically collects data. Default is true<\/code>.<\/td><\/tr><\/tbody><\/table> <\/p> tencentSDKInitParams Parameter Description:<\/strong><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> user_action_set_id<\/td> number<\/td> Yes<\/td> Data source ID<\/td><\/tr> secret_key<\/td> string<\/td> Yes<\/td> Encryption key<\/td><\/tr> appid<\/td> string<\/td> Yes<\/td> WeChat Mini Game APPID, starts with wx<\/code><\/td><\/tr><\/tbody><\/table> <\/p> You can set the configuration field \"reportingToTencentSdk\" individually for the \"Launch Event\" and \"each pre-defined event\". The following is the list of currently supported pre-defined events:<\/li>4.2.3 In-App Purchase<\/li> 4.2.6 Registration<\/li> 4.2.8 Reactivation<\/li> 4.2.9 Add to Wishlist<\/li> 4.2.10 Share Mini Game<\/li> 4.2.11 Create Role<\/li> 4.2.12 Tutorial Finish<\/li> 4.2.13 Update Level<\/li> 4.2.14 View Mall<\/li> 4.2.15 View Activity<\/li> Note: It is recommended to actively report the above events.<\/li><\/ul> You can configure the \"reportingToTencentSdk\" field individually for each event as needed to achieve more granular control and data postback.<\/li> reportingToTencentSdk<\/strong> Field Description:<\/li>Option 1 (Recommended<\/span>): Tencent Ads is responsible for attribution matching, and all user event information will be reported back to Tencent Ads. Please configure the field reportingToTencentSdk to 1.<\/li> Option 2: SolarEngine is responsible for attribution matching, and only users attributed to Tencent Ads will be reported back to Tencent Ads. Please configure the field reportingToTencentSdk to 2.\u3010Note: After Tencent Ads API attribution is discontinued, attribution via SolarEngine will no longer be possible. Please use Option 1 then.\u3011<\/li> Option 3 (Not Recommended): SolarEngine is responsible for attribution matching, but user information is not reported back to Tencent Ads. Please configure the field reportingToTencentSdk to 3.<\/li> Note:<\/strong> Channels other than Tencent Ads are still attributed and matched by SolarEngine, and events are reported back via API. No additional SDK configurations needed.<\/li><\/ul><\/ul> Get Tencent Ads SDK Instance<\/strong><\/li>If you need to track more events besides the pre-defined events listed above, you can call the interface to get the Tencent Ads SDK instance and call its native reporting methods.<\/li><\/ul> Precautions:<\/strong><\/li>For scenarios already covered by pre-defined events, it is forbidden to call the Tencent Ads SDK's same-name reporting interface again to avoid data anomalies for the same event.<\/li> When calling the Tencent Ads SDK for custom events, it is recommended to simultaneously report the SESDK custom event to keep the event data on both ends aligned as much as possible.<\/li><\/ul><\/ul><\/ul>Code Example<\/strong><\/p> \/\/ Call after SE SDK initialization\n\n\/\/ Get Tencent Ads SDK instance\nconst tencentSdk = SESDK.getTencentAdvertisingGameSDK();\n\nif (tencentSdk) {\n \/\/ Report custom Tencent events not covered by SE SDK\n tencentSdk.track('CUSTOM_EVENT', {\n customKey: 'customValue',\n });\n}<\/code><\/pre>Q&A<\/strong><\/li>How to determine if an event was successfully reported to Tencent? <\/li><\/ul><\/ul> You can check the return value of the interface https:\/\/api.datanexus.qq.com\/data-nexus-cgi\/miniprogram<\/a><\/p> code=0 means success.<\/p> <\/p> <\/p> <\/p> Changelog<\/h1>2026-07-20 1.3.5<\/strong><\/p>Event reporting logic optimization<\/li><\/ul>2026-02-02 1.3.2<\/strong><\/p>Event reporting logic optimization<\/li><\/ul>2025-03-14 1.3.0<\/strong><\/p>Event reporting logic optimization<\/li><\/ul>2025-03-13 1.2.9<\/strong><\/p>Event reporting logic optimization<\/li><\/ul>2025-02-13 1.2.8<\/strong><\/p> Fixed error when integrating Tencent Ads SDK<\/li><\/ul>2025-01-03 1.2.7<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2024-12-31 1.2.6<\/strong><\/p> Internal initialization logic optimization<\/li><\/ul>2024-12-10 1.2.4<\/strong><\/p> Compatible with CocosCreator platform compilation and build<\/li><\/ul>2024-11-29 1.2.3<\/strong><\/p> Added support for Tencent Ads Mini Games<\/li> Attribution data result structure adjustment<\/li><\/ul>2024-11-11 1.2.2<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-10-31 1.2.1<\/strong><\/p> Added SDK internal log reporting<\/li><\/ul>2024-08-14 1.1.9<\/strong><\/p> The type of the reported scene value _launch_scene<\/code> was changed from numeric to string<\/li><\/ul>2024-05-22 1.1.8<\/strong><\/p> Fixed the issue of the WeChat Mini Game install<\/code> event being reported multiple times<\/li><\/ul>2024-04-22 1.1.7<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-04-16 1.1.6<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-04-01 1.1.5<\/strong><\/p> Fixed the issue where reported events could not be deleted in extreme scenarios<\/li> Optimized the trigger timing of the ready<\/code> hook under Mini Programs<\/li><\/ul>2024-03-15 1.1.4<\/strong><\/p> Added new parameters to A\/B test requests<\/li><\/ul>2024-03-01 1.1.3<\/strong><\/p> Fixed A\/B test initialization parameter issue<\/li><\/ul>2024-01-22 1.1.2<\/strong><\/p> Fixed internal log reporting issue<\/li><\/ul>2023-12-06 1.1.1<\/strong><\/p> Added getDistinct<\/code> method to get distinct_id<\/code> and distinct_id_type<\/code><\/li> Added setOnAttributionListener<\/code> method to set a callback for listening to attribution results<\/li> Added getAttribution<\/code> method to actively get attribution result information<\/li> Added unionid<\/code> parameter to the init<\/code> method<\/li> Added signature verification for event reporting<\/li><\/ul>2023-11-02 1.1.0<\/strong><\/p> Supported pre-defined property and custom property settings<\/li> Supported pre-defined event and custom event reporting<\/li> Supported user property settings<\/li> Supported A\/B testing plugin<\/li><\/ul>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/MiniWx\/SolarEngine-MiniWx-CN-SDK-1.3.5.zip \u00a02.4. Configure Weixin Official Accounts PlatformGet AppID and AppSecret \u00a0 \u00a0 \u00a0Log in to\u300cWeixin Official Accounts Platform\u300dand go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u8005ID. Then copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SE dashboard. Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300cWeixin Official Accounts Platform\u300d, go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):https:\/\/api-receiver.detailroi.comhttps:\/\/rule.detailroi.comIP Whitelist Configuration \u00a0 \u00a0 \u00a0Log in to\u300cWeixin Official Accounts Platform\u300d, go to the homepage > \u5f00\u53d1\u7ba1\u7406 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u8005ID > IP\u767d\u540d\u5355If the IP whitelist protection is not enabled, there is no need to configure the SE fixed IPs.If the IP whitelist protection is already enabled, you need to add the following SE fixed IPs:71.132.0.10252.81.1.4552.54.188.14634.196.30.48If you need to integrate Tencent Mini Game Ads SDK, please refer to the configuration of 3.1. in documentation.3. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0 \u00a0It is recommended to import and initialize SDK in the entry JS file of your Mini Game project to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0 \u00a0Note: The SDK should only be imported once in one Mini Game. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ game.js\nimport SESDK from '.\/miniwx-cn-sesdk-umd.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/miniwx-cn-sesdk-umd.js')\n\n\/\/ Pre-initialization\nSESDK.prevInit('appKey'); \n\/\/ Initialization\nSESDK.init(initParams);\n\/\/ Mount to global (e.g. globalThis) for use elsewhere\nglobalThis.SESDK = SESDK;initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above unionid string No Mini Game Union ID openid string No Mini Game Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SE dashboard following 2.4.) config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean No Whether to enable the debugging mode (Default false) logEnabled boolean No Whether the console prints SDK logs (Default false) isInitTencentAdvertisingGameSDK boolean No Whether to initialize Tencent Mini Game Ads SDK (Default false) tencentAdvertisingGameSDK function No Reference to the Tencent Mini Game Ads SDK class. Download it according to the Tencent Mini Game Ads SDK integration guide. If you are developing a Mini Game on the Cocos Creator platform, manually download and import the UMD build (Download Link). reportingToTencentSdk number No Whether to report the launch event to Tencent. Default 3.1: Report all data to Tencent2: Report partial data to Tencent3: Do not report to Tencent tencentAdvertisingGameSDKInitParams tencentSDKInitParams No Required parameters for initializing the Tencent Mini Game Ads SDK. tencentSdkIsAutoTrack boolean No Whether the Tencent SDK automatically collects data. Default true.tencentSDKInitParams parameter description: Parameter Type Required Description user_action_set_id number YES Data source ID secret_key string YES Encryped key appid string YES WeChat Mini Game AppID; start with \"wx\"Sample Code\/\/ Load Tencent Mini Game Ads SDK\nimport { SDK } from '.\/dn-sdk-minigame\/index.js';\n\nSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n isInitTencentAdvertisingGameSDK: true,\n tencentAdvertisingGameSDK: SDK,\n tencentAdvertisingGameSDKInitParams: {\n user_action_set_id: 'xxx',\n secret_key: 'xxx',\n appid: 'xxx'\n }\n },\n});\n\n\/\/ Import with CocosCreator platform\nimport TencentSDK from '.\/dn-sdk-minigame\/index.umd.js';\nSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n isInitTencentAdvertisingGameSDK: true,\n tencentAdvertisingGameSDK: TencentSDK.SDK,\n tencentAdvertisingGameSDKInitParams: { \n user_action_set_id: 'xxx', \n secret_key: 'xxx', \n appid: 'xxx'\n } \n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g._mpInstall_mpStart_mpEndall (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1103 uuid Note: openid > uuid3.8. Get Attribution Results3.8.1. Set Attribution Callback Listener \u00a0 \u00a0 \u00a0 \u00a0Developers can set a callback listener for attribution results. This method can only be called once and returns a Promise object.SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})3.8.2. Actively Retrieve Attribution Results \u00a0 \u00a0 \u00a0 \u00a0Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.SESDK.getAttribution().then(res => { \n \/\/ res.result\n})Attribution Results ExampleRe-engagement attribution results will be displayed in \"re_data\".{\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }attributionData parameter description: Parameter Example Description attribution_touch_type click, impression Attribution touchpoint type ry_touchpoint_ts Attribution display or click time (YYYY-MM-DD HH:MM:SS) Attribution touchpoint time install_time Device activation time (YYYY-MM-DD HH:MM:SS) Activation time attribution_time 2022\/5\/11 15:00:03 Attribution time turl_campaign_id 3e0a9bad8455d685eaaf91bad71bdeb2 Tracking link ID turl_campaign_name Mintegral_tracking Tracking link name turl_id UfeE7za Short link ID channel_id 1234 Channel ID channel_name mintegral Attribution channel name attribution_type ua UA (indicates new user acquisition) account_id , Channel promotion account ID adgroup_id , Channel promotion ad group ID adgroup_name , Channel promotion ad group name adplan_id , Channel promotion plan ID adplan_name , Channel promotion plan name adcreative_id , Channel promotion creative ID adcreative_name , Channel promotion creative name adcreative_type , Channel promotion creative type site_id , Sub-channel ID site_name , Sub-channel name ad_type , Channel promotion ad type placement_id , Channel promotion ad placement ID conversion_id , Ad placement ID click_id , Channel promotion unique click ID impression_id , Channel promotion unique impression ID request_id , Ad request ID callback_id EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==, Callback ID custom_params_1 Predefined tracking link parameter 1-10 custom_params_2 Predefined tracking link parameter 1-10 custom_params_3 Predefined tracking link parameter 1-10 custom_params_4 Predefined tracking link parameter 1-10 custom_params_5 Predefined tracking link parameter 1-10 custom_params_6 Predefined tracking link parameter 1-10 custom_params_7 Predefined tracking link parameter 1-10 custom_params_8 Predefined tracking link parameter 1-10 custom_params_9 Predefined tracking link parameter 1-10 custom_params_10 Predefined tracking link parameter 1-104. Event Reporting \u00a0 After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: \u00a0 The event name supports uppercase and lowercase English characters, numbers, and underscores. The length cannot exceed 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Game. (If a user deletes the Mini Game and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Game is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Game is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events1) Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})2) Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})3) In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized.1: Full reporting2: Partial reporting3: No reporting number yes orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4) Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})5) In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})6) Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized.1: Full reporting2: Partial reporting3: No reporting number Yes registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})7) Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})8) Reactivation event \u00a0 \u00a0 \u00a0 \u00a0Triggered when a previously registered Mini Game user returns after becoming inactive. The recommended inactivity thresholds are 7, 14, or 30 days. However, any custom N (days) is supported. The corresponding _event_name is _mpReActive.SESDK.trackReActive(data)data: object. See parameters below: Parameter Name Parameter Meaning Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized.1: Full reporting2: Partial reporting3: No reporting number Yes backFlowDay Reactivation cycle (days) number Yes customProperties \/ object NoCode ExampleSESDK.trackReActive({\n reportingToTencentSdk: 1,\n backFlowDay: 7,\n customProperties: {\n one: '1',\n }\n})9) Add Mini Game to Wishlist \u00a0 \u00a0 \u00a0 \u00a0Triggered when a user adds a Mini Game to their wishlist, including adding to favorites, adding to \"My Mini Games,\" adding to the home screen, or any custom wishlist logic defined by developers. The _event_name is _mpAddToWishlist.SESDK.trackAddToWishlist(data)data: object. See parameters below: Parameter Name Parameter Meaning Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting number Yes addToWishlistType Wishlist Type (Enum values): \u00b7 Regular Favorite (default)\u00b7 Add to My Mini Programs (my)\u00b7 Add to Home Screen (desktop) \u00b7 Others (others) string Yes customProperties \/ object NoCode ExampleSESDK.trackAddToWishlist({\n reportingToTencentSdk: 1,\n addToWishlistType: 'default',\n customProperties: {\n one: '1',\n }\n})10) Share Mini Game \u00a0 \u00a0 \u00a0 \u00a0Triggered when a user shares a Mini Game. Distinguish between \"Share to Friend\" and \"Share to Moments.\" The _event_name is _mpShare.SESDK.trackShare(data)data: object. See parameters below: Parameter Name Parameter Meaning Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting number Yes mpShareTarget Share Type (Enum values): \u00b7 Forward to Friend (APP_MESSAGE)\u00b7 Share to Moments (TIME_LINE) string Yes customProperties \/ object NoCode Example\/\/ 1\u3001Share to Friend \nwx.onShareAppMessage(() => {\n \/\/ sdk.track('SHARE', {\n \/\/ target: 'APP_MESSAGE'\n \/\/ });\n SESDK.trackShare({\n reportingToTencentSdk: 1,\n mpShareTarget: 'APP_MESSAGE',\n customProperties: {\n one: '1',\n }\n })\n});\n\n\/\/ 2\u3001Share to Moments\nwx.onShareTimeline(() => {\n \/\/ sdk.track('SHARE', {\n \/\/ target: 'TIME_LINE'\n \/\/ });\n SESDK.trackShare({\n reportingToTencentSdk: 1,\n mpShareTarget: 'TIME_LINE',\n customProperties: {\n one: '1',\n }\n })\n});\n\n\/\/ 3\u3001Report a share event when it's proactively triggered (report first, then invoke the share interface for higher success rate).\n\/\/ sdk.track('SHARE', {\n\/\/ target: 'APP_MESSAGE'\n\/\/ });\nSESDK.trackShare({\n reportingToTencentSdk: 1,\n mpShareTarget: 'APP_MESSAGE',\n customProperties: {\n one: '1',\n }\n})\nwx.shareAppMessage();\n11) Create Role \u00a0 \u00a0 \u00a0 \u00a0Triggered when a user successfully creates a role in the Mini Game. The _event_name is _mpCreateRole.SESDK.trackCreateRole(data)data: object. See parameters below: Parameter Name Parameter Meaning Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting number Yes mpRoleName Role Name string Yes customProperties \/ object NoCode ExampleSESDK.trackCreateRole({\n reportingToTencentSdk: 1,\n mpRoleName: 'Role Name',\n customProperties: {\n one: '1',\n }\n})12) Tutorial Finish \u00a0 \u00a0 \u00a0 \u00a0Triggered when a user completes the game's new user tutorial. The _event_name is _mpTutorialFinish.SESDK.trackTutorialFinish(data)data: object. See parameters below: Parameter Name Parameter Meaning Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting number Yes customProperties \/ object NoCode ExampleSESDK.trackTutorialFinish({\n reportingToTencentSdk: 1,\n customProperties: { \n one: '1',\n }\n})13) Update Level \u00a0 \u00a0 \u00a0 \u00a0Triggered when a user levels up in the Mini Game. The _event_name is _mpUpdateLevel.SESDK.trackTutorialFinish(data)data: object. See parameters below: Parameter Name Parameter Meaning Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting number Yes beforeUpgrade Level before upgrade number Yes afterUpgrade Level after upgrade number Yes customProperties \/ object NoCode ExampleSESDK.trackUpdateLevel({\n reportingToTencentSdk: 1,\n beforeUpgrade:1,\n afterUpgrade:2,\n customProperties: {\n one: '1',\n }\n})14) View Mall \u00a0 \u00a0 \u00a0 \u00a0Triggered when a user browses the in-game mall page. The _event_name is _mpViewContentMall.SESDK.trackViewContentMall(data)data: object. See parameters below: Parameter Name Parameter Meaning Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting number Yes customProperties \/ object NoCode ExampleSESDK.trackViewContentMall({\n reportingToTencentSdk: 1,\n customProperties: {\n one: '1',\n }\n})15) View Activity \u00a0 \u00a0 \u00a0 \u00a0Triggered when a user browses the in-game activity page. The _event_name is _mpViewContentActivity.SESDK.trackViewContentActivity(data)data: object. See parameters below: Parameter Name Parameter Meaning Type Required reportingToTencentSdk Report events to Tencent. Required if Tencent Ads SDK is initialized. 1: Full reporting 2: Partial reporting 3: No reporting \u00a0 number Yes customProperties \/ object NoCode ExampleSESDK.trackViewContentActivity({\n reportingToTencentSdk: 1,\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID Yes6. Channel SDK Compatibility Guide6.1. Tencent AdsOverview: After integrating the SE_SDK, you need to introduce the Tencent Ads SDK. Once you complete the SE initialization method, the system will automatically trigger the initialization of Tencent Ads SDK. When you report key events such as registration and purchase, the system will automatically send this event information to Tencent Ads based on your configuration to complete attribution analysis and data postback.Operation Overview:Load the Tencent Mini Game Ads SDK: import { SDK } from '.\/dn-sdk-minigame\/index.js';Pass the Tencent Ads SDK to SE (tencentAdvertisingGameSDK)Enable initialization of the Tencent Ads SDK (isInitTencentAdvertisingGameSDK)Fill in the necessary parameters for initializing the Tencent Ads SDK (tencentAdvertisingGameSDKInitParams)Select the data type for the current event to be reported to Tencent (reportingToTencentSdk).In the initialization method, add new parameters to the Config (see code example in 3.1 SDK Initialization) Parameter Type Required Description isInitTencentAdvertisingGameSDK boolean No Whether to initialize the Tencent Mini Game Ads SDK. Default is false. tencentAdvertisingGameSDK function No The reference class for the Tencent Mini Game Ads SDK. Download it by referring to the Tencent Mini Game Ads SDK Integration Document. reportingToTencentSdk number No Whether to report the launch event to Tencent. Default is 3.1: Report all to Tencent2: Report partially to Tencent3: Do not report to Tencent tencentAdvertisingGameSDKInitParams tencentSDKInitParams No Required parameters for initializing the Tencent Mini Game Ads SDK. tencentSdkIsAutoTrack boolean No Whether the Tencent SDK automatically collects data. Default is true.tencentSDKInitParams Parameter Description: Parameter Type Required Description user_action_set_id number Yes Data source ID secret_key string Yes Encryption key appid string Yes WeChat Mini Game APPID, starts with wxYou can set the configuration field \"reportingToTencentSdk\" individually for the \"Launch Event\" and \"each pre-defined event\". The following is the list of currently supported pre-defined events:4.2.3 In-App Purchase4.2.6 Registration4.2.8 Reactivation4.2.9 Add to Wishlist4.2.10 Share Mini Game4.2.11 Create Role4.2.12 Tutorial Finish4.2.13 Update Level4.2.14 View Mall4.2.15 View ActivityNote: It is recommended to actively report the above events.You can configure the \"reportingToTencentSdk\" field individually for each event as needed to achieve more granular control and data postback.reportingToTencentSdk Field Description:Option 1 (Recommended): Tencent Ads is responsible for attribution matching, and all user event information will be reported back to Tencent Ads. Please configure the field reportingToTencentSdk to 1.Option 2: SolarEngine is responsible for attribution matching, and only users attributed to Tencent Ads will be reported back to Tencent Ads. Please configure the field reportingToTencentSdk to 2.\u3010Note: After Tencent Ads API attribution is discontinued, attribution via SolarEngine will no longer be possible. Please use Option 1 then.\u3011Option 3 (Not Recommended): SolarEngine is responsible for attribution matching, but user information is not reported back to Tencent Ads. Please configure the field reportingToTencentSdk to 3.Note: Channels other than Tencent Ads are still attributed and matched by SolarEngine, and events are reported back via API. No additional SDK configurations needed.Get Tencent Ads SDK InstanceIf you need to track more events besides the pre-defined events listed above, you can call the interface to get the Tencent Ads SDK instance and call its native reporting methods.Precautions:For scenarios already covered by pre-defined events, it is forbidden to call the Tencent Ads SDK's same-name reporting interface again to avoid data anomalies for the same event.When calling the Tencent Ads SDK for custom events, it is recommended to simultaneously report the SESDK custom event to keep the event data on both ends aligned as much as possible.Code Example\/\/ Call after SE SDK initialization\n\n\/\/ Get Tencent Ads SDK instance\nconst tencentSdk = SESDK.getTencentAdvertisingGameSDK();\n\nif (tencentSdk) {\n \/\/ Report custom Tencent events not covered by SE SDK\n tencentSdk.track('CUSTOM_EVENT', {\n customKey: 'customValue',\n });\n}Q&AHow to determine if an event was successfully reported to Tencent? \u00a0 \u00a0 \u00a0 You can check the return value of the interface https:\/\/api.datanexus.qq.com\/data-nexus-cgi\/miniprogram \u00a0 \u00a0 \u00a0 code=0 means success.Changelog2026-07-20 1.3.5Event reporting logic optimization2026-02-02 1.3.2Event reporting logic optimization2025-03-14 1.3.0Event reporting logic optimization2025-03-13 1.2.9Event reporting logic optimization2025-02-13 1.2.8Fixed error when integrating Tencent Ads SDK2025-01-03 1.2.7Payment event reporting optimization2024-12-31 1.2.6Internal initialization logic optimization2024-12-10 1.2.4Compatible with CocosCreator platform compilation and build2024-11-29 1.2.3Added support for Tencent Ads Mini GamesAttribution data result structure adjustment2024-11-11 1.2.2Optimized event reporting logic2024-10-31 1.2.1Added SDK internal log reporting2024-08-14 1.1.9The type of the reported scene value _launch_scene was changed from numeric to string2024-05-22 1.1.8Fixed the issue of the WeChat Mini Game install event being reported multiple times2024-04-22 1.1.7Optimized event reporting logic2024-04-16 1.1.6Optimized event reporting logic2024-04-01 1.1.5Fixed the issue where reported events could not be deleted in extreme scenariosOptimized the trigger timing of the ready hook under Mini Programs2024-03-15 1.1.4Added new parameters to A\/B test requests2024-03-01 1.1.3Fixed A\/B test initialization parameter issue2024-01-22 1.1.2Fixed internal log reporting issue2023-12-06 1.1.1Added getDistinct method to get distinct_id and distinct_id_typeAdded setOnAttributionListener method to set a callback for listening to attribution resultsAdded getAttribution method to actively get attribution result informationAdded unionid parameter to the init methodAdded signature verification for event reporting2023-11-02 1.1.0Supported pre-defined property and custom property settingsSupported pre-defined event and custom event reportingSupported user property settingsSupported A\/B testing plugin","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789552777","update_time":"1789893438"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"},{"id":"941963","string_id":"rChlzMtC","status":"1","parent_id":"942813","slug":"Douyin-Mini-Program-SDK","order":"8","name":"Douyin Mini Program SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789627494","add_time":"1789624790","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"941963","content":"1. SDK Basic Information<\/h1>SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p> Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p> <\/p> 2. Before you start<\/span><\/h1>2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p> <\/p>2.2. Get AppKey<\/h2> Access Path<\/strong>: Asset Management - App Management - AppKey<\/p> <\/p>2.3. Obtain SDK<\/h2>Download SDK (UMD and ES packages provided) :<\/p> https:\/\/sdk.solar-engine.com\/MiniTt\/SolarEngine-MiniTt-CN-SDK-1.3.2.zip<\/a> <\/p> 2.4. Configure Douyin Open Platform<\/h2>Get AppID and AppSecret<\/strong><\/span><\/li><\/ul> Log in to\u300c\u6296\u97f3\u5f00\u653e\u5e73\u53f0 (Douyin Open Platform)\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u914d\u7f6e > \u5bc6\u94a5\u7ba1\u7406 > \u5c0f\u7a0b\u5e8fKey. Then copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SolarEngine.<\/p> <\/p> <\/p> Server Domain Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300c\u6296\u97f3\u5f00\u653e\u5e73\u53f0 (Douyin Open Platform)\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u914d\u7f6e > \u57df\u540d\u7ba1\u7406 > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):<\/p> https:\/\/api-receiver.detailroi.com<\/li> https:\/\/rule.detailroi.com<\/li><\/ul><\/p> 3. Initialize the SDK<\/span><\/h1>3.1. SDK initialization<\/span><\/h2> It is recommended to import the SDK in the app.js<\/code> file of your Mini Program project, and initialize it within onLaunch<\/code> (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p> Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use in other parts of the project.<\/p> Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ app.js\nimport SESDK from '.\/minitt-cn-sesdk-umd.js';\n\n\/\/ If your build environment enforces ES Modules, please import the ES format file. \n\/\/ import SESDK from '.\/minitt-cn-sesdk-es.js' \n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minitt-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey');\n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere\n globalThis.SESDK = SESDK;\n },\n});<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> unionid<\/td> string<\/td> No<\/td> Mini Program Union ID<\/td><\/tr> openid <\/td> string<\/td> No<\/td> Mini Program Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret<\/span> on SE dashboard following 2.4.)<\/td><\/tr> anonymous_openid<\/td> string<\/td> No<\/td> Mini Program anonymous_openid. (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SolarEngine dashboard.)<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> NO<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> NO<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> SESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n anonymous_openid: 'ccccccccccc',\n config: {\n logEnabled: true,\n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre>3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. mpInstall mpStart mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre>3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101 <\/td> openid<\/td><\/tr> 1102<\/td> anonymous_openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > anonymous_openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 3.8. Get Attribution Results<\/span><\/h2>3.8.1. Set Attribution Callback Listener<\/h3> Developers can set a callback listener for attribution results. This method can only be called once<\/strong> and returns a Promise object.<\/p> SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})<\/code><\/pre>3.8.2. Actively Retrieve Attribution Results<\/h3> Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.<\/p> SESDK.getAttribution().then(res => { \n \/\/ res.result\n})<\/code><\/pre>Attribution Results Example<\/span><\/h3>Re-engagement attribution results will be displayed in \"re_data\".<\/p> {\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }<\/code><\/pre>attributionData<\/strong> parameter description:<\/p> Parameter<\/th> Example<\/th> Description<\/th><\/tr> attribution_touch_type<\/td> click, impression<\/td> Attribution touchpoint type<\/td><\/tr> ry_touchpoint_ts<\/td> Attribution display or click time (YYYY-MM-DD HH:MM:SS)<\/td> Attribution touchpoint time<\/td><\/tr> install_time<\/td> Device activation time (YYYY-MM-DD HH:MM:SS)<\/td> Activation time<\/td><\/tr> attribution_time<\/td> 2022\/5\/11 15:00:03<\/td> Attribution time<\/td><\/tr> turl_campaign_id<\/td> 3e0a9bad8455d685eaaf91bad71bdeb2<\/td> Tracking link ID<\/td><\/tr> turl_campaign_name<\/td> Mintegral_tracking<\/td> Tracking link name<\/td><\/tr> turl_id<\/td> UfeE7za<\/td> Short link ID<\/td><\/tr> channel_id<\/td> 1234<\/td> Channel ID<\/td><\/tr> channel_name<\/td> mintegral<\/td> Attribution channel name<\/td><\/tr> attribution_type<\/td> ua<\/td> UA (indicates new user acquisition)<\/td><\/tr> account_id<\/td> ,<\/td> Channel promotion account ID<\/td><\/tr> adgroup_id<\/td> ,<\/td> Channel promotion ad group ID<\/td><\/tr> adgroup_name<\/td> ,<\/td> Channel promotion ad group name<\/td><\/tr> adplan_id<\/td> ,<\/td> Channel promotion plan ID<\/td><\/tr> adplan_name<\/td> ,<\/td> Channel promotion plan name<\/td><\/tr> adcreative_id<\/td> ,<\/td> Channel promotion creative ID<\/td><\/tr> adcreative_name<\/td> ,<\/td> Channel promotion creative name<\/td><\/tr> adcreative_type<\/td> ,<\/td> Channel promotion creative type<\/td><\/tr> site_id<\/td> ,<\/td> Sub-channel ID<\/td><\/tr> site_name<\/td> ,<\/td> Sub-channel name<\/td><\/tr> ad_type<\/td> ,<\/td> Channel promotion ad type<\/td><\/tr> placement_id<\/td> ,<\/td> Channel promotion ad placement ID<\/td><\/tr> conversion_id<\/td> ,<\/td> Ad placement ID<\/td><\/tr> click_id<\/td> ,<\/td> Channel promotion unique click ID<\/td><\/tr> impression_id<\/td> ,<\/td> Channel promotion unique impression ID<\/td><\/tr> request_id<\/td> ,<\/td> Ad request ID<\/td><\/tr> callback_id<\/td> EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxM TI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==,<\/td> Callback ID<\/td><\/tr> custom_params_1<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_2<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_3<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_4<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_5<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_6<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_7<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_8<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_9<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_10<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr><\/tbody><\/table> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.<\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Program is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 4.2.1. Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.2. Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.3. In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderId<\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.4. Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>4.2.5. In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.6. Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> registerType<\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.7. Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre><\/h2> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> Changelog<\/h1>2026-02-02 1.3.2<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-14 1.3.0<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-13 1.2.9<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-02-13 1.2.8<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2025-01-03 1.2.7<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2024-12-31 1.2.6<\/strong><\/p> Internal initialization logic optimization<\/li><\/ul>2024-12-10 1.2.4<\/strong><\/p> Reporting logic optimization<\/li><\/ul>2024-11-29 1.2.3<\/strong><\/p> Initialization logic optimization<\/li> Attribution data result structure adjustment<\/li><\/ul>2024-11-11 1.2.2<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-10-31 1.2.1<\/strong><\/p> Added SDK internal log reporting<\/li><\/ul>2024-08-14 1.1.9<\/strong><\/p> The type of the reported scene value _launch_scene<\/code> was changed from numeric to string<\/li><\/ul>2024-05-22 1.1.8<\/strong><\/p> install<\/code> event reporting optimization<\/li><\/ul>2024-04-22 1.1.7<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-04-16 1.1.6<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-04-01 1.1.5<\/strong><\/p> Fixed an issue where reported events could not be deleted in extreme scenarios<\/li> Optimized the trigger timing of the ready<\/code> hook in Mini Programs<\/li><\/ul>2024-03-15 1.1.4<\/strong><\/p> Added new parameters to A\/B test requests<\/li><\/ul>2024-03-01 1.1.3<\/strong><\/p> Fixed A\/B test initialization parameter issue<\/li><\/ul>2024-01-22 1.1.2<\/strong><\/p> Fixed internal log reporting issue<\/li><\/ul>2023-12-06 1.1.1<\/strong><\/p> Added getDistinct<\/code> method to get distinct_id<\/code> and distinct_id_type<\/code><\/li> Added setOnAttributionListener<\/code> method to set a callback for listening to attribution results<\/li> Added getAttribution<\/code> method to actively get attribution result information<\/li> Added unionid<\/code> parameter to the init<\/code> method<\/li> Added signature verification for event reporting<\/li><\/ul>2023-11-02 1.1.0<\/strong><\/p> Supported pre-defined property and custom property settings<\/li> Supported pre-defined event and custom event reporting<\/li> Supported user property settings<\/li> Supported A\/B testing plugin<\/li> Supported automatic collection<\/li> Supported Settings delivery<\/li><\/ul>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/MiniTt\/SolarEngine-MiniTt-CN-SDK-1.3.2.zip \u00a02.4. Configure Douyin Open PlatformGet AppID and AppSecret \u00a0 \u00a0 \u00a0Log in to\u300c\u6296\u97f3\u5f00\u653e\u5e73\u53f0 (Douyin Open Platform)\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u914d\u7f6e > \u5bc6\u94a5\u7ba1\u7406 > \u5c0f\u7a0b\u5e8fKey. Then copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SolarEngine.Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300c\u6296\u97f3\u5f00\u653e\u5e73\u53f0 (Douyin Open Platform)\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u914d\u7f6e > \u57df\u540d\u7ba1\u7406 > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):https:\/\/api-receiver.detailroi.comhttps:\/\/rule.detailroi.com3. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0 \u00a0It is recommended to import the SDK in the app.js file of your Mini Program project, and initialize it within onLaunch (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0 \u00a0Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use in other parts of the project.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ app.js\nimport SESDK from '.\/minitt-cn-sesdk-umd.js';\n\n\/\/ If your build environment enforces ES Modules, please import the ES format file. \n\/\/ import SESDK from '.\/minitt-cn-sesdk-es.js' \n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minitt-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey');\n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere\n globalThis.SESDK = SESDK;\n },\n});initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above unionid string No Mini Program Union ID openid string No Mini Program Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SE dashboard following 2.4.) anonymous_openid string No Mini Program anonymous_openid. (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SolarEngine dashboard.) config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean NO Whether to enable the debugging mode (Default false) logEnabled boolean NO Whether the console prints SDK logs (Default false)Sample CodeSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n anonymous_openid: 'ccccccccccc',\n config: {\n logEnabled: true,\n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g.mpInstallmpStartmpEnd all (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1102 anonymous_openid 1103 uuid Note: openid > anonymous_openid > uuid3.8. Get Attribution Results3.8.1. Set Attribution Callback Listener \u00a0 \u00a0 \u00a0 \u00a0Developers can set a callback listener for attribution results. This method can only be called once and returns a Promise object.SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})3.8.2. Actively Retrieve Attribution Results \u00a0 \u00a0 \u00a0 \u00a0Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.SESDK.getAttribution().then(res => { \n \/\/ res.result\n})Attribution Results ExampleRe-engagement attribution results will be displayed in \"re_data\".{\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }attributionData parameter description: Parameter Example Description attribution_touch_type click, impression Attribution touchpoint type ry_touchpoint_ts Attribution display or click time (YYYY-MM-DD HH:MM:SS) Attribution touchpoint time install_time Device activation time (YYYY-MM-DD HH:MM:SS) Activation time attribution_time 2022\/5\/11 15:00:03 Attribution time turl_campaign_id 3e0a9bad8455d685eaaf91bad71bdeb2 Tracking link ID turl_campaign_name Mintegral_tracking Tracking link name turl_id UfeE7za Short link ID channel_id 1234 Channel ID channel_name mintegral Attribution channel name attribution_type ua UA (indicates new user acquisition) account_id , Channel promotion account ID adgroup_id , Channel promotion ad group ID adgroup_name , Channel promotion ad group name adplan_id , Channel promotion plan ID adplan_name , Channel promotion plan name adcreative_id , Channel promotion creative ID adcreative_name , Channel promotion creative name adcreative_type , Channel promotion creative type site_id , Sub-channel ID site_name , Sub-channel name ad_type , Channel promotion ad type placement_id , Channel promotion ad placement ID conversion_id , Ad placement ID click_id , Channel promotion unique click ID impression_id , Channel promotion unique impression ID request_id , Ad request ID callback_id EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==, Callback ID custom_params_1 Predefined tracking link parameter 1-10 custom_params_2 Predefined tracking link parameter 1-10 custom_params_3 Predefined tracking link parameter 1-10 custom_params_4 Predefined tracking link parameter 1-10 custom_params_5 Predefined tracking link parameter 1-10 custom_params_6 Predefined tracking link parameter 1-10 custom_params_7 Predefined tracking link parameter 1-10 custom_params_8 Predefined tracking link parameter 1-10 custom_params_9 Predefined tracking link parameter 1-10 custom_params_10 Predefined tracking link parameter 1-104. Event Reporting \u00a0 After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events4.2.1. Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})4.2.2. Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})4.2.3. In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4.2.4. Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})4.2.5. In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})4.2.6. Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.2.7. Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID YesChangelog2026-02-02 1.3.2Event reporting logic optimization2025-03-14 1.3.0Event reporting logic optimization2025-03-13 1.2.9Event reporting logic optimization2025-02-13 1.2.8Payment event reporting optimization2025-01-03 1.2.7Payment event reporting optimization2024-12-31 1.2.6Internal initialization logic optimization2024-12-10 1.2.4Reporting logic optimization2024-11-29 1.2.3Initialization logic optimizationAttribution data result structure adjustment2024-11-11 1.2.2Optimized event reporting logic2024-10-31 1.2.1Added SDK internal log reporting2024-08-14 1.1.9The type of the reported scene value _launch_scene was changed from numeric to string2024-05-22 1.1.8install event reporting optimization2024-04-22 1.1.7Optimized event reporting logic2024-04-16 1.1.6Optimized event reporting logic2024-04-01 1.1.5Fixed an issue where reported events could not be deleted in extreme scenariosOptimized the trigger timing of the ready hook in Mini Programs2024-03-15 1.1.4Added new parameters to A\/B test requests2024-03-01 1.1.3Fixed A\/B test initialization parameter issue2024-01-22 1.1.2Fixed internal log reporting issue2023-12-06 1.1.1Added getDistinct method to get distinct_id and distinct_id_typeAdded setOnAttributionListener method to set a callback for listening to attribution resultsAdded getAttribution method to actively get attribution result informationAdded unionid parameter to the init methodAdded signature verification for event reporting2023-11-02 1.1.0Supported pre-defined property and custom property settingsSupported pre-defined event and custom event reportingSupported user property settingsSupported A\/B testing pluginSupported automatic collectionSupported Settings delivery","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789624790","update_time":"1789893470"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"},{"id":"942363","string_id":"wRyXWWez","status":"1","parent_id":"942813","slug":"Douyin-Mini-Game-SDK","order":"7","name":"Douyin Mini Game SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789628399","add_time":"1789627562","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"942363","content":"1. SDK Basic Information<\/h1>SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p> Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p> <\/p> 2. Before you start<\/span><\/h1>2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p> <\/p>2.2. Get AppKey<\/h2> Access Path<\/strong>: Asset Management - App Management - AppKey<\/p> <\/p>2.3. Obtain SDK<\/h2>Download SDK (UMD and ES packages provided) :<\/p> https:\/\/sdk.solar-engine.com\/MiniTt\/SolarEngine-MiniTt-CN-SDK-1.3.2.zip<\/a> <\/p> 2.4. Configure Douyin Open Platform<\/h2>Get AppID and AppSecret<\/strong><\/span><\/li><\/ul> Log in to\u300c\u6296\u97f3\u5c0f\u6e38\u620f_\u5f00\u53d1\u8005\u5e73\u53f0<\/span>\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u7ba1\u7406 > \u5c0f\u7a0b\u5e8fKey. Then copy the AppID and AppSecret, and paste them into SolarEngine dashboard.<\/p> <\/p> <\/p> Server Domain Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300c\u6296\u97f3\u5c0f\u6e38\u620f_\u5f00\u53d1\u8005\u5e73\u53f0\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u7ba1\u7406 > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):<\/p> https:\/\/api-receiver.detailroi.com<\/li> https:\/\/rule.detailroi.com<\/li><\/ul><\/p> 3. Initialize the SDK<\/span><\/h1>3.1. SDK initialization<\/span><\/h2> It is recommended to import and initialize SDK in the entry JS file of your Mini Game project to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p> Note: The SDK should only be imported once in one Mini Game. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere.<\/p> Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ game.js\nimport SESDK from '.\/minitt-cn-sesdk-umd.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minitt-cn-sesdk-umd.js')\n\n\/\/ Pre-initialization\nSESDK.prevInit('appKey'); \n\/\/ Initialization\nSESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere \nglobalThis.SESDK = SESDK;<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> unionid<\/td> string<\/td> No<\/td> Mini Game Union ID<\/td><\/tr> openid <\/td> string<\/td> No<\/td> Mini Game Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret<\/span> on SE dashboard following 2.4.)<\/td><\/tr> anonymous_openid<\/td> string<\/td> No<\/td> Mini Game anonymous_openid. (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SolarEngine dashboard.)<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> No<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> No<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> SESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n anonymous_openid: 'ccccccccccc',\n config: {\n logEnabled: true,\n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre>3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. mpInstall mpStart mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre> <\/p> 3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101 <\/td> openid<\/td><\/tr> 1102<\/td> anonymous_openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > anonymous_openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 3.8. Get Attribution Results<\/span><\/h2>3.8.1. Set Attribution Callback Listener<\/h3> Developers can set a callback listener for attribution results. This method can only be called once<\/strong> and returns a Promise object.<\/p> SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})<\/code><\/pre>3.8.2. Actively Retrieve Attribution Results<\/h3> Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.<\/p> SESDK.getAttribution().then(res => { \n \/\/ res.result\n})<\/code><\/pre>Attribution Results Example<\/span><\/h3>Re-engagement attribution results will be displayed in \"re_data\".<\/p> {\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }<\/code><\/pre>attributionData<\/strong> parameter description:<\/p> Parameter<\/th> Example<\/th> Description<\/th><\/tr> attribution_touch_type<\/td> click, impression<\/td> Attribution touchpoint type<\/td><\/tr> ry_touchpoint_ts<\/td> Attribution display or click time (YYYY-MM-DD HH:MM:SS)<\/td> Attribution touchpoint time<\/td><\/tr> install_time<\/td> Device activation time (YYYY-MM-DD HH:MM:SS)<\/td> Activation time<\/td><\/tr> attribution_time<\/td> 2022\/5\/11 15:00:03<\/td> Attribution time<\/td><\/tr> turl_campaign_id<\/td> 3e0a9bad8455d685eaaf91bad71bdeb2<\/td> Tracking link ID<\/td><\/tr> turl_campaign_name<\/td> Mintegral_tracking<\/td> Tracking link name<\/td><\/tr> turl_id<\/td> UfeE7za<\/td> Short link ID<\/td><\/tr> channel_id<\/td> 1234<\/td> Channel ID<\/td><\/tr> channel_name<\/td> mintegral<\/td> Attribution channel name<\/td><\/tr> attribution_type<\/td> ua<\/td> UA (indicates new user acquisition)<\/td><\/tr> account_id<\/td> ,<\/td> Channel promotion account ID<\/td><\/tr> adgroup_id<\/td> ,<\/td> Channel promotion ad group ID<\/td><\/tr> adgroup_name<\/td> ,<\/td> Channel promotion ad group name<\/td><\/tr> adplan_id<\/td> ,<\/td> Channel promotion plan ID<\/td><\/tr> adplan_name<\/td> ,<\/td> Channel promotion plan name<\/td><\/tr> adcreative_id<\/td> ,<\/td> Channel promotion creative ID<\/td><\/tr> adcreative_name<\/td> ,<\/td> Channel promotion creative name<\/td><\/tr> adcreative_type<\/td> ,<\/td> Channel promotion creative type<\/td><\/tr> site_id<\/td> ,<\/td> Sub-channel ID<\/td><\/tr> site_name<\/td> ,<\/td> Sub-channel name<\/td><\/tr> ad_type<\/td> ,<\/td> Channel promotion ad type<\/td><\/tr> placement_id<\/td> ,<\/td> Channel promotion ad placement ID<\/td><\/tr> conversion_id<\/td> ,<\/td> Ad placement ID<\/td><\/tr> click_id<\/td> ,<\/td> Channel promotion unique click ID<\/td><\/tr> impression_id<\/td> ,<\/td> Channel promotion unique impression ID<\/td><\/tr> request_id<\/td> ,<\/td> Ad request ID<\/td><\/tr> callback_id<\/td> EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxM TI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==,<\/td> Callback ID<\/td><\/tr> custom_params_1<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_2<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_3<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_4<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_5<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_6<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_7<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_8<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_9<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_10<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr><\/tbody><\/table> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.<\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Game. (If a user deletes the Mini Game and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Game is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 4.2.1. Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.2. Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.3. In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderId<\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.4. Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>4.2.5. In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.6. Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> registerType<\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.7. Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre> <\/p> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> Changelog<\/h1>2026-02-02 1.3.2<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-14 1.3.0<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-13 1.2.9<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-02-13 1.2.8<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2025-01-03 1.2.7<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2024-12-31 1.2.6<\/strong><\/p> Internal initialization logic optimization<\/li><\/ul>2024-12-10 1.2.4<\/strong><\/p> Compatible with CocosCreator platform compilation and build<\/li><\/ul>2024-11-29 1.2.3<\/strong><\/p> Initialization logic optimization<\/li> Attribution data result structure adjustment<\/li><\/ul>2024-11-11 1.2.2<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-10-31 1.2.1<\/strong><\/p> Added SDK internal log reporting<\/li><\/ul>2024-08-14 1.1.9<\/strong><\/p> The type of the reported scene value _launch_scene<\/code> was changed from numeric to string<\/li><\/ul>2024-05-22 1.1.8<\/strong><\/p> Fixed the issue of the Douyin Mini Game install<\/code> event being reported multiple times<\/li><\/ul>2024-04-22 1.1.7<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-04-16 1.1.6<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-04-01 1.1.5<\/strong><\/p> Fixed an issue where reported events could not be deleted in extreme scenarios<\/li> Optimized the trigger timing of the ready<\/code> hook in Mini Programs<\/li><\/ul>2024-03-15 1.1.4<\/strong><\/p> Added new parameters to A\/B test requests<\/li><\/ul>2024-03-01 1.1.3<\/strong><\/p> Fixed A\/B test initialization parameter issue<\/li><\/ul>2024-01-22 1.1.2<\/strong><\/p> Fixed internal log reporting issue<\/li><\/ul>2023-12-06 1.1.1<\/strong><\/p> Added getDistinct<\/code> method to get distinct_id<\/code> and distinct_id_type<\/code><\/li> Added setOnAttributionListener<\/code> method to set a callback for listening to attribution results<\/li> Added getAttribution<\/code> method to actively get attribution result information<\/li> Added unionid<\/code> parameter to the init<\/code> method<\/li> Added signature verification for event reporting<\/li><\/ul>2023-11-02 1.1.0<\/strong><\/p> Supported pre-defined property and custom property settings<\/li> Supported pre-defined event and custom event reporting<\/li> Supported user property settings<\/li> Supported A\/B testing plugin<\/li><\/ul>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/MiniTt\/SolarEngine-MiniTt-CN-SDK-1.3.2.zip \u00a02.4. Configure Douyin Open PlatformGet AppID and AppSecret \u00a0 \u00a0 \u00a0Log in to\u300c\u6296\u97f3\u5c0f\u6e38\u620f_\u5f00\u53d1\u8005\u5e73\u53f0\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u7ba1\u7406 > \u5c0f\u7a0b\u5e8fKey. Then copy the AppID and AppSecret, and paste them into SolarEngine dashboard.Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300c\u6296\u97f3\u5c0f\u6e38\u620f_\u5f00\u53d1\u8005\u5e73\u53f0\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u8bbe\u7f6e > \u5f00\u53d1\u7ba1\u7406 > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):https:\/\/api-receiver.detailroi.comhttps:\/\/rule.detailroi.com3. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0 It is recommended to import and initialize SDK in the entry JS file of your Mini Game project to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0 Note: The SDK should only be imported once in one Mini Game. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ game.js\nimport SESDK from '.\/minitt-cn-sesdk-umd.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minitt-cn-sesdk-umd.js')\n\n\/\/ Pre-initialization\nSESDK.prevInit('appKey'); \n\/\/ Initialization\nSESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere \nglobalThis.SESDK = SESDK;initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above unionid string No Mini Game Union ID openid string No Mini Game Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SE dashboard following 2.4.) anonymous_openid string No Mini Game anonymous_openid. (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SolarEngine dashboard.) config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean No Whether to enable the debugging mode (Default false) logEnabled boolean No Whether the console prints SDK logs (Default false)Sample CodeSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n anonymous_openid: 'ccccccccccc',\n config: {\n logEnabled: true,\n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g.mpInstallmpStartmpEnd all (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1102 anonymous_openid 1103 uuid Note: openid > anonymous_openid > uuid3.8. Get Attribution Results3.8.1. Set Attribution Callback Listener \u00a0 \u00a0 \u00a0 \u00a0Developers can set a callback listener for attribution results. This method can only be called once and returns a Promise object.SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})3.8.2. Actively Retrieve Attribution Results \u00a0 \u00a0 \u00a0 \u00a0Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.SESDK.getAttribution().then(res => { \n \/\/ res.result\n})Attribution Results ExampleRe-engagement attribution results will be displayed in \"re_data\".{\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }attributionData parameter description: Parameter Example Description attribution_touch_type click, impression Attribution touchpoint type ry_touchpoint_ts Attribution display or click time (YYYY-MM-DD HH:MM:SS) Attribution touchpoint time install_time Device activation time (YYYY-MM-DD HH:MM:SS) Activation time attribution_time 2022\/5\/11 15:00:03 Attribution time turl_campaign_id 3e0a9bad8455d685eaaf91bad71bdeb2 Tracking link ID turl_campaign_name Mintegral_tracking Tracking link name turl_id UfeE7za Short link ID channel_id 1234 Channel ID channel_name mintegral Attribution channel name attribution_type ua UA (indicates new user acquisition) account_id , Channel promotion account ID adgroup_id , Channel promotion ad group ID adgroup_name , Channel promotion ad group name adplan_id , Channel promotion plan ID adplan_name , Channel promotion plan name adcreative_id , Channel promotion creative ID adcreative_name , Channel promotion creative name adcreative_type , Channel promotion creative type site_id , Sub-channel ID site_name , Sub-channel name ad_type , Channel promotion ad type placement_id , Channel promotion ad placement ID conversion_id , Ad placement ID click_id , Channel promotion unique click ID impression_id , Channel promotion unique impression ID request_id , Ad request ID callback_id EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==, Callback ID custom_params_1 Predefined tracking link parameter 1-10 custom_params_2 Predefined tracking link parameter 1-10 custom_params_3 Predefined tracking link parameter 1-10 custom_params_4 Predefined tracking link parameter 1-10 custom_params_5 Predefined tracking link parameter 1-10 custom_params_6 Predefined tracking link parameter 1-10 custom_params_7 Predefined tracking link parameter 1-10 custom_params_8 Predefined tracking link parameter 1-10 custom_params_9 Predefined tracking link parameter 1-10 custom_params_10 Predefined tracking link parameter 1-104. Event Reporting \u00a0 After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Game. (If a user deletes the Mini Game and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Game is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Game is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events4.2.1. Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})4.2.2. Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})4.2.3. In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4.2.4. Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})4.2.5. In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})4.2.6. Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.2.7. Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID YesChangelog2026-02-02 1.3.2Event reporting logic optimization2025-03-14 1.3.0Event reporting logic optimization2025-03-13 1.2.9Event reporting logic optimization2025-02-13 1.2.8Payment event reporting optimization2025-01-03 1.2.7Payment event reporting optimization2024-12-31 1.2.6Internal initialization logic optimization2024-12-10 1.2.4Compatible with CocosCreator platform compilation and build2024-11-29 1.2.3Initialization logic optimizationAttribution data result structure adjustment2024-11-11 1.2.2Optimized event reporting logic2024-10-31 1.2.1Added SDK internal log reporting2024-08-14 1.1.9The type of the reported scene value _launch_scene was changed from numeric to string2024-05-22 1.1.8Fixed the issue of the Douyin Mini Game install event being reported multiple times2024-04-22 1.1.7Optimized event reporting logic2024-04-16 1.1.6Optimized event reporting logic2024-04-01 1.1.5Fixed an issue where reported events could not be deleted in extreme scenariosOptimized the trigger timing of the ready hook in Mini Programs2024-03-15 1.1.4Added new parameters to A\/B test requests2024-03-01 1.1.3Fixed A\/B test initialization parameter issue2024-01-22 1.1.2Fixed internal log reporting issue2023-12-06 1.1.1Added getDistinct method to get distinct_id and distinct_id_typeAdded setOnAttributionListener method to set a callback for listening to attribution resultsAdded getAttribution method to actively get attribution result informationAdded unionid parameter to the init methodAdded signature verification for event reporting2023-11-02 1.1.0Supported pre-defined property and custom property settingsSupported pre-defined event and custom event reportingSupported user property settingsSupported A\/B testing plugin","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789627562","update_time":"1789893502"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"},{"id":"942519","string_id":"YLg35tsy","status":"1","parent_id":"942813","slug":"Kuaishou-Mini-Program-SDK","order":"6","name":"Kuaishou Mini Program SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789631014","add_time":"1789628465","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"942519","content":"1. SDK Basic Information<\/h1>SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p> Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p> <\/p> 2. Before you start<\/span><\/h1>2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p> <\/p>2.2. Get AppKey<\/h2> Access Path<\/strong>: Asset Management - App Management - AppKey<\/p> <\/p>2.3. Obtain SDK<\/h2>Download SDK (UMD and ES packages provided) :<\/p> https:\/\/sdk.solar-engine.com\/MiniKs\/SolarEngine-MiniKs-CN-SDK-1.3.2.zip<\/a> <\/p> 2.4. Configure Kuaishou Open Platform<\/h2>Get AppID and AppSecret<\/strong><\/span><\/li><\/ul> Log in to\u300c\u5feb\u624b\u5f00\u653e\u5e73\u53f0 (Kuaishou Open Platform)\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u8005\u8bbe\u7f6e > \u5f00\u53d1\u8005ID. Then copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SolarEngine.<\/p> <\/p> <\/p> Server Domain Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300c\u5feb\u624b\u5f00\u653e\u5e73\u53f0 (Kuaishou Open Platform)\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u8005\u8bbe\u7f6e > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):<\/p> https:\/\/api-receiver.detailroi.com<\/li> https:\/\/rule.detailroi.com<\/li><\/ul><\/p> IP Whitelist Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300c\u5feb\u624b\u5f00\u653e\u5e73\u53f0 (Kuaishou Open Platform)\u300d > \u5f00\u53d1\u7ba1\u7406 > \u5c0f\u7a0b\u5e8f\u4ee3\u7801\u4e0a\u4f20 > \u914d\u7f6e\u4fe1\u606f > IP\u767d\u540d\u5355.<\/p> If the IP whitelist protection is not enabled, there is no need to configure the SE fixed IPs.<\/li> If the IP whitelist protection is already enabled, you need to add the following SE fixed IPs:<\/li>71.132.0.102<\/li> 52.81.1.45<\/li> 52.54.188.146<\/li> 34.196.30.48<\/li><\/ul><\/ul><\/p> 3. Initialize the SDK<\/span><\/h1>3.1. SDK initialization<\/span><\/h2> It is recommended to import the SDK in the app.js<\/code> file of your Mini Program project, and initialize it within onLaunch<\/code> (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p> Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use in other parts of the project.<\/p> Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ app.js\nimport SESDK from '.\/miniks-cn-sesdk-umd.js';\n\n\/\/ If your build environment enforces ES Modules, please import the ES format file. \n\/\/ import SESDK from '.\/miniks-cn-sesdk-es.js' \n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/miniks-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey'); \n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere\n globalThis.SESDK = SESDK;\n },\n});<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> openid <\/td> string<\/td> No<\/td> Mini Program Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret<\/span> on SE dashboard following 2.4.)<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> NO<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> NO<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> SESDK.prevInit('6666666'); \nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre>3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. mpInstall mpStart mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre> <\/p> 3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101 <\/td> openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 3.8. Get Attribution Results<\/span><\/h2>3.8.1. Set Attribution Callback Listener<\/h3> Developers can set a callback listener for attribution results. This method can only be called once<\/strong> and returns a Promise object.<\/p> SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})<\/code><\/pre>3.8.2. Actively Retrieve Attribution Results<\/h3> Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.<\/p> SESDK.getAttribution().then(res => { \n \/\/ res.result\n})<\/code><\/pre>Attribution Results Example<\/span><\/h3>Re-engagement attribution results will be displayed in \"re_data\".<\/p> {\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }<\/code><\/pre>attributionData<\/strong> parameter description:<\/p> Parameter<\/th> Example<\/th> Description<\/th><\/tr> attribution_touch_type<\/td> click, impression<\/td> Attribution touchpoint type<\/td><\/tr> ry_touchpoint_ts<\/td> Attribution display or click time (YYYY-MM-DD HH:MM:SS)<\/td> Attribution touchpoint time<\/td><\/tr> install_time<\/td> Device activation time (YYYY-MM-DD HH:MM:SS)<\/td> Activation time<\/td><\/tr> attribution_time<\/td> 2022\/5\/11 15:00:03<\/td> Attribution time<\/td><\/tr> turl_campaign_id<\/td> 3e0a9bad8455d685eaaf91bad71bdeb2<\/td> Tracking link ID<\/td><\/tr> turl_campaign_name<\/td> Mintegral_tracking<\/td> Tracking link name<\/td><\/tr> turl_id<\/td> UfeE7za<\/td> Short link ID<\/td><\/tr> channel_id<\/td> 1234<\/td> Channel ID<\/td><\/tr> channel_name<\/td> mintegral<\/td> Attribution channel name<\/td><\/tr> attribution_type<\/td> ua<\/td> UA (indicates new user acquisition)<\/td><\/tr> account_id<\/td> ,<\/td> Channel promotion account ID<\/td><\/tr> adgroup_id<\/td> ,<\/td> Channel promotion ad group ID<\/td><\/tr> adgroup_name<\/td> ,<\/td> Channel promotion ad group name<\/td><\/tr> adplan_id<\/td> ,<\/td> Channel promotion plan ID<\/td><\/tr> adplan_name<\/td> ,<\/td> Channel promotion plan name<\/td><\/tr> adcreative_id<\/td> ,<\/td> Channel promotion creative ID<\/td><\/tr> adcreative_name<\/td> ,<\/td> Channel promotion creative name<\/td><\/tr> adcreative_type<\/td> ,<\/td> Channel promotion creative type<\/td><\/tr> site_id<\/td> ,<\/td> Sub-channel ID<\/td><\/tr> site_name<\/td> ,<\/td> Sub-channel name<\/td><\/tr> ad_type<\/td> ,<\/td> Channel promotion ad type<\/td><\/tr> placement_id<\/td> ,<\/td> Channel promotion ad placement ID<\/td><\/tr> conversion_id<\/td> ,<\/td> Ad placement ID<\/td><\/tr> click_id<\/td> ,<\/td> Channel promotion unique click ID<\/td><\/tr> impression_id<\/td> ,<\/td> Channel promotion unique impression ID<\/td><\/tr> request_id<\/td> ,<\/td> Ad request ID<\/td><\/tr> callback_id<\/td> EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxM TI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==,<\/td> Callback ID<\/td><\/tr> custom_params_1<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_2<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_3<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_4<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_5<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_6<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_7<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_8<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_9<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_10<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr><\/tbody><\/table> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.<\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Program is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 4.2.1. Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.2. Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.3. In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderId<\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.4. Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>4.2.5. In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.6. Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Parameter Type<\/th> Required<\/th><\/tr> registerType<\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.7. Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre><\/h2> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> Changelog<\/h1>2026-02-02 1.3.2<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-14 1.3.0<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-13 1.2.9<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-02-13 1.2.8<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2025-01-03 1.2.7<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2024-12-31 1.2.6<\/strong><\/p> Internal initialization logic optimization<\/li><\/ul>2024-12-10 1.2.4<\/strong><\/p> Reporting logic optimization<\/li><\/ul>2024-11-29 1.2.3<\/strong><\/p> Initialization logic optimization<\/li> Attribution data result structure adjustment<\/li><\/ul>2024-11-11 1.2.2<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-10-31 1.2.1<\/strong><\/p> Added SDK internal log reporting<\/li><\/ul>2024-08-14 1.1.9<\/strong><\/p> SolarEngine Kuaishou Mini Program SDK initial release<\/li> Supported pre-defined property and custom property settings<\/li> Supported pre-defined event and custom event reporting<\/li> Supported user property settings<\/li> Supported parameter delivery plugin<\/li> Supported automatic data collection<\/li> Supported obtaining openid<\/li> Supported obtaining attribution results<\/li><\/ul>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/MiniKs\/SolarEngine-MiniKs-CN-SDK-1.3.2.zip 2.4. Configure Kuaishou Open PlatformGet AppID and AppSecret \u00a0 \u00a0 \u00a0Log in to\u300c\u5feb\u624b\u5f00\u653e\u5e73\u53f0 (Kuaishou Open Platform)\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u8005\u8bbe\u7f6e > \u5f00\u53d1\u8005ID. Then copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SolarEngine.Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300c\u5feb\u624b\u5f00\u653e\u5e73\u53f0 (Kuaishou Open Platform)\u300dand go to the homepage > \u5f00\u53d1 > \u5f00\u53d1\u8005\u8bbe\u7f6e > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):https:\/\/api-receiver.detailroi.comhttps:\/\/rule.detailroi.comIP Whitelist Configuration \u00a0 \u00a0 \u00a0Log in to\u300c\u5feb\u624b\u5f00\u653e\u5e73\u53f0 (Kuaishou Open Platform)\u300d > \u5f00\u53d1\u7ba1\u7406 > \u5c0f\u7a0b\u5e8f\u4ee3\u7801\u4e0a\u4f20 > \u914d\u7f6e\u4fe1\u606f > IP\u767d\u540d\u5355.If the IP whitelist protection is not enabled, there is no need to configure the SE fixed IPs.If the IP whitelist protection is already enabled, you need to add the following SE fixed IPs:71.132.0.10252.81.1.4552.54.188.14634.196.30.483. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0 \u00a0It is recommended to import the SDK in the app.js file of your Mini Program project, and initialize it within onLaunch (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0 \u00a0Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use in other parts of the project.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ app.js\nimport SESDK from '.\/miniks-cn-sesdk-umd.js';\n\n\/\/ If your build environment enforces ES Modules, please import the ES format file. \n\/\/ import SESDK from '.\/miniks-cn-sesdk-es.js' \n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/miniks-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey'); \n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere\n globalThis.SESDK = SESDK;\n },\n});initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above openid string No Mini Program Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SE dashboard following 2.4.) config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean NO Whether to enable the debugging mode (Default false) logEnabled boolean NO Whether the console prints SDK logs (Default false)Sample CodeSESDK.prevInit('6666666'); \nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g.mpInstallmpStartmpEnd all (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1103 uuid Note: openid > uuid3.8. Get Attribution Results3.8.1. Set Attribution Callback Listener \u00a0 \u00a0 \u00a0 \u00a0Developers can set a callback listener for attribution results. This method can only be called once and returns a Promise object.SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})3.8.2. Actively Retrieve Attribution Results \u00a0 \u00a0 \u00a0 \u00a0Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.SESDK.getAttribution().then(res => { \n \/\/ res.result\n})Attribution Results ExampleRe-engagement attribution results will be displayed in \"re_data\".{\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }attributionData parameter description: Parameter Example Description attribution_touch_type click, impression Attribution touchpoint type ry_touchpoint_ts Attribution display or click time (YYYY-MM-DD HH:MM:SS) Attribution touchpoint time install_time Device activation time (YYYY-MM-DD HH:MM:SS) Activation time attribution_time 2022\/5\/11 15:00:03 Attribution time turl_campaign_id 3e0a9bad8455d685eaaf91bad71bdeb2 Tracking link ID turl_campaign_name Mintegral_tracking Tracking link name turl_id UfeE7za Short link ID channel_id 1234 Channel ID channel_name mintegral Attribution channel name attribution_type ua UA (indicates new user acquisition) account_id , Channel promotion account ID adgroup_id , Channel promotion ad group ID adgroup_name , Channel promotion ad group name adplan_id , Channel promotion plan ID adplan_name , Channel promotion plan name adcreative_id , Channel promotion creative ID adcreative_name , Channel promotion creative name adcreative_type , Channel promotion creative type site_id , Sub-channel ID site_name , Sub-channel name ad_type , Channel promotion ad type placement_id , Channel promotion ad placement ID conversion_id , Ad placement ID click_id , Channel promotion unique click ID impression_id , Channel promotion unique impression ID request_id , Ad request ID callback_id EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==, Callback ID custom_params_1 Predefined tracking link parameter 1-10 custom_params_2 Predefined tracking link parameter 1-10 custom_params_3 Predefined tracking link parameter 1-10 custom_params_4 Predefined tracking link parameter 1-10 custom_params_5 Predefined tracking link parameter 1-10 custom_params_6 Predefined tracking link parameter 1-10 custom_params_7 Predefined tracking link parameter 1-10 custom_params_8 Predefined tracking link parameter 1-10 custom_params_9 Predefined tracking link parameter 1-10 custom_params_10 Predefined tracking link parameter 1-104. Event Reporting \u00a0 After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events4.2.1. Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})4.2.2. Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})4.2.3. In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4.2.4. Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})4.2.5. In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})4.2.6. Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Parameter Type Required registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.2.7. Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID YesChangelog2026-02-02 1.3.2Event reporting logic optimization2025-03-14 1.3.0Event reporting logic optimization2025-03-13 1.2.9Event reporting logic optimization2025-02-13 1.2.8Payment event reporting optimization2025-01-03 1.2.7Payment event reporting optimization2024-12-31 1.2.6Internal initialization logic optimization2024-12-10 1.2.4Reporting logic optimization2024-11-29 1.2.3Initialization logic optimizationAttribution data result structure adjustment2024-11-11 1.2.2Optimized event reporting logic2024-10-31 1.2.1Added SDK internal log reporting2024-08-14 1.1.9SolarEngine Kuaishou Mini Program SDK initial releaseSupported pre-defined property and custom property settingsSupported pre-defined event and custom event reportingSupported user property settingsSupported parameter delivery pluginSupported automatic data collectionSupported obtaining openidSupported obtaining attribution results","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789628465","update_time":"1789893532"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"},{"id":"942770","string_id":"8h89mBxl","status":"1","parent_id":"942813","slug":"Kuaishou-Mini-Game-SDK","order":"5","name":"Kuaishou Mini Game SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789636553","add_time":"1789635875","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"942770","content":"1. SDK Basic Information<\/h1>SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p> Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p> <\/p> 2. Before you start<\/span><\/h1>2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p> <\/p>2.2. Get AppKey<\/h2> Access Path<\/strong>: Asset Management - App Management - AppKey<\/p> <\/p>2.3. Obtain SDK<\/h2>Download SDK (UMD and ES packages provided) :<\/p> https:\/\/sdk.solar-engine.com\/MiniKs\/SolarEngine-MiniKs-CN-SDK-1.3.2.zip<\/a> <\/p> 2.4. Configure Kuaishou Open Platform<\/h2>\u2022 <\/span>Get AppID and AppSecret<\/strong><\/span><\/p> Log in to\u300c\u5feb\u624b\u5c0f\u6e38\u620f\u5f00\u53d1\u5e73\u53f0\u300dand go to the homepage. Copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SolarEngine.<\/p> <\/p> <\/p> \u2022 <\/span>Server Domain Configuration<\/strong><\/span><\/p> Log in to\u300c\u5feb\u624b\u5c0f\u6e38\u620f\u5f00\u53d1\u5e73\u53f0\u300dand go to the homepage > \u5f00\u53d1\u8bbe\u7f6e > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):<\/p> \u2022 https:\/\/api-receiver.detailroi.com<\/p> \u2022 https:\/\/rule.detailroi.com<\/p> <\/p> \u2022 <\/span>IP Whitelist Configuration<\/strong><\/span><\/p> If the IP whitelist protection is enabled, you need to add the following SE fixed IPs:<\/p> 71.132.0.102<\/li> 52.81.1.45<\/li> 52.54.188.146<\/li> 34.196.30.48<\/li><\/ul><\/ul>3. Initialize the SDK<\/span><\/h1>3.1. SDK initialization<\/span><\/h2> It is recommended to import the SDK in the app.js<\/code> file of your Mini Program project, and initialize it within onLaunch<\/code> (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p> Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere in the project.<\/p> Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ app.js\nimport SESDK from '.\/miniks-cn-sesdk-umd.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/miniks-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey'); \n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere \n globalThis.SESDK = SESDK;\n },\n});<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> unionid<\/td> string<\/td> No<\/td> Mini Game Union ID<\/td><\/tr> openid <\/td> string<\/td> No<\/td> Mini Game Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret<\/span> on SE dashboard following 2.4.)<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> No<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> No<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> SESDK.prevInit('6666666'); \nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre>3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. mpInstall mpStart mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre> <\/p> 3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101 <\/td> openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 3.8. Get Attribution Results<\/span><\/h2>3.8.1. Set Attribution Callback Listener<\/h3> Developers can set a callback listener for attribution results. This method can only be called once<\/strong> and returns a Promise object.<\/p> SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})<\/code><\/pre>3.8.2. Actively Retrieve Attribution Results<\/h3> Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.<\/p> SESDK.getAttribution().then(res => { \n \/\/ res.result\n})<\/code><\/pre>Attribution Results Example<\/span><\/h3>Re-engagement attribution results will be displayed in \"re_data\".<\/p> {\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }<\/code><\/pre>attributionData<\/strong> parameter description:<\/p> Parameter<\/th> Example<\/th> Description<\/th><\/tr> attribution_touch_type<\/td> click, impression<\/td> Attribution touchpoint type<\/td><\/tr> ry_touchpoint_ts<\/td> Attribution display or click time (YYYY-MM-DD HH:MM:SS)<\/td> Attribution touchpoint time<\/td><\/tr> install_time<\/td> Device activation time (YYYY-MM-DD HH:MM:SS)<\/td> Activation time<\/td><\/tr> attribution_time<\/td> 2022\/5\/11 15:00:03<\/td> Attribution time<\/td><\/tr> turl_campaign_id<\/td> 3e0a9bad8455d685eaaf91bad71bdeb2<\/td> Tracking link ID<\/td><\/tr> turl_campaign_name<\/td> Mintegral_tracking<\/td> Tracking link name<\/td><\/tr> turl_id<\/td> UfeE7za<\/td> Short link ID<\/td><\/tr> channel_id<\/td> 1234<\/td> Channel ID<\/td><\/tr> channel_name<\/td> mintegral<\/td> Attribution channel name<\/td><\/tr> attribution_type<\/td> ua<\/td> UA (indicates new user acquisition)<\/td><\/tr> account_id<\/td> ,<\/td> Channel promotion account ID<\/td><\/tr> adgroup_id<\/td> ,<\/td> Channel promotion ad group ID<\/td><\/tr> adgroup_name<\/td> ,<\/td> Channel promotion ad group name<\/td><\/tr> adplan_id<\/td> ,<\/td> Channel promotion plan ID<\/td><\/tr> adplan_name<\/td> ,<\/td> Channel promotion plan name<\/td><\/tr> adcreative_id<\/td> ,<\/td> Channel promotion creative ID<\/td><\/tr> adcreative_name<\/td> ,<\/td> Channel promotion creative name<\/td><\/tr> adcreative_type<\/td> ,<\/td> Channel promotion creative type<\/td><\/tr> site_id<\/td> ,<\/td> Sub-channel ID<\/td><\/tr> site_name<\/td> ,<\/td> Sub-channel name<\/td><\/tr> ad_type<\/td> ,<\/td> Channel promotion ad type<\/td><\/tr> placement_id<\/td> ,<\/td> Channel promotion ad placement ID<\/td><\/tr> conversion_id<\/td> ,<\/td> Ad placement ID<\/td><\/tr> click_id<\/td> ,<\/td> Channel promotion unique click ID<\/td><\/tr> impression_id<\/td> ,<\/td> Channel promotion unique impression ID<\/td><\/tr> request_id<\/td> ,<\/td> Ad request ID<\/td><\/tr> callback_id<\/td> EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxM TI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==,<\/td> Callback ID<\/td><\/tr> custom_params_1<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_2<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_3<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_4<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_5<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_6<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_7<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_8<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_9<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr> custom_params_10<\/td> <\/td> Predefined tracking link parameter 1-10<\/td><\/tr><\/tbody><\/table> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.<\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Game. (If a user deletes the Mini Game and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Game is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 4.2.1. Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.2. Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.3. In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> orderId<\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.4. Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>4.2.5. In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.6. Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> registerType<\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.7. Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre> <\/p> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> Changelog<\/h1>2026-02-02 1.3.2<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-14 1.3.0<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-13 1.2.9<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-02-13 1.2.8<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2025-01-03 1.2.7<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2024-12-31 1.2.6<\/strong><\/p> Internal initialization logic optimization<\/li><\/ul>2024-12-10 1.2.4<\/strong><\/p> Reporting logic optimization<\/li><\/ul>2024-11-29 1.2.3<\/strong><\/p> Initialization logic optimization<\/li> Attribution data result structure adjustment<\/li><\/ul>2024-11-11 1.2.2<\/strong><\/p> Optimized event reporting logic<\/li><\/ul>2024-10-31 1.2.1<\/strong><\/p> Added SDK internal log reporting<\/li><\/ul>2024-08-14 1.1.9<\/strong><\/p> SolarEngine Kuaishou Mini Program SDK initial release<\/li> Supported pre-defined property and custom property settings<\/li> Supported pre-defined event and custom event reporting<\/li> Supported user property settings<\/li> Supported parameter delivery plugin<\/li> Supported automatic data collection<\/li> Supported obtaining openid<\/li> Supported obtaining attribution results<\/li><\/ul>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/MiniKs\/SolarEngine-MiniKs-CN-SDK-1.3.2.zip \u00a0 \u00a0 \u00a02.4. Configure Kuaishou Open Platform\u2022 Get AppID and AppSecret \u00a0 \u00a0 \u00a0 \u00a0Log in to\u300c\u5feb\u624b\u5c0f\u6e38\u620f\u5f00\u53d1\u5e73\u53f0\u300dand go to the homepage. Copy the AppID (Mini Program ID) and AppSecret (Mini Program Secret), and paste them into SolarEngine. \u2022 Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300c\u5feb\u624b\u5c0f\u6e38\u620f\u5f00\u53d1\u5e73\u53f0\u300dand go to the homepage > \u5f00\u53d1\u8bbe\u7f6e > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):\u2022 https:\/\/api-receiver.detailroi.com\u2022 https:\/\/rule.detailroi.com \u2022 IP Whitelist Configuration \u00a0 \u00a0 \u00a0 \u00a0If the IP whitelist protection is enabled, you need to add the following SE fixed IPs:71.132.0.10252.81.1.4552.54.188.14634.196.30.483. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0 It is recommended to import the SDK in the app.js file of your Mini Program project, and initialize it within onLaunch (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0 Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere in the project.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ app.js\nimport SESDK from '.\/miniks-cn-sesdk-umd.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/miniks-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey'); \n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere \n globalThis.SESDK = SESDK;\n },\n});initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above unionid string No Mini Game Union ID openid string No Mini Game Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SE dashboard following 2.4.) config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean No Whether to enable the debugging mode (Default false) logEnabled boolean No Whether the console prints SDK logs (Default false)Sample CodeSESDK.prevInit('6666666'); \nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g.mpInstallmpStartmpEnd all (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1103 uuid Note: openid > uuid3.8. Get Attribution Results3.8.1. Set Attribution Callback Listener \u00a0 \u00a0 \u00a0 \u00a0Developers can set a callback listener for attribution results. This method can only be called once and returns a Promise object.SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})3.8.2. Actively Retrieve Attribution Results \u00a0 \u00a0 \u00a0 \u00a0Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.SESDK.getAttribution().then(res => { \n \/\/ res.result\n})Attribution Results ExampleRe-engagement attribution results will be displayed in \"re_data\".{\n \/\/New user attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"attribution_type\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\",\n \"re_data\": {\n \/\/Re-engagement attribution results\n \"account_id\": \"\",\n \"ad_type\": \"\",\n \"adcreative_id\": \"\",\n \"adcreative_name\": \"\",\n \"adcreative_type\": \"\",\n \"adgroup_id\": \"\",\n \"adgroup_name\": \"\",\n \"adplan_id\": \"\",\n \"adplan_name\": \"\",\n \"attribution_time\": \"2023-08-31 11:16:35\",\n \"attribution_touch_type\": \"\",\n \"promotion_objectives\": \"\",\n \"callback_id\": \"\",\n \"channel_id\": \"-1\",\n \"channel_name\": \"organic\",\n \"click_id\": \"\",\n \"conversion_id\": \"\",\n \"custom_params_1\": \"\",\n \"custom_params_10\": \"\",\n \"custom_params_2\": \"\",\n \"custom_params_3\": \"\",\n \"custom_params_4\": \"\",\n \"custom_params_5\": \"\",\n \"custom_params_6\": \"\",\n \"custom_params_7\": \"\",\n \"custom_params_8\": \"\",\n \"custom_params_9\": \"\",\n \"impression_id\": \"\",\n \"install_time\": \"2023-08-31 11:16:32\",\n \"placement_id\": \"\",\n \"report_time\": \"2023-08-31 11:16:34\",\n \"request_id\": \"\",\n \"ry_touchpoint_ts\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"turl_campaign_id\": \"\",\n \"turl_campaign_name\": \"\",\n \"turl_id\": \"\"\n }\n }attributionData parameter description: Parameter Example Description attribution_touch_type click, impression Attribution touchpoint type ry_touchpoint_ts Attribution display or click time (YYYY-MM-DD HH:MM:SS) Attribution touchpoint time install_time Device activation time (YYYY-MM-DD HH:MM:SS) Activation time attribution_time 2022\/5\/11 15:00:03 Attribution time turl_campaign_id 3e0a9bad8455d685eaaf91bad71bdeb2 Tracking link ID turl_campaign_name Mintegral_tracking Tracking link name turl_id UfeE7za Short link ID channel_id 1234 Channel ID channel_name mintegral Attribution channel name attribution_type ua UA (indicates new user acquisition) account_id , Channel promotion account ID adgroup_id , Channel promotion ad group ID adgroup_name , Channel promotion ad group name adplan_id , Channel promotion plan ID adplan_name , Channel promotion plan name adcreative_id , Channel promotion creative ID adcreative_name , Channel promotion creative name adcreative_type , Channel promotion creative type site_id , Sub-channel ID site_name , Sub-channel name ad_type , Channel promotion ad type placement_id , Channel promotion ad placement ID conversion_id , Ad placement ID click_id , Channel promotion unique click ID impression_id , Channel promotion unique impression ID request_id , Ad request ID callback_id EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==, Callback ID custom_params_1 Predefined tracking link parameter 1-10 custom_params_2 Predefined tracking link parameter 1-10 custom_params_3 Predefined tracking link parameter 1-10 custom_params_4 Predefined tracking link parameter 1-10 custom_params_5 Predefined tracking link parameter 1-10 custom_params_6 Predefined tracking link parameter 1-10 custom_params_7 Predefined tracking link parameter 1-10 custom_params_8 Predefined tracking link parameter 1-10 custom_params_9 Predefined tracking link parameter 1-10 custom_params_10 Predefined tracking link parameter 1-104. Event Reporting \u00a0 \u00a0 \u00a0After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Game. (If a user deletes the Mini Game and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Game is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Game is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events4.2.1. Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})4.2.2. Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})4.2.3. In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Type Required orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4.2.4. Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Data Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})4.2.5. In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Data Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})4.2.6. Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Data Type Required registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.2.7. Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID YesChangelog2026-02-02 1.3.2Event reporting logic optimization2025-03-14 1.3.0Event reporting logic optimization2025-03-13 1.2.9Event reporting logic optimization2025-02-13 1.2.8Payment event reporting optimization2025-01-03 1.2.7Payment event reporting optimization2024-12-31 1.2.6Internal initialization logic optimization2024-12-10 1.2.4Reporting logic optimization2024-11-29 1.2.3Initialization logic optimizationAttribution data result structure adjustment2024-11-11 1.2.2Optimized event reporting logic2024-10-31 1.2.1Added SDK internal log reporting2024-08-14 1.1.9SolarEngine Kuaishou Mini Program SDK initial releaseSupported pre-defined property and custom property settingsSupported pre-defined event and custom event reportingSupported user property settingsSupported parameter delivery pluginSupported automatic data collectionSupported obtaining openidSupported obtaining attribution results","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789635875","update_time":"1789893597"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"},{"id":"942794","string_id":"7ivA2g8w","status":"1","parent_id":"942813","slug":"Bilibili-Mini-Game-SDK","order":"4","name":"Bilibili Mini Game SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789637516","add_time":"1789636596","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"942794","content":"1. SDK Basic Information<\/h1>SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p> Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p> <\/p> 2. Before you start<\/span><\/h1>2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p> <\/p>2.2. Get AppKey<\/h2> Access Path<\/strong>: Asset Management - App Management - AppKey<\/p> <\/p>2.3. Obtain SDK<\/h2>Download SDK (UMD and ES packages provided) :<\/p> https:\/\/sdk.solar-engine.com\/MiniBl\/SolarEngine-MiniBl-CN-SDK-1.3.2.zip<\/a> <\/p> 2.4. Configure Bilibili Open Platform<\/h2>Get AppID and AppSecret<\/strong><\/span><\/li><\/ul> Log in to\u300cbilibili \u6e38\u620f\u5f00\u653e\u5e73\u53f0<\/span>\u300d<\/p>If Mini Game is not yet reviewed, after submitting the review, click \"\u63d0\u524d\u5f00\u59cb\u5f00\u53d1\" to get the app_id (AppID) and secret_key (AppSecret), and then paste to SolarEngine dashboard.<\/li><\/ul><\/ul><\/p>If Mini Game is reviewed already, navigate to the homepage ( https:\/\/open.biligame.com\/#\/register\/choose-type<\/a>), get the app_id (AppID) and secret_key (AppSecret), and then paste to SolarEngine dashboard.<\/li><\/ul><\/ul><\/p> <\/p> Server Domain Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300cbilibili \u6e38\u620f\u5f00\u653e\u5e73\u53f0\u300dand go to the homepage > \u5f00\u53d1 > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):<\/p> https:\/\/api-receiver.detailroi.com<\/li> https:\/\/rule.detailroi.com<\/li><\/ul><\/p> 3. Initialize the SDK<\/span><\/h1>3.1. SDK initialization<\/span><\/h2> It is recommended to import and initialize SDK in the entry JS file of your Mini Game project to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p> Note: The SDK should only be imported once in one Mini Game. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere.<\/p> Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ game.js\nimport SESDK from '.\/minibl-cn-sesdk-umd.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minibl-cn-sesdk-umd.js')\n\n\/\/ Pre-initialization \nSESDK.prevInit('appKey'); \n\/\/ Initialization \nSESDK.init(initParams);\n\/\/ Mount to global (e.g. globalThis) for use elsewhere \nglobalThis.SESDK = SESDK;<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> unionid<\/td> string<\/td> No<\/td> Mini Game Union ID<\/td><\/tr> openid <\/td> string<\/td> YES<\/td> Mini Game Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret<\/span> on SE dashboard following 2.4.)<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> No<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> No<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> SESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre> <\/p> 3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. mpInstall mpStart mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre> <\/p> 3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101 <\/td> openid<\/td><\/tr> 1102<\/td> anonymous_openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > anonymous_openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 3.8. Get Attribution Results<\/span><\/h2>3.8.1. Set Attribution Callback Listener<\/h3> Developers can set a callback listener for attribution results. This method can only be called once<\/strong> and returns a Promise object.<\/p> SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})<\/code><\/pre>3.8.2. Actively Retrieve Attribution Results<\/h3> Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.<\/p> SESDK.getAttribution().then(res => { \n \/\/ res.result\n})<\/code><\/pre> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.<\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Game. (If a user deletes the Mini Game and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Game is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 4.2.1. Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.2. Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.3. In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> orderId<\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.4. Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>4.2.5. In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.6. Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> registerType<\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.7. Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre> <\/p> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> Changelog<\/h1>2026-02-02 1.3.2<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-03-14 1.3.0<\/strong><\/p> Added support for obtaining openid<\/li> Added support for obtaining attribution results<\/li><\/ul>2025-03-13 1.2.9<\/strong><\/p> Event reporting logic optimization<\/li><\/ul>2025-02-13 1.2.8<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2025-01-03 1.2.7<\/strong><\/p> Payment event reporting optimization<\/li><\/ul>2024-12-31 1.2.5<\/strong><\/p> Supported pre-defined property and custom property settings<\/li> Supported pre-defined event and custom event reporting<\/li> Supported user property settings<\/li> Supported A\/B testing plugin<\/li><\/ul>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/MiniBl\/SolarEngine-MiniBl-CN-SDK-1.3.2.zip \u00a02.4. Configure Bilibili Open PlatformGet AppID and AppSecret \u00a0 \u00a0 \u00a0Log in to\u300cbilibili \u6e38\u620f\u5f00\u653e\u5e73\u53f0\u300dIf Mini Game is not yet reviewed, after submitting the review, click \"\u63d0\u524d\u5f00\u59cb\u5f00\u53d1\" to get the app_id (AppID) and secret_key (AppSecret), and then paste to SolarEngine dashboard.If Mini Game is reviewed already, navigate to the homepage ( https:\/\/open.biligame.com\/#\/register\/choose-type), get the app_id (AppID) and secret_key (AppSecret), and then paste to SolarEngine dashboard.Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300cbilibili \u6e38\u620f\u5f00\u653e\u5e73\u53f0\u300dand go to the homepage > \u5f00\u53d1 > \u670d\u52a1\u5668\u57df\u540d > request \u5408\u6cd5\u57df\u540d, and enter the following domains to complete the configuration (see example screenshot):https:\/\/api-receiver.detailroi.comhttps:\/\/rule.detailroi.com3. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0 It is recommended to import and initialize SDK in the entry JS file of your Mini Game project to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0 Note: The SDK should only be imported once in one Mini Game. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ game.js\nimport SESDK from '.\/minibl-cn-sesdk-umd.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minibl-cn-sesdk-umd.js')\n\n\/\/ Pre-initialization \nSESDK.prevInit('appKey'); \n\/\/ Initialization \nSESDK.init(initParams);\n\/\/ Mount to global (e.g. globalThis) for use elsewhere \nglobalThis.SESDK = SESDK;initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above unionid string No Mini Game Union ID openid string YES Mini Game Open ID (If not provided, SDK will obtain automatically, but you must fill in the AppID and AppSecret on SE dashboard following 2.4.) config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean No Whether to enable the debugging mode (Default false) logEnabled boolean No Whether the console prints SDK logs (Default false)Sample CodeSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g.mpInstallmpStartmpEnd all (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1102 anonymous_openid 1103 uuid Note: openid > anonymous_openid > uuid3.8. Get Attribution Results3.8.1. Set Attribution Callback Listener \u00a0 \u00a0 \u00a0 \u00a0Developers can set a callback listener for attribution results. This method can only be called once and returns a Promise object.SESDK.setOnAttributionListener().then(res => {\n \/\/ res.result\n})3.8.2. Actively Retrieve Attribution Results \u00a0 \u00a0 \u00a0 \u00a0Developers can actively retrieve attribution results. This method can be called multiple times and returns a Promise object.SESDK.getAttribution().then(res => { \n \/\/ res.result\n})4. Event Reporting \u00a0 After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Game. (If a user deletes the Mini Game and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Game is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Game is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events4.2.1. Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Data Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})4.2.2. Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})4.2.3. In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Data Type Required orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4.2.4. Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Data Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})4.2.5. In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Data Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})4.2.6. Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Data Type Required registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.2.7. Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID YesChangelog2026-02-02 1.3.2Event reporting logic optimization2025-03-14 1.3.0Added support for obtaining openidAdded support for obtaining attribution results2025-03-13 1.2.9Event reporting logic optimization2025-02-13 1.2.8Payment event reporting optimization2025-01-03 1.2.7Payment event reporting optimization2024-12-31 1.2.5Supported pre-defined property and custom property settingsSupported pre-defined event and custom event reportingSupported user property settingsSupported A\/B testing plugin","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789636596","update_time":"1789893661"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"},{"id":"942821","string_id":"tsuOQwqe","status":"1","parent_id":"942813","slug":"TikTok-Mini-Program-SDK","order":"3","name":"TikTok Mini Program SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789638397","add_time":"1789637638","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"942821","content":"1. SDK Basic Information<\/h1>SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p> Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p> <\/p> 2. Before you start<\/span><\/h1>2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p> <\/p>2.2. Get AppKey<\/h2> Access Path<\/strong>: Asset Management - App Management - AppKey<\/p> <\/p>2.3. Obtain SDK<\/h2>Download SDK (UMD and ES packages provided) :<\/p> https:\/\/sdk.solar-engine.com\/TikTok\/SolarEngine-TikTok-US-SDK-1.3.3.zip<\/a> <\/p> 2.4. Configure TikTok Open Platform<\/h2>Get AppID and AppSecret<\/strong><\/span><\/li><\/ul> Log in to\u300cTikTok Open Platform\u300dand go to the homepage > Developer Portal > Select your Mini Program > Basic Information > Credentials. Then copy the \"Client key<\/strong>\" and \"Client Secret<\/strong>\", and paste them into SolarEngine.<\/p> TikTok Open Platform:<\/strong><\/p> <\/p> SolarEngine Platform:<\/strong><\/p> <\/p>Server Domain Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300cTikTok Open Platform\u300dand go to the homepage > Development configuration<\/span> > Security > Add domian, and enter the following domains to complete the configuration (see example screenshot):<\/p>https:\/\/vg-api-receiver.detailroi.com<\/a><\/li> https:\/\/vg-rule.detailroi.com<\/a> <\/li><\/ul><\/p> 3. Initialize the SDK<\/span><\/h1>3.1. SDK initialization<\/span><\/h2> It is recommended to import the SDK in the app.js<\/code> file of your Mini Program project, and initialize it within onLaunch<\/code> (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p> Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use in other parts of the project.<\/p> Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ app.js\nimport SESDK from '.\/minitiktok-us-sesdk-es.js';\n\n\/\/ If your build environment enforces ES Modules, please import the ES format file. \n\/\/ import SESDK from '.\/minitiktok-us-sesdk-es.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minitt-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey');\n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere\n globalThis.SESDK = SESDK;\n },\n});<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> openid <\/td> string<\/td> No<\/td> Obtain the Open ID from TikTok first, then pass it to the SE SDK during initialization.<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> NO<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> NO<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> SESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre> <\/p> 3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. mpInstall mpStart mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre>3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101 <\/td> openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.<\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Program is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 4.2.1. Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.2. Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.3. In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> orderId<\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.4. Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>4.2.5. In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.6. Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> registerType<\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.7. Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre><\/h2> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> Changelog<\/h1>2026-06-10<\/strong><\/p> Support TikTok Mini Program<\/li><\/ul>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/TikTok\/SolarEngine-TikTok-US-SDK-1.3.3.zip \u00a02.4. Configure TikTok Open PlatformGet AppID and AppSecret \u00a0 \u00a0 \u00a0Log in to\u300cTikTok Open Platform\u300dand go to the homepage > Developer Portal > Select your Mini Program > Basic Information > Credentials. Then copy the \"Client key\" and \"Client Secret\", and paste them into SolarEngine. \u00a0 \u00a0 \u00a0TikTok Open Platform: \u00a0 \u00a0 \u00a0SolarEngine Platform:Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300cTikTok Open Platform\u300dand go to the homepage > Development configuration > Security > Add domian, and enter the following domains to complete the configuration (see example screenshot):https:\/\/vg-api-receiver.detailroi.comhttps:\/\/vg-rule.detailroi.com 3. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0 \u00a0It is recommended to import the SDK in the app.js file of your Mini Program project, and initialize it within onLaunch (triggered on Mini Program cold start) to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0 \u00a0Note: The SDK should only be imported once in one Mini Program. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use in other parts of the project.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ app.js\nimport SESDK from '.\/minitiktok-us-sesdk-es.js';\n\n\/\/ If your build environment enforces ES Modules, please import the ES format file. \n\/\/ import SESDK from '.\/minitiktok-us-sesdk-es.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minitt-cn-sesdk-umd.js')\n\nApp({\n onLaunch() {\n \/\/ Pre-initialization\n SESDK.prevInit('appKey');\n \/\/ Initialization\n SESDK.init(initParams);\n \/\/ Mount to global (e.g. globalThis) for use elsewhere\n globalThis.SESDK = SESDK;\n },\n});initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above openid string No Obtain the Open ID from TikTok first, then pass it to the SE SDK during initialization. config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean NO Whether to enable the debugging mode (Default false) logEnabled boolean NO Whether the console prints SDK logs (Default false)Sample CodeSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g.mpInstallmpStartmpEnd all (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1103 uuid Note: openid > uuid4. Event Reporting \u00a0 After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events4.2.1. Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})4.2.2. Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})4.2.3. In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Type Required orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4.2.4. Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})4.2.5. In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})4.2.6. Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Type Required registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.2.7. Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID YesChangelog2026-06-10Support TikTok Mini Program","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789637638","update_time":"1789893704"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"},{"id":"942855","string_id":"C236A3qF","status":"1","parent_id":"942813","slug":"TikTok-Mini-Game-SDK","order":"2","name":"TikTok Mini Game SDK","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"xinru","published_time":"1789638783","add_time":"1789638409","update_time":"1789898282","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"942855","content":"1. SDK Basic Information<\/h1>SolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.<\/p> Privacy Policy<\/strong>: https:\/\/www.solar-engine.com\/privacyPolicyEN.html<\/a> <\/p> <\/p> 2. Before you start<\/span><\/h1>2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p> <\/p>2.2. Get AppKey<\/h2> Access Path<\/strong>: Asset Management - App Management - AppKey<\/p> <\/p>2.3. Obtain SDK<\/h2>Download SDK (UMD and ES packages provided) :<\/p> https:\/\/sdk.solar-engine.com\/TikTok\/SolarEngine-TikTok-US-SDK-1.3.3.zip<\/a> <\/p> 2.4. Configure TikTok Open Platform<\/h2>Get AppID and AppSecret<\/strong><\/span><\/li><\/ul> Log in to\u300cTikTok Open Platform\u300dand go to the homepage > Developer Portal > Select your Mini Game > Basic Information > Credentials. Then copy the \"Client key<\/strong>\" and \"Client Secret<\/strong>\", and paste them into SolarEngine.<\/p> TikTok Open Platform:<\/strong><\/p> <\/p> SolarEngine Platform:<\/strong><\/p> <\/p>Server Domain Configuration<\/strong><\/span><\/li><\/ul> Log in to\u300cTikTok Open Platform\u300dand go to the homepage > Development configuration<\/span> > Security > Add domian, and enter the following domains to complete the configuration (see example screenshot):<\/p>https:\/\/vg-api-receiver.detailroi.com<\/a><\/li> https:\/\/vg-rule.detailroi.com<\/a> <\/li><\/ul><\/p> 3. Initialize the SDK<\/span><\/h1>3.1. SDK initialization<\/span><\/h2> It is recommended to import and initialize SDK in the entry JS file of your Mini Game project to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit<\/code> method and passing in the appKey.<\/p> Note: The SDK should only be imported once in one Mini Game. After importing the SDK in app.js<\/code>, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere.<\/p> Import the ES format file for ES Modules environments; otherwise, use the UMD format.<\/span><\/blockquote>\/\/ game.js\nimport SESDK from '.\/minitiktok-us-sesdk-es.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minitt-cn-sesdk-umd.js')\n\n\/\/ Pre-initialization\nSESDK.prevInit('appKey'); \n\/\/ Initialization\nSESDK.init(initParams);\n\/\/ Mount to global (e.g. globalThis) for use elsewhere\nglobalThis.SESDK = SESDK;<\/code><\/pre>initParams parameter description:<\/span><\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> userId<\/td> string<\/td> YES<\/td> UserCode obtained above<\/td><\/tr> appKey<\/td> string<\/td> YES<\/td> AppKey obtained above<\/td><\/tr> openid <\/td> string<\/td> No<\/td> Obtain the Open ID from TikTok first, then pass it to the SE SDK during initialization.<\/td><\/tr> config<\/td> Config<\/td> No<\/td> Initialization related config<\/td><\/tr><\/tbody><\/table>Config parameter description:<\/p> Parameter<\/th> Type<\/th> Required<\/th> Description<\/th><\/tr> debugModel<\/td> boolean<\/td> NO<\/td> Whether to enable the debugging mode (Default false)<\/td><\/tr> logEnabled<\/td> boolean<\/td> NO<\/td> Whether the console prints SDK logs (Default false)<\/td><\/tr><\/tbody><\/table>Sample Code<\/strong><\/span><\/p> SESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n});<\/code><\/pre> Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete<\/strong><\/span>, you may call the ready<\/code> method.<\/p> SESDK.ready(callback);<\/code><\/pre> During SDK initialization, if you need to load SDK plugins, you may call the use<\/code> method.<\/p> SESDK.use(sdkPlugin);<\/code><\/pre> <\/p> 3.2. Visitor ID<\/span><\/h2> Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login.<\/p> We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it <\/span>before SDK initialization<\/strong><\/span>.<\/span><\/p> Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.<\/p> Set visitor ID<\/span><\/h3> Call <\/span>setVisitorID<\/code><\/span> to set the visitor ID:<\/span><\/p> SESDK.setVisitorId('vid8709901241')<\/code><\/pre>Note:<\/p> This call only passes the visitor ID to SDK and does not report user setting events.<\/li> The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain visitor ID<\/span><\/h3> Call <\/span>getVisitorId<\/code><\/span> to get the current visitor ID:<\/span><\/p> SESDK.getVisitorId()<\/code><\/pre> <\/p> 3.3. Account ID<\/span><\/h2> Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier.<\/p> Once the account ID is set, it will be retained permanently until the logout<\/code> method is called to clear the account ID. The logout<\/code> method should only be called when users actually log out, but no need to be called when the app is closed or running in the background.<\/p> Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.<\/p> Set Account ID<\/strong><\/h3> Call login<\/code> to set the user's account ID:<\/p> SESDK.login('aid25491084');<\/code><\/pre>Note:<\/p> This call only passes the account ID to SDK and does not report user login events.<\/li> The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail.<\/li> Once set by the developer, it will be stored in local storage.<\/li><\/ul>Obtain account ID<\/h3> Call getAccountId<\/code> to get the user's account ID:<\/p> SESDK.getAccountId();<\/code><\/pre>Clear account ID<\/span><\/h3> Call<\/span> logout<\/code><\/span> to clear the account ID:<\/span><\/p> SESDK.logout();<\/code><\/pre>Note: <\/strong><\/p> <\/strong>This call only notifies the SDK to clear the account ID and will not report the user logout event.<\/p> <\/p> 3.4. Public event properties<\/span><\/h2> Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions.<\/p> You can call setSuperProperties<\/code> function to set public event properties. We recommend you setting the public event properties before sending any events.<\/p> The format of public event properties are the same as custom properties --> <\/span>4.4 Custom Properties<\/u><\/span><\/a><\/p> SESDK.setSuperProperties({\n key: value\n});<\/code><\/pre> If you need to delete a public event property, you can call<\/span> unsetSuperProperty<\/code><\/span> to clear one of them.<\/p> SESDK.unsetSuperProperty(key);<\/code><\/pre> If you want to clear all public event properties, you can call<\/span> clearSuperProperties<\/code><\/span> .<\/span><\/p> SESDK.clearSuperProperties();<\/code><\/pre>Note:<\/strong><\/p> If you call setSuperProperties<\/code> to upload public event properties that have been set previously, the new values will overwrite the existing ones<\/strong><\/span>.<\/li> If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property<\/strong><\/span>.<\/li> Once set by the developer, these properties will be stored in local storage.<\/li><\/ol>3.5. Preset event properties<\/span><\/h2> The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.<\/span><\/p> SESDK.setPresetEvent(eventType, properties);<\/code><\/pre>Parameter<\/th> Description<\/th> Parameter Type<\/th> Required<\/th><\/tr> eventType<\/td> e.g. mpInstall mpStart mpEnd all (all preset events)<\/td> string<\/td> YES<\/td><\/tr> properties<\/td> Custom properties<\/td> object<\/td> NO<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.<\/li> Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.<\/li> If the enumeration for eventType<\/strong> is set to all<\/strong>, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.<\/li> Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:<\/li><\/ul>SESDK.setPresetEvent('webInstall', null)<\/code> This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to <\/strong>the corresponding enumeration value.<\/p> Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:<\/li><\/ul>SESDK.setPresetEvent('all', null)<\/code> This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.<\/p> Code Example:<\/strong><\/p> SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});<\/code><\/pre> <\/p> 3.6. Set other properties<\/span><\/h2>3.6.1. Set channel name<\/h3> Call setChannel<\/code> method to set the channel name \"_channel\".<\/p> SESDK.setChannel('channel'); <\/code><\/pre>3.6.2. Set referrer page title<\/h3> Call setReferrerTitle<\/code> method to set the referrer page title information \"_referrer_title\".<\/p> SESDK.setReferrerTitle('title'); <\/code><\/pre>3.6.2. Set current page title<\/h3> Call setXcxPageTitle<\/code><\/span> method to set the current page title information \"_page_title<\/span>\".<\/p> SESDK.setXcxPageTitle('title'); <\/code><\/pre>3.7. Get distinct_id & distinct_id_type<\/h2> Call getDistinct<\/code> method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.<\/p> SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n})<\/code><\/pre>distinct_id_type<\/th> Description<\/th><\/tr> 1101 <\/td> openid<\/td><\/tr> 1103<\/td> uuid<\/td><\/tr> Note:<\/strong><\/td> openid > uuid<\/td><\/tr><\/tbody><\/table> <\/p> 4. Event Reporting<\/span><\/h1> After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:<\/p> 1. Preset Events<\/strong>: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.<\/p> 2. Predefined Events<\/strong>: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.<\/p> 3. Custom Events<\/strong>: These events can be custom defined by developers according to their own analytical needs.<\/p> 4. Duration Events<\/strong>: These events track the duration of a specific event.<\/p> Note: <\/strong><\/span><\/p> Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.<\/p> 4.1. Preset events<\/span><\/h2>1) Install<\/span><\/h3> This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.)<\/span><\/p> The _event_name is <\/span>_mpInstall<\/span>.<\/span><\/p> 2) Start<\/span><\/h3> This event is automatically reported every time the Mini Program is opened or brought to foreground from background.<\/p> The _event_name is <\/span>_mpStart<\/span>.<\/span><\/p> 3) End<\/h3> This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p> 4.2. Predefined events<\/h2> 4.2.1. Ad Impression<\/h3> Automatically reported every time an ad gets displayed.<\/span><\/p> SESDK.trackAdImpression(data)<\/code><\/pre>Parameter description:<\/span><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platform (Value: platform name) csj: \u7a7f\u5c71\u7532 China Mainland version pangle: \u7a7f\u5c71\u7532 Non-China-Mainland version tencent: \u817e\u8baf\u4f18\u91cf\u6c47 baidu: \u767e\u5ea6\u767e\u9752\u85e4 kuaishou: \u5feb\u624b oppo: OPPO vivo\uff1avivo mi: \u5c0f\u7c73 huawei: \u534e\u4e3a applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: \u6e38\u53ef\u8d62 fyber: Fyber chartboost: Chartboost adcolony: Adcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adNetworkAppID<\/td> The App ID on monetization platforms.<\/td> String<\/td> no<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> ecpm<\/td> Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted)<\/td> number<\/td> yes<\/td><\/tr> currency<\/td> Revenue Currency Type (following ISO 4217) e.g. CNY, USD<\/td> String<\/td> yes<\/td><\/tr> rendered<\/td> Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.<\/td> Boolean<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.2. Ad Click<\/span><\/h3> Automatically reported when ads are clicked.<\/span><\/p> SESDK.trackAdClick(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> adNetworkPlatform<\/td> Monetization platforms, for example (value: name), csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248 pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248 tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47 baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4 kuaishou\uff1a\u5feb\u624b oppo\uff1aOPPO vivo\uff1avivo mi\uff1a\u5c0f\u7c73 huawei\uff1a\u534e\u4e3a applovin\uff1aApplovin sigmob\uff1aSigmob mintegral\uff1aMintegral oneway\uff1aOneWay vungle\uff1aVungle facebook\uff1aFacebook admob\uff1aAdMob unity\uff1aUnityAds is\uff1aIronSource adtiming\uff1aAdTiming klein\uff1a\u6e38\u53ef\u8d62 fyber\uff1aFyber chartboost\uff1aChartboost adcolony\uff1aAdcolony<\/td> String<\/td> yes<\/td><\/tr> adType<\/td> Ad types: 1\uff1aRewarded Video 2\uff1aSplash 3\uff1aInterstitial 4\uff1aFullscreen Video 5\uff1aBanner 6\uff1aNative 7\uff1aNative Video 8\uff1aBanner (MPU) 9\uff1aInstream Video 10\uff1aMREC 0\uff1aOther<\/td> Number<\/td> yes<\/td><\/tr> adID<\/td> The Placement ID on monetization platforms.<\/td> String<\/td> yes<\/td><\/tr> mediationPlatform<\/td> Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send \"custom\" if no mediation platform is used.<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.3. In-app Purchase<\/span><\/h3> It shall be triggered as users make a purchase.<\/p> SESDK.trackIAP(data)<\/code><\/pre>Parameter description:<\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> orderId<\/td> The order ID generated by the system for this purchase<\/td> String<\/td> no<\/td><\/tr> payAmount<\/td> The amount paid for this purchase (Unit: yuan)<\/td> Number<\/td> yes<\/td><\/tr> currencyType<\/td> The currency type of payment (following ISO 4217)<\/td> String<\/td> yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> no<\/td><\/tr> productID<\/td> Purchased item ID<\/td> String<\/td> no<\/td><\/tr> productName<\/td> Purchased item name<\/td> String<\/td> no<\/td><\/tr> productCount<\/td> Quantity of items purchased<\/td> Number<\/td> no<\/td><\/tr> payStatus<\/td> Payment status 1: success 2: fail<\/td> Number<\/td> yes<\/td><\/tr> failReason<\/td> Reason for payment failure<\/td> String<\/td> no<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The failureReason<\/strong> parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".<\/p> Code Example:<\/strong><\/span><\/p> SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.4. Self-Reported Attribution Results<\/h3> <\/span> This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting <\/span>timing can be customized by developers. (Event Name: \"<\/span>_mpAttr<\/span>\")<\/span><\/p> SESDK.trackAppAttr(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> adNetwork<\/td> Channel ID (should match the channel ID in ROI analysis)<\/td> String<\/td> yes<\/td><\/tr> subChannel<\/td> Sub-channels for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountID<\/td> Ad account ID for advertising<\/td> String<\/td> no<\/td><\/tr> adAccountName<\/td> Ad account name for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignID<\/td> Ad campaign ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCampaignName<\/td> Ad campaign name for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferID<\/td> Ad offer ID for advertising<\/td> String<\/td> no<\/td><\/tr> adOfferName<\/td> Ad offer name for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeID<\/td> Ad creative ID for advertising<\/td> String<\/td> no<\/td><\/tr> adCreativeName<\/td> Ad creative name for advertising<\/td> String<\/td> no<\/td><\/tr> attributionPlatform<\/td> Monitoring Platform<\/td> String<\/td> yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> no<\/td><\/tr><\/tbody><\/table>Sample code:<\/strong><\/p> SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})<\/code><\/pre>4.2.5. In-App Order<\/h3> It shall be triggered as users initiate an order.<\/p> SESDK.trackOrder(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> orderID<\/td> Order ID<\/td> String<\/td> No<\/td><\/tr> payAmount<\/td> The payment amount of the order (Unit: yuan)<\/td> Number<\/td> Yes<\/td><\/tr> currencyType<\/td> The currency type of the order (following ISO 4217)<\/td> String<\/td> Yes<\/td><\/tr> payType<\/td> Payment methods, such as alipay, weixin, applepay, paypal, etc.<\/td> String<\/td> No<\/td><\/tr> status<\/td> Order Status<\/td> String<\/td> Yes<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/span><\/p> SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.6. Registration event<\/span><\/h3> <\/span>It shall be triggered as users register.<\/p> SESDK.trackRegister(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Type<\/th> Required<\/th><\/tr> registerType<\/td> Registration types such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> registerStatus<\/td> Registration status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example:<\/strong><\/p> SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre>4.2.7. Login event<\/span><\/h3> It shall be triggered as users login.<\/p> SESDK.trackLogin(data)<\/code><\/pre>Parameter description:<\/strong><\/p> Parameter Name<\/th> Parameter Meaning<\/th> Data Type<\/th> Required<\/th><\/tr> loginType<\/td> Login type such as \"WeChat\", \"QQ\" and other custom values<\/td> String<\/td> Yes<\/td><\/tr> loginStatus<\/td> Login status such as \"success\"<\/td> String<\/td> No<\/td><\/tr> customProperties<\/td> \/<\/td> Object<\/td> No<\/td><\/tr><\/tbody><\/table>Code Example<\/strong><\/span><\/p> SESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})<\/code><\/pre> <\/p> 4.3. Custom Events<\/span><\/h2> In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs.<\/span><\/p> Developers should name the custom events following the guide below:<\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Code Example:<\/strong><\/span><\/p> SESDK.track('test', {\n one: '1',\n});<\/code><\/pre><\/h2> 4.4. Custom Properties<\/h2> A custom property is an Object where each key-value represents a property.<\/p> Key: Property Name<\/strong><\/span><\/p> String type<\/li> Start with letters only.<\/li> No more than 40 characters.<\/li> Contain numbers, lowercase letters and underscores only.<\/li><\/ul>Value: Property Value<\/strong><\/span><\/p> Support data types like string, number, boolean, and array<\/li> For elements of an array, only string type is supported.<\/li> For other types, they will be forcibly converted to strings and stored.<\/li><\/ul>Custom Property Types<\/strong><\/span><\/p> The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database.<\/p> Data Type<\/th> Description<\/th> Example<\/th><\/tr> number<\/td> Range from -9E15 to 9E15, without quotation marks.<\/td> 1234, 12.34<\/td><\/tr> string<\/td> Limit 2KB. Numbers with quotation marks will also be identified as strings.<\/td> \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\"<\/td><\/tr> date<\/td> \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\"<\/td> \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\"<\/td><\/tr> boolean<\/td> True or false without quotation marks.<\/td> true, false<\/td><\/tr> array<\/td> All elements in an array will be converted into strings.<\/td> [\"a\",\"1\",\"true\"]<\/td><\/tr><\/tbody><\/table>Note:<\/strong><\/span><\/p> The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.<\/p> 4.5. Duration Events<\/span><\/h2> If you need to record the duration of an event, c<\/span>all the <\/span>eventStart(eventName)<\/code> to start timing, and configure the event namet. When the event comes to an end, you need to call <\/span>eventFinish(event name, data)<\/code><\/span>, and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.<\/span><\/p> SESDK.eventFinish('testEvent', {\n one: '1',\n});<\/code><\/pre> When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.<\/p> <\/p> 5. Set User Property<\/span><\/h1>SolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.<\/p> It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.<\/p> User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.<\/p> Note:<\/strong><\/p> The format requirements of user properties are consistent with those of event properties.<\/p> 5.1. userInit<\/span><\/h2> If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.<\/p> Code Example<\/strong><\/p> SESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});<\/code><\/pre>5.2. userUpdate<\/h2> <\/span>For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});<\/code><\/pre>5.3. userAdd<\/h2> If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAdd({\n age: 1, \/\/ cusom property\n});<\/code><\/pre>Note:<\/strong><\/span><\/p> The value called by userAdd only allows Number type.<\/p> 5.4. userUnset<\/span><\/h2> When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute <\/span>will not<\/strong><\/span> be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userUnset([\"age\"]);<\/code><\/pre> The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.<\/span><\/p> 5.5. userAppend<\/span><\/h2> You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});<\/code><\/pre>5.6. userDelete<\/h2> You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.<\/span><\/p> Code Example<\/strong><\/p> SESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId');<\/code><\/pre>Parameter Name<\/th> Parameter Type<\/th> Required<\/th><\/tr> deleteType<\/td> userDeleteByAccountId: Delete a user by Account ID userDeleteByVisitorId: Delete a user by Visitor ID<\/td> Yes<\/td><\/tr><\/tbody><\/table> <\/p> Changelog<\/h1>2026-06-10<\/strong><\/p> Support TikTok Mini Game<\/li><\/ul>","pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We provide both fixed analysis reports and highly customizable data analytics services, allowing developers to personalize configurations across multiple aspects, including data tracking, property settings, report creation, and dashboard configuration.Privacy Policy: \u00a0https:\/\/www.solar-engine.com\/privacyPolicyEN.html 2. Before you start2.1. Get User CodeAccess Path: Account Management - Account Profile - Secret - User Code2.2. Get AppKey \u00a0 \u00a0 \u00a0 Access Path: Asset Management - App Management - AppKey2.3. Obtain SDKDownload SDK (UMD and ES packages provided) : \u00a0 \u00a0 \u00a0https:\/\/sdk.solar-engine.com\/TikTok\/SolarEngine-TikTok-US-SDK-1.3.3.zip \u00a02.4. Configure TikTok Open PlatformGet AppID and AppSecret \u00a0 \u00a0 \u00a0Log in to\u300cTikTok Open Platform\u300dand go to the homepage > Developer Portal > Select your Mini Game > Basic Information > Credentials. Then copy the \"Client key\" and \"Client Secret\", and paste them into SolarEngine. \u00a0 \u00a0 \u00a0TikTok Open Platform: \u00a0 \u00a0 \u00a0SolarEngine Platform:Server Domain Configuration \u00a0 \u00a0 \u00a0Log in to\u300cTikTok Open Platform\u300dand go to the homepage > Development configuration > Security > Add domian, and enter the following domains to complete the configuration (see example screenshot):https:\/\/vg-api-receiver.detailroi.comhttps:\/\/vg-rule.detailroi.com 3. Initialize the SDK3.1. SDK initialization \u00a0 \u00a0It is recommended to import and initialize SDK in the entry JS file of your Mini Game project to ensure data accuracy. Before initializing the SDK, you need to perform pre-initialization by calling the prevInit method and passing in the appKey. \u00a0 \u00a0Note: The SDK should only be imported once in one Mini Game. After importing the SDK in app.js, it is recommended to mount it to the global scope (e.g. globalThis) for use elsewhere.Import the ES format file for ES Modules environments; otherwise, use the UMD format.\/\/ game.js\nimport SESDK from '.\/minitiktok-us-sesdk-es.js';\n\n\/\/ Some platforms only support CommonJS imports, in which case please use require. \n\/\/ const SESDK = require('.\/minitt-cn-sesdk-umd.js')\n\n\/\/ Pre-initialization\nSESDK.prevInit('appKey'); \n\/\/ Initialization\nSESDK.init(initParams);\n\/\/ Mount to global (e.g. globalThis) for use elsewhere\nglobalThis.SESDK = SESDK;initParams parameter description: Parameter Type Required Description userId string YES UserCode obtained above appKey string YES AppKey obtained above openid string No Obtain the Open ID from TikTok first, then pass it to the SE SDK during initialization. config Config No Initialization related configConfig parameter description: Parameter Type Required Description debugModel boolean NO Whether to enable the debugging mode (Default false) logEnabled boolean NO Whether the console prints SDK logs (Default false)Sample CodeSESDK.prevInit('666666');\nSESDK.init({\n appKey: '666666',\n userId: '888888',\n openid: 'xxxxxxxxxxx',\n config: {\n logEnabled: true,\n },\n}); \u00a0 \u00a0Since the SDK initialization logic runs asynchronously, if your business logic needs to be executed after SDK initialization is complete, you may call the ready method.SESDK.ready(callback); \u00a0 \u00a0During SDK initialization, if you need to load SDK plugins, you may call the use method.SESDK.use(sdkPlugin);3.2. Visitor ID \u00a0 \u00a0 \u00a0 Visitor ID refers to the user's unique identifier (_visitor_id) after install and before login. \u00a0 \u00a0 \u00a0 We provide an interface for developers to customize the visitor ID. If you have your own visitor management system and need to replace SolarEngine's visitor ID, you must set it before SDK initialization. \u00a0 \u00a0 \u00a0 Only the last visitor ID passed in will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple visitor IDs are reported consecutively.Set visitor ID \u00a0 \u00a0 \u00a0 \u00a0Call setVisitorID to set the visitor ID:SESDK.setVisitorId('vid8709901241')Note: This call only passes the visitor ID to SDK and does not report user setting events. The length of the visitor ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain visitor ID \u00a0 \u00a0Call getVisitorId to get the current visitor ID:SESDK.getVisitorId()3.3. Account ID \u00a0 \u00a0 \u00a0 \u00a0Account ID refers to the unique identifier for users who finished login within the app. Prior to login, the visitor ID will be used as the user identifier. \u00a0 \u00a0 \u00a0 Once the account ID is set, it will be retained permanently until the logout method is called to clear the account ID. The logout method should only be called when users actually log out, but no need to be called when the app is closed or running in the background. \u00a0 \u00a0 \u00a0 Only the last passed account ID will be used for data reporting. Multiple calls should be avoided to prevent abnormal situations where multiple abnormal account IDs are reported consecutively.Set Account ID \u00a0 \u00a0 \u00a0 Call login to set the user's account ID:SESDK.login('aid25491084');Note: This call only passes the account ID to SDK and does not report user login events. The account ID set by the developer cannot exceed 128 characters, otherwise the setting will fail. Once set by the developer, it will be stored in local storage.Obtain account ID \u00a0 \u00a0 \u00a0 \u00a0Call getAccountId to get the user's account ID:SESDK.getAccountId();Clear account ID \u00a0 \u00a0 \u00a0 \u00a0Call logout to clear the account ID:SESDK.logout();Note: \u00a0 \u00a0 \u00a0 \u00a0This call only notifies the SDK to clear the account ID and will not report the user logout event.3.4. Public event properties \u00a0 \u00a0 \u00a0 Public event properties are included in every event, such as the user's source channel and the advertising ID associated with conversions. \u00a0 \u00a0 \u00a0 You can call setSuperProperties function to set public event properties. We recommend you setting the public event properties before sending any events. \u00a0 \u00a0 \u00a0 The format of public event properties are the same as custom properties --> 4.4 Custom PropertiesSESDK.setSuperProperties({\n key: value\n}); \u00a0 \u00a0 \u00a0 \u00a0If you need to delete a public event property, you can call unsetSuperProperty to clear one of them.SESDK.unsetSuperProperty(key); \u00a0 \u00a0 \u00a0 \u00a0If you want to clear all public event properties, you can call clearSuperProperties .SESDK.clearSuperProperties();Note:If you call setSuperProperties to upload public event properties that have been set previously, the new values will overwrite the existing ones.If a property key in a normal event is the same as a public event property key, the normal event property will override the public event property.Once set by the developer, these properties will be stored in local storage.3.5. Preset event properties \u00a0 \u00a0The SolarEngine SDK supports developers to set custom properties for the two preset events: install, and app open.SESDK.setPresetEvent(eventType, properties); Parameter Description Parameter Type Required eventType e.g.mpInstallmpStartmpEnd all (all preset events) string YES properties Custom properties object NONote:Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set later, the preset events generated before setting will not include these custom properties.Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.If the enumeration for eventType is set to all, it will overwrite the custom properties set in webInstall and webStart enumerations. If set multiple times, only the last setting takes effect.Custom properties set for preset events can be cleared by calling the corresponding enumeration, as shown below:SESDK.setPresetEvent('webInstall', null) \u00a0This method can be used to clear webInstall custom properties, while webStart custom properties can be cleared by changing to the corresponding enumeration value.Additionally, SolarEngine SDK supports globally clearing custom properties for all preset events, as shown below:SESDK.setPresetEvent('all', null) \u00a0This method clears the custom properties for all preset events, including those set via the webInstall and webStart enumerations.Code Example:SESDK.setPresetEvent('webInstall', {\n k1: 'v1',\n k2: 'v2'\n});3.6. Set other properties3.6.1. Set channel name \u00a0 \u00a0 \u00a0 \u00a0Call setChannel method to set the channel name \"_channel\".SESDK.setChannel('channel'); 3.6.2. Set referrer page title \u00a0 \u00a0 \u00a0 \u00a0Call setReferrerTitle method to set the referrer page title information \"_referrer_title\".SESDK.setReferrerTitle('title'); 3.6.2. Set current page title \u00a0 \u00a0 \u00a0 \u00a0Call setXcxPageTitle method to set the current page title information \"_page_title\".SESDK.setXcxPageTitle('title'); 3.7. Get distinct_id & distinct_id_type \u00a0 \u00a0 \u00a0 \u00a0Call getDistinct method to retrieve distinct_id and distinct_id_type. This method returns a Promise object.SESDK.getDistinct().then(data => {\n \/\/ data.result.distinct_id\n \/\/ data.result.distinct_id_type\n}) distinct_id_type Description 1101 openid 1103 uuid Note: openid > uuid4. Event Reporting \u00a0 After SDK is initialized, you can call the following methods to report other event data, which can be categorized into the following four types:1. Preset Events: These events are triggered and reported automatically by the SDK according to preset rules. They have specific _event_name such as webInstall, webStart.2. Predefined Events: These events have predefined definitions and event names in the system. They require developers to report data when those events are triggered, such as in-app ad impression, in-app purchase, etc.3. Custom Events: These events can be custom defined by developers according to their own analytical needs.4. Duration Events: These events track the duration of a specific event.Note: Event name supports uppercase and lowercase English characters, numbers, and underscores. Limit 40 characters.4.1. Preset events1) Install \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported when users first open Mini Program. (If a user deletes the Mini Program and opens again, it will count as a new install.) \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpInstall.2) Start \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is opened or brought to foreground from background. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpStart.3) End \u00a0 \u00a0 \u00a0 \u00a0This event is automatically reported every time the Mini Program is brought to background from foreground. \u00a0 \u00a0 \u00a0 \u00a0The _event_name is _mpEnd.4.2. Predefined events4.2.1. Ad Impression \u00a0 \u00a0 \u00a0 \u00a0Automatically reported every time an ad gets displayed.SESDK.trackAdImpression(data)Parameter description: Parameter Name Parameter Meaning Data Type Required adNetworkPlatform Monetization platform (Value: platform name)csj: \u7a7f\u5c71\u7532 China Mainland versionpangle: \u7a7f\u5c71\u7532 Non-China-Mainland versiontencent: \u817e\u8baf\u4f18\u91cf\u6c47baidu: \u767e\u5ea6\u767e\u9752\u85e4kuaishou: \u5feb\u624boppo: OPPOvivo\uff1avivomi: \u5c0f\u7c73huawei: \u534e\u4e3aapplovin: AppLovinsigmob: Sigmobmintegral:Mintegraloneway: OneWayvungle: Vunglefacebook: Facebookadmob: AdMobunity: UnityAdsis: IronSourceadtiming: AdTimingklein: \u6e38\u53ef\u8d62fyber: Fyberchartboost: Chartboostadcolony: Adcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adNetworkAppID The App ID on monetization platforms. String no adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes ecpm Advertising eCPM (revenue per thousand ad impressions, 0 or negative means no data transmitted) number yes currency Revenue Currency Type (following ISO 4217)e.g. CNY, USD String yes rendered Whether the ad is rendered successfully.YES: successNO: Failed.If you do not need to pass in this indicator, please pass YES. Boolean yes customProperties \/ Object noCode Example:SESDK.trackAdImpression({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adNetworkAppID: '123',\n adId: '123',\n mediationPlatform: 'custom',\n ecpm: 13.140001,\n currency: 'USD',\n rendered: true,\n customProperties: {\n one: '1',\n }\n})4.2.2. Ad Click \u00a0 \u00a0Automatically reported when ads are clicked.SESDK.trackAdClick(data)Parameter description: Parameter Name Parameter Meaning Data Type Required adNetworkPlatform Monetization platforms, for example (value: name),csj\uff1a\u7a7f\u5c71\u7532\u56fd\u5185\u7248pangle\uff1a\u7a7f\u5c71\u7532\u56fd\u9645\u7248tencent\uff1a\u817e\u8baf\u4f18\u91cf\u6c47baidu\uff1a\u767e\u5ea6\u767e\u9752\u85e4kuaishou\uff1a\u5feb\u624boppo\uff1aOPPOvivo\uff1avivomi\uff1a\u5c0f\u7c73huawei\uff1a\u534e\u4e3aapplovin\uff1aApplovinsigmob\uff1aSigmobmintegral\uff1aMintegraloneway\uff1aOneWayvungle\uff1aVunglefacebook\uff1aFacebookadmob\uff1aAdMobunity\uff1aUnityAdsis\uff1aIronSourceadtiming\uff1aAdTimingklein\uff1a\u6e38\u53ef\u8d62fyber\uff1aFyberchartboost\uff1aChartboostadcolony\uff1aAdcolony String yes adType Ad types:1\uff1aRewarded Video2\uff1aSplash3\uff1aInterstitial4\uff1aFullscreen Video5\uff1aBanner6\uff1aNative7\uff1aNative Video8\uff1aBanner (MPU)9\uff1aInstream Video10\uff1aMREC0\uff1aOther Number yes adID The Placement ID on monetization platforms. String yes mediationPlatform Mediation platforms commonly used:maxironsourceadmobhyperbidtoponcasTradplusTobidIf your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters.Send \"custom\" if no mediation platform is used. String yes customProperties \/ Object noCode ExampleSESDK.trackAdClick({\n adNetworkPlatform: 'oppo',\n adType: 1,\n adId: '123',\n mediationPlatform: 'custom',\n customProperties: {\n one: '1',\n }\n})4.2.3. In-app Purchase \u00a0 \u00a0 It shall be triggered as users make a purchase.SESDK.trackIAP(data)Parameter description: Parameter Name Parameter Meaning Type Required orderId The order ID generated by the system for this purchase String no payAmount The amount paid for this purchase (Unit: yuan) Number yes currencyType The currency type of payment (following ISO 4217) String yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String no productID Purchased item ID String no productName Purchased item name String no productCount Quantity of items purchased Number no payStatus Payment status1: success2: fail Number yes failReason Reason for payment failure String no customProperties \/ Object noNote:The failureReason parameter should only be passed in when payStatus is 2 (fail). For other statuses, simply pass \"\".Code Example:SESDK.trackIAP({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n productID: '12345678',\n productName: 'this is product name',\n productCount: 10,\n payStatus: 1,\n failReason: 'this is fail reason',\n customProperties: {\n one: '1',\n }\n})4.2.4. Self-Reported Attribution Results \u00a0 \u00a0 \u00a0This feature allows developers to send attribution data from a third-party or self-attribution platform to SolarEngine. The reporting timing can be customized by developers. (Event Name: \"_mpAttr\")SESDK.trackAppAttr(data)Parameter description: Parameter Name Parameter Meaning Type Required adNetwork Channel ID (should match the channel ID in ROI analysis) String yes subChannel Sub-channels for advertising String no adAccountID Ad account ID for advertising String no adAccountName Ad account name for advertising String no adCampaignID Ad campaign ID for advertising String no adCampaignName Ad campaign name for advertising String no adOfferID Ad offer ID for advertising String no adOfferName Ad offer name for advertising String no adCreativeID Ad creative ID for advertising String no adCreativeName Ad creative name for advertising String no attributionPlatform Monitoring Platform String yes customProperties \/ Object noSample code:SESDK.trackAppAttr({\n adNetwork: '123456',\n subChannel: '123456',\n adAccountID: '123456',\n adAccountName: '123456',\n adCampaignID: '123456',\n adCampaignName: '123456',\n adOfferID: '123456',\n adOfferName: '123456',\n adCreativeID: '123456',\n adCreativeName: '123456',\n attributionPlatform: '123456',\n customProperties: {\n \tone: '1',\n }\n})4.2.5. In-App Order \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users initiate an order.SESDK.trackOrder(data)Parameter description: Parameter Name Parameter Meaning Type Required orderID Order ID String No payAmount The payment amount of the order (Unit: yuan) Number Yes currencyType The currency type of the order (following ISO 4217) String Yes payType Payment methods, such as alipay, weixin, applepay, paypal, etc. String No status Order Status String Yes customProperties \/ Object NoCode Example:SESDK.trackOrder({\n orderId: '12345678',\n payAmount: 1234.5678,\n currencyType: 'USD',\n payType: 'alipay',\n status: 'this is fail status',\n customProperties: {\n one: '1',\n }\n})4.2.6. Registration event \u00a0 \u00a0 \u00a0 \u00a0It shall be triggered as users register.SESDK.trackRegister(data)Parameter description: Parameter Name Parameter Meaning Type Required registerType Registration types such as \"WeChat\", \"QQ\" and other custom values String Yes registerStatus Registration status such as \"success\" String No customProperties \/ Object NoCode Example:SESDK.trackRegister({\n regType: 'WeChat',\n registerStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.2.7. Login event \u00a0 \u00a0 \u00a0 It shall be triggered as users login.SESDK.trackLogin(data)Parameter description: Parameter Name Parameter Meaning Data Type Required loginType Login type such as \"WeChat\", \"QQ\" and other custom values String Yes loginStatus Login status such as \"success\" String No customProperties \/ Object NoCode ExampleSESDK.trackLogin({\n loginType: 'WeChat',\n loginStatus: 'success',\n customProperties: {\n one: '1',\n }\n})4.3. Custom Events \u00a0 \u00a0 \u00a0 \u00a0In addition to the clearly predefined events listed above, developers can report custom events according to their own analysis needs. \u00a0 \u00a0 \u00a0 \u00a0Developers should name the custom events following the guide below:String typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Code Example:SESDK.track('test', {\n one: '1',\n});4.4. Custom Properties \u00a0 \u00a0 \u00a0 \u00a0A custom property is an Object where each key-value represents a property.Key: Property NameString typeStart with letters only.No more than 40 characters.Contain numbers, lowercase letters and underscores only.Value: Property ValueSupport data types like string, number, boolean, and arrayFor elements of an array, only string type is supported.For other types, they will be forcibly converted to strings and stored.Custom Property Types \u00a0 \u00a0 \u00a0 \u00a0The data type of custom event properties is determined by their data types reported for the first time and cannot be changed once confirmed. For subsequent reporting of the same properties, only properties with the same data types as the first time will be stored in the database. Data Type Description Example number Range from -9E15 to 9E15, without quotation marks. 1234, 12.34 string Limit 2KB. Numbers with quotation marks will also be identified as strings. \"dashen\", \"\u5317\u4eac\", \"1234\", \"true\" date \"yyyy-MM-dd HH:mm:ss.SSS\", \"yyyy-MM-dd HH:mm:ss\", or \"yyyy-MM-dd 00:00:00\" \"2023-03-01 12:34:56\",\"2023-03-01 12:34:56.789\",\"2023-03-01 00:00:00\" boolean True or false without quotation marks. true, false array All elements in an array will be converted into strings. [\"a\",\"1\",\"true\"]Note: \u00a0 The data type of the property determines their analysis logic available in analysis models. For example, the numerical type can perform calculations such as maximum value, minimum value, and sum, while the Boolean type can perform calculations of true and false values. Therefore, when determining the format of data reporting, you need to consider the analysis scenarios and business needs and formulate a complete event tracking plan as directions.4.5. Duration Events \u00a0 \u00a0 \u00a0 \u00a0If you need to record the duration of an event, call the eventStart(eventName) to start timing, and configure the event namet. When the event comes to an end, you need to call eventFinish(event name, data), and a \"_duration\" property will automatically be added for this event (unit: millisecond). It should be noted that there can only be one timing task for the same event.SESDK.eventFinish('testEvent', {\n one: '1',\n}); \u00a0 \u00a0 \u00a0 \u00a0When reporting the preset event _appEnd, the SDK will automatically report the duration timed from the previous _appStart. In other words, you do not need to manually configure the start time for the exit event; the duration will be assigned by default.5. Set User PropertySolarEngine provides multiple methods for reporting user properties. You can use these methods to add or modify user properties.It is recommended for you to select properties that change infrequently or hold significant value, for example, age, game level, location, first payment time and total payment amount. Other properties with higher change frequency can be reported and recorded through events.User property settings can be set by calling userUpdate, userInit, userAdd, userUnset, userAppend, or userDelete.Note: \u00a0 \u00a0 \u00a0 The format requirements of user properties are consistent with those of event properties.5.1. userInit \u00a0 \u00a0 \u00a0 \u00a0If you want to upload a batch of user attributes, among which the existing user attributes will not update their values, and the non-existing attributes will be created and saved, you can call userInit to set them.Code ExampleSESDK.userInit({\n regtime: \"2021-03-01 12:34:56.789\", \/\/ cusom property\n rolename: \"engineer\", \/\/ cusom property\n age: 29, \/\/ cusom property\n});5.2. userUpdate \u00a0 \u00a0 \u00a0 \u00a0For general user attributes, you can call userUpdate to set them. The attributes uploaded in this way will overwrite the original attribute values. If the user attribute does not exist before, it will be created, and the data type will follow the value passed in.Code ExampleSESDK.userUpdate({\n rolename: \"leader\", \/\/ cusom property\n});5.3. userAdd \u00a0 \u00a0 \u00a0 \u00a0If you want to report a numeric attribute and accumulate its values, you can call userAdd. If the attribute has not been set, it will be assigned a value of 0 and then calculated. You can pass in a negative value, which is equivalent to a subtraction operation.Code ExampleSESDK.userAdd({\n age: 1, \/\/ cusom property\n});Note: \u00a0 The value called by userAdd only allows Number type.5.4. userUnset \u00a0 \u00a0 \u00a0 \u00a0When you want to clear the user attribute values of a user, you can call userUnset to clear the specified attributes (string array). If the attribute has not been created in the array, the attribute will not be created.Code ExampleSESDK.userUnset([\"age\"]); \u00a0 \u00a0 \u00a0 \u00a0The parameter passed in by userUnset is the attribute name of the user attribute, and the type is a string array.5.5. userAppend \u00a0 \u00a0 \u00a0 \u00a0You can call userAppend to append user attributes of array type. If the attribute does not exist, it will be created.Code ExampleSESDK.userAppend({\n location: [\"BeiJing\"], \/\/ cusom property\n});5.6. userDelete \u00a0 \u00a0 \u00a0 \u00a0You can call userDelete to delete users. After a user is deleted, you will no longer be able to query the user's user attributes, but the events generated by the user can still be queried.Code ExampleSESDK.userDelete(deleteType);\n\n\/\/ Delete user by AccountId\nSESDK.userDelete('userDeleteByAccountId'); \n\n\/\/ Delete user by VisitorId\nSESDK.userDelete('userDeleteByVisitorId'); Parameter Name Parameter Type Required deleteType userDeleteByAccountId: \u00a0Delete a user by Account ID userDeleteByVisitorId: \u00a0Delete a user by Visitor ID YesChangelog2026-06-10Support TikTok Mini Game","is_draft":"0","editor_type":"1","file_path":"","add_time":"1789638409","update_time":"1789893762"},"pure_content":"1. SDK Basic InformationSolarEngine (SE) is an all-in-one mobile app growth analytics and data intelligence platform, designed to assist developers to monitor every stage of business development. We p"}],"content":{"icon":"","desc":"","content_id":"942813","add_time":"1789637561","update_time":"1789637561","content":"","is_traffic_less":"0","file_type":""},"hot_list":[],"user_read_num":"0","is_auth":"0"},"msg":"Success","code":200}

3) End<\/h3>
This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

<\/h2>

6. Channel SDK Compatibility Guide<\/h1>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p><\/p>

3) End<\/h3> This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

<\/h2>

2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p><\/p>

3) End<\/h3> This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

<\/h2>

6. Channel SDK Compatibility Guide<\/h1>

2.1. Get User Code<\/h2>Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p><\/p>

3) End<\/h3> This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p> The _event_name is _mpEnd<\/span>.<\/p>

4.2. Predefined events<\/h2>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Game is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>

2.1. Get User Code<\/h2>
Access Path<\/strong>: Account Management - Account Profile - Secret - User Code<\/p>
$\"\"$ <\/p>

3) End<\/h3>
This event is automatically reported every time the Mini Program is brought to background from foreground.<\/p>
The _event_name is _mpEnd<\/span>.<\/p>