导航|地址|刷新
HarmonyOS用户运营SDK集成指南-个推文档中心






文档中心开发者中心

，欢迎您！

您的优惠服务将于到期。





基本资料



安全设置



应用管理




退出登录
登录/注册SDK下载个推学堂请选择产品
消息推送

用户运营

OneID服务

AI应用工坊

统计分析

用户分析

标签管理

模型管理

短信服务

数字人外呼

一键认证

合规检测

点击提升







体验更多产品服务


欢迎登录开发者中心

立即登录

本月不再提醒





产品简介

产品使用手册
生命周期
概览

价值用户挖掘

沉默用户促活

流失用户预测

卸载原因分析


埋点行为数据采集和管理

数据统计分析和洞察

用户分层打标和群体扩量

场景模板
场景运营介绍


运营计划

用户群管理

数据管理

权限管理

流程画布

AI助手
ChatBI智能问数


Webhook
业务介绍

技术对接说明



应用场景
埋点应用场景案例


服务端
RestAPI
开发须知

接口调用规范

鉴权API

标签API

用户API

统计API

公共参数

返回码说明



客户端
Android
集成文档

API文档

使用文档

SDK集成视频


iOS
集成文档

API文档

使用文档

隐私清单说明


HarmonyOS
集成文档

API接口

使用文档


H5&小程序
集成文档

API文档


客户端插件

SDK更新日志


常见问题




当前位置：用户运营 > 客户端 > HarmonyOS > 集成文档



HarmonyOS用户运营SDK集成指南


HarmonyOS用户运营SDK集成指南



前言



本文档适用 IDO SDK 版本：1.0.1 及以后

本文默认读者已经具有基础的鸿蒙知识，以及项目工程结构如下：
Demo/ |- entry/ （项目主模块） ||- libs/ （第三方库,用户手动创建） ||- src/ （代码目录） ||- oh-package.json5（模块级oh-package.json5文件） |- build-profile.json5 |- hvigorfile.ts |- oh-package.json5 （顶层oh-package.json5文件） | ......
注：其中 “......” 表示省略其他与本教程无关的内容，以下 “......” 表示相同意义，不再重复说明。

1. 创建个推应用

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

2. 自动集成

2.1 打开工程项目，在 entry 模块下的 oh-package.json5 文件添加：
{ "dependencies": { "@getui/ido": "x.x.x"//填写对应版本号，如："@getui/ido": "1.0.1" } }
2.2 个推 har 为字节码，必须使用 DevEco Studio 5.0.3.800 及以上版本，并在工程级（最外层）build-profile.json5，配置"useNormalizedOHMUrl": true，如下图：
{ "app": { "products": [ { "buildOption": { "strictMode": { "useNormalizedOHMUrl": true } } } ] } }
3. 本地集成

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

3.1 下载配置SDK的har包


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



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



将下载好的har包ido.har放到libs文件夹下
Demo/ |- entry/ （项目主模块） ||- libs/ （第三方库,用户手动创建） ||-IDO-HM-1.0.1.har (个推用户运营SDK) | ......

3.2 配置依赖及参数


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


oh-package.json5 配置如下：
{ "name": "entry", "version": "1.0.0", "description": "Please describe the basic information.", "main": "", "author": "", "license": "", "dependencies": { "@getui/ido": "file:./libs/IDO-HM-1.0.1.har" } }


module.json5 配置如下：

配置注册好的个推AppId和权限
{ "module": { ..... "metadata": [ { "name": "GETUI_APPID", "value": "替换您注册个推AppId" } ], "requestPermissions": [ { "name": "ohos.permission.INTERNET" }, { "name": "ohos.permission.GET_NETWORK_INFO" }, { "name": "ohos.permission.GET_WIFI_INFO" }, { "name": "ohos.permission.APP_TRACKING_CONSENT", "reason" : "$string:oaid_reason", "usedScene": { "when": "always" } } ] } }


运行指令ohpm install


在控制台进入entry目录，执行ohpm install

在entry目录下出现oh_modules文件夹，代表依赖成功

4. 集成代码

4.1 预初始化

在`@ohos.app.ability.AbilityStage的onCreate方法中进行预初始化：Ido.preInit(context: Context)`
import { Ido, IdoConfig } from '@getui/ido' export defaultclassMyAbilityStateextendsAbilityStage{ onCreate(): void { // 日志开关IdoConfig.setDebugEnable(true) // 设置channelIdoConfig.setChannel('getui_channel') // 预初始化Ido.preInit(this.context) Ido.setUserId('getui_ido_user') }
4.2 初始化

在适当时机进行初始化：init(context: Context): Promise<string>
Ido.init(this.context).then((gtcId) => { hilog.info(0x0000, 'IDOAbility', 'IDO init Succeeded. GtcId: (%{public}s)', gtcId); })
4.3 应用活跃时长统计

应用时长统计用于统计应用启动次数和真实活跃时长，初始化SDK 后不需要开发者调用额外的接口。

其中鸿蒙平台一次完整的启动包括如下两种情况：

1.从启动应用到关闭应用；

2.从启动应用到应用退至后台，且在后台时间超过 30秒（该值可通过下面的方法修改，单位毫秒）；
IdoConfig.setSessionTimeoutMillis(sessionTimeoutMillis: number)
4.4 自定义事件

自定义事件可以统计某些用户自定义埋点的发生时间以及次数，例如广告点击、短信数量等。

通常由 event_id 作为一个事件的唯一标识。

自定义事件分为：

统计事件：


计数统计事件：统计指定行为被触发的次数。



计时统计事件：统计指定行为消耗的时间，单位毫秒。需要 eventBegin 和 eventEnd 接口成对使用才可生效。


用户属性事件：统计对应用户的相关信息。

每类事件都支持使用 Map<string, string | number | Date | boolean> 参数类型，其中 key 必须为字符串类型，value 目前支持类型有 string、 Number 、 Boolean 、 Date 。
// 计数统计事件 const map1 = newMap<string, string | number | Date | boolean>() map1.set('test1', 1) map1.set('test2', '2') map1.set('test3', true) map1.set('test4', newDate()) Ido.onEvent('event1', map1) // 计时统计事件 Ido.onBeginEvent('event2') const map2 = newMap<string, string | number | Date | boolean>() map2.set('test1', 1) map2.set('test2', '2') map2.set('test3', true) map2.set('test4', newDate()) Ido.onEndEvent('event2', map2) // 用户属性事件 const map3 = newMap<string, string | number | Date | boolean>() map3.set('test1', 1) map3.set('test2', '2') map3.set('test3', true) map4.set('test4', newDate()) Ido.onProfile(map3)
5. 预置事件说明

预置事件说明

6. 预置属性说明

预置属性说明

7.用户属性事件预置属性

用户预置事件说明




以上文档对您是否有帮助？
有帮助没帮助



您的改进建议

是否遇到以下问题

问题类型


1、内容与功能不一致；

2、文章描述不清晰；

3、图片和视频难理解；

4、对产品功能不满意；

5、不是我想要的内容；

6、其他:


问题类型不能为空



反馈建议



联系方式



取 消提 交





反馈成功

非常感谢您的反馈，我们会继续努力做到更好！
确定






在这篇文章中：前言 1. 创建个推应用2. 自动集成3. 本地集成4. 集成代码5. 预置事件说明6. 预置属性说明7.用户属性事件预置属性







文档中心搜索

搜 索















------
导航页 打开网址