Advanced guide
1. Initialization parameters
The TDSettings configuration passed in during initialization is described below:
1.1 TDSettings
| Property name | Type | Description |
|---|---|---|
| appId | String | app id of the project created in the AE backend |
| serverUrl | String | server url of the project created in the AE backend |
| mode | String | SDK running mode (none, debug, debugOnly) |
| enableLog | Boolean | Whether to enable log printing |
| zoneOffset | Number | Default time zone of the SDK |
| enableBatch | Boolean | Whether to enable batch reporting of cached events |
| batchConfig | object | Batch reporting configuration |
| autoTrack | object | Auto-tracking settings |
1.2 SDK running modes
| Enum values | Description |
|---|---|
| normal、none | Reports data normally, and the data is ingested. |
debug | Reports collected data in Debug mode. The device id must be added to the test device list in the AE console. You can view the data collected in real time under AE console -> Debugger. Reported data is stored in the AE system. |
debugOnly | Reports collected data in DebugOnly mode. The device id must be added to the test device list in the AE console. You can view the data collected in real time under AE console -> Debugger. Reported data is not stored in the AE system. |
2. Customize fetch timing
2.1 Automatic fetching
The SDK automatically fetches remote configuration data in the following scenarios
- Mini game cold start
- Mini game foreground/background switch, more than 6 hours after the previous one
- The TDAnalytics SDK account system changes, for example, on login or logout
2.2 Manual fetching
Call the SDK method manually to fetch remote configuration at any time
TDRemoteConfig.fetch();
This API has internal rate limiting. Avoid fetching too frequently.
3. Customize Fetch parameters
Fetch parameters are parameters that the client SDK can use when it requests values from the AE server. You can customize Fetch parameters and add them as Environment Parameters of config channels. You can then use the Fetch parameters to customize the target audience when you configure strategies.
3.1 Add
TDRemoteConfig.setCustomFetchParams({});
3.2 Delete
Delete by the specified key
TDRemoteConfig.removeCustomFetchParam("key");