目录

数据接入说明

关于数据模型

华为分析服务以用户-事件-属性为基础构建各种分析模型。

事件是指一个用户在某个时间点、某个地方、以某种方式完成了某个具体的事情。Who、When、Where、What、How是其五要素:

事件分为系统自动采集事件、预置事件、开发者自定义事件,可用于构建各种行为分析模型。

事件类型

说明

自动采集事件

由华为分析服务提供的SDK依赖系统能力自动采集的事件,不需要开发者编写代码埋点。

预置事件

华为分析服务按照场景提供了事件规范,开发者按需采用此套规范埋点上报事件。

自定义事件

由开发者自行定义事件规范,并埋点上报事件。

属性是指一个用户具备的与事件无关的共性参数。如:用户使用的设备特征、用户的常驻地等,通常作为各种分析模型的洞察维度。

属性分为系统自动采集属性、预置属性、开发者自定义属性。

属性类型

说明

自动采集属性

由华为分析服务提供的SDK依赖系统能力自动采集的用户属性,可能由端侧直接采集,也可能是根据端侧采集的信息在云侧计算得到,不需要编写代码埋点。

预置属性

华为分析服务按照场景提供了属性规范,您可按需采用这套规范埋点上报用户属性。

自定义属性

由开发者自行定义属性规范,并埋点上报属性。

用户识别

华为分析服务仅将开发者设置的userid作为标识用户的依据,不会判断开发者设置的userid是何种值。

请勿将个人敏感用户标识(包括但不限于手机号码、身份证号码、护照号、邮箱地址等)设置为用户帐号标识。

华为分析服务支持按User-ID和设备或仅按设备标识您应用内的用户。当您想分析同一个帐号在不同设备、不同平台的数据,或分析登录状态的用户行为时,可以调用setUserId接口设置用户帐号标识,并在“管理 > 分析设置”中选择按User-ID和设备标识用户。

调用setUserId接口时,如果旧id不为空字符串且和新id不同,会重新生成新的Session会话。

若您不希望使用setUserId标识用户(如用户退出时),必须将id设为null。

数据规则

端侧参数约束

约束项

约束规则

场景

自定义用户属性名

非空,仅能由数字、字母、下划线组成,必须以字母开头,长度不超过256的字符串。

调用setUserProfile接口时,对name参数的约束。

自定义用户属性值

非空,长度不超过256的字符串。

调用setUserProfile接口时,对value参数的约束。

自定义事件ID

非空,仅能由数字、字母、下划线组成,必须以字母开头,长度不超过256的字符串。

调用onEvent接口时,对eventId参数的约束。

自定义事件参数ID

非空,仅能由数字、字母、下划线组成,必须以字母开头,长度不超过256的字符串。

调用onEvent接口时,对Bundle类型参数Key值的约束。

自定义事件参数值

非空,长度不超过256的字符串。

调用onEvent接口时,对Bundle类型参数Value值的约束。

自定义事件参数大小

Bundle内键值对不超过2048个,同时大小不超过204800个字符。

调用onEvent接口时,对params参数的约束。

设置数据上报策略

  • 应用切后台上报策略和阈值上报策略为必选策略,无论设置什么策略,这两个策略都会生效,但是可以改变阈值上报策略的阈值。
  • 多次调用设置上报策略的接口,会刷新上报策略,仅最后一次设置的策略生效,请谨慎多次调用。
  • 当策略满足触发事件上报时,如果没有网络,则会将事件缓存在本地,等待下次条件满足继续上报。
  • 以上上报策略仅在非调试模式下生效。

华为分析服务SDK默认在应用切换至后台或缓存数据超过阈值时,上报缓存的行为事件至云侧。如需修改上报策略,可以通过调用setReportPolicies接口设置上报策略,目前支持的策略有:

策略枚举值

策略说明

ON_APP_LAUNCH_POLICY

选择该策略时,立即上报一次,此后每次应用启动时上报一次。

ON_MOVE_BACKGROUND_POLICY

选择该策略时,应用每次切后台(包括应用退出)将历史缓存数据上报至云侧。

ON_SCHEDULED_TIME_POLICY

选择该策略时,根据指定的间隔时间轮循上报事件,取值范围为[60, 1800]秒(默认60秒)。

ON_CACHE_THRESHOLD_POLICY

选择该策略时,缓存事件条数达到阈值时上报事件,取值范围为[30, 1000]条(默认30条)。

云侧事件及参数限制

约束项

约束规则

自定义用户属性数

每项目最多25个自定义用户属性。

自定义事件个数

每项目最多500个自定义用户事件。

可注册的事件参数

每事件最多可以注册25个事件参数;一个项目下各个事件注册的所有参数总数不超过500个。

删除自定义用户属性

删除的用户属性次日生效,该属性的历史数据不会被清理。

支持通过“华为分析 > 管理 > 用户属性管理”删除不再需要的自定义用户属性。

停止自定义事件

被标记为停止使用的事件次日生效,该事件的历史数据不会被清理,但该事件不会继续被用于各项分析报告。

支持通过“华为分析 > 管理 > 事件管理”停止不再需要分析的自定义事件。

禁止数据采集

  • 禁止数据采集(setAnalyticsEnabled)与限制处理(setRestrictionEnabled)的差异在于:当用户禁止采集数据时,华为分析服务SDK将不再上报用户行为数据至云侧,即使开发者调用onEvent接口。同时,华为分析服务也不再处理该用户的历史数据;当用户限制处理数据时,华为分析服务SDK会继续跟进onEvent调用情况上报数据,但不会处理该用户的行为数据。
  • 当您已经调用过setRestrictionEnabled接口,再次打开埋点采集能力时,数据分析能力不会同步打开,需要设置setRestrictionEnabled接口的参数值为false;如果开发者从未调用过setRestrictionEnabled接口,再次打开埋点采集能力时,数据分析能力会同步打开。

为满足终端用户的数据主体权利,开发者需要在用户界面为用户提供同意/禁止数据采集的能力,当用户同意/禁止采集其行为数据时,开发者需要调用华为分析服务SDK提供的setAnalyticsEnabled接口,并相应地提供正确的参数值。

enabled枚举值

枚举值说明

true

开启数据采集功能

false

停止数据采集能力

限制处理

为满足终端用户的数据主体权利,开发者需要在用户界面为用户提供同意/禁止数据处理的能力,当用户同意/禁止处理其行为数据时,开发者需要调用华为分析服务SDK提供的setRestrictionEnabled接口,并相应地提供正确的参数值。

isEnabled枚举值

枚举值说明

true

禁止处理数据

false

同意处理数据

提供个人数据电子拷贝

当开发者需要支持终端用户获取个人数据电子拷贝,以满足GDPR要求时,开发者可以在其开发的应用中提供获取个人数据电子拷贝按钮,当终端用户点击此按钮时,开发者的应用服务器可以调用“导出个人数据”接口,导出其采集上报到Analytics Kit服务端的该用户个人数据电子拷贝。应用服务器通过“查询导出任务状态”接口查询导出请求任务在分析平台的执行进展,并及时下载导出数据提供给终端用户。

交互过程:

详细请参见:导出个人数据、查询导出任务状态。

删除个人数据

当开发者需要支持终端用户删除个人数据,以满足GDPR要求时,开发者可以在其开发的应用中提供删除个人数据按钮,当终端用户点击此按钮时,开发者的应用服务器可以调用“删除个人数据”接口,删除其采集上报到Analytics Kit服务端的该用户的数据。应用服务器通过“查询删除任务状态”接口查询数据删除请求任务在分析平台的执行进展,并及时通知用户删除结果。

交互过程:

详细请参见:删除个人数据、查询删除任务状态。

消息格式

华为分析服务提供了SDK供开发者上报用户标识、属性和事件,SDK与云侧间采用JSON格式传递数据,消息样例如下:

其中,header部分为通用的通信信息,用于标识传输数据的来源、事件、会话标识等;event部分为上报的用户事件及用户属性。

关键字段的解释如下:

字段名

字段含义

备注

productid

AGC为项目分配的唯一编码

-

appid

AGC为应用分配的唯一编码

-

requestid

一次传输数据请求的唯一标识

-

timestamp

传输数据的时间

-

aaid

应用匿名标识符

可通过Analytics SDK提供的getAAID接口获取。

userid

帐号标识符

可通过Analytics SDK提供的setUserId接口设置。

properties

用户属性

“_”开头的属性为系统自动采集的用户属性。自定义用户属性不可以以“_”开头。

_channel

应用下载渠道

需要开发者在AndroidManifest.xml文件中添加name为install_channel的meta-data参数。

eventtime

事件发生时间

开发者调用SDK提供的onEvent接口时,由系统自动生成的事件发生时间。无论是预置事件还是自定义事件,开发者都不需要再自行设置事件发生时间,避免产生高基维参数。

event_session_name

事件所属的会话标识

由系统自动生成,不需要开发者自行设置。

event

事件ID

对于自动采集事件和预置事件,事件ID以$开头。

开发者自定义事件ID不可以以$开头。

properties

事件参数列表

对于自动采集事件和预置事件,事件参数ID以$开头。

开发者自定义事件参数ID不可以以$开头。