HarmonyOS用户运营SDK集成指南

前言

• 本文档介绍DevEco Studio版本5.0.3.900 ，鸿蒙API 12，个推用户运营SDK集成方式
• 本文档适用 OneID SDK 版本：1.0.0 及以后

• 本文默认读者已经具有基础的鸿蒙知识，以及项目工程结构如下：

    Demo/
        |- entry/ （项目主模块）
        |    |- libs/ （第三方库,用户手动创建）
        |    |- src/ （代码目录）
        |    |- oh-package.json5（模块级oh-package.json5文件）
        |- build-profile.json5
        |- hvigorfile.ts
        |- oh-package.json5 （顶层oh-package.json5文件）
        | ......

注：其中 “......” 表示省略其他与本教程无关的内容，以下 “......” 表示相同意义，不再重复说明。

1.重点提示

1.1开发环境配置

• DevEco Studio版本5.0.3.900及以上，鸿蒙API 12及以上。 早期需要联系华为技术人员获取，在其指导下搭建好开发环境

2. 创建个推应用

请参考 创建应用 获取相应的AppID信息。该信息在之后的步骤配置中将会使用。

3. 本地集成

注意：当前只支持本地集成

3.1 下载配置SDK的har包

• 通过官网下载或技术支持获取OneID.har

• 在项目主模块entry下创建libs文件夹

• 将下载好的har包OneID.har放到libs文件夹下

  Demo/
      |- entry/ （项目主模块）
      |    |- libs/ （第三方库,用户手动创建）
      |       |-OneID-HM-1.0.0.har (个推 OneID SDK)
        | ......  
  

3.2 配置依赖及参数

1. 找到entry模块级oh-package.json5文件，依赖OneID.har

    Demo/
        |- entry/ （项目主模块）
        |    |- libs/ （第三方库,用户手动创建）
        |       |- src/ （代码目录）
        |    |    |- main/
        |    |    |    |- module.json5（模块级基本配置文件）
        |    |- oh-package.json5（模块级oh-package文件）
          | ......
   

2. oh-package.json5 配置如下：

   {
    "name": "entry",
    "version": "1.0.0",
    "description": "Please describe the basic information.",
    "main": "",
    "author": "",
    "license": "",
    "dependencies": {
      "@getui/oneid": "file:./libs/OneID-HM-1.0.0.har"
    }
   }  
   

3. module.json5 配置如下：

   配置注册好的个推AppId和权限

   {
      "module": {
          .....
          "metadata": [
              {
                  "name": "GETUI_APPID",
                  "value": "替换您注册个推AppId"
              },
              {
                  "name": "ZX_CHANNELID_GT",
                  "value": "xxxx"
              }
          ],
          "requestPermissions": [
              {
                  "name": "ohos.permission.INTERNET"
              },
              {
                  "name": "ohos.permission.LOCATION",
                  "usedScene": {
                      "when": "always"
                  },
                  "reason": "$string:permission_reason"
              },
              {
                  "name": "ohos.permission.APPROXIMATELY_LOCATION",
                  "usedScene": {
                      "when": "always"
                  },
                  "reason": "$string:permission_reason"
              }
          ]
      }
   }
   

4. 运行指令ohpm install

• 在控制台进入entry目录，执行ohpm install
• 在entry目录下出现oh_modules文件夹，代表依赖成功

4. 集成代码

4.1 预初始化

在合适的时机进行初始化：OneID.init(context: Context): Promise<string>

import { OneID } from '@getui/oneid';

OneID.init(this.context)
  .then((ret) => {
    hilog.info(0x0000, 'testOneID', 'OneID.init %{public}s', ret)
  })
  .catch((err: Error) => {
    hilog.info(0x0000, 'testOneID', 'OneID.init Error %{public}s', err.message)
  })

4.2 场景查询

查询场景信息：OneID.queryLBS(context: Context, gpsInterval: number, gpsTimeOut: number): Promise<string>

OneID.queryLBS(this.context, 30, 20)
  .then((ret) => {
    hilog.info(0x0000, 'testOneID', 'OneID.queryLBS %{public}s', ret)
  })
  .catch((err: Error) => {
    hilog.info(0x0000, 'testOneID', 'OneID.queryLBS Error %{public}s', err.message)
  })