变现广告展示事件

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

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

广告展示事件的 _event_name 为 _appImp

方法示例

public static trackAdImpression(seAdImpEventModel: SEAdImpEventModel)

SEAdImpEventModel类参数说明：

（各聚合平台调用示例参见：调用示例）

参数名称	参数含义	参数类型	是否必传
adNetworkPlatform	变现平台例如：变现平台为快手时，只需要传入 kuaishou 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	是
mediationPlatform	聚合平台标识，常见聚合平台枚举如下，若您使用的聚合平台不在如下枚举值，您可以自定义命名，并控制字符数在32位。没有聚合平台标识，请设置为 "custom"。 max ironsource admob hyperbid topon cas Tradplus Tobid	string	是
adType	展示广告的类型，枚举值如下：例如：adType 为激励视频时，只需要传入 1 1：激励视频 2：开屏 3：插屏 4：全屏视频 5：Banner 6：信息流 7：短视频信息流 8：大横幅 9：视频贴片 10：中等尺寸横幅 0：其它	number	是
adNetworkAppID	变现平台的应用 ID	string	否
adNetworkADID	变现平台的变现广告位 ID	string	是
ecpm	广告 ecpm，单位：元（广告千次展现的变现收入，0或负值表示没传，单位为元）	number	是
currencyType	展示收益的货币种类，遵循《ISO 4217国际标准》，如 CNY、USD	string	是
isRenderSuccess	广告是否渲染成功，具体枚举值如下：例如：成功时，只需要传入 true true：成功 false：失败如果不需要统计该指标，请传 true	boolean	是
customProperties	开发者传入的自定义属性	Record<string,Object>	否

调用示例

import { SolarEngineManager } from '@solarengine/core'

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

let impModel = new SEAdImpEventModel();
impModel.adNetworkPlatform = "Mintegral";
impModel.mediationPlatform = "gromore";
impModel.adType = 1;
impModel.adNetworkAppID = "xxxAppIDxxx";
impModel.adNetworkADID = "xxx广告IDxxx";
impModel.ecpm = 16;
impModel.currencyType = "CNY";
impModel.isRenderSuccess = true;
impModel.customProperties = custom_properties;

SolarEngineManager.trackAdImpression(impModel);

变现广告点击事件

用户点击变现广告时上报， _event_name 为 _appClick

方法示例

public static trackAdClick(seAdClickEventModel: SEAdClickEventModel)

SEAdClickEventModel类参数说明：

参数名称	参数含义	参数类型	是否必传
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（DT Exchange） chartboost：Chartboost adcolony：Adcolony inmobi：Inmobi	string	是
mediationPlatform	聚合平台标识，常见聚合平台枚举如下，若您使用的聚合平台不在如下枚举值，您可以自定义命名，并控制字符数在32位。没有聚合平台标识，请设置为 "custom"。 max ironsource admob hyperbid topon cas Tradplus Tobid	string	是
adType	展示广告的类型，枚举值如下（传值传前面的枚举简称即可）： 1：激励视频 2：开屏 3：插屏 4：全屏视频 5：Banner 6：信息流 7：短视频信息流 8：大横幅 9：视频贴片 0：其它	number	是
adNetworkADID	变现平台的变现广告位 ID	string	是
customProperties	开发者传入的自定义属性	Record<string,Object>	否

调用示例

import { SolarEngineManager } from '@solarengine/core'

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

let clickEventModel = new SEAdClickEventModel();
clickEventModel.adNetworkPlatform = "Mintegral";
clickEventModel.mediationPlatform = "gromore";
clickEventModel.adType = 1;
clickEventModel.adNetworkADID = "xxx广告IDxxx";
clickEventModel.customProperties = custom_properties;

SolarEngineManager.trackAdClick(clickEventModel);

应用内购买事件

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

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

应用内购买事件的 _event_name 为 _appPur

方法示例

public static trackPurchase(sePurchaseEventModel: SEPurchaseEventModel)

SEPurchaseEventModel类参数说明：

参数名称	参数含义	参数类型	是否必传
orderId	本次购买由系统生成的订单 ID	string	否，投放荣耀商推、网易有道、豆瓣和oppo时必填
payAmount	本次购买支付的金额，单位：元	number	是
currencyType	支付的货币类型，遵循《ISO 4217国际标准》，如 CNY、USD	string	是
payType	支付方式：如 alipay、weixin、applepay、paypal 等	string	否
productId	购买商品的ID	string	否
productName	商品名称	string	否
productNum	购买商品的数量	number	否
payStatus	支付状态，例如：成功时，只需要传入 1 1：成功 2：失败	number	是
failReason	支付失败的原因	string	否
customProperties	开发者传入的自定义属性	Record<string,Object>	否

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

调用示例

import { SolarEngineManager } from '@solarengine/core';

let purchaseEventModel = new SEPurchaseEventModel();
purchaseEventModel.orderId = "xxx订单IDxxx";
purchaseEventModel.payAmount = 100;
purchaseEventModel.currencyType = "CNY";
purchaseEventModel.payType = "weixin";
purchaseEventModel.productId = "xxx 商品IDxxx";
purchaseEventModel.productName = "xxx商品名称xxx";
purchaseEventModel.productNum = 1;
purchaseEventModel.payStatus = 1;

const custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
custom_properties["key3"] = "value3";
purchaseEventModel.customProperties = custom_properties;
SolarEngineManager.trackPurchase(purchaseEventModel);

SolarEngineManager.trackPurchase(sEPurchaseEventModel);

订单事件

用户产生订单时上报，_event_name 为 _appOrder

方法示例

public static trackOrder(seOrderEventModel: SEOrderEventModel)

SEOrderEventModel类参数说明：

参数名称	参数含义	参数类型	是否必传
orderId	订单 ID	string	否，投放荣耀商推、网易有道、豆瓣和oppo时必填
payAmount	订单金额，单位：元	number	是
currencyType	支付的货币类型，遵循《ISO 4217国际标准》，如 CNY、USD	string	是
payType	支付方式：如 alipay、weixin、applepay、paypal 等	string	否
status	订单状态	string	否
customProperties	开发者传入的自定义属性	Record<string,Object>	否

调用示例

import { SolarEngineManager } from '@solarengine/core';

let orderEventModel = new SEOrderEventModel();
orderEventModel.orderId = "xxx订单IDxxx";
orderEventModel.payAmount = 100;
orderEventModel.currencyType = "CNY";
orderEventModel.payType = "weixin";
orderEventModel.status = "xxx订单状态xxx";

const custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
custom_properties["key3"] = "value3";
sEPurchaseEventModel.customProperties = custom_properties;

SolarEngineManager.trackOrder(orderEventModel);

注册事件

用户产生注册行为时上报，_event_name 为 _appReg

方法示例

public static trackAppRegister(seRegisterEventModel: SERegisterEventModel)

SERegisterEventModel类参数说明：

参数名称	参数含义	参数类型	是否必传
regType	注册类型如 WeChat、QQ 等自定义值	string	是
status	注册状态	string	否
customProperties	开发者传入的自定义属性	Record<string,Object>	否

调用示例

import { SolarEngineManager } from '@solarengine/core';

let registerEventModel = new SERegisterEventModel();
registerEventModel.regType = "QQ";
registerEventModel.status = "success";

const custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
custom_properties["key3"] = "value3";
sEPurchaseEventModel.customProperties = custom_properties;

SolarEngineManager.trackAppRegister(registerEventModel);

登录事件

用户产生登录行为时上报，_event_name 为 _appLogin，在登录成功后应调用设置账号 ID 方法，以便后续产生的事件中带有登录的账号 ID

方法示例

public static trackAppLogin(seLoginEventModel: SELoginEventModel)

SELoginEventModel类参数说明：

参数名称	参数含义	参数类型	是否必传
loginType	登录类型如 WeChat、QQ 等自定义值	string	是
status	登录状态	string	否
customProperties	开发者传入的自定义属性	Record<string,Object>	否

调用示例

import { SolarEngineManager } from '@solarengine/core';

let loginEventModel = new SELoginEventModel();
loginEventModel.loginType = "QQ";
loginEventModel.status = "success";

const custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
custom_properties["key3"] = "value3";
sEPurchaseEventModel.customProperties = custom_properties;

SolarEngineManager.trackAppLogin(loginEventModel);

上报自归因事件

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

自归因事件的 _event_name 为 _appAttr

方法示例

public static trackAppAttribution(seAttributionEventModel: SEAttributionEventModel)

SEAttrEventModel类参数说明：

参数名称	参数含义	参数类型	是否必传
adNetwork	投放广告的渠道 ID，需要与ROI分析匹配	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	开发者传入的自定义属性	Record<string, Object>	否

调用示例

import { SolarEngineManager } from '@solarengine/core';

let attributionEventModel = new SEAttributionEventModel();
attributionEventModel.adNetwork = "xxx广告的渠道IDxxx";
attributionEventModel.subChannel = "xxx投放广告的子渠道xxx";
attributionEventModel.adAccountId = "xxx投放广告的投放账号IDxxx";
attributionEventModel.adAccountName = "xxx投放广告的投放账号名称xxx";
attributionEventModel.adCampaignId = "xxx投放广告的广告计划IDxxx";
attributionEventModel.adCampaignName = "xxx投放广告的广告计划名称xxx";
attributionEventModel.adOfferId = "xxx投放广告的广告单元IDxxx";
attributionEventModel.adOfferName = "xxx投放广告的广告单元名称xxx";
attributionEventModel.adCreativeId = "xxx投放广告的广告创意IDxxx";
attributionEventModel.adCreativeName = "xxx投放广告的广告创意名称xxx";
attributionEventModel.attributionPlatform = "xxx广告监测平台xxx";

const custom_properties: Record<string, Object> = {};
custom_properties["key1"] = "value1";
custom_properties["key2"] = "value2";
custom_properties["key3"] = "value3";
sEPurchaseEventModel.customProperties = custom_properties;
SolarEngineManager.trackAppAttribution(attributionEventModel);

可选功能