Menu

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:

Parameter NameParameter MeaningParameter TypeMandatory
adPlatformMonetization platform (Value: platform 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 (DT Exchange)
chartboost: Chartboost
adcolony: Adcolony
inmobi:Inmobi
bigo:BIGO
Stringyes
adTypeAd 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
Intyes
adAppIdThe App ID on monetization platforms.Stringno
adIdAd unit ID on monetization platforms.Stringyes
mediationPlatformMediation 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.
Stringyes
adEcpm=revenue of 1,000 ad impressions
(Mininum Unit: USD dollar)
(0 or negative values are invalid.)
doubleyes
currencyTypeRevenue Currency Type (following ISO 4217)Stringyes
isRenderedWhether the ad is rendered successfully.
YES: success
NO: Failed.
If you do not need to pass in this indicator, please pass YES.
Booleanyes
customProperties/objectno

Call example:

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


2. Ad Click

       Automatically reported when ads are clicked within the app. (Event Name: "_appClick")

Parameters:

Parameter NameParameter MeaningParameter TypeMandatory
adPlatformMonetization 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
inmobi:Inmobi
Stringyes
adTypeAd 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
Intyes
adIdAd unit ID on monetization platforms.Stringyes
mediationPlatformMediation 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.
Stringyes
customProperties/Objectno


Call example:

let properties = {
		adPlatform:"mtg",
		adType: 2,
		adId: "广告位ID",
		mediationPlatform: "custom",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
solarengine.trackAdClick(properties);	
// customProperties is optional.

3. In-App Purchase

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

It is a key event for training payment prediction algorithm model. If you're using SE payment prediction services, please make sure to report this event.

Parameters:

Parameter NameParameter MeaningParameter TypeMandatory
orderIdThe order ID generated by the system for this purchaseStringno
payAmountThe amount paid for this purchase (Unit: yuan)doubleyes
currencyTypeThe currency type of payment (following ISO 4217)Stringyes
payTypePayment methods, such as alipay, weixin, applepay, paypal, etc.Stringno
productIdPurchased item IDStringno
productNamePurchased item nameStringno
productNumQuantity of items purchasedIntno
payStatusPayment status
1: successful
2: failed
Intyes
failReasonReason for payment failureStringno
customProperties/objectno


Note:

  The failureReason parameter is only be passed in when the payStatus parameter is SolarEngineIAPFail. For other statuses, simply pass "".

Call example:

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);	
// customProperties is optional.


4. In-App Order

       Event name: "_appOrder"

Parameters:

Parameter NameParameter MeaningParameter TypeMandatory
orderIDOrder IDStringNo
payAmountThe payment amount of the order (Unit: yuan)doubleYes
currencyTypeThe currency type of the order (following ISO 4217)StringYes
payTypePayment methods, such as alipay, weixin, applepay, paypal, etc.StringNo
statusOrder StatusStringYes
customProperties/JSONObjectNo


Call example:

let properties = {
		orderId: "订单ID",
		payAmount: 15.6,
		currencyType:"USD",
		payType: "aliPay",
		status: "success",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackOrder(properties);	
// customProperties is optional.

5. Registration

Automatically reported when users register within the app. (Event Name: "_appReg")

Parameters:

Parameter NameParameter MeaningParameter TypeMandatory
registerTypeRegistration types such as "WeChat", "QQ" and other custom valuesStringYes
registerStatusRegistration status such as "success"StringNo
customProperties/ObjectNo


Call example:

let properties = {
		registerType:"WeChat",
		registerStatus:"success",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackRegister(properties);	
// customProperties is optional.

6. Login

Automatically reported when users login within the app. (Event Name: "_appLogin")

Parameters:

Parameter NameParameter MeaningParameter TypeMandatory
loginTypeLogin type such as "WeChat", "QQ" and other custom valuesStringYes
loginStatusLogin status such as "success"StringNo
customProperties/ObjectNo


Call example:

let properties = {
		loginType:"WeChat",
		loginStatus:"success",
		customProperties:{
			test_key1:"1",
			test_key2:2,
		}
	}
solarengine.trackLogin(properties);	
// customProperties is optional.

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 NameParameter MeaningParameter TypeMandatory
adNetworkChannel ID (should match the channel ID in ROI analysis)Stringyes
subChannelSub-channels for advertisingStringno
adAccountIDAd account ID for advertisingStringno
adAccountNameAd account name for advertisingStringno
adCampaignIdAd campaign ID for advertisingStringno
adCampaignNameAd campaign name for advertisingStringno
adOfferIdAd offer ID for advertisingStringno
adOfferNameAd offer name for advertisingStringno
adCreativeIdAd creative ID for advertisingStringno
adCreativeNameAd creative name for advertisingStringno
attributionPlatformMonitoring PlatformStringyes
customProperties/JSONObjectno

Code example:

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


Previous
Preset Events
Next
Custom Event & Property
Last modified: 2024-10-29Powered by