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")

Parameter description:

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

Sample Code

let properties = {
		adPlatform:"csj",
		adType:1,
		adAppId:"App ID",
		adId:"Ad Unit ID",
		mediationPlatform:"custom",
		adEcpm: 13.14,
		currencyType: "USD",
		isRendered:true,
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackAdImpression(properties);

2. In-App Purchase

       Automatically reported when in-app purchase is made. (Event Name: "_appPur")

Parameters:

Note:

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

Sample Code

let properties = {
		orderId:"se_demo_007",
		payAmount:6.99,
		currencyType:"CNY",
		payType:"weixin",
		productId:"se_demo_00001",
		productName: "se_demo_name",
		productNum: 1,
		payStatus: 1,
		failReason:"test_failReason",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackPurchase(properties);	
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

3. Ad Click

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

Parameters:

Sample Code

let properties = {
		adPlatform:"mtg",
		adType: 2,
		adId: "Ad Unit ID",
		mediationPlatform: "custom",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
solarengine.trackAdClick(properties);	
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

4. Registration

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

Parameters:

Sample Code

let properties = {
		registerType:"WeChat",
		registerStatus:"success",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackRegister(properties);	
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

5. Login

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

Parameters:

Sample Code

let properties = {
		registerType:"WeChat",
		registerStatus:"success",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackRegister(properties);	
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

6. In-App Order

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

Parameters:

Sample Code

let properties = {
		orderId: "订单ID",
		payAmount: 15.6,
		currencyType:"USD",
		payType: "aliPay",
		status: "success",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackOrder(properties);	
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

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")

Parameters:

Sample Code

let properties = {
		adNetwork: "adNetwork",
		subChannel: "subChannel",
		adAccountId:  "adAccountId",
		adAccountName:  "adAccountName",
		adCampaignId:  "adCampaignId",
		adCampaignName:  "adCampaignName",
		adOfferId:  "adOfferId",
		adOfferName:  "adOfferName",
		adCreativeId: "adCreativeId",
		adCreativeName:  "adCreativeName",
		attributionPlatform: "attributionPlatform",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackAppAttr(properties);