Harmony SDK 集成指南

一、下载并导入 SDK

从下载中心下载 Harmony最新版本 SDK 压缩包解压后将文件导入工程。并在主工程oh-package.json5里配置包引用路径，样例如下:

{
  "dependencies": {
    "@xinstall/sdk": "接入的xinstall的包路径",
  }
}

使用 ohpm install 命令将安装最新版本的 sdk

ohpm install @xinstall/sdk

如需更新，请使用 ohpm update 命令

ohpm update @xinstall/sdk

在 module.json5配置文件中配置 appkey 和需要的权限

{
  "module": {
    // ...
    "metadata": [
      {
        "name": "com.xinstall.APP_KEY",
        "value": "xinstall生成的appkey",
      }
    ], 
    "requestPermissions": [
      {
        "name": "ohos.permission.INTERNET"
      },
      {
        "name": "ohos.permission.GET_WIFI_INFO"
      },
      {
        "name": "ohos.permission.GET_BUNDLE_INFO"
      },
      {
        "name": "ohos.permission.STORE_PERSISTENT_DATA"
      }
    ],
  }
}

二、初始化

在应用入口Ability里初始化SDK(确保用户接受了隐私协议后再调用init接口):

export default classEntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    //初始化sdk
    const isReceive = //隐私协议是否接受
    if (isReceive) {
      //已经接受了隐私协议
      XInstall.init(this.context);
    } else {
      //未接受
    }
  }
}

三、功能集成

1.快速下载

如果只需要快速下载功能，无需其它功能（携带参数安装、渠道统计、一键拉起），完成初始化即可

2.一键拉起

2.1 在module.json5配置文件中，在需要打开的EntryAbility中配置 scheme，用于浏览器中跳转到应用

{
  "module": {
    // ...
    "abilities": [
      {
        // ...
        "skills": [
          {
            //...
            "actions": [
              "ohos.want.action.viewData",
            ],
            "uris": [
              {
                "scheme": "xinstall为应用生成的scheme",
              }
            ]
          }
        ]
      },
      // ...
    ]
  }
}

在 EntryAbility 的 onCreate 和 onNewWant 方法中调用getWakeUp(want: Want)

XInstall.getWakeUp(want).then(data => {
  console.log('唤起参数：' + json.stringify(data));
}).catch((error: BusinessError) => {
  console.log('报错：' + json.stringify(e));
});

3.携带参数安装/拉起

在 APP 需要安装参数时（由 web 网页中传递过来的，如邀请码、游戏房间号等动态参数），调用XInstall.getInstall方法，在回调中获取参数（可重复获取）

XInstall.getInstall().then((data) => {
  console.log('安装参数参数：' + json.stringify(data));
}).catch((e: BusinessError) => {
  console.log('报错：' + json.stringify(e));
});

您可以在 Xinstall 管理后台对应的 App 内，看到所有的传递参数以及参数出现的次数，方便你们做运营统计分析，如通过该报表知道哪些页面或代理带来了最多客户，客户最感兴趣的 App 页面是什么等。具体参数名和值，运营人员可以和技术协商定义，或联系 Xinstall 客服咨询。具体效果如下图：

4.高级数据统计

SDK 会自动完成访问量、点击量、安装量、活跃量、留存率等统计工作。

4.1 注册量统计

如需统计每个渠道的注册量（对评估渠道质量很重要），可根据自身的业务规则，在确保用户完成 app 注册的情况下调用以下接口：

//用户注册成功后调用
XInstall.reportRegister()

4.2 事件统计

事件统计可以自定义埋点数据，通过埋点，可以了解到用户使用您应用的后续行为，用于评估渠道效果与价值。如：加购数、下单人数等。使用事件统计，需要先在【事件统计】页面内添加事件统计。

调用接口时，请使用后台创建的 “事件统计ID” 作为 eventID

// 入参:事件统计ID,事件值
XInstall.reportEvent("事件id", "事件值");

您可以设置不同事件来满足不同的业务场景，如下图所示，您可以设置充值事件，进行上报。就可以统计到总的充值设备数为32个，累积充值金额为364元

4.3 事件明细统计

除了旧有事件业务，我们还开发了事件明细统计，用来统计各个事件具体发生情况

在使用之前要现在后台管理系统中打开该事件明细统计功能，具体如下：

在开启权限之后，我们直接使用Xinstall SDK 的public static void reportEventWhenOpenDetailInfo(String var0, int var1, String var2)方法上传单个事件的第二个详细值

// 123 为事件值
XInstall.reportEventWhenOpenDetailInfo("事件ID",123,"事件详情值（如用户名）");

最终在事件列表中可以点击查看查阅具体详情的内容

5.场景定制统计

5.1 分享统计

场景业务介绍，可到分享数据统计页面查看

分享统计主要用来统计分享业务相关的数据，例如分享次数、分享查看人数、分享新增用户等。在用户分享操作触发后（注：此处为分享事件触发，非分享完成或成功），可调用如下方法上报一次分享数据：

具体调用如下

// 入参:填写分享人或UID
XInstall.reportShareByXinShareId("填写分享人或UID");

注：分享人或UID 可由您自行定义，只需要用以区分用户即可

您可在 Xinstall 管理后台对应 App 中查看详细分享数据报表，表中的「分享人/UID」即为调用方法时携带的参数，其余字段含义可将鼠标移到字段右边的小问号上进行查看：

Harmony集成