SDK Basic Information

SDK Name: SolarEngine Unreal SDK v1.0.2

Developer: Huiliang Cloud (Beijing) Technology Co., Ltd.

SDK Version: 1.0.2

Features: SolarEngine (SE) is an all-in-one mobile app growth analytics and publishing intelligence platform. It supports data management across global channels, assisting developers to monitor every stage of business development. With our attribution and user-level ROI analysis, you'll be able to measure the true value every channel creates and optimize future growth strategies. SE also offers various analysis models and A/B testing feature to help fully visualize the user journey, identify potential pain points, implement targeted product enhancements and ultimately drive large-scale app growth.

Privacy Policy: https://www.solar-engine.com/privacyPolicyEN.html

Note:

The SolarEngine SDK supports Android 5.0 (API Level 21) and above.

Step 1: Get AppKey

Access Path:  Asset Management - App Management - AppKey

Please login to the live version and get appkey for your own product.

Step 2: Obtain SDK

2.1 Obtain SDK

Get SEAnalytics Plugin:

If your product data is stored in China Mainland, please download SDK via:  

https://solar-sdk.oss-cn-beijing.aliyuncs.com/Unreal/solarengine_unreal_sdk_cn_v1.0.2.zip

If your product data is stored in Non China Mainland, please download SDK via:

https://solar-sdk.oss-cn-beijing.aliyuncs.com/Unreal/solarengine_unreal_sdk_us_v1.0.2.zip

Step 3: Integrate SDK

• Place the extracted SEAnalytics folder into the Plugins directory of your project. If the Plugins directory does not exist, create it in the project root directory first, and then place the SEAnalytics directory inside it.
• Restart Unreal Editor
• Open Edit > Plugins, under the project Analytics category, enable SEAnalytics
• Restart Unreal Editor again
• If you wish to use the SEAnalytics interface directly in C++ code, you need to add the following content to your project's *.Build.cs file:

PrivateDependencyModuleNames.AddRange(new string[] { "SEAnalytics" });

• And, include the SEAnalytics.h header file in the file where you wish to use the SDK:

#include "SEAnalytics.h"

Android

If obfuscation is needed during packaging, please add the following code to the obfuscation configuration file.

-keep class com.reyun.** {*; }
-keep class route.**{*;}
-keep interface com.reyun.** {*; }
-keep interface route.**{*;}
-dontwarn com.reyun.**
-dontwarn org.json.**
-keep class org.json.**{*;}
# Google lib library
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
    com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
    java.lang.String getId();
    boolean isLimitAdTrackingEnabled();
}
-keep public class com.android.installreferrer.** { *; }
# If you need to obtain OAID, please add the following obfuscation 
-keep class com.huawei.hms.**{*;}
-keep class com.hihonor.**{*;}

iOS

       For Xcode versions, 14.0 and above are supported.

       Accessible for iOS 11.0 and later.

Add Required Dependency Frameworks

• Security.framework — Used to store device identifiers.
• CoreTelephony.framework — Used to retrieve carrier information.
• AdSupport.framework — Used to obtain the Advertising Identifier (IDFA).
• SystemConfiguration.framework — Used to check the current network environment.
• libsqlite3.tbd — Used for data storage.
• AdServices.framework — Used to retrieve ad attribution data.

Note: If you need ASA attribution, AdServices.framework must be added; or attribution results cannot be obtained.

Step 4: Pre-Initialize SDK

       When the app is first launched after install, the SDK is pre-initialized. During pre-initialization, the SDK does not collect any personal information or report data to SolarEngine.

Method

static void preInit(const FString& appkey);

Code Example

USEAnalytics::preInit(appkey)

Step 5: SDK Initialization Config (optional)

FSEConfig parameter description:

       This configuration class is used to finely control service capabilities and data collection behavior when initializing the SDK. It is divided into three categories: core feature switches, auxiliary feature switches, and data collection switches.

       The config configuration returned by this method are optional parameters; if not set, default values are used.

Method Example

FSEConfig config;
config.logEnabled = true;   

1. Core Feature Switches

       It controls the enablement or disablement of core SDK capabilities, directly determining whether core services such as attribution and analytics take effect.

       Note: Disabling relevant core feature switches will disrupt the data reporting. You will no longer be able to fully utilise all functions within SolarEngine dashboard.

2. Auxiliary Feature Switches

3. Data Collection Switches

       It controls whether data such as IPv6, OAID and UA is collected.

       Note: Disabling corresponding data collection parameters will impair attribution and analytics services, and you will not be able to use relevant functions normally on SolarEngine dashboard.

Step 6: Initialize SDK

SDK Initialization Parameters

Code Example

FSEConfig config;
config.logEnabled = true;                    // Enable debug logs
USEAnalytics::init("appkey", config);

Listen to Initialization Callback

Add an initialization callback method in addition to the existing initialization method.

Code Example

// Initialization
USEAnalytics::preInit("appkey")   // Pre-initialization must be called first.
FSEConfig config;
seConfig.logEnabled = true;
config.initCompletedCallback = FInitCompletedCallback::CreateLambda([this](int32 code)
{
	if (code == 0)
	{
		UE_LOG(LogTemp, Log, TEXT("initialization success callback received"));
	}
	else
	{
		UE_LOG(LogTemp, Warning, TEXT("initialization fail callback received, code=%d"), code);
	}
});
USEAnalytics::init("appkey", config);

Initialization callback codes:

Step 6: Get Attribution Results

6.1 Set Attribution Result Callback (New)

USEAnalytics::preInit(AppKey);

FSEConfig Config;
Config.enableSeparatedAttribution = true;

// UA attribution
Config.uaAttributionCallback = FUAAttributionCallback::CreateLambda(
    [](FSEAttributionData Data)
    {
        UE_LOG(LogTemp, Log, TEXT("UA Attribution: code=%d"), Data.code);
    });

// Re-engagement attribution
Config.reAttributionCallback = FREAttributionCallback::CreateLambda(
    [](FSEAttributionData Data)
    {
        UE_LOG(LogTemp, Log, TEXT("RE Attribution: code=%d"), Data.code);
    });

USEAnalytics::init(AppKey, Config);

Important Note: When using the callback mode to receive attribution results, the attribution listener must be set before calling init. If the listener is set after initialization, it may lead to inaccurate attribution results.

6.2 Get Attribution Result Directly (New)

       In addition to adding an attribution callback during initialization, you can also proactively call the API later in your business logic to read the attribution results.

Note: This method reads from the local device cache. It returns null if the cache is not yet ready.

//Get UA attribution result
 USEAnalytics::getUAAttributionData();
//Get re-engagement attribution result
 USEAnalytics::getREAttributionData();

Attribution Result Example

Attribution error code descriptions and detailed attribution results can be found in:

https://help.solar-engine.com/en/docs/SDK-Attribution-Result-Details