Web SDK
1. Function Overview
In order to reduce the trouble for developers to update the application version frequently, the SolarEngine introduces online parameter functionality. By delivering parameters, the values of parameters in the application can be adjusted remotely at any time, allowing for application content updates without requiring a new release.
When using the online parameter SDK plug-in, it depends on the Web SDK .
2. Before you start
Before officially starting data access, there are some parameters and SDK packages required. Follow the directions below to get prepared.
Step 1: Get User Code & AppKey
See the Web SDK integration documentation for details.
Step 2: Obtain Online Parameter SDK Plug-in
Click the link below to download the online parameter SDK plug-in package.
https://sdk.solar-engine.com/webabtest/SolarEngine-webabtest-SDK-1.3.0.zip
3. Integrate the SDK
3.1 SDK Initialization
Since the Parameter Delivery SDK is a plugin of the SolarEngine SDK, the initialization of the Parameter Delivery SDK depends on the SolarEngine SDK. Please refer to the Android SDK integration documentation for specific details.
The SDK is built in UMD mode and supports multiple loading methods. Common loading methods are listed below:
import SESDK from './web-sesdk.js'
import webabtestPlugin from './sesdk-webabtest-plugin.js';
// Load online parameter SDK plug-in
SESDK.use(webabtestPlugin);
// Pre-initialization
SESDK.prevInit(appKey);
// SDK initialization
SESDK.init(initParams);<script src="./web-sesdk.js"></script>
<script src="./sesdk-webabtest-plugin.js"></script>
// Load online parameter SDK plug-in
window.SESDK.use(window.webabtestPlugin);
// Pre-initialization
window.SESDK.prevInit(appKey);
// SDK initialization
window.SESDK.init(initParams);initParams parameter description:
| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| userId | User Code obtained in preparation | String | YES |
| appKey | AppKey obtained in preparation | String | YES |
| config | Initialization related configuration | Config | NO |
Config parameter description:
| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| remoteConfig | Online parameters & A/B test configuration | RemoteConfig | NO |
| multilinkTestConfig | Multi-link test configuration | MultilinkTestConfig | NO |
RemoteConfig parameter description:
| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| enable | Whether to initialize the online parameter SDK (Default false) | boolean | NO |
| mergeType | Server and SDK merge type 0: Use the server configuration to merge with the user's local cache configuration. 1: Use the server configuration to merge with the user's default configuration | number | NO |
| customIDProperties | Custom ID, matches the custom ID set by the user in the background | object | NO |
| customIDEventProperties | Custom ID event property value, matches the custom ID event attribute value set by the user in the background. | object | NO |
| customIDUserProperties | Custom ID user property value, matches the user attribute value set by the user in the background. | object | NO |
| pollingInterval | Polling interval (unit: minutes), interval: 30 minutes-720 minutes, default 30 minutes | number | NO |
| requestTimeout | Timeout for requesting configuration plug-in (Default 60*1000 milliseconds) | number | NO |
Multi-linkTestConfig parameter description:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| enable | boolean | NO | Whether to initialize the multi-link test SDK (default false) |
| maskTimeoutCloseTime | number | NO | The timeout of multi-link test config request (default 500 milliseconds, minimum 200 milliseconds) |
| isSetMask | boolean | NO | Whether to add a mask layer to the test page and prevent user operations before requesting a multi-link test configuration response. (default true). If you enable the mask layer, you need to put the SDK initialization logic in the head tag of the page, otherwise the page will flicker . |
| customIDProperties | object | NO | Custom ID, matches the custom ID set by the user in the background |
| customIDEventProperties | object | NO | Custom ID event property value, matches the custom ID event attribute value set by the user in the background. |
| customIDUserProperties | object | NO | Custom ID user property value, matches the user attribute value set by the user in the background. |
| requestTimeout | number | NO | Timeout for requesting configuration plug-in (Default 60*1000 milliseconds) |
Call example:
SESDK.init({
appKey: '666666',
userId: '888888',
config: {
debugModel: true,
remoteConfig: {
pollingInterval: 30,
enable: true,
mergeType: 1,
customIDProperties: { a: 1 },
customIDEventProperties: { e: 1 },
customIDUserProperties: { u: 1 },
},
multilinkTestConfig: {
enable: true,
isSetMask: true,
maskTimeoutCloseTime: 500,
customIDProperties: { a: 1 },
customIDEventProperties: { e: 1 },
customIDUserProperties: { u: 1 },
},
},
});3.2 A/B Testing & Online Parameter
1) Set Default Configuration
Developers who use parameters to deliver the SDK need to preset a default configuration into the App through the API. The SDK uses this default configuration as an alternative.
Method example:
SESDK.setRemoteDefaultConfig(defaultConfig)| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| defaultConfig | The default configuration passed by the developer | Array<object> | Yes |
defaultConfig example:
// defaultConfig defaultConfig default configuration. Each parameter configuration is an object, formatted as follows:
SESDK.setRemoteDefaultConfig([
{
name : "k1", // Name of the configuration item, corresponding to the parameter key of the fastFetchRemoteConfig interface
type : 1, // Type of the configuration item: 1 for string, 2 for number, 3 for boolean, 4 for json
value : "v1", // Value of the configuration item
}
]); 2) Set Custom Event Properties
Developers can set custom attributes for events, and the parameter delivery SDK will bring this attribute when requesting server configuration for server-side parameter matching.
Method example:
SESDK.setRemoteConfigEventProperties(properties)Note: It must be set before SDK initialization.
| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| properties | Custom event properties | object | Yes |
Call example:
SESDK.setRemoteConfigEventProperties({
k1: v1,
k2: v2
}); 3) Set Custom User Properties
Developers can set custom attributes for users. The parameter delivery SDK will bring this attribute when requesting server configuration for server-side parameter matching.
Method example:
SESDK.setRemoteConfigUserProperties(properties)| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| properties | Custom user properties | object | Yes |
Call example:
SESDK.setRemoteConfigUserProperties({
k1: v1,
k2: v2
});4) Obtain Online Parameter Configuration
The parameter delivery SDK provides two methods for retrieving parameter configuration: synchronous and asynchronous.
- Synchronous: Developers can directly obtain the result by calling the corresponding method.
- Asynchronous: The result needs to be obtained after the callback is completed.
Note:
When retrieving parameters synchronously or asynchronously, the SDK will trigger an event to report which experiment the user is assigned to. Therefore, it is recommended to retrieve parameters when the user reaches the experimental scenario (retrieving parameters signifies that the user has reached the experimental scenario and entered the experiment associated with that parameter). Please refrain from retrieving parameters prematurely.
Synchronously obtain online parameter configuration
Method example:
SESDK.fastFetchRemoteConfig(key);Note: It must be obtained after the SDK. The SESDK.ready method can be called to determine whether the SDK has completed initialization.
| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| key | Parameter delivery key, corresponds to the parameter key configured by the user in the background. | String | Yes |
Return value type: id
Call example:
SESDK.ready(function(){
const v = SESDK.fastFetchRemoteConfig("k1");
// Operations after getting the value
})Asynchronously obtain online parameter configuration
Method example:
SESDK.asyncFetchRemoteConfig(key); //Return Promise| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| key | Parameter delivery key, corresponds to the parameter key configured by the user in the background. | String | Yes |
Call example:
SESDK.asyncFetchRemoteConfig("k1").then(function(value){
// Operations after getting the value
})4. Multi-Link Test
4.1 Set Custom Event Properties
Developers can set custom attributes for events, and the parameter delivery SDK will bring this attribute when requesting server configuration for server-side parameter matching.
Method example:
SESDK.setMultilinkTestEventProperties(properties)Note: It must be set before SDK initialization.
| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| properties | Custom event properties | object | Yes |
Call example:
SESDK.setRemoteConfigEventProperties({ k1: v1, k2: v2 }); 4.2 Set Custom User Properties
Developers can set custom attributes for users. The parameter delivery SDK will bring this attribute when requesting server configuration for server-side parameter matching.
Method example:
SESDK.setMultilinkTestUserProperties(properties)| Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
|---|---|---|---|
| properties | Custom user properties | object | Yes |
Call example:
SESDK.setMultilinkTestUserProperties({
k1: v1,
k2: v2
});————————————
SDK Update Log
2025-03-14 1.3.0
• Align with the main SDK version
2025-03-13 1.2.9
• Align with the main SDK version
2025-02-13 1.2.8
• Align with the main SDK version
2025-01-03 1.2.7
• Align with the main SDK version
2024-12-10 1.2.4
• Align with the main SDK version
2024-11-29 1.2.3
• Align with the main SDK version
2024-11-11 1.2.2
• Align with the main SDK version
2024-10-31 1.2.1
•Align with the main SDK version
2024-09-26 1.2.0
• Align with the main SDK version
2024-08-14 1.1.9
• Align with the main SDK version
2024-05-22 1.1.8
• Align with the main SDK version
2024-04-22 1.1.7
• Align with the main SDK version
2024-04-16 1.1.6
• Align with the main SDK version
2024-04-01 1.1.5
• Align with the main SDK version
2024-03-15 1.1.4
• Request to add parameters for A/B testing
2024-03-01 1.1.3
• Fix initialization parameter issue in A/B testing.
2024-01-22 1.1.2
• Align with the main SDK version
2023-12-06 1.1.1
- Incident reporting online verification
2023-11-02 1.1.0
- Align with the main SDK version
2023-08-16 1.0.6
- Event reporting and offline verification
2023-08-08 1.0.5
- Add multi-link test
2023-07-31 1.0.4
- Optimize the offload event logic
2023-06-01 1.0.3
- Add Setting service
2023-03-30 1.0.1
- The plug-in logic is compatible with the debugModel debugging mode of the main SDK
2023-03-20 1.0.0
- First version of online parameter SDK
- Support online parameter function
- Support AB testing function
- Add internal log management to online parameters
;}.cls-2{fill:%230868f7;}.cls-3{fill:url(%23未命名的渐变_44);}.cls-4{fill:%23333;}%3c/style%3e%3clinearGradient%20id='未命名的渐变_8'%20x1='33.73'%20y1='100.61'%20x2='-0.03'%20y2='-1.06'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%237ae9fb'/%3e%3cstop%20offset='0.67'%20stop-color='%232b90f8'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3clinearGradient%20id='未命名的渐变_44'%20x1='27.86'%20y1='18.67'%20x2='68.36'%20y2='22.22'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%235ac7f2'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3c/defs%3e%3cpath%20class='cls-1'%20d='M29,28.74V81.91l-9.51-3.68v0L8.52,74A7.17,7.17,0,0,1,4,67.32V24.54A3.76,3.76,0,0,1,9.08,21Z'/%3e%3cpath%20class='cls-2'%20d='M68.09,78.07a13.15,13.15,0,0,1-17.9,12.06L29,81.91h0V28.74L50.19,37A13.17,13.17,0,0,0,68.08,25.3h0Z'/%3e%3cpath%20class='cls-3'%20d='M68.08,25.3a13.19,13.19,0,0,1-6.73,10.87A13.09,13.09,0,0,1,50.19,37L29,28.74V6A3.76,3.76,0,0,1,34.1,2.52l25.59,9.91A13.22,13.22,0,0,1,68.08,25.3Z'/%3e%3cpath%20class='cls-4'%20d='M129.06,81.76a4.33,4.33,0,0,1-3.19-1.31,4.4,4.4,0,0,1-1.31-3.24V56.86H97.65V77.21a4.36,4.36,0,0,1-1.35,3.2A4.68,4.68,0,0,1,93,81.76a4.32,4.32,0,0,1-3.19-1.31,4.37,4.37,0,0,1-1.32-3.24V27.27A4.58,4.58,0,0,1,89.83,24a4.59,4.59,0,0,1,7.82,3.27V48.15h26.91V27.27A4.58,4.58,0,0,1,125.91,24a4.59,4.59,0,0,1,7.82,3.27V77.21a4.37,4.37,0,0,1-1.36,3.2A4.65,4.65,0,0,1,129.06,81.76Z'/%3e%3cpath%20class='cls-4'%20d='M163.77,81.66c-6.57,0-11.76-1.92-15.44-5.7s-5.54-9.07-5.54-15.74a26.76,26.76,0,0,1,2.09-10.43,17.72,17.72,0,0,1,6.67-8.06,19.15,19.15,0,0,1,10.68-2.95,19,19,0,0,1,10.46,2.8,18.7,18.7,0,0,1,6.55,7.36,22.53,22.53,0,0,1,2.36,10.28A4.51,4.51,0,0,1,177,63.77H152.23a10.8,10.8,0,0,0,3.49,6.65c2,1.68,4.88,2.52,8.66,2.52a22.25,22.25,0,0,0,7.54-1.21c.74-.3,1.55-.67,2.37-1.07a3.75,3.75,0,0,1,1.84-.4,4.09,4.09,0,0,1,3,1.15,4,4,0,0,1,1.12,3,4.38,4.38,0,0,1-2.58,3.82,32.34,32.34,0,0,1-6.36,2.61A28.67,28.67,0,0,1,163.77,81.66ZM172.4,55.9a9.72,9.72,0,0,0-1.63-4.56A9.9,9.9,0,0,0,167,48a10.38,10.38,0,0,0-4.64-1.14,12,12,0,0,0-4.77,1.06,9.54,9.54,0,0,0-4.89,5.66,11.78,11.78,0,0,0-.51,2.3Z'/%3e%3cpath%20class='cls-4'%20d='M193,81.64a4.49,4.49,0,0,1-4.51-4.55V27.28A4.58,4.58,0,0,1,189.84,24a4.48,4.48,0,0,1,3.28-1.36A4.36,4.36,0,0,1,196.35,24a4.46,4.46,0,0,1,1.31,3.31V77.09a4.34,4.34,0,0,1-1.35,3.2A4.67,4.67,0,0,1,193,81.64Z'/%3e%3cpath%20class='cls-4'%20d='M263.79,81.71a5.7,5.7,0,0,1-4.2-1.74,5.76,5.76,0,0,1-1.73-4.19V27.37a4.58,4.58,0,0,1,1.35-3.27A4.59,4.59,0,0,1,267,27.37V72.53h24a4.58,4.58,0,0,1,3.27,7.82A4.66,4.66,0,0,1,291,81.71Z'/%3e%3cpath%20class='cls-4'%20d='M424.48,81.74a4.71,4.71,0,0,1-2.71-.88,5.43,5.43,0,0,1-1-1l-.07-.09-12.41-17-5.41,5v9.44a4.31,4.31,0,0,1-1.36,3.19,4.66,4.66,0,0,1-3.3,1.36A4.29,4.29,0,0,1,395,80.42a4.36,4.36,0,0,1-1.32-3.23V27.37A4.58,4.58,0,0,1,395,24.1a4.52,4.52,0,0,1,6.58.12,4.54,4.54,0,0,1,1.24,3.15V56.31l17.72-16.38.05,0a4.8,4.8,0,0,1,2.94-1.11,4.4,4.4,0,0,1,3.27,1.2,4.57,4.57,0,0,1,1.2,3.27,4.44,4.44,0,0,1-.77,2.33,7.45,7.45,0,0,1-1.43,1.65l-11,9.64,13.34,17.68a5,5,0,0,1,1,2.71,4.12,4.12,0,0,1-1.36,3.24A4.64,4.64,0,0,1,424.48,81.74Z'/%3e%3cpath%20class='cls-4'%20d='M317.93,81.76a21.5,21.5,0,1,1,21.17-21.5A21.37,21.37,0,0,1,317.93,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,317.93,47.66Z'/%3e%3cpath%20class='cls-4'%20d='M212.18,101.22a4.12,4.12,0,0,1-3.05-1.26,4.17,4.17,0,0,1-1.26-3.1V43.34a4.37,4.37,0,0,1,1.3-3.14,4.26,4.26,0,0,1,3.13-1.3,4.19,4.19,0,0,1,3.1,1.26,4.32,4.32,0,0,1,1.26,3.16,20.77,20.77,0,0,1,13-4.54,21.51,21.51,0,0,1,0,43,20.51,20.51,0,0,1-13-4.57V96.86a4.15,4.15,0,0,1-1.3,3.06A4.5,4.5,0,0,1,212.18,101.22Zm17.43-53.63c-6.23,0-12.93,4.11-12.93,12.72a12.73,12.73,0,0,0,25.46,0A12.71,12.71,0,0,0,229.61,47.59Z'/%3e%3cpath%20class='cls-4'%20d='M365.76,81.76a21.5,21.5,0,1,1,21.18-21.5A21.37,21.37,0,0,1,365.76,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,365.76,47.66Z'/%3e%3c/svg%3e)