首次事件

首次事件是指针对某些维度（设备 ID或其他维度的 ID）只记录一次的事件，例如记录某个账号的注册事件，可以使用首次事件来记录，服务端会按照 setCheckId() 设置的 ID 去重，同一 ID 只会记录第一次上报的事件。

预置事件（_appInstall、_appStart、_appEnd）不支持设置为首次事件。

方法示例

export function trackFirstEvent(firstCheckId:string,eventAttribute:
                                                  SEIAPEventAttribute|
                                                  SEAppAttrEventAttribute|
                                                  SEOrderEventAttribute|
                                                  SERegisterEventAttribute|
                                                  SELoginEventAttribute|
                                                  SEAdImpressionEventAttribute|
                                                  SEAdClickEventAttribute|
                                                  SECustomEventAttribute);

参数说明

eventAttribute 参数使用时需要传 对应 的实例，具体说明如下：

调用示例

1.变现广告展示事件首次事件

参数说明：

（各聚合平台对应传值字段参见： ROI-三方账户管理-聚合平台-其他聚合平台 ）

SEAdImpressionEventAttribute 类参数说明：

调用示例

let firstCheckId = "my first check id";
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.trackFirstEvent(firstCheckId,attribute);

2.变现广告点击事件首次事件

SEAdClickEventAttribute 类参数说明：

调用示例

let firstCheckId = "my first check id";
let attribute:SEAdClickEventAttribute = {

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

3.自归因事件首次事件

SEAppAttrEventAttribute 类参数介绍：

调用示例

let firstCheckId = "my first check id";
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.trackFirstEvent(firstCheckId,attribute);

4.登录事件首次事件

SELoginEventAttribute 类参数介绍：

调用示例

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

5.注册事件首次事件

SERegisterEventAttribute 类参数介绍：

调用示例

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

6.订单事件首次事件

SEOrderEventAttribute 类参数介绍：

调用示例

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

7.应用内购买事件首次事件

SEIAPEventAttribute 类参数说明：

调用示例

let firstCheckId = "my first check id";
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.trackFirstEvent(firstCheckId,attribute);

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

8.自定义事件首次事件

CustomAttributes 类参数说明：

_pay_amount与_currency_type，其他字段会被SDK舍弃

调用示例

let firstCheckId = "my first check id";

SolarEngine.trackFirstEvent(firstCheckId,attribute);

注：如果要上报自定义事件首次事件，那么eventName字段为必传字段，否则无法上报。