更新记录

1.0（2024-11-21）

插件1.0版本发布

平台兼容性

lilu-dysdk-convert

开发文档

UTS 语法 UTS API插件 UTS 组件插件 Hello UTS

插件介绍

1. 该插件封装了抖音的巨量广告转化安卓端SDK，该转化SDK版本号为6.16.9，接入该SDK后可挂抖音小风车，
    SDK文档地址：https://bytedance.feishu.cn/docx/doxcnjAFo7iUImEIq9DuA7Tr69g

2. 实现了巨量广告转化SDK中的初始化、上报注册事件、上报支付事件等方法。

3. 该插件同时也集成了抖音应用管理中心分包SDK，既：HumeSDK-1.1.1.aar，可以获取抖音分包之后渠道号，
    SDK文档地址：https://bytedance.feishu.cn/docs/doccnWHO1ZOWn3YrZVblvoEw4th#

API列表

    /**
     *  设置抖音巨量转化SDK参数
     *  @param appId 抖音后台获取的appId,可参考第一个文档的2.1节获取
     *  @param channel 渠道信息，请注意不能为空
     */
    void setSdkParam(String appId, String channel)

    /**
     * 初始化巨量广告转化SDK
     */
    void initAppLog()

    /**
     *  上报注册事件
     *  @param registerType 注册类型
     *  @param success 是否成功
     */
    void onEventRegister(String registerType, boolean success)

    /**
     *  上报购买支付事件
     *  @param goodsType 商品类型
     *  @param goodsName 商品名称
     *  @param goodsId 商品ID
     *  @param goodsNum 商品数量
     *  @param payChannel 支付渠道
     *  @param currency 币种
     *  @param success 是否成功
     *  @param amount 金额，单位为元
     */
    void onEventPurchase(String goodsType, String goodsName, String goodsId, int goodsNum, String payChannel, 
        String currency, boolean success, int amount )

    /**
     * 检查是否授权READ_PHONE_STATE，该权限用于巨量广告转化SDK的初始化，记录设备激活事件
     * @return boolean  是否已授权
     */
    boolean checkPermissionBeforeInit()

    /**
     * 手动请求权限READ_PHONE_STATE，该权限用于巨量广告转化SDK的初始化，记录设备激活事件
     * 调用该方法之后就不用调用initAppLog()方法了，sdk会在请求授权的回调里面自动调用该方法
     */
    void requestPermissionForInit()

    /**
     * 获取抖音分包后的渠道号
     */
    string getChannel()

    /**
     * 设置设备的mac地址采集开关，默认开启，一般不需要修改
     */
    void setMacEnable(boolean macEnable);

    /**
     * 设置设备的imei地址采集开关，默认开启，一般不需要修改
     */
    void setImeiEnable(boolean imeiEnable);

    /**
     * 设置设备的Android ID采集开关，默认开启，一般不需要修改
     */
    void setAndroidIdEnabled(boolean androidIdEnabled);

    /**
     * 设置设备的ICCID采集开关，默认开启，一般不需要修改
     */
    void setIccIdEnabled(boolean iccIdEnabled);

    /**
     * 设置设备的SN（硬件序列号）采集开关，默认开启，一般不需要修改
     */
    void setSerialNumberEnable(boolean serialNumberEnable);

    /**
     * 设置设备的GAID采集开关，cn 默认关闭，global 默认打开，一般不需要修改
     */
    void setGaidEnabled(boolean gaidEnabled);

    /**
     * 设置设备的运营商信息采集开关，默认开启，一般不需要修改
     */
    void setOperatorInfoEnabled(boolean operatorInfoEnabled);

SDK调用流程

1. 首先调用setSdkParam(String appId, String channel)方法，将初始化参数传入SDK。

2. 调用checkPermissionBeforeInit()方法检查用户是否已经授权READ_PHONE_STATE权限，如果已授权则直接调用initAppLog()方法激活巨量广告转化SDK。

3. 如果第2部中检查未授权，则弹出框提示用户将要请求权限，用户点击确认按钮后调用方法requestPermissionForInit()，注意，示例中只会弹出一次请求，如果用户拒绝后续将不会继续弹出请求窗口。

5. 用户在点击同意授权后，系统会自动调用initAppLog()方法激活巨量广告转化SDK，开发人员无须另外处理。

7. 在用户注册成功回调里面调用SDK方法onEventRegister，在支付成功的回调里面调用SDK方法onEventPurchase。

SDK激活与获取渠道号示例

    //该页面以App.vue为例
    <template>

        ...

    </template>

    <script>
        //引入SDK，from后面的路径请根据您项目中具体页面位置编写，一般是在uni_modules下面
        import * as UTSDySdk from "uni_modules/lilu-dysdk-convert"

        export default {
            data() {
                return {
                }
            },
            onLoad() {
                this.runDouyinSdk();
                this.getDouyinChannel();
            },
            methods: {
                runDouyinSdk() {
                    UTSDySdk.setSdkParam("xxxxxx", "1")//初始化sdk参数, 这里需要将xxxxxx替换成真实的appId
                    let granted = UTSDySdk.checkPermissionBeforeInit();
                    console.log('检查权限结果: ' + granted);

                    if (granted) { //已经授权
                        UTSDySdk.initAppLog();
                    } else { //未授权
                        //是否已经弹出过权限申请窗口，如果已弹出则不弹
                        let showPermission = uni.getStorageSync('showPermission') || '0'
                        if (showPermission !== '1') { //第一次弹出授权请求窗口
                            let me = this;
                            uni.showModal({
                                title: '提示',
                                content: '为保证您正常、安全地使用，需要获取设备识别码（部分手机提示为获取手机号码/拨打电话）使用权限，请允许。',
                                showCancel: false,
                                success: function(res) {
                                    if (res.confirm) {
                                        uni.setStorageSync('showPermission', '1');
                                        UTSDySdk.requestPermissionForInit();
                                    }
                                }
                            })
                        }
                    }
                }，
                getDouyinChannel() {
                    //获取抖音分包的渠道号 : result.dyChannel
                    let douyinChannel = UTSDySdk.getChannel() || '0';//app未在巨量后台分包的话就会获取空
                    uni.setStorageSync('douyinChannel', douyinChannel);
                },
            }
        }
    </script>

上报注册事件示例

    <template>

        ...

    </template>

    <script>
        //from后面的路径请根据您项目中具体页面位置编写，一般是在uni_modules下面
        import {onEventRegister} from '../../uni_modules/lilu-dysdk-convert'

        export default {
            data() {
                return {
                }
            },
            methods: {
                onRegister() {//这个方法可以在注册成功的回调里面调用
                    onEventRegister('xxxxx', true);//xxxxx替换为自己的注册方式，自定义就可以
                }

            }
        }
    </script>

上报消费支付示例

    <template>

        ...

    </template>

    <script>
        //from后面的路径请根据您项目中具体页面位置编写，一般是在uni_modules下面
        import {onEventPurchase} from '../../uni_modules/lilu-dysdk-convert'

        export default {
            data() {
                return {
                }
            },
            methods: {
                onPurchase() {//这个方法可以在支付成功的回调里面调用
                    onEventPurchase("充值", '600钻石', "1001", 1, "ptb", "¥", true, 6);//根据自己实际场景替换参数，可参考API
                }

            }
        }
    </script>