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 Name | Parameter Meaning | Parameter Type | Mandatory |
---|---|---|---|
adPlatform | Monetization 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 | String | yes |
adType | 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 |
adAppId | The App ID on monetization platforms. | String | no |
adId | Ad unit ID on monetization platforms. | String | yes |
mediationPlatform | 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 |
adEcpm | =revenue of 1,000 ad impressions (Mininum Unit: USD dollar) (0 or negative values are invalid.) | double | yes |
currencyType | Revenue Currency Type (following ISO 4217) | String | yes |
isRendered | 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 | / | object | no |
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);
Automatically reported when ads are clicked within the app. (Event Name: "_appClick")
Parameters:
Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
---|---|---|---|
adPlatform | 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 inmobi:Inmobi | String | yes |
adType | 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 |
adId | Ad unit ID on monetization platforms. | String | yes |
mediationPlatform | 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 | / | Object | no |
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.
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 Name | Parameter Meaning | Parameter Type | Mandatory |
---|---|---|---|
orderId | The order ID generated by the system for this purchase | String | no |
payAmount | The amount paid for this purchase (Unit: yuan) | double | yes |
currencyType | The currency type of payment (following ISO 4217) | String | yes |
payType | Payment methods, such as alipay, weixin, applepay, paypal, etc. | String | no |
productId | Purchased item ID | String | no |
productName | Purchased item name | String | no |
productNum | Quantity of items purchased | Int | no |
payStatus | Payment status 1: successful 2: failed | Int | yes |
failReason | Reason for payment failure | String | no |
customProperties | / | object | no |
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.
Event name: "_appOrder"
Parameters:
Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
---|---|---|---|
orderID | Order ID | String | No |
payAmount | The payment amount of the order (Unit: yuan) | double | Yes |
currencyType | The currency type of the order (following ISO 4217) | String | Yes |
payType | Payment methods, such as alipay, weixin, applepay, paypal, etc. | String | No |
status | Order Status | String | Yes |
customProperties | / | JSONObject | No |
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.
Automatically reported when users register within the app. (Event Name: "_appReg")
Parameters:
Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
---|---|---|---|
registerType | Registration types such as "WeChat", "QQ" and other custom values | String | Yes |
registerStatus | Registration status such as "success" | String | No |
customProperties | / | Object | No |
Call example:
let properties = {
registerType:"WeChat",
registerStatus:"success",
customProperties:{
test_key1:"1",
test_key2:2,
}
}
solarengine.trackRegister(properties);
// customProperties is optional.
Automatically reported when users login within the app. (Event Name: "_appLogin")
Parameters:
Parameter Name | Parameter Meaning | Parameter Type | Mandatory |
---|---|---|---|
loginType | Login type such as "WeChat", "QQ" and other custom values | String | Yes |
loginStatus | Login status such as "success" | String | No |
customProperties | / | Object | No |
Call example:
let properties = {
loginType:"WeChat",
loginStatus:"success",
customProperties:{
test_key1:"1",
test_key2:2,
}
}
solarengine.trackLogin(properties);
// customProperties is optional.
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 Name | Parameter Meaning | Parameter Type | Mandatory |
---|---|---|---|
adNetwork | Channel ID (should match the channel ID in ROI analysis) | String | yes |
subChannel | Sub-channels for advertising | String | no |
adAccountID | Ad account ID for advertising | String | no |
adAccountName | Ad account name for advertising | String | no |
adCampaignId | Ad campaign ID for advertising | String | no |
adCampaignName | Ad campaign name for advertising | String | no |
adOfferId | Ad offer ID for advertising | String | no |
adOfferName | Ad offer name for advertising | String | no |
adCreativeId | Ad creative ID for advertising | String | no |
adCreativeName | Ad creative name for advertising | String | no |
attributionPlatform | Monitoring Platform | String | yes |
customProperties | / | JSONObject | no |
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);