Class Analytics

clears all the collected data from the local cache

清除本地缓存的所有采集数据

huawei.hms.analytics.analyticsService.clearCachedData();

obtains the app instance ID

获取 App Instance ID

huawei.hms.analytics.analyticsService.once(huawei.hms.analytics.HMS_ANALYTICS_EVENT_LISTENER_NAME.GET_AAID, (result) => {
    cc.log('getAAID', JSON.stringify(result));
);

huawei.hms.analytics.analyticsService.getAAID();

obtains the predefined or custom user attributes

获取预定义或者自定义的用户属性。

huawei.hms.analytics.analyticsService.once(huawei.hms.analytics.HMS_ANALYTICS_EVENT_LISTENER_NAME.GET_USER_PROFILES, (result) => {
    cc.log('getUserProfiles', JSON.stringify(result));
});

huawei.hms.analytics.analyticsService.getUserProfiles();

Initialize analytics, create the global instance from java side, called automatically when the plugin init

初始化统计，在 java 层会创建统计全局实例，插件启动时自动调用

records custom events

记录自定义事件。

let eventName = 'myEvent';
let params = {
    name: 'userName',
    age: 18,
    others: {
        stature: 199,
        level: 100
    }
};

huawei.hms.analytics.analyticsService.onEvent(eventName, params);

defines a custom page exit event

自定义退出页面事件。

huawei.hms.analytics.analyticsService.pageEnd("pageName1");

defines a custom page entry event

自定义进入页面事件

huawei.hms.analytics.analyticsService.pageStart("pageName1", "pageClassOverride1");

specifies whether to enable event collection

是否打开打点采集能力

huawei.hms.analytics.analyticsService.setAnalyticsEnabled(true);

sets the minimum interval for starting a new session

设置重新开始新Session的最短时间间隔，单位：毫秒

let value = 1000 * 60 * 60;
huawei.hms.analytics.analyticsService.setMinActivitySessions(value);

sets the push token, which is obtained using the Push Kit

设置 push token，需要通过 HMS Core Push Kit 获取

set the report policies

设置上报策略

let ReportPolicy = huawei.hms.analytics.ReportPolicy;
let moveBackgroundPolicy = ReportPolicy.ON_MOVE_BACKGROUND_POLICY;
let scheduledTimePolicy = ReportPolicy.ON_SCHEDULED_TIME_POLICY;
scheduledTimePolicy.threshold = 600;
huawei.hms.analytics.analyticsService.setReportPolicies(moveBackgroundPolicy, scheduledTimePolicy);

sets the session timeout interval

设置 Session 超时时长，单位：毫秒

let value = 1000 * 60 * 60;
huawei.hms.analytics.analyticsService.setSessionDuration(value);

sets a user ID

设置用户的 ID

huawei.hms.analytics.analyticsService.setUserId("a123456");

sets user attributes, pass value as null or undefined to delete the user attributes

设置用户属性，传递value为null或者undefined来删除对应的用户属性

let name = 'profile1';
let value = 'value1';
huawei.hms.analytics.analyticsService.setUserProfile(name, value);