Advanced guide
1. Initialization parameters
The configuration passed in during initialization is described below:
| Property name | Type | Description |
|---|---|---|
| APP ID | String | app id of the project created in the AE backend |
| Server Url | String | server url of the project created in the AE backend |
| mode | TDMode | Enum of SDK running modes |
| enableLog | boolean | Whether to enable log printing |
1.1 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. |
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 TDStrategy SDK. After you SET custom client parameters through the APIs provided by the TDStrategy SDK, you can add them to the Client Parameters 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.
The TDStrategy SDK configures client parameters as follows
#include "TDStrategy.h"
UTDStrategy::AddClientParams("{\"key1\":\"value1\",\"key2\":\"value2\"}");
3. 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 in the push content, and report them as follows:
void OnTriggerResult(FString str){
UTDAnalytics::Track("ops_click","opsProperties parameter in str");
}
UTDStrategy::SetTriggerListener(OnTriggerResult);
4. Send Test
To quickly verify the availability of a channel and the validity of a task, the SDK supports a test mode.
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