变现广告展示事件

App内变现广告展示时，报送该事件，用于进行广告展示及变现收入分析。

使用ROI分析功能、自定义分析变现指标时，为必须报送事件。

广告展示事件的 _event_name 为 _appImp

方法示例

export function trackAdImpressionWithAttributes(adImpressionEventAttribute:SEAdImpressionEventAttribute);

SEAdImpressionEventAttribute 类参数说明

参数名称	参数含义	参数类型	是否必传
adNetworkPlatform	变现平台，前面为应传值，后面为平台名称 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	是
adType	所展示的广告的类型( 枚举AdType) RewardedVideo：激励视频 Splash：开屏 Interstitial：插屏 FullscreenVideo：全屏视频 Banner：Banner Native：信息流 NativeVideo：短视频信息流 MPUBanner：大横幅 InstreamVideo：视频贴片 MREC：中等尺寸横幅其它广告类型,可以自定义数字(大于20,与上述类型区分开)	number	是
adNetworkAppID	变现平台的应用 ID	string	否
adNetworkPlacementID	变现平台的变现广告位 ID	string	是
mediationPlatform	聚合平台标识，常见聚合平台枚举如下，若您使用的聚合平台不在如下枚举值，您可以自定义命名，并控制字符数在32位。没有聚合平台标识，请设置为 "custom"。 max ironsource admob hyperbid topon cas Tradplus Tobid	string	是
ecpm	广告ECPM（广告千次展现的变现收入，0或负值表示没传），单位：元	number	是
currency	展示收益的货币种类，遵循《ISO 4217国际标准》如 CNY、USD	string	是
rendered	广告是否渲染成功，具体枚举值如下：例如：成功时，只需要传入 true (true：成功 false：失败) 如果不需要统计该指标，请传 true	boolean	是
customProperties	自定义属性, json字符串	Object	否

调用示例

let attribute:SEAdImpressionEventAttribute = {

  adNetworkPlatform:"AdMob",
  adType:AdType.Interstitial,
  adNetworkAppID:"AdMob appid",
  adNetworkPlacementID:"AdMob placementid",
  mediationPlatform:"MAX",
  currency:"USD",
  ecpm:1.234, //此处单位为 '元' ,请注意单位转换
  rendered:true,
  customProperties:{"key1":"value1","key2":"value2"}
  // customProperties 为自定义属性，可以不设置
  // 注：开发者传入属性 key 不能为"_"下划线开头，"_"下划线开头为SDK保留字段，开发者设置则直接报错丢弃    
}
SolarEngine.trackAdImpressionWithAttributes(attribute);

应用内购买事件

App 内付费购买时，报送该事件，用于进行购买及内购收入分析。

该事件为用于付费预测模型训练的关键事件，使用系统提供的预测服务时，为必须报送事件。

应用内购买事件的 _event_name 为 _appPur。

方法示例

export function trackIAPWithAttributes(iapEventAttribute:SEIAPEventAttribute);

SEIAPEventAttribute 类参数说明

参数名称	参数含义	参数类型	是否必传
orderId	本次购买由系统生成的订单 ID	string	否，投放荣耀商推、网易有道、豆瓣和oppo时必填
payAmount	本次购买支付的金额，单位：元	number	是
currency	支付的货币类型，遵循《ISO 4217国际标准》，如 CNY、USD	string	是
payType	支付方式：可使用已定义好的常量 export const Alipay = "alipay"; export const Weixin = "weixin"; export const ApplePay = "applepay"; export const Paypal = "paypal"; 如是其他支付方式,可自定义	string	否
productID	购买商品的ID	string	否
productName	商品名称	string	否
productCount	购买商品的数量	number	否
payStatus	支付状态 SEIAPStatus枚举 Success:成功 Failed:失败 Restored:恢复	SEIAPStatus	是
failReason	支付失败的原因	string	否
customProperties	自定义属性	Object	否

注：支付失败原因 failReason 参数仅在 payStatus 参数为 Failed 支付失败时才会传入，其他状态传""即可。

调用示例

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"}
// customProperties 为自定义属性，可以不设置
// 注：开发者传入属性 key 不能为"_"下划线开头，"_"下划线开头为SDK保留字段，开发者设置则直接报错丢弃
}
SolarEngine.trackIAPWithAttributes(attribute);

上报变现广告点击事件

调用 trackAdClickWithAttributes 方法可以上报变现广告点击事件

方法示例

export function trackAdClickWithAttributes(adClickEventAttribute:SEAdClickEventAttribute);

SEAdClickEventAttribute 类参数说明

参数名称	参数含义	参数类型	是否必传
adNetworkPlatform	变现平台，前面为应传值，后面为平台名称 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	是
adType	所展示的广告的类型( 枚举AdType) RewardedVideo：激励视频 Splash：开屏 Interstitial：插屏 FullscreenVideo：全屏视频 Banner：Banner Native：信息流 NativeVideo：短视频信息流 MPUBanner：大横幅 InstreamVideo：视频贴片 MREC：中等尺寸横幅其它广告类型,可以自定义数字(大于20,与上述类型区分开)	number	是
adNetworkPlacementID	变现平台的变现广告位 ID	string	是
mediationPlatform	聚合平台标识，常见聚合平台枚举如下，若您使用的聚合平台不在如下枚举值，您可以自定义命名，并控制字符数在32位。没有聚合平台标识，请设置为 "custom"。 max ironsource admob hyperbid topon cas Tradplus Tobid	string	是
customProperties	自定义属性说明见目录：4.自定义属性	Object	否

调用示例

let attribute:SEAdClickEventAttribute = {

  adNetworkPlatform: "AdNetwork platform",
  adType:AdType.Interstitial,
  adNetworkPlacementID:"AdNetwork placementid",
  mediationPlatform:"mediation name",
  customProperties:{"key":"adclick customProperties value"}
// customProperties 为自定义属性，可以不设置
// 注：开发者传入属性 key 不能为"_"下划线开头，"_"下划线开头为SDK保留字段，开发者设置则直接报错丢弃
}
SolarEngine.trackAdClickWithAttributes(attribute);

上报注册事件

调用 trackRegisterWithAttributes 方法可以上报注册事件

方法示例

export function trackRegisterWithAttributes(registerEventAttribute:SERegisterEventAttribute);

SERegisterEventAttribute 类参数介绍

参数名称	参数含义	参数类型	是否必传
registerType	注册类型如 "WeChat"、"QQ" 等自定义值	string	是，不超过 32 字符
registerStatus	注册状态如 "success"	string	否
customProperties	自定义属性	Object	否

调用示例

let attribute:SERegisterEventAttribute = {

  registerType:"WeChat",
  registerStatus:"success",
  customProperties:{"key":"register customProperties value"}
// customProperties 为自定义属性，可以不设置
// 注：开发者传入属性 key 不能为"_"下划线开头，"_"下划线开头为SDK保留字段，开发者设置则直接报错丢弃
}
SolarEngine.trackRegisterWithAttributes(attribute);

上报登录事件

调用 trackLoginWithAttributes 方法可以上报登录事件

方法示例

export function trackLoginWithAttributes(loginEventAttribute:SELoginEventAttribute);

SELoginEventAttribute 类参数介绍

参数名称	参数含义	参数类型	是否必传
loginType	登录类型如 "WeChat"、"QQ" 等自定义值	string	是，不超过 32 字符
loginStatus	登录状态如 "success"	string	否
customProperties	自定义属性	Object	否

调用示例

  let attribute:SELoginEventAttribute = {
    loginType:"WeChat",
    loginStatus:"failed",
    customProperties:{"key":"login customProperties value"}
// customProperties 为自定义属性，可以不设置
// 注：开发者传入属性 key 不能为"_"下划线开头，"_"下划线开头为SDK保留字段，开发者设置则直接报错丢弃
  }
  SolarEngine.trackLoginWithAttributes(attribute);

上报订单事件

调用 trackOrderWithAttributes 方法可以上报订单事件

方法示例

export function trackOrderWithAttributes(orderEventAttribute:SEOrderEventAttribute);

SEOrderEventAttribute 类参数介绍

参数名称	参数含义	参数类型	是否必传
orderID	订单 ID	string	否，不超过 128 字符，投放荣耀商推、网易有道、豆瓣和oppo时必填
payAmount	订单的金额	number	是
currency	展示货币类型，遵循《ISO 4217国际标准》，如 CNY、USD	string	是
payType	支付方式：可使用已定义好的常量 export const Alipay = "alipay"; export const Weixin = "weixin"; export const ApplePay = "applepay"; export const Paypal = "paypal"; 如是其他支付方式,可自定义	string	否，不超过 32 字符
status	订单状态	string	是
customProperties	自定义属性说明见目录：4.自定义属性	Object	否

调用示例

let attribute:SEOrderEventAttribute = {
  orderID:"order id",
  payAmount:3.1415926,
  currency:"USD",
  payType:Paypal,
  status:"success",
  customProperties:{"key":"order customProperties value"}
// customProperties 为自定义属性，可以不设置
// 注：开发者传入属性 key 不能为"_"下划线开头，"_"下划线开头为SDK保留字段，开发者设置则直接报错丢弃
}
SolarEngine.trackOrderWithAttributes(attribute);

上报自归因事件

增加归因安装事件，支持统计归因数据，满足客户使用三方归因或者自归因之后的结果数据回传到自定义分析，上报时机支持开发者自定义触发

自归因事件的 `_event_name` 为 _appAttr

方法示例

export function trackAppAttrWithAttributes(appAttrEventAttribute:SEAppAttrEventAttribute);

SEAppAttrEventAttribute 类参数介绍

参数名称	参数含义	参数类型	是否必传
adNetwork	投放广告的渠道 ID，需要与发行平台匹配	string	是
subChannel	投放广告的子渠道	string	否
adAccountID	投放广告的投放账号 ID	string	否
adAccountName	投放广告的投放账号名称	string	否
adCampaignID	投放广告的广告计划 ID	string	否
adCampaignName	投放广告的广告计划名称	string	否
adOfferID	投放广告的广告单元 ID	string	否
adOfferName	投放广告的广告单元名称	string	否
adCreativeID	投放广告的广告创意 ID	string	否
adCreativeName	投放广告的广告创意名称	string	否
attributionPlatform	监测平台	string	是
customProperties	开发者传入的自定义属性	Object	否

调用示例

let attribute:SEAppAttrEventAttribute = {
  adNetwork:"toutiao",
  subChannel:"103300",
  adAccountID:"1655958321988611",
  adAccountName:"xxx科技全量18",
  adCampaignID:"1680711982033293",
  adCampaignName:"冲冲冲计划157-1024",
  adOfferID:"1685219082855528",
  adOfferName:"冲冲冲单元406-1024",
  adCreativeID:"1680128668901378",
  adCreativeName:"自动创建20210901178921",
  attributionPlatform:"广告监测平台xxx",
  customProperties:{"customProperties":"app attr customProperties value"}
// customProperties 为自定义属性，可以不设置
// 注：开发者传入属性 key 不能为"_"下划线开头，"_"下划线开头为SDK保留字段，开发者设置则直接报错丢弃
}
SolarEngine.trackAppAttrWithAttributes(attribute);

可选功能