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.

Parameter	Description	Type	Required
ad_platform	Monetization platform (Value: platform name) csj: 穿山甲 China Mainland version pangle: 穿山甲 International version tencent: 腾讯优量汇 baidu: 百度百青藤 kuaishou: 快手 oppo: OPPO vivo：vivo mi: 小米 huawei: 华为 applovin: AppLovin sigmob: Sigmob mintegral:Mintegral oneway: OneWay vungle: Vungle facebook: Facebook admob: AdMob unity: UnityAds is: IronSource adtiming: AdTiming klein: 游可赢 fyber: Fyber chartboost: Chartboost adcolony: Adcolony	String	yes
ad_type	Ad types: 1：Rewarded Video 2：Splash 3：Interstitial 4：Fullscreen Video 5：Banner 6：Native 7：Native Video 8：Banner (MPU) 9：Instream Video 10：MREC 0：Other	Int	yes
ad_appid	The App ID on monetization platforms.	String	no
ad_id	Ad Unit ID on monetization platforms.	String	yes
mediation_platform	Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send "custom" if no mediation platform is used.	String	yes
ad_ecpm	=revenue of 1,000 ad impressions (0 or negative values are invalid.) (Mininum Unit: USD dollar)	double	yes
currency_type	Revenue Currency Type (following ISO 4217)	String	yes
is_rendered	Whether the ad is rendered successfully. YES: success NO: Failed. If you do not need to pass in this indicator, please pass YES.	Boolean	yes
customProperties	/	Dictionary	no

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:

Parameter	Description	Type	Required
order_id	The order ID generated by the system for this purchase	String	no
pay_amount	The amount paid for this purchase (Unit: e.g. USD, CNY, etc.)	double	yes
currency_type	The currency type of payment (following ISO 4217)	String	yes
pay_type	Payment methods, such as alipay, weixin, applepay, paypal, etc.	String	no
product_id	Purchased item ID	String	no
product_name	Purchased item name	String	no
product_num	Quantity of items purchased	Int	no
paystatus	Payment status 1: successful 2: failed	SEConstant_IAP_PayStatus	yes
fail_reason	Reason for payment failure	String	no
customProperties	/	Dictionary	no

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:

Parameter	Description	Type	Required
ad_platform	Monetization platforms, for example (value: name), csj：穿山甲国内版 pangle：穿山甲国际版 tencent：腾讯优量汇 baidu：百度百青藤 kuaishou：快手 oppo：OPPO vivo：vivo mi：小米 huawei：华为 applovin：Applovin sigmob：Sigmob mintegral：Mintegral oneway：OneWay vungle：Vungle facebook：Facebook admob：AdMob unity：UnityAds is：IronSource adtiming：AdTiming klein：游可赢 fyber：Fyber chartboost：Chartboost adcolony：Adcolony	String	yes
ad_type	Ad types, for example (value: explanation), 1：Rewarded Video Ads 2：Splash Ads 3：Interstitial Ads 4：Full Screen Videos 5：Banner Ads 6：In-Feed Ads 7：Native Video Ads 8：Playable Ads 9：Pre-movie Ads 0：Other	int	yes
ad_id	Ad unit ID on monetization platforms.	String	yes
mediation_platform	Mediation platforms commonly used: max ironsource admob hyperbid topon cas Tradplus Tobid If your mediation platform is not on the list, you can name it yourself, only that the name cannot exceed 32 characters. Send "custom" if no mediation platform is used.	String	yes
customProperties	/	Dictionary	no

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:

Parameter	Description	Type	Required
register_type	Registration types such as "WeChat", "QQ" and other custom values	String	Yes
register_status	Registration status such as "success"	String	No
customProperties	Custom Properties	Dictionary	No

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:

Parameter	Description	Type	Required
login_type	Login type such as "WeChat", "QQ" and other custom values	String	Yes
login_status	Login status such as "success"	String	No
customProperties	Custom Properties	Dictionary	No

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:

Parameter	Description	Type	Required
order_id	Order ID	String	No
pay_amount	The payment amount of the order (Unit: e.g. USD, CNY, etc.)	double	Yes
currency_type	The currency type of the order (following ISO 4217)	String	Yes
pay_type	Payment methods, such as alipay, weixin, applepay, paypal, etc.	String	No
status	Order Status	String	Yes
customProperties	Custom Properties	Dictionary	No

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:

Parameter	Description	Type	Required
ad_network	Channel ID (should match the channel ID in ROI analysis)	String	yes
sub_channel	Sub-channels for advertising	String	no
ad_account_id	Ad account ID for advertising	String	no
ad_account_name	Ad account name for advertising	String	no
ad_campaign_id	Ad campaign ID for advertising	String	no
ad_campaign_name	Ad campaign name for advertising	String	no
ad_offer_id	Ad offer ID for advertising	String	no
ad_offer_name	Ad offer name for advertising	String	no
ad_creative_id	Ad creative ID for advertising	String	no
ad_creative_name	Ad creative name for advertising	String	no
attribution_platform	Monitoring Platform	String	yes
customProperties	Custom Properties	Dictionary	no

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

Optional Features