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

export function trackAdImpressionWithAttributes(adImpressionEventAttribute:SEAdImpressionEventAttribute);

SEAdImpressionEventAttribute parameters:

      Please report the corresponding fields from mediation to SolarEngine following https://help.solar-engine.com/en/docs/Impression-level-revenue-integration.

Sample Code

let attribute:SEAdImpressionEventAttribute = {

  adNetworkPlatform:"AdMob",
  adType:AdType.Interstitial,
  adNetworkAppID:"AdMob appid",
  adNetworkPlacementID:"AdMob placementid",
  mediationPlatform:"MAX",
  currency:"USD",
  ecpm:1.234, //Here the unit is' USD ', please note the unit conversion
  rendered:true,
  customProperties:{"key1":"value1","key2":"value2"}
  // You can choose not to set customProperties. 
  // Note: Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.
}
SolarEngine.trackAdImpressionWithAttributes(attribute);

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.

export function trackIAPWithAttributes(iapEventAttribute:SEIAPEventAttribute);

SEIAPEventAttribute parameters:

Note:

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

Sample Code

let attribute:SEIAPEventAttribute = {
  productID:"product id",
  productName:"product name",
  productCount:3,
  orderId:"order id",
  payAmount:3.14,
  currency:"USD",
  // const Alipay    = "alipay";
  // const Weixin    = "weixin";
  // const ApplePay  = "applepay";
  // const Paypal    = "paypal";
  payType:Paypal,
  payStatus:SEIAPStatus.Success,
  failReason:"",
  customProperties:{"key":"iap customProperties value"}
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.

SolarEngine.trackIAPWithAttributes(attribute);

3. Ad Click

Call trackAdClickWithAttributes to report in-app ad click events:

export function trackAdClickWithAttributes(adClickEventAttribute:SEAdClickEventAttribute);

SEAdClickEventAttribute parameters:

Sample Code

let attribute:SEAdClickEventAttribute = {

  adNetworkPlatform: "AdNetwork platform",
  adType:AdType.Interstitial,
  adNetworkPlacementID:"AdNetwork placementid",
  mediationPlatform:"mediation name",
  customProperties:{"key":"adclick customProperties value"}
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.
}
SolarEngine.trackAdClickWithAttributes(attribute);

4. Registration

Call trackRegisterWithAttributes to report the registration event:

export function trackRegisterWithAttributes(registerEventAttribute:SERegisterEventAttribute);

SERegisterEventAttribute parameters:

Sample Code

let attribute:SERegisterEventAttribute = {

  registerType:"WeChat",
  registerStatus:"success",
  customProperties:{"key":"register customProperties value"}
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.
}
SolarEngine.trackRegisterWithAttributes(attribute);

5. Login

Call trackLoginWithAttributes to report the login event:

export function trackLoginWithAttributes(loginEventAttribute:SELoginEventAttribute);

SELoginEventAttribute parameters:

Sample Code

  let attribute:SELoginEventAttribute = {
    loginType:"WeChat",
    loginStatus:"failed",
    customProperties:{"key":"login customProperties value"}
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.
  }
  SolarEngine.trackLoginWithAttributes(attribute);

6. In-App Order

Call trackOrderWithAttributes to report in-app order event:

export function trackOrderWithAttributes(orderEventAttribute:SEOrderEventAttribute);

SEOrderEventAttribute parameters:

Sample Code

let attribute:SEOrderEventAttribute = {
  orderID:"order id",
  payAmount:3.1415926,
  currency:"USD",
  payType:Paypal,
  status:"success",
  customProperties:{"key":"order customProperties value"}
// You can choose not to set customProperties. 
// Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.
}
SolarEngine.trackOrderWithAttributes(attribute);

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

export function trackAppAttrWithAttributes(appAttrEventAttribute:SEAppAttrEventAttribute);

SEAppAttrEventAttribute parameters:

Sample Code

let attribute:SEAppAttrEventAttribute = {
  adNetwork:"toutiao",
  subChannel:"103300",
  adAccountID:"1655958321988611",
  adAccountName:"xxxFPS18",
  adCampaignID:"1680711982033293",
  adCampaignName:"FPS-Campaign157-1024",
  adOfferID:"1685219082855528",
  adOfferName:"FPS-Offer406-1024",
  adCreativeID:"1680128668901378",
  adCreativeName:"Auto-created20210901178921",
  attributionPlatform:"Attribution Platformxxx",
  customProperties:{"customProperties":"app attr customProperties value"}
  // You can choose not to set customProperties. 
  // Please do not report custom properties starting with "_", otherwise SDK will abandon its value by default.
}
SolarEngine.trackAppAttrWithAttributes(attribute);