更新记录

1.0（2024-03-02）

初始化发布

平台兼容性

Android	Android CPU类型	iOS
适用版本区间：4.4 - 14.0	armeabi-v7a：未测试，arm64-v8a：未测试，x86：未测试	适用版本区间：9 - 17

原生插件通用使用流程：

购买插件，选择该插件绑定的项目。
在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

adjust接入

[eventListener](#a1) [trackEvent](#a2) [setEnabled](#a3) [isEnabled](#a4) [setReferrer](#a5) [setOfflineMode](#a6) [setPushToken](#a7) [appWillOpenUrl](#a8) [sendFirstPackages](#a9) [addSessionCallbackParameter](#a10) [addSessionPartnerParameter](#a11) [removeSessionCallbackParameter](#a12) [removeSessionPartnerParameter](#a13) [resetSessionCallbackParameters](#a14) [resetSessionPartnerParameters](#a15) [gdprForgetMe](#a16) [getGoogleAdId](#a17) [getAdid](#a18) [getAmazonAdId](#a19) [getAttribution](#a20) [requestTrackingAuthorizationWithCompletionHandler](#a21) [appTrackingAuthorizationStatus](#a22) [updateConversionValue](#a23) [trackPlayStoreSubscription](#a24) [trackAdRevenue](#a25) [trackThirdPartySharing](#a26) [trackThirdPartySharing1](#a27) [trackMeasurementConsent](#a28)

概述

XF-adjust模块，实现了安卓平台集成adjust移动数据分析sdk。

模块使用攻略 1、方案一：Android离线打包manifests配置信息如下：

<application>
<meta-data android:name="Adjust_AppToken" android:value="11uabiie1vqo"/>
<meta-data android:name="Adjust_logLevel" android:value="DEBUG"/>
<meta-data android:name="Adjust_environment" android:value="sandbox"/>
<meta-data android:name="Adjust_eventBufferingEnabled" android:value="false"/>
<meta-data android:name="Adjust_defaultTracker" android:value="u9n28xe"/>
<meta-data android:name="Adjust_sendInBackground" android:value="true"/>
<meta-data android:name="Adjust_isDeviceKnown" android:value="true"/>
<meta-data android:name="Adjust_shouldLaunchDeeplink" android:value="false"/>
<meta-data android:name="Adjust_delayStart" android:value="0.01"/>
</application>
//添加引用
implementation 'com.adjust.sdk:adjust-android:4.32.0'
implementation 'com.android.installreferrer:installreferrer:2.2'
implementation 'com.google.android.gms:play-services-ads-identifier:17.0.1'

2、方案二：Android在线打包插件配置信息如下：

Adjust_AppToken：

类型：字符串
描述：（必填项）Android端的appToken

Adjust_logLevel：

类型：字符串
描述：（可选项）日志级别(VERBOSE DEBUG INFO WARN ERROR ASSERT SUPPRESS)
默认值：INFO

Adjust_environment：

类型：字符串
描述：（可选项）sdk插件模式(sandbox production)。
默认值：production

Adjust_eventBufferingEnabled：

类型：布尔值
描述：（可选项）是否开启事件缓冲(true开启，false不开启)。
默认值：false

Adjust_defaultTracker：

类型：字符串
描述：（可选项）预安装跟踪码。

Adjust_userAgent：

类型：字符串
描述：（可选项）userAgent。

Adjust_secretId：

类型：数字型
描述：（可选项）SDK签名:secretId。

Adjust_info1：

类型：数字型
描述：（可选项）SDK签名:info1。

Adjust_info2：

类型：数字型
描述：（可选项）SDK签名:info2。

Adjust_info3：

类型：数字型
描述：（可选项）SDK签名:info3。

Adjust_info4：

类型：数字型
描述：（可选项）SDK签名:info4。

Adjust_sendInBackground：

类型：布尔值
描述：（可选项）是否开启后台跟踪(true开启，false不开启)。
默认值：false

Adjust_isDeviceKnown：

类型：布尔值
描述：（可选项）是否开启isDeviceKnown(true开启，false不开启)。
默认值：false

Adjust_shouldLaunchDeeplink：

类型：布尔值
描述：（可选项）是否开启延迟深度链接场景(true开启，false不开启)。
默认值：false

Adjust_delayStart：

类型：浮点型
描述：（可选项）延迟启动。
默认值：0.0

3、方案三：iOS离线打包Info.plist配置信息如下：

   <key>Adjust_AppToken</key>
    <string>11uabiie1vqo</string>
    <key>Adjust_logLevel</key>
    <string>INFO</string>
    <key>Adjust_environment</key>
    <string>sandbox</string>
    <key>Adjust_eventBufferingEnabled</key>
    <string>false</string>
    <key>Adjust_defaultTracker</key>
    <string>u9n28xe</string>
    <key>Adjust_sendInBackground</key>
    <string>true</string>
    <key>Adjust_userAgent</key>
    <string></string>
    <key>Adjust_isDeviceKnown</key>
    <string>true</string>
    <key>Adjust_shouldLaunchDeeplink</key>
    <string>false</string>
    <key>Adjust_delayStart</key>
    <string>0.01</string>
    <key>Adjust_deactivateSKAdNetworkHandling</key>
    <string>true</string>

4、方案四：iOS在线打包插件配置信息如下：

Adjust_AppToken：

类型：字符串
描述：（必填项）iOS端的appToken

Adjust_logLevel：

类型：字符串
描述：（可选项）日志级别(VERBOSE DEBUG INFO WARN ERROR ASSERT SUPPRESS)
默认值：INFO

Adjust_environment：

类型：字符串
描述：（可选项）sdk插件模式(sandbox production)。
默认值：production

Adjust_eventBufferingEnabled：

类型：布尔值
描述：（可选项）是否开启事件缓冲(true开启，false不开启)。
默认值：false

Adjust_defaultTracker：

类型：字符串
描述：（可选项）预安装跟踪码。

Adjust_userAgent：

类型：字符串
描述：（可选项）userAgent。

Adjust_secretId：

类型：数字型
描述：（可选项）SDK签名:secretId。

Adjust_info1：

类型：数字型
描述：（可选项）SDK签名:info1。

Adjust_info2：

类型：数字型
描述：（可选项）SDK签名:info2。

Adjust_info3：

类型：数字型
描述：（可选项）SDK签名:info3。

Adjust_info4：

类型：数字型
描述：（可选项）SDK签名:info4。

Adjust_sendInBackground：

类型：布尔值
描述：（可选项）是否开启后台跟踪(true开启，false不开启)。
默认值：false

Adjust_isDeviceKnown：

类型：布尔值
描述：（可选项）是否开启isDeviceKnown(true开启，false不开启)。
默认值：false

Adjust_shouldLaunchDeeplink：

类型：布尔值
描述：（可选项）是否开启延迟深度链接场景(true开启，false不开启)。
默认值：false

Adjust_delayStart：

类型：浮点型
描述：（可选项）延迟启动。
默认值：0.0

Adjust_deactivateSKAdNetworkHandling：

类型：布尔值
描述：（可选项）是否停用SK广告网络处理。
默认值：true

eventListener

数据监听

eventListener(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    evenType : "adjust_attribution"//返回事件类型
                //adjust_attribution   跟踪链接归因变化的通知
                //adjust_eventTrackingSucceeded 用来跟踪成功事件
                //adjust_eventTrackingFailed 跟踪失败事件
                //adjust_sessionTrackingSucceeded 跟踪成功会话
                //adjust_sessionTrackingFailed 跟踪失败会话
                //adjust_deferredDeeplink  一旦Adjust SDK从后台获取到关于深度链接内容的信息，该监听器将被触发。
    data:{
    }
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.eventListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

trackEvent

事件跟踪

trackEvent({params}, callback(ret))

params

eventToken：

类型：字符串
描述：（必填项）事件名称

currency：

类型：字符串
描述：（可选项）收入跟踪货币类型如:EUR 为空时收入跟踪无效

revenue：

类型：浮点型
描述：（可选项）收入金额(currency不为空时有效)。
默认值：0.0

transactionId：

类型：字符串
描述：（可选项）订单id,便于重复数据过滤.

callbackParameters：

类型：JSON串
描述：（可选项）回调参数.

partnerParameters：

类型：JSON串
描述：（可选项）合作伙伴参数.

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.trackEvent({
    eventToken : '',//事件名称
}, function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setEnabled

开启或者关闭Adjust SDK

setEnabled({params}, callback(ret))

params

enabled：

类型：布尔型
描述：（可选项）true 开启 false关闭。
默认值：false

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.setEnabled(function(ret) {});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

isEnabled

查看Adjust SDK目前是否被启用

isEnabled(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.isEnabled(function(ret) {});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setReferrer

设置referrer

setReferrer({params}, callback(ret))

params

referrer：

类型：字符串
描述：（必填项）referrer。

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.setReferrer({
        referrer : ''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setOfflineMode

离线模式

setOfflineMode({params}, callback(ret))

params

enabled：

类型：布尔型
描述：（可选项）true 开启离线 false终止离线模式。
默认值：false

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.setOfflineMode({
    enabled : true
},function(ret) {});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setPushToken

推送标签（Push token）[每当您获取或更新识别码时调用]

setPushToken({params}, callback(ret))

params

token：

类型：字符串
描述：（必填项）标签。

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.setPushToken({
    token: ''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

appWillOpenUrl

通过深度链接的再归因(一旦您已经在应用中收到深度链接内容信息，请添加回传至Adjust.appWillOpenUrl方式)

appWillOpenUrl({params}, callback(ret))

params

strUri：

类型：字符串
描述：（必填项）深度链接信息。

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.appWillOpenUrl({
    strUri : ''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

sendFirstPackages

用户将Adjust SDK将恢复正常

sendFirstPackages(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.sendFirstPackages(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addSessionCallbackParameter

会话回调参数

addSessionCallbackParameter({params}, callback(ret))

params

key：

类型：字符串
描述：（必填项）自定义key。

value：

类型：字符串
描述：（可选项）自定义value。

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.addSessionCallbackParameter({
    key : '',
    value : ''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addSessionPartnerParameter

会话合作伙伴参数

addSessionPartnerParameter({params}, callback(ret))

params

key：

类型：字符串
描述：（必填项）自定义key。

value：

类型：字符串
描述：（可选项）自定义value。

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.addSessionPartnerParameter({
    key : '',
    value : ''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

removeSessionCallbackParameter

删除特定会话回调参数

removeSessionCallbackParameter({params}, callback(ret))

params

key：

类型：字符串
描述：（必填项）自定义key。

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.removeSessionCallbackParameter({
    key : ''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

removeSessionPartnerParameter

删除特定会话回调参数

removeSessionPartnerParameter({params}, callback(ret))

params

key：

类型：字符串
描述：（必填项）自定义key。

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.removeSessionPartnerParameter({
    key : ''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

resetSessionCallbackParameters

删除会话回调参数中所有的Key及相应值

resetSessionCallbackParameters(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.resetSessionCallbackParameters(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

resetSessionPartnerParameters

删除会话合作伙伴参数中所有的Key及其相应值

resetSessionPartnerParameters(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.resetSessionPartnerParameters(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

gdprForgetMe

GDPR 的被遗忘权(根据欧盟的《一般数据保护条例》(GDPR) 第 17 条规定，用户行使被遗忘权时，您可以通知 Adjust)

gdprForgetMe(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.gdprForgetMe(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getGoogleAdId

获取 Google 广告ID

getGoogleAdId(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,
    GoogleAdId : ''
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.getGoogleAdId(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

getAdid

获取 Adjust设备ID

getAdid(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,
    AdId : ''
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.getAdid(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getAmazonAdId

获取 Amazon广告ID

getAmazonAdId(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,
    AmazonAdId : ''
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.getAmazonAdId(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

getAttribution

用户归因

getAttribution(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,
    Attribution : {
        //...
    }
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.getAttribution(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

requestTrackingAuthorizationWithCompletionHandler

应用跟踪授权包装器

requestTrackingAuthorizationWithCompletionHandler(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status: true,
    code : 0,// 0: (授权状态待定) 1: (授权状态受限) 2:(已拒绝) 3:(已授权)
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
demo.requestTrackingAuthorizationWithCompletionHandler(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS系统

可提供的1.0.0及更高版本

appTrackingAuthorizationStatus

获得当前授权状态

appTrackingAuthorizationStatus()

ret：

类型：JSON对象
内部字段：

{
    status: true,
    code : 0,//  0：用户尚未收到请求 1：用户设备受限 2：用户拒绝提供 IDFA 3：用户授权访问 IDFA -1：状态不可用
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
var ret = demo.appTrackingAuthorizationStatus();
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

updateConversionValue

更新 SKAdNetwork 转化值

updateConversionValue({params})

params

conversionValue：

类型：数字型
描述：（必填项）conversionValue。
默认值：0

ret：

类型：JSON对象
内部字段：

{
    status: true,
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
var ret = demo.updateConversionValue({});
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

trackPlayStoreSubscription

订阅跟踪

trackPlayStoreSubscription({params})

params

price：

类型：字符串型
描述：（可选项）price。
默认值：0

currency：

类型：字符串型
描述：（可选项）currency。

orderId：

类型：字符串型
描述：（必填项）orderId。

receipt：

类型：字符串型
描述：（可选项）receipt。

purchaseTime：

类型：字符串型
描述：（可选项）purchaseTime。

salesRegion：

类型：字符串型
描述：（可选项）salesRegion。

callbackParameters：

类型：JSON型
描述：（可选项）callbackParameters。

partnerParameters：

类型：JSON型
描述：（可选项）partnerParameters。

ret：

类型：JSON对象
内部字段：

{
    status: true,
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
var ret = demo.trackPlayStoreSubscription({});
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

trackAdRevenue

广告收入跟踪

trackAdRevenue({params})

params

source：

类型：字符串型
描述：（必填项）source。

payload：

类型：数组型
描述：（必填项）payload。

ret：

类型：JSON对象
内部字段：

{
    status: true,
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
var ret = demo.trackAdRevenue({});
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

trackThirdPartySharing

为具体用户启用或重启第三方数据分享

trackThirdPartySharing({params})

params

isEnabled：

类型：布尔型
描述：（必填项）isEnabled。
默认值：false

ret：

类型：JSON对象
内部字段：

{
    status: true,
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
var ret = demo.trackThirdPartySharing({});
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

trackThirdPartySharing1

为具体用户启用或重启第三方数据分享

trackThirdPartySharing1({params})

params

partnerName：

类型：布尔型
描述：（必填项）partnerName。

partnerKey：

类型：布尔型
描述：（必填项）partnerKey。

partnerValue：

类型：布尔型
描述：（必填项）partnerValue。

ret：

类型：JSON对象
内部字段：

{
    status: true,
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
var ret = demo.trackThirdPartySharing1({});
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

trackMeasurementConsent

监测具体用户的许可

trackMeasurementConsent({params})

params

consentMeasurement：

类型：布尔型
描述：（必填项）是否准许许可。
默认值：false

ret：

类型：JSON对象
内部字段：

{
    status: true,
}

示例代码

var demo = uni.requireNativePlugin('XF-adjust');
var ret = demo.trackMeasurementConsent({});
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

实现了安卓平台集成adjust移动数据分析sdk adjust

更新记录

1.0（2024-03-02）

平台兼容性

原生插件通用使用流程：

adjust接入

概述

eventListener

callback(ret)

示例代码

可用性

trackEvent

params

callback(ret)

示例代码

可用性

setEnabled

params

callback(ret)

示例代码

可用性

isEnabled

callback(ret)

示例代码

可用性

setReferrer

params

callback(ret)

示例代码

可用性

setOfflineMode

params

callback(ret)

示例代码

可用性

setPushToken

params

callback(ret)

示例代码

可用性

appWillOpenUrl

params

callback(ret)

示例代码

可用性

sendFirstPackages

callback(ret)

示例代码

可用性

addSessionCallbackParameter

params

callback(ret)

示例代码

可用性

addSessionPartnerParameter

params

callback(ret)

示例代码

可用性

removeSessionCallbackParameter

params

callback(ret)

示例代码

可用性

removeSessionPartnerParameter

params

callback(ret)

示例代码

可用性

resetSessionCallbackParameters

callback(ret)

示例代码

可用性

resetSessionPartnerParameters

callback(ret)

示例代码

可用性

gdprForgetMe

callback(ret)

示例代码