Qualifier and Type	Method Name and Description
Promise<void>	setAnalyticsEnabled(flag: boolean) 是否打开埋点采集能力。
Promise<void>	setUserId(userId:string) 设置用户ID。
Promise<void>	setUserProfile(name:string,value:string) 设置用户属性。
Promise<void>	setSessionDuration(sessionDuration: number) 设置Session超时时长。
Promise<void>	onEvent(eventId: string, params?: { [key: string]: any }) 记录事件。
Promise<void>	pageStart(screenName:string) 自定义进入页面事件。
Promise<void>	pageEnd(screenName:string) 自定义退出页面事件。
Promise<void>	setAppVersion(version: string) 设置版本信息。
Promise<{ [key: string]: string \| number }>	getUserProfiles(preDefined: boolean) 获取自采集或者自定义的用户属性。
Promise<void>	setRestrictionEnabled(flag: boolean) 设置是否限制数据分析能力。
Promise<boolean>	isRestrictionEnabled() 获取当前限制数据分析开关的状态。
Promise<void>	setRestrictionShared(shared: boolean) 设置是否限制数据共享。
Promise<boolean>	isRestrictionShared() 获取限制数据共享开关的状态。
Promise<string>	getAAID() 获取Anonymous Application ID。
Promise<void>	addDefaultEventParams(params?: { [key: string]: string \| number \| boolean \| null }) 添加默认事件参数。
Promise<void>	setRoutePolicy(id: string \| null ) 设置数据处理位置。
Promise<void>	setCollectAdsIdEnabled(enabled: boolean) 设置是否开启广告标识符的采集。
Promise<void>	setReportPolicies(policies: ReportPolicy) 设置上报策略。
Promise<void>	onReport() 立即上报所有事件。

Public Methods

setAnalyticsEnabled

展开

Method
setAnalyticsEnabled(flag: boolean): Promise<void> 是否打开埋点采集开关。关闭后将不再记录任何数据。说明如果您已经调用过setRestrictionEnabled接口，再次打开埋点采集能力时，数据分析能力不会同步打开，需要您设置setRestrictionEnabled接口的参数值为false。如果您未调用过setRestrictionEnabled接口，再次打开埋点采集能力时，数据分析能力会同步打开。

Method

setAnalyticsEnabled(flag: boolean): Promise<void>

是否打开埋点采集开关。关闭后将不再记录任何数据。

说明

如果您已经调用过setRestrictionEnabled接口，再次打开埋点采集能力时，数据分析能力不会同步打开，需要您设置setRestrictionEnabled接口的参数值为false。
如果您未调用过setRestrictionEnabled接口，再次打开埋点采集能力时，数据分析能力会同步打开。

Parameters

展开

Name	Description
flag	是否打开埋点采集开关。默认为true。 true：打开 false：关闭

Sample code：

SDK默认打开采集数据，您可参考以下示例代码，关闭埋点采集能力。

收起
自动换行
深色代码主题
复制
...
agconnect.instance().configInstance(agConnectConfig);
let analytics = agconnect.analytics();
analytics.setAnalyticsEnabled(false);

setUserId

展开

Method
setUserId(userId:string): Promise<void> 设置用户ID。SDK不会保存您的用户ID，建议您在每次应用启动后设置用户ID。

Method

setUserId(userId:string): Promise<void>

设置用户ID。SDK不会保存您的用户ID，建议您在每次应用启动后设置用户ID。

Parameters

展开

Name	Description
userId	用户ID，非空，长度不超过256字符。 userId：匿名化用户标识，在华为分析服务侧通过此标识进行关联用户数据。只有您可以使用该标识符追溯到具体的用户，分析系统无法使用您设置的userId追溯到原始用户。说明设置userId时，需要遵守分析服务协议，避免使用能标识个人身份信息的原始userId，建议使用随机化的userId。

Name

Description

userId

用户ID，非空，长度不超过256字符。

userId：匿名化用户标识，在华为分析服务侧通过此标识进行关联用户数据。只有您可以使用该标识符追溯到具体的用户，分析系统无法使用您设置的userId追溯到原始用户。

说明

设置userId时，需要遵守分析服务协议，避免使用能标识个人身份信息的原始userId，建议使用随机化的userId。

setUserProfile

展开

Method
setUserProfile(name:string,value:string): Promise<void> 设置用户属性。用户属性值将在整个应用程序生命周期和会话期间保持不变。最多支持25个用户属性名称，如果后面设置属性有重复的name，则刷新value值。

Method

setUserProfile(name:string,value:string): Promise<void>

设置用户属性。用户属性值将在整个应用程序生命周期和会话期间保持不变。最多支持25个用户属性名称，如果后面设置属性有重复的name，则刷新value值。

Parameters

展开

Name	Description
name	用户属性的标识符。非空，由数字、字母、下划线组成，以字母开头，长度不超过256字符。
value	属性值。长度不超过256字符。

说明

value可以设置为null，通过传null来实现删除对应的用户属性。
如果您删除或新增属性，需要在端侧和云侧同步修改，并通过设置的属性name进行关联。

setSessionDuration

展开

Method
setSessionDuration(sessionDuration: number): Promise<void> 设置Session超时时长。App一直在前台运行，当两个相邻事件的时间间隔超过此接口设置的阈值时，将生成一个新的会话。

Method

setSessionDuration(sessionDuration: number): Promise<void>

设置Session超时时长。App一直在前台运行，当两个相邻事件的时间间隔超过此接口设置的阈值时，将生成一个新的会话。

Parameters

展开

Name	Description
sessionDuration	Session超时时长。单位：毫秒。取值范围：最小值5秒，最大值5小时。如果设置的值小于最小则取最小，大于最大则取最大。默认1800000毫秒（30分钟）。

Name

Description

sessionDuration

Session超时时长。单位：毫秒。

取值范围：最小值5秒，最大值5小时。如果设置的值小于最小则取最小，大于最大则取最大。默认1800000毫秒（30分钟）。

onEvent

展开

Method
onEvent(eventId: string, params?: { [key: string]: any }): Promise<void> 记录事件。

Method

onEvent(eventId: string, params?: { [key: string]: any }): Promise<void>

记录事件。

Parameters

展开

Name	Description
eventId	事件标识符。非空，由数字、字母、下划线组成，不能以数字开头，不能包含空格，长度不超过256字符，不能使用自动采集事件ID。例如：event_description10。
params	事件携带的信息。键值对个数不超过2048，同时大小不超过204800个字符。键值对中key由数字、字母、下划线组成，不能以数字开头。

Name

Description

eventId

事件标识符。非空，由数字、字母、下划线组成，不能以数字开头，不能包含空格，长度不超过256字符，不能使用自动采集事件ID。

例如：event_description10。

params

事件携带的信息。键值对个数不超过2048，同时大小不超过204800个字符。键值对中key由数字、字母、下划线组成，不能以数字开头。

pageStart

展开

Method
pageStart(screenName:string): Promise<void> 快应用是基于SPA开发的单页应用，其在做“页面跳转”时，实际上页面未发生跳转。用该接口可自定义进入页面事件。该接口通常与pageEnd接口配对使用。

Method

pageStart(screenName:string): Promise<void>

快应用是基于SPA开发的单页应用，其在做“页面跳转”时，实际上页面未发生跳转。用该接口可自定义进入页面事件。

该接口通常与pageEnd接口配对使用。

Parameters

展开

Name	Description
screenName	进入页面的名字。

pageEnd

展开

Method
pageEnd(screenName:string): Promise<void> 快应用是基于SPA开发的单页应用，其在做“页面跳转”时，实际上页面未发生跳转。用该接口可自定义退出页面事件。该接口通常与pageStart接口配对使用。

Method

pageEnd(screenName:string): Promise<void>

快应用是基于SPA开发的单页应用，其在做“页面跳转”时，实际上页面未发生跳转。用该接口可自定义退出页面事件。

该接口通常与pageStart接口配对使用。

Parameters

展开

Name	Description
screenName	退出页面的名字。

setAppVersion

展开

Method
setAppVersion(version: string): Promise<void> 设置版本信息。

Method

setAppVersion(version: string): Promise<void>

设置版本信息。

Parameters

展开

Name	Description
version	版本信息。最长不超过100个字符。

getUserProfiles

展开

Method
getUserProfiles(preDefined: boolean):Promise<{ [key: string]: string \| number }> 获取自采集或者自定义的用户属性。说明此接口获取不到自动采集用户属性中的AAID、广告标识符。

Method

getUserProfiles(preDefined: boolean):Promise<{ [key: string]: string | number }>

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

说明

此接口获取不到自动采集用户属性中的AAID、广告标识符。

Parameters

展开

Name	Description
preDefined	获取自采集用户属性或者自定义用户属性。 true：获取自采集用户属性。 false：获取自定义用户属性。

Name

Description

preDefined

获取自采集用户属性或者自定义用户属性。

true：获取自采集用户属性。
false：获取自定义用户属性。

Returns

展开

Type	Description
Promise<{ [key: string]: string \| number }>	自采集或者自定义的用户属性。

setRestrictionEnabled

展开

Method
setRestrictionEnabled(flag: boolean): Promise<void> 设置是否限制数据分析能力。限制分析开关默认值为false，即默认开启数据分析能力。

Method

setRestrictionEnabled(flag: boolean): Promise<void>

设置是否限制数据分析能力。限制分析开关默认值为false，即默认开启数据分析能力。

Parameters

展开

Name	Description
flag	打开或关闭数据分析能力。默认值为false，即打开数据分析能力。 true：关闭 false：打开

isRestrictionEnabled

展开

Method
isRestrictionEnabled(): Promise<boolean> 获取当前限制数据分析开关的状态。

Method

isRestrictionEnabled(): Promise<boolean>

获取当前限制数据分析开关的状态。

Returns

展开

Type	Description
Promise<boolean>	获取当前限制数据分析开关的状态。 true：表示当前数据分析是关闭状态。 false：表示当前数据分析是打开状态。

Type

Description

Promise<boolean>

获取当前限制数据分析开关的状态。

true：表示当前数据分析是关闭状态。
false：表示当前数据分析是打开状态。

setRestrictionShared

展开

Method
setRestrictionShared(shared: boolean): Promise<void> 设置是否限制数据共享能力。限制数据共享开关默认值为false，即默认开启数据共享能力。说明仅中国大陆可用，非中国大陆调用无效。

Method

setRestrictionShared(shared: boolean): Promise<void>

设置是否限制数据共享能力。限制数据共享开关默认值为false，即默认开启数据共享能力。

说明

仅中国大陆可用，非中国大陆调用无效。

Parameters

展开

Name	Description
shared	打开或关闭数据共享能力。默认值为false，即打开数据共享能力。 true：关闭 false：打开

Name

Description

shared

打开或关闭数据共享能力。默认值为false，即打开数据共享能力。

true：关闭
false：打开

isRestrictionShared

展开

Method
isRestrictionShared(): Promise<boolean> 获取当前限制数据共享开关状态。说明仅中国大陆可用，非中国大陆调用无效。

Method

isRestrictionShared(): Promise<boolean>

获取当前限制数据共享开关状态。

说明

仅中国大陆可用，非中国大陆调用无效。

Returns

展开

Type	Description
Promise<boolean>	获取当前限制数据共享开关状态。 true：当前数据共享是关闭状态。 false：当前数据共享是打开状态。

Type

Description

Promise<boolean>

获取当前限制数据共享开关状态。

true：当前数据共享是关闭状态。
false：当前数据共享是打开状态。

getAAID

展开

Method
getAAID(): Promise<string> 从AppGallery Connect（以下简称AGC）服务中获取Anonymous Application ID。

Method

getAAID(): Promise<string>

从AppGallery Connect（以下简称AGC）服务中获取Anonymous Application ID。

Returns

展开

Type	Description
Promise<string>	获取Anonymous Application ID的Promise。

addDefaultEventParams

展开

Method
addDefaultEventParams(params?: { [key: string]: string \| number \| boolean \| null }): Promise<void> 添加默认事件参数，默认事件参数将被添加到除自动采集事件之外的所有事件中，默认事件参数与事件参数同名时，使用事件参数。

Method

addDefaultEventParams(params?: { [key: string]: string | number | boolean | null }): Promise<void>

添加默认事件参数，默认事件参数将被添加到除自动采集事件之外的所有事件中，默认事件参数与事件参数同名时，使用事件参数。

Parameters

展开

Name	Description
params	默认事件参数。参数最多支持100个键值对，每个键值对中key的长度不能超过256个字符，且只能由数字、字母、下划线组成，不能以数字开头；value长度不能超过256个字符，value只支持string、number、boolean、null。说明如果传入的params为null，将清除所有缓存的默认事件参数；如果传入的键值对中value为null，将删除对应的默认事件参数；如果传入的键值对中key已存在，将更新对应的默认事件参数。默认事件参数的个数和大小会被onEvent计入，请注意参数的使用限制。

Name

Description

params

默认事件参数。

参数最多支持100个键值对，每个键值对中key的长度不能超过256个字符，且只能由数字、字母、下划线组成，不能以数字开头；value长度不能超过256个字符，value只支持string、number、boolean、null。

说明

如果传入的params为null，将清除所有缓存的默认事件参数；如果传入的键值对中value为null，将删除对应的默认事件参数；如果传入的键值对中key已存在，将更新对应的默认事件参数。
默认事件参数的个数和大小会被onEvent计入，请注意参数的使用限制。

setRoutePolicy

展开

Method
setRoutePolicy (id: string \| null ): Promise<void> 设置数据处理位置。说明需通过在线提单申请多数据处理位置功能体验，该接口方可生效。在线提单操作详情请参见在线提单指导。使用多数据处理位置接口时，请务必使用最新的SDK配置信息。获取最新SDK配置信息方法：在“项目设置”页面中，下载“应用”栏下的“agconnect-services.json”。

Method

setRoutePolicy (id: string | null ): Promise<void>

设置数据处理位置。

说明

需通过在线提单申请多数据处理位置功能体验，该接口方可生效。在线提单操作详情请参见在线提单指导。
使用多数据处理位置接口时，请务必使用最新的SDK配置信息。获取最新SDK配置信息方法：在“项目设置”页面中，下载“应用”栏下的“agconnect-services.json”。

Parameters

展开

Name	Description
id	设置的数据处理位置。数据处理位置包括：CN(中国)、DE(德国)、SG(新加坡)、RU(俄罗斯)。说明设置的数据处理位置必须是开通过存储权限的数据处理位置，如果没有开通，数据将无法上报，请务必设置有效的数据处理位置。如果设置为null，数据上报到默认数据处理位置。

setCollectAdsIdEnabled

展开

Method
setCollectAdsIdEnabled (enabled: boolean): Promise<void> 设置是否开启采集广告标识符。

Method

setCollectAdsIdEnabled (enabled: boolean): Promise<void>

设置是否开启采集广告标识符。

Parameters

展开

Name	Description
enabled	打开或关闭广告标识符的采集。 true：采集广告标识符。 false：不采集广告标识符。

Name

Description

enabled

打开或关闭广告标识符的采集。

true：采集广告标识符。
false：不采集广告标识符。

setReportPolicies

展开

Method
setReportPolicies (policies: ReportPolicy): Promise<void> 设置上报策略。

Method

setReportPolicies (policies: ReportPolicy): Promise<void>

设置上报策略。

Parameters

展开

Name	Description
policies	设置上报策略。

onReport

展开

Method
onReport(): Promise<void> 立即上报所有事件。

Method

onReport(): Promise<void>

立即上报所有事件。

Overview

意见反馈

以上内容对您是否有帮助？

意见反馈

如果您有其他疑问，您也可以通过开发者社区问答频道来和我们联系探讨。

社区提问智能客服提问