appsFlyer

addConversionListener

startAppsFlyer

setCollectIMEI

setCollectAndroidID

setCollectOaid

setDisableAdvertisingIdentifiers

setImeiData

setOaidData

setAndroidId

getAppsFlyerUID

setCustomerUserId

setUserEmails

addPushNotificationDeepLinkPath

trackEvent

概述

appsFlyer封装了appsFlyer的iOS、Android的SDK；通过集成appsFlyer SDK到移动应用中，用户可以获取关于应用安装、用户行为、广告效果等方面的详细数据，进行精确的应用分析和营销优化。

配置说明

<feature name="appsFlyer">
    <param name="devKey_Android" value=""/>//AppsFlyer 平台Android 的DevKey
    <param name="devKey_iOS" value=""/>//AppsFlyer 平台iOS 的DevKey
    <param name="appleAppID" value=""/>//AppsFlyer 平台iOS 的AppID
</feature>

接口

addConversionListener

AppsFlyer深度链接数据监听

addConversionListener(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
    evenType: '',//onInstallConversionFailure
               //onInstallConversionDataLoaded
               //onAttributionFailure
               //onAppOpenAttribution
    errorMessage: '',
    conversionData:'',
}

示例代码

var obj = api.require('appsFlyer');
obj.addConversionListener(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startAppsFlyer

启动AppsFlyer SDK

startAppsFlyer(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

err：

  • 类型：JSON对象
  • 内部字段：
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('appsFlyer');
obj.startAppsFlyer(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setCollectIMEI

是否采集IMEI

setCollectIMEI({params})

params

enable：

  • 类型：布尔型
  • 描述：(可选项) enable。
  • 默认值：true

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setCollectIMEI();
alert(JSON.stringify(ret));

可用性

Android系统

可提供的1.0.0及更高版本

setCollectAndroidID

是否采集AndroidID

setCollectAndroidID({params})

params

enable：

  • 类型：布尔型
  • 描述：(可选项) enable。
  • 默认值：true

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setCollectAndroidID();
alert(JSON.stringify(ret));

可用性

Android系统

可提供的1.0.0及更高版本

setCollectOaid

是否采集Oaid

setCollectOaid({params})

params

enable：

  • 类型：布尔型
  • 描述：(可选项) enable。
  • 默认值：true

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setCollectOaid();
alert(JSON.stringify(ret));

可用性

Android系统

可提供的1.0.0及更高版本

setDisableAdvertisingIdentifiers

DisableAdvertisingIdentifiers

setDisableAdvertisingIdentifiers({params})

params

enable：

  • 类型：布尔型
  • 描述：(可选项) enable。
  • 默认值：true

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setDisableAdvertisingIdentifiers();
alert(JSON.stringify(ret));

可用性

Android系统

可提供的1.0.0及更高版本

setImeiData

设置Imei

setImeiData({params})

params

imei：

  • 类型：字符串型
  • 描述：(必填项) imei。

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setImeiData({...});
alert(JSON.stringify(ret));

可用性

Android系统

可提供的1.0.0及更高版本

setOaidData

设置Oaid

setOaidData({params})

params

oaid：

  • 类型：字符串型
  • 描述：(必填项) oaid。

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setOaidData({...});
alert(JSON.stringify(ret));

可用性

Android系统

可提供的1.0.0及更高版本

setAndroidId

设置AndroidId

setAndroidId({params})

params

androidId：

  • 类型：字符串型
  • 描述：(必填项) androidId。

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setAndroidId({...});
alert(JSON.stringify(ret));

可用性

Android系统

可提供的1.0.0及更高版本

getAppsFlyerUID

获取AppsFlyerDeviceID

getAppsFlyerUID()

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
    appsFlyerId: ''
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.getAppsFlyerUID();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setCustomerUserId

设置客户用户ID(设置后，下次启动app会自动开启AppFlyer SDK)

setCustomerUserId({params})

params

userId：

  • 类型：字符串型
  • 描述：(必填项) userId。

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setCustomerUserId({...});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setUserEmails

设置用户电子邮件

setUserEmails({params})

params

email1：

  • 类型：字符串型
  • 描述：(可选项) email1。

email2：

  • 类型：字符串型
  • 描述：(可选项) email2。

email3：

  • 类型：字符串型
  • 描述：(可选项) email3。

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.setUserEmails({...});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addPushNotificationDeepLinkPath

设置PushNotificationDeepLinkPath

addPushNotificationDeepLinkPath({params})

params

data：

  • 类型：字符串型
  • 描述：(必填项) data。

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.addPushNotificationDeepLinkPath({...});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

trackEvent

设置事件

trackEvent({params})

params

eventType：

  • 类型：数字型
  • 描述：(必填项) 事件类型（1:达到级别,2:添加付款信息,3:添加到购物车,4:添加到心愿单,5:完成注册,6:教程完成,7:发起到结账,8:购买,9:订阅,10:Start Trial,11:评级,12:搜索,13:花掉的积分,14:解锁的成就,15:内容视图,16:列表视图,17:Ad Click,18:Ad VIew,19:旅行预定,20:分享,21:邀请,22:登陆,23:用户唤醒,24:从推送通知打开,25:更新）。

level：

  • 类型：数字型
  • 描述：(可选项) 级别（eventType==1）。

score：

  • 类型：数字型
  • 描述：(可选项) 得分（eventType==1）。

success：

  • 类型：布尔型
  • 描述：(可选项) 是否添加成功（eventType==2|6|12）。
  • 默认值：false

price：

  • 类型：浮点型
  • 描述：(可选项) 价格（eventType==3|4|7|8|10|13|15）。

contentType：

  • 类型：字符串型
  • 描述：(可选项) contentType（eventType==3|4|7|8|11|12|13|15|16|19）。

contentId：

  • 类型：字符串型
  • 描述：(可选项) contentId（eventType==3|4|6|7|8|11|13|15|19|25）。

content：

  • 类型：字符串型
  • 描述：(可选项) 内容（eventType==3|4|6|7|8|11|13|15）。

currency：

  • 类型：字符串型
  • 描述：(可选项) 货币（eventType==3|4|7|8|9|10|15|17|18）。

quantity：

  • 类型：数字型
  • 描述：(可选项) 数量（eventType==3|4|7|8）。

registrationMethod：

  • 类型：字符串型
  • 描述：(可选项) registrationMethod（eventType==5）。

paymentInfoAvailable：

  • 类型：布尔型
  • 描述：(可选项) paymentInfoAvailable（eventType==7）。
  • 默认值：false

revenue：

  • 类型：数字型
  • 描述：(可选项) 收入（eventType==8|9|19）。

orderId：

  • 类型：字符串型
  • 描述：(可选项) 订单ID（eventType==8）。

ratingValue：

  • 类型：浮点型
  • 描述：(可选项) ratingValue（eventType==11）。
  • 默认值：0

maxRatingValue：

  • 类型：浮点型
  • 描述：(可选项) maxRatingValue（eventType==11）。
  • 默认值：0

searchString：

  • 类型：字符串型
  • 描述：(可选项) searchString（eventType==12）。

description：

  • 类型：字符串型
  • 描述：(可选项) 描述（eventType==14|19|20|21|23）。

contentList：

  • 类型：数组型
  • 描述：(可选项) 描述（eventType==16）。

adType：

  • 类型：数字型
  • 描述：(可选项) adType（eventType==17|18）。

destinationA：

  • 类型：字符串型
  • 描述：(可选项) destinationA（eventType==19）。

destinationB：

  • 类型：字符串型
  • 描述：(可选项) destinationB（eventType==19）。

className：

  • 类型：字符串型
  • 描述：(可选项) className（eventType==19）。

dateA：

  • 类型：字符串型
  • 描述：(可选项) dateA（eventType==19）。

dateB：

  • 类型：字符串型
  • 描述：(可选项) dateB（eventType==19）。

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var obj = api.require('appsFlyer');
var ret = obj.trackEvent({...});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24