HarmonyOS用户运营SDK API接口文档

HarmonyOS用户运营SDK API接口文档

接口类说明

本文档所有接口所涉及的相关类及说明如下:

接口 说明
Ido SDK 功能接口类,用于调用SDK相关功能
IdoConfig SDK 配置接口类,用于设SDK相关参数(注意:IdoConfig 配置需要在 SDK 初始化之前配置。)

预初始化

类名 Ido
接口 preInit(context: Context): void

说明:

预初始化SDK,读取配置参数,此时用户运营服务未启动,gtcid并未生成,用户运营功能未启动。

参数:

context:Context提供了ability或application的上下文的能力,包括访问特定应用程序的资源等。

初始化

类名 Ido
接口 init(context: Context): Promise

说明:

初始化成功后SDK将自动生成应用活跃时长事件。

参数:

context:Context提供了ability或application的上下文的能力,包括访问特定应用程序的资源等。

返回值:

返回一个含有gtcId的Promise

获取版本号

类名 Ido
接口 getVersion(): string

说明:

获取SDK版本号。

自定义事件

计数事件

类名 Ido
接口 onEvent(eventId: string, attrs: EventAttributes, ext?: string): void

说明:

每次在事件触发时调用onEvent方法,应用统计平台根据eventId ,统计该事件触发的次数。

参数:

  • eventId:自定义事件 Id ,用于标识事件的唯一
  • attrs: 自定义属性,用于扩展统计需求

代码示范:

// 计数统计事件
const map1 = new Map<string, string | number | Date | boolean>()
map1.set('test1', 1)
map1.set('test2', '2')
map1.set('test3', true)
map1.set('test4', new Date())
Ido.onEvent('event1', map1)

用户属性

类名 Ido
接口 onProfile(attrs: EventAttributes, ext?: string): void

说明:

设置⽤户属性,用于记录用户基本固定不变的属性,例如性别、年龄、注册时间、注册地域、注册渠道等。

参数:

  • attrs: 自定义用户属性,用于扩展统计需求

代码示范:

// 用户属性事件
const map3 = new Map<string, string | number | Date | boolean>()
map3.set('test1', 1)
map3.set('test2', '2')
map3.set('test3', true)
map4.set('test4', new Date())
Ido.onProfile(map3)

设置开发者模式

类名 IdoConfig
接口 setDebugEnable(enable: boolean): void

说明

开启/关闭开启开发者模式,开发者模式下,将在logcat输出 SDK 相关日志。

请在调试的时候使用该接口,切勿发布到线上版本。

参数:

  • enable:开启/关闭开启开发者模式

设置AppId

类名 IdoConfig
接口 setAppId(appId: string): void

说明

设置appid,这里设置的appid优先级比module.json5文件中配置的appid优先级更高。

请在Ido初始化之前调用。

参数:

  • appId:从个推开发者平台申请的appid

设置计数事件上传频率

类名 IdoConfig
接口 setEventUploadInterval(timeMillis: number): void

说明

  • 设置计数事件的上传频率eventUploadInterval,默认值为10000,即10秒;
  • 上传计数事件前会先检测上次上传操作的时间,如果距离上次上传操作已经过去了eventUploadInterval这么多时间,则会触发事件上传操作,否则将等待下次符合要求再上传。

参数

  • timeMillis:设置的eventUploadInterval值,单位毫秒。

设置计数事件事件强制上传条数

类名 IdoConfig
接口 setEventForceUploadSize(size: number): void

说明

  • 设置计数事件的强制上传条数eventForceUploadSize,默认数量为30条;
    -

如果距离上次上传计数事件的时间不满足eventUploadInterval频率限制,SDK还会去检测现有的离线计数事件条数,如果超过eventForceUploadSize这个条数,则会强制触发上传。

参数

  • size:设置的eventForceUploadSize值。

设置用户属性事件上传频率

类名 IdoConfig
接口 setProfileUploadInterval(timeMillis: number): void

说明

  • 设置用户属性事件传频率profileUploadInterval,默认值为5000,即5秒;
  • 上传用户属性事件前会先检测上次上传操作的时间,如果距离上次上传操作已经过去了profileUploadInterval这么多时间,则会触发事件上传操作,否则将等待下次符合要求再上传。

参数

  • timeMillis:设置的profileUploadInterval值,单位毫秒。

设置用户属性事件强制上传条数

类名 IdoConfig
接口 setProfileForceUploadSize(size: number): void

说明

  • 设置用户属性事件的强制上传条数profileForceUploadSize,默认数量为5条;
    -

如果距离上次上传用户属性事件的时间不满足profileUploadInterval频率限制,SDK还会去检测现有的离线用户属性事件条数,如果超过profileForceUploadSize这个条数,则会强制触发上传。

参数

  • size:设置的profileForceUploadSize值。

设置会话超时时长

类名 IdoConfig
接口 setSessionTimeoutMillis(sessionTimeoutMillis: number): void

说明

  • 应用从前台退至后台,在后台运行时间超过 sessionTimeout 后,此时再回到前台,SDK将认为是一次全新的启动。

  • sessionTimeout 的默认值为30秒。

参数

  • timeoutMillis:sessionTimeout值,单位毫秒

设置最小有效活跃时长

类名 IdoConfig
接口 setMinAppActiveDuration(minAppActiveDuration: number): void

说明

  • SDK统计应用前台活跃时长时,会对时长做判定,如果该时长小于minAppActiveDuration,SDK将认为无效,不予上传。

  • minAppActiveDuration的默认值为0;

参数

  • minAppActiveDuration:最小有效活跃时长,单位毫秒

设置最大有效活跃时长

类名 IdoConfig
接口 setMaxAppActiveDuration(maxAppActiveDuration: number): void

说明

  • SDK统计应用前台活跃时长时,会对时长做判定,如果该时长大于maxAppActiveDuration,SDK将认为无效,不予上传。

  • maxAppActiveDuration的默认值为12小时。

参数

  • maxAppActiveDuration:最大有效活跃,单位毫秒

##

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询