Public Method Summary
Qualifier and Type | Method Name and Description |
|---|---|
Promise<void> | setAnalyticsEnabled(flag: boolean) 是否打开埋点采集能力。 |
Promise<void> | setUserId(id:string) 设置用户ID。 |
Promise<void> | setUserProfile(name:string,value:string) 设置用户属性。 |
Promise<void> | setSessionDuration(milliseconds: 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> | 获取当前分析开关的状态。 |
Promise<string> | getAAID() 获取Anonymous Application ID。 |
Promise<void> | addDefaultEventParams(params?: { [key: string]: string | number | boolean | null }) 添加默认事件参数。 |
[h2]setAnalyticsEnabled
Method |
|---|
setAnalyticsEnabled(flag: boolean): Promise<void> 是否打开埋点采集开关。关闭后将不再记录任何数据。 说明：
|
Parameters
Name | Description |
|---|---|
flag | 是否打开埋点采集开关。默认为true。
|
Sample code：
SDK默认打开采集数据，您可参考以下示例代码，关闭埋点采集能力。
... agconnect.instance().configInstance(agConnectConfig); let analytics = agconnect.analytics(); analytics.setAnalyticsEnabled(false);
[h2]setUserId
Method |
|---|
setUserId(id:string): Promise<void> 设置用户ID。 |
Parameters
Name | Description |
|---|---|
id | 用户ID，非空，长度不超过256字符。 id：匿名化用户标识，在华为分析服务侧通过此标识进行关联用户数据。只有您可以使用该标识符追溯到具体的用户，分析系统无法使用您设置的ID追溯到原始用户。 说明： 设置id时，需要遵守分析服务协议，避免使用能标识个人身份信息的原始id，建议使用随机化的id。 |
[h2]setUserProfile
Method |
|---|
setUserProfile(name:string,value:string): Promise<void> 设置用户属性。用户属性值将在整个应用程序生命周期和会话期间保持不变。最多支持25个用户属性名称，如果后面设置属性有重复的name，则刷新value值。 |
Parameters
Name | Description |
|---|---|
name | 用户属性的标识符。非空，由数字、字母、下划线组成，以字母开头，长度不超过256字符。 |
value | 属性值。长度不超过256字符。 |
- value可以设置为null，通过传null来实现删除对应的用户属性。
- 如果您删除或新增属性，需要在端侧和云侧同步修改，并通过设置的属性name进行关联。
[h2]setSessionDuration
Method |
|---|
setSessionDuration(milliseconds: number): Promise<void> 设置Session超时时长。Web一直在前台运行，当两个相邻事件的时间间隔超过此方法设置的阈值时，将生成一个新的会话。默认30分钟。 |
Parameters
Name | Description |
|---|---|
milliseconds | Session超时时长。单位：毫秒。 |
[h2]onEvent
Method |
|---|
onEvent(eventId: string, params?: { [key: string]: any }): Promise<void> 记录事件。 |
Parameters
Name | Description |
|---|---|
eventId | 事件标识符。非空，由数字、字母、下划线组成，不能以数字开头，不能包含空格，长度不超过256字符，不能使用自动采集事件ID。 例如：“event_description10”。 |
params | 事件携带的信息。键值对个数不超过2048，同时大小不超过204800个字符。键值对中key由数字、字母、下划线组成，不能以数字开头。 |
[h2]pageStart
Method |
|---|
pageStart(screenName:string): Promise<void> 现代的web应用，大量是基于SPA开发的单页应用，其在做“页面跳转”时，实际上页面未发生跳转。用该方法可自定义进入页面事件。 该方法通常与pageEnd方法配对使用。 |
Parameters
Name | Description |
|---|---|
screenName | 进入页面的名字。 |
[h2]pageEnd
Method |
|---|
pageEnd(screenName:string): Promise<void> 现代的web应用，大量是基于SPA开发的单页应用，其在做“页面跳转”时，实际上页面未发生跳转。用该方法可自定义退出页面事件。 该方法通常与pageStart方法配对使用。 |
Parameters
Name | Description |
|---|---|
screenName | 退出页面的名字。 |
[h2]setAppVersion
Method |
|---|
setAppVersion(version: string): Promise<void> 设置版本信息。 |
Parameters
Name | Description |
|---|---|
version | 版本信息。最长不超过100个字符。 |
[h2]getUserProfiles
Method |
|---|
getUserProfiles(preDefined: boolean):Promise<{ [key: string]: string | number }> 获取自采集或者自定义的用户属性。 |
Parameters
Name | Description |
|---|---|
preDefined | 获取自采集用户属性或者自定义用户属性。
|
Returns
Type | Description |
|---|---|
Promise<{ [key: string]: string | number }> | 自采集或者自定义的用户属性。 |
[h2]setRestrictionEnabled
Method |
|---|
setRestrictionEnabled(flag: boolean): Promise<void> 设置是否限制数据分析能力。限制分析开关默认值为false，即默认开启数据分析能力。 |
Parameters
Name | Description |
|---|---|
flag | 打开或关闭数据分析能力。默认值为false，即打开数据分析能力。
|
[h2]isRestrictionEnabled
Method |
|---|
isRestrictionEnabled(): Promise<boolean> 获取当前分析开关状态。 |
Returns
Type | Description |
|---|---|
Promise<boolean> | 获取当前分析开关状态。
|
[h2]getAAID
Method |
|---|
getAAID(): Promise<string> 从AppGallery Connect（以下简称AGC）服务中获取Anonymous Application ID。 |
Returns
Type | Description |
|---|---|
Promise<string> | 获取Anonymous Application ID的Promise。 |
[h2]addDefaultEventParams
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。 说明：
|