首次事件

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

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

方法示例

public static trackFirstEvent(seBaseEventModel: BaseEventModel)

参数说明

seBaseEventModel参数使用时需要传BaseEventModel的子类实例，具体说明如下：

调用示例

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

参数说明：

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

调用示例

import { SolarEngineManager } from '@solarengine/core'

let seFirstEventModel = new SEAdImpEventModel();
//如果不传checkId则当前事件会被当成正常事件上报，若传checkId则首次事件只会被调用一次，不会重复上报
seFirstEventModel.checkId = "11aaBB";
seFirstEventModel.adNetworkPlatform = "kuaishou";
seFirstEventModel.mediationPlatform = "Mintgaral";
seFirstEventModel.adType = 1;
seFirstEventModel.adNetworkAppID = "广告AppID";
seFirstEventModel.adNetworkADID = "广告ID";
seFirstEventModel.ecpm = 10.1;
seFirstEventModel.currencyType = "USD";
seFirstEventModel.isRenderSuccess = true;

let custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
seFirstEventModel.customProperties = custom_properties;

SolarEngineManager.trackFirstEvent(seFirstEventModel);

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

参数说明：

调用示例

import { SolarEngineManager } from '@solarengine/core'

let seAdClickEventModel = new SEAdClickEventModel();
seAdClickEventModel.checkId = "22bbCC";
seAdClickEventModel.adNetworkPlatform = "kuaishou";
seAdClickEventModel.mediationPlatform = "Mintgaral";
seAdClickEventModel.adType = 2;
seAdClickEventModel.adNetworkADID = "广告ID";

let custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
seAdClickEventModel.customProperties = custom_properties;

SolarEngineManager.trackFirstEvent(seAdClickEventModel);

3.自归因事件首次事件

参数说明：

调用示例

import { SolarEngineManager } from '@solarengine/core'

let seAttrEventModel = new SEAttributionEventModel();
//如果不传checkId则当前事件会被当成正常事件上报，若传checkId则首次事件只会被调用一次，不会重复上报 
seAttrEventModel.checkId = "33ccDD"
seAttrEventModel.adNetwork = "投放广告的渠道ID";
seAttrEventModel.subChannel = "投放广告的子渠道";
seAttrEventModel.adAccountId = "投放广告的投放账号ID";
seAttrEventModel.adAccountName = "投放广告的投放账号名称";
seAttrEventModel.adCampaignId = "投放广告的广告计划ID";
seAttrEventModel.adCampaignName = "投放广告的广告计划名称";
seAttrEventModel.adOfferId = "投放广告的广告单元ID";
seAttrEventModel.adOfferName = "投放广告的广告单元名称";
seAttrEventModel.adCreativeId = "投放广告的广告创意ID";
seAttrEventModel.adCreativeName = "投放广告的广告创意名称";
seAttrEventModel.attributionPlatform = "监测平台";

let custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";

seAttrEventModel.customProperties = custom_properties;
SolarEngineManager.trackFirstEvent(seAttrEventModel);

4.登录事件首次事件

参数说明：

调用示例

import { SolarEngineManager } from '@solarengine/core'

let seLoginEventModel = new SELoginEventModel();
seLoginEventModel.checkId = "44ddEE"
seLoginEventModel.loginType = "QQ";
seLoginEventModel.status = "success";

let custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
seLoginEventModel.customProperties = custom_properties;
SolarEngineManager.trackFirstEvent(seLoginEventModel);

5.注册事件首次事件

参数说明：

调用示例

import { SolarEngineManager } from '@solarengine/core'

let seRegisterEventModel = new SERegisterEventModel();
//如果不传checkId则当前事件会被当成正常事件上报，若传checkId则首次事件只会被调用一次，不会重复上报 
seRegisterEventModel.checkId = "55eeFF"
seRegisterEventModel.regType = "Wechat";
seRegisterEventModel.status = "success";

let custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
seRegisterEventModel.customProperties = custom_properties;

SolarEngineManager.trackFirstEvent(seRegisterEventModel);

6.订单事件首次事件

参数说明：

调用示例

import { SolarEngineManager } from '@solarengine/core'

let seOrderEventModel = new SEOrderEventModel();
//如果不传checkId则当前事件会被当成正常事件上报，若传checkId则首次事件只会被调用一次，不会重复上报 
seOrderEventModel.checkId = "66ffGG"
seOrderEventModel.orderId = "本次购买由系统生成的订单ID";
seOrderEventModel.payAmount = 10.11;
seOrderEventModel.currencyType = "USD";
seOrderEventModel.payType = "alipay";
seOrderEventModel.status = "success";

let custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
seOrderEventModel.customProperties = custom_properties;

SolarEngineManager.trackFirstEvent(seOrderEventModel);

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

参数说明:

调用示例

import { SolarEngineManager } from '@solarengine/core'

let sePurchaseEventModel = new SEPurchaseEventModel();
//如果不传checkId则当前事件会被当成正常事件上报，若传checkId则首次事件只会被调用一次，不会重复上报 
sePurchaseEventModel.checkId = "77ggHH";
sePurchaseEventModel.orderId = "本次购买由系统生成的订单ID";
sePurchaseEventModel.payAmount = 11.01;
sePurchaseEventModel.currencyType = "CNY";
sePurchaseEventModel.payType = "alipay";
sePurchaseEventModel.productId = "购买商品的ID";
sePurchaseEventModel.productName = "购买商品的名称";
sePurchaseEventModel.productNum = 66;
sePurchaseEventModel.payStatus = 2;
sePurchaseEventModel.failReason = "failed";

let custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
sePurchaseEventModel.customProperties = custom_properties;

SolarEngineManager.trackFirstEvent(sePurchaseEventModel);

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

8.自定义事件首次事件

参数说明:

preProperties

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

调用示例

import { SolarEngineManager } from '@solarengine/core'

let seCustomEventModel = new SECustomEventModel();
//如果不传checkId则当前事件会被当成正常事件上报，若传checkId则首次事件只会被调用一次，不会重复上报 
seCustomEventModel.checkId = "88hhII"
//如果要上报自定义事件首次事件，那么eventName字段为必传字段，否则无法上报
seCustomEventModel.eventName = "your_custom_event_name"

//设置预置属性，目前只支持_pay_amount与_currency_type，其他字段会被SDK舍弃
let preProperties: Record<string, Object> = {};
preProperties["_pay_amount"] = 11.2;
preProperties["_currency_type"] = "USD";
seCustomEventModel.preProperties = preProperties;

let custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
seCustomEventModel.customProperties = custom_properties;

SolarEngineManager.trackFirstEvent(seCustomEventModel);

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