Predefined Events

1. Ad Impression

Automatically reported when displaying ads within the app, which is essential for ROI analysis and monetization-related metrics in user analysis. (Event Name:  "_appImp")

public static void trackAdImpression(ImpressionAttributes attributes)

ImpressionAttributes parameter description:

      Please report the corresponding parameters from Mediation to SolarEngine following Impression-level-revenue-integration.

Sample Code

ImpressionAttributes impressionAttributes = new ImpressionAttributes();
impressionAttributes.ad_platform = "AdMob";
impressionAttributes.ad_appid = "ad_appid";
impressionAttributes.ad_id = "ad_unit_id";
impressionAttributes.ad_type = 1;
impressionAttributes.ad_ecpm = 0.8;
impressionAttributes.currency_type = "USD";
impressionAttributes.mediation_platform = "MAX"//Please input the mediation platform you're using.
impressionAttributes.is_rendered = true;
Dictionary properties = new Dictionary();
properties.Add("K1", "V1");
properties.Add("K2", "V2");
properties.Add("K3", 2);
impressionAttributes.customProperties = properties;
// You can choose not to set customProperties.
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.
SolarEngine.Analytics.trackAdImpression(impressionAttributes);

2. In-App Purchase

       Automatically reported when in-app purchase is made. (Event Name: "_appPur") This is a key event for training the purchase prediction model.

public static void trackPurchase(ProductsAttributes attributes)

ProductsAttributes parameters:

Note:

       The fail_reason parameter is only be passed in when the PayStatus parameter is fail. For other statuses, simply pass "".

Sample Code

ProductsAttributes productsAttributes = new ProductsAttributes();
productsAttributes.product_name = "product_name";
productsAttributes.product_id = "product_id";
productsAttributes.product_num = 8;
productsAttributes.currency_type = "USD";
productsAttributes.order_id = "order_id";
productsAttributes.fail_reason = "fail_reason";
productsAttributes.paystatus = 1; // 1 means success, 2 means fail
productsAttributes.pay_type = "wechat";
productsAttributes.pay_amount = 9.9;
Dictionary properties = new Dictionary();
properties.Add("K1", "V1");
properties.Add("K2", "V2");
properties.Add("K3", 2);
productsAttributes.customProperties = properties;
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

SolarEngine.Analytics.trackPurchase(productsAttributes);

3. Ad Click

       Call trackAdClick to report in-app ad click events (Event Name: "_appClick") :

public static void trackAdClick(AdClickAttributes attributes)

AdClickAttribute parameters:

Sample Code

AdClickAttributes AdClickAttributes = new AdClickAttributes();
AdClickAttributes.ad_platform = "admob"; // Monetization Platform Name
AdClickAttributes.mediation_platform = "gromore";// Mediation Platform that provides the ad 
AdClickAttributes.ad_id = "943508343"; // Monetization Platform ad placement ID
AdClickAttributes.ad_type = 1; 
Dictionary properties = new Dictionary();
properties.Add("K1", "V1");
properties.Add("K2", "V2");
properties.Add("K3", 2);
AdClickAttributes.customProperties = properties;
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.


SolarEngine.Analytics.trackAdClick(AdClickAttributes);

4. Registration

Call trackRegister to report the registration event (Event Name: "_appReg"):

public static void trackRegister(RegisterAttributes attributes)

RegisterAttributes parameters:

Sample Code

RegisterAttributes RegisterAttributes = new RegisterAttributes();
RegisterAttributes.register_type = "QQ";
RegisterAttributes.register_status = "success";
Dictionary properties = new Dictionary();
properties.Add("K1", "V1");
properties.Add("K2", "V2");
properties.Add("K3", 2);
RegisterAttributes.customProperties = properties;
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

SolarEngine.Analytics.trackRegister(RegisterAttributes);

5. Login

Call trackLogin to report the login event (Event Name: "_appLogin") :

public static void trackLogin(LoginAttributes attributes)

LoginAttributes parameters:

Sample Code

LoginAttributes LoginAttributes = new LoginAttributes();
LoginAttributes.login_type = "QQ";
LoginAttributes.login_status = "success";
Dictionary properties = new Dictionary();
properties.Add("K1", "V1");
properties.Add("K2", "V2");
properties.Add("K3", 2);
LoginAttributes.customProperties = properties;
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.


SolarEngine.Analytics.trackLogin(LoginAttributes);

6. In-App Order

Call trackOrder to report in-app order event (Event Name: "_appOrder") :

public static void trackOrder(OrderAttributes attributes)

OrderAttributes parameters:

Sample Code

OrderAttributes OrderAttributes = new OrderAttributes();
OrderAttributes.order_id = "2341242342676398724"; // Not exceeding 128 characters
OrderAttributes.pay_amount = 128.00; // Unit: e.g. USD, CNY, etc.
OrderAttributes.currency_type = "USD"; // Currency Type
OrderAttributes.pay_type = "Alipay"; // Payment Type
OrderAttributes.status = "success"; // Order Status
Dictionary properties = new Dictionary();
properties.Add("K1", "V1");
properties.Add("K2", "V2");
properties.Add("K3", 2);
OrderAttributes.customProperties = properties;
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

SolarEngine.Analytics.trackOrder(OrderAttributes);

7.  Self-Reported Attribution Results

Enables the reporting of attribution results data from a third-party or self-attribution platform to SolarEngine. The timing of reporting can be customized by developers. (Event Name: "_appAttr")

public static void trackAttribution(Attributes attributes)

Parameters:

Sample Code

AppAttributes AppAttributes = new AppAttributes();
AppAttributes.ad_network = "toutiao";
AppAttributes.sub_channel = "103300";
AppAttributes.ad_account_id = "1655958321988611";
AppAttributes.ad_account_name = "xxxFPS18";
AppAttributes.ad_campaign_id = "1680711982033293";
AppAttributes.ad_campaign_name = "FPS-Campaign157-1024";
AppAttributes.ad_offer_id = "1685219082855528";
AppAttributes.ad_offer_name = "FPS-Offer406-1024";
AppAttributes.ad_creative_id = "1680128668901378";
AppAttributes.ad_creative_name = "Auto-created20210901178921";
AppAttributes.attribution_platform = "Attribution Platformxxx";
AppAttributes AppAttributes = new AppAttributes();
AppAttributes.ad_network = "toutiao";
AppAttributes.sub_channel = "103300";
AppAttributes.ad_account_id = "1655958321988611";
AppAttributes.ad_account_name = "xxxFPS18";
AppAttributes.ad_campaign_id = "1680711982033293";
AppAttributes.ad_campaign_name = "FPS-Campaign157-1024";
AppAttributes.ad_offer_id = "1685219082855528";
AppAttributes.ad_offer_name = "FPS-Offer406-1024";
AppAttributes.ad_creative_id = "1680128668901378";
AppAttributes.ad_creative_name = "Auto-created20210901178921";
AppAttributes.attribution_platform = "Attribution Platformxxx";
Dictionary properties = new Dictionary();
properties.Add("K1", "V1");
properties.Add("K2", "V2");
properties.Add("K3", 2);

AppAttributes.customProperties = properties;

SolarEngine.Analytics.trackAttribution(AppAttributes);