Advanced guide

Last updated 10/03/2026

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
instanceName	String	Alias of the data collection SDK instance
mode	TDMode	Enum of SDK running modes
enableLog	boolean	Whether to enable log printing
defaultTimeZone	TimeZone	Default time zone of the SDK
encryptVersion	int	Key version number when data encryption is enabled
encryptKey	String	Public key information when data encryption is enabled
enableAutoPush	boolean	Whether to enable automatic collection of push clicks
enableAutoCalibrated	boolean	Whether to enable automatic time calibration

1.2 TDMode

Enum values	Description
NORMAL	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.
DEBUG_ONLY	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. Set client parameters

When you create a client-triggered task, you can fill in Client-side Conditions. For configuration details, see Create client-triggered tasks

The parameters available in Client-side Conditions come from the environment parameters that the client collects automatically and the client parameters that you set through the TDRemoteConfig SDK. After you set custom client parameters through the APIs provided by the TDRemoteConfig SDK, you can add them to the Client Parameters management module in the AE Engage settings and use them in operation tasks.

Note: The names and types of the parameters you SET on the client must match the client parameters configured in the AE Engage backend.

Add client parameters

import cn.thinkingdata.remoteconfig.TDRemoteConfig;

// Set client parameters. If you set them multiple times, the union is used
JSONObject json = new JSONObject();
json.put("key","value");
TDRemoteConfig.addClientParams(json);

Delete client parameters

TDRemoteConfig.removeClientParam("key");

Get client parameters

//Get all client parameters
JSONObject params = TDRemoteConfig.getClientParams();

//Get a single client parameter
Object obj = TDRemoteConfig.getClientParamValueForKey("key");

Client parameters with accumulated values

TDRemoteConfig.accumulateNum("key",1);

3. Customize fetch timing

3.1 Automatic fetching

The SDK automatically fetches remote configuration data in the following scenarios

• App cold start
• App foreground/background switch, more than 6 hours after the previous one
• The ThinkingSDK account system changes, for example, on login or logout

3.2 Manual fetching

Call the SDK method manually to fetch remote configuration at any time

TDStrategy.fetch();

This API has internal rate limiting. Avoid fetching too frequently.

4. Touch funnel events

When you create a client-triggered channel, you can enable the touch funnel settings. For configuration details, see Channel Settings

After you enable the touch funnel, you can configure the event names associated with the funnel steps. You can then view the conversion data of the configured steps on the data details page of operation tasks that use this channel.

Events selected for Delivered and Clicked must meet the following requirements:

• The event must carry Engage-specific parameters. You can get these parameters from the opsProperties property of the TDStrategyResult object in the push content, and report them as follows:

TDStrategy.setTriggerListener(new TDStrategyResultListener() {
    @Override
    public void onTriggerResult(TDStrategyResult tdStrategyResult) {
        TDAnalytics.track("ops_click",tdStrategyResult.opsProperties);
    }
});

5. Send Test

To quickly verify the availability of a channel and the validity of a task, the SDK supports a test mode.

TDSettings settings = new TDSettings();
settings.appId = "AppId";
settings.serverUrl = "ServerUrl";
// debug 
settings.mode = TDSettings.TDMode.DEBUG;
TDApp.init(this,settings);

After you enable debug mode on the client, the client fetches test tasks every 5s. In the AE Engage module, you can create channel tests or task tests. While a task is waiting to be triggered, you can watch the progress nodes on the frontend page.

Related documentation: Send Test for tasks, Send Test for channels

Send tests for client-triggered tasks require test devices. You can select or add test devices in the test device list