目录

接入Analytics

分析服务提供基于您上报事件的分析数据模型。

分析数据模型采用了Event-Param-User模型来记录数据,通过不同的参数对事件进行描述,同时对用户的特征也进行了描述。

术语

名称

说明

Event

事件

描述一个用户在某个时间点、某个地方、以某种方式完成了某个具体的事情。包含who、when、where、how、what等关键要素。

Param

参数

事件上报的关联参数。如加入购物车事件中的商品名称参数,商品价格参数,支持后续的深入分析。

UserProfiles

用户属性

用户的属性表,常见的用户属性有设备型号、应用版本、自定义的用户属性(如食品偏好)等。

Analytics Kit会收集AAID。AAID是应用匿名标识符,每个App在同一个设备上会分配不同的AAID。AAID用于连通华为提供的各项服务,例如Push、华为分析服务、远程配置等。

AAID会在如下场景重置:

接入步骤

  1. 初始化Analytics SDK。

    SDK初始化时会发送网络请求,请您务必在用户同意隐私协议后再初始化SDK。

    agconnect-services.plist文件导入成功后,在AppDelegate中通过config接口完成初始化。

    • Objective-C:在AppDelegate.m中进行初始化。
    • Swift:在AppDelegate.swift中进行初始化。
    “Objective-C”
    #import "AppDelegate.h"
    #import <HiAnalytics/HiAnalytics.h>
    
    @interface AppDelegate ()
    
    @end
    
    @implementation AppDelegate
    ...
    // 应用启动后对业务逻辑进行自定义
    - (void)applicationWillFinishLaunching:(NSNotification *)aNotification {   
       // 初始化
      [HiAnalytics config];  
    }
    ...
    @end
    “Swift”
    import Cocoa
    import HiAnalytics
    
    @main
    class AppDelegate: NSObject, NSApplicationDelegate {
    ...
    // 应用启动后对业务逻辑进行自定义
     func applicationWillFinishLaunching(_ aNotification: Notification) {
       // 初始化
       HiAnalytics.config();
     }
    ...
    }
  2. (可选)设置上报策略。

    Analytics SDK提供了四种事件上报策略,支持多种策略自由组合,任何一种策略满足时即可触发事件上报。您可以根据场景选择合适的事件上报策略。

    如果设置上报策略,建议包含应用切后台上报策略,防止应用退出后部分事件缓存在本地不能及时上报。

    策略

    描述

    说明

    onAppLaunchPolicy

    应用启动上报策略

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

    onMoveBackgroundPolicy

    应用切后台上报策略

    应用切后台时上报事件,包括应用退出。

    onScheduledTimePolicy

    定时上报策略

    根据指定的间隔时间上报事件,取值范围为60-1800秒,如果设置的值超过给定范围则取边界值。

    onCacheThresholdPolicy

    阈值上报策略

    缓存事件条数达到阈值时上报事件,取值范围为30-1000条(默认200条),如果设置的值超过给定范围则取边界值。

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

    事件的定义请参见事件说明。

  4. 参见API说明,调用接口实现各类功能。例如:设置用户属性setUserProfile。

示例代码

  1. 在代码合适位置插入埋点代码。
    “Objective-C”
    // 设置用户属性
    [HiAnalytics setUserProfile:@"userProfile1" setValue:@"userProfileValue1"];
    [HiAnalytics setUserProfile:@"userProfile2" setValue:@"userProfileValue2"];
    // 自定义埋点,在工程合适位置插入埋点代码
    [HiAnalytics onEvent:@"customEventName" setParams:@{@"key1":@"value1",@"key2":@"value2"}];
    “Swift”
    // 设置用户属性
    HiAnalytics.setUserProfile("userProfile1", setValue: "userProfileValue1");
    HiAnalytics.setUserProfile("userProfile2", setValue: "userProfileValue2");
    // 自定义埋点,在工程合适位置插入埋点代码
    HiAnalytics.onEvent("customEventName", setParams: ["key1":"value1","key2":"value2"]);
  2. (可选)您可以任意选择四种上报策略,如果未设置上报策略,则默认选择设置应用切后台上报策略和阈值上报策略。
    “Objective-C”
    // 定时触发上报
    // @param seconds 周期时间以秒为单位  (区间60 - 1800)
    + (HAReportPolicy *)onScheduledTimePolicy:(NSInteger)seconds;
    // 应用打开触发上报
    + (HAReportPolicy *)onAppLaunchPolicy;
    // 应用切后台触发上报 
    + (HAReportPolicy *)onMoveBackgroundPolicy;
    // 阈值触发上报
    // @param threshold 数据条数阈值  (区间30 - 1000),默认200
    + (HAReportPolicy *)onCacheThresholdPolicy:(NSInteger)threshold;
    // 4种策略组合上报
    [HiAnalytics setReportPolicies:@[[HAReportPolicy onMoveBackgroundPolicy],[HAReportPolicy onCacheThresholdPolicy:30],[HAReportPolicy onAppLaunchPolicy],[HAReportPolicy onScheduledTimePolicy:100]]];
    “Swift”
    // 定时触发上报
    // @param seconds 周期时间以秒为单位  (区间60 - 1800)
    + (HAReportPolicy *)onScheduledTimePolicy:(NSInteger)seconds;
    // 应用打开触发上报
    + (HAReportPolicy *)onAppLaunchPolicy;
    // 应用切后台触发上报 
    + (HAReportPolicy *)onMoveBackgroundPolicy;
    // 阈值触发上报
    // @param threshold 数据条数阈值  (区间30 - 1000),默认200
    + (HAReportPolicy *)onCacheThresholdPolicy:(NSInteger)threshold;
    // 4种策略组合上报
    HiAnalytics.setReportPolicies([HAReportPolicy.onMoveBackground(),HAReportPolicy.onCacheThresholdPolicy(30),HAReportPolicy.onAppLaunch(),HAReportPolicy.onScheduledTime(100)]);

接入调试

在开发过程中可以启用调试模式,借助DebugView实时查看事件的记录情况,观察具体结果并根据需要进行调整。

[h2]开启/停用调试模式

[h2]通过增加运行参数来调整日志级别

通过增加运行参数来调整日志级别:

有如下四个级别的可选项:-HALogLevelDebug、-HALogLevelInfo、-HALogLevelWarn、-HALogLevelError,以-HALogLevelDebug为例;

Xcode菜单选择“Product > > Scheme > > Edit Scheme”,然后选择第二个页签“Arguments”,点击“+”号增加一个参数“-HALogLevelDebug”,添加完成后点击右下角的“Close”进行保存。

-HALogLevelDebug