目录

接入Analytics

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

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

术语

名称

说明

Event

事件

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

Param

参数

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

UserProfile

用户属性

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

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

AAID会在如下场景重置:

接入步骤

  1. 导入并初始化SDK。
    1. 完成接入Analytics的脚本。
      • 方法一:下载Codelab的demo工程,获取“Analytics.js”文件,并将其放入“assets/Script”目录。

        请勿将“Analytics.js”文件设置为“导入为插件”。

      • 方法二:在“assets/Script”目录下创建“Analytics.js”文件,并编写文件内容如下:
        // TODO: 编写Analytics.js文件内容
        cc.Class({
          extends: cc.Component,
         
          properties: {},
         
          onLoad() {
            // 获取当前场景名称
            this.curScreenName = cc.director.getScene().getName()
         
            // 用您应用的配置替换下方代码
            var aGConnectServicesConfig = {};
         
            if (!window.analytics) {
                // 配置agconnect实例
                agconnect.instance().configInstance(aGConnectServicesConfig);
                // 初始化分析实例
                window.analytics = agconnect.analytics();
            }
            // 配置pageStart事件
            window.analytics.pageStart(this.curScreenName)
          },
         
          onDestroy: function() {
            // 配置pageEnd事件
            window.analytics.pageEnd(this.curScreenName)
          }
        });

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

    2. 在所有场景文件的根对象(通常为Canvas对象)上绑定Analytics脚本。

    3. 登录AppGallery Connect网站,选择“我的项目”,在项目中找到需要集成SDK的应用,然后切换到“项目设置”页面,下载“agconnect-services.json”文件。
    4. 将文件内容赋值给“Analytics.js”文件中的变量aGConnectServicesConfig,完成SDK的初始化。
      // 用您应用的配置替换下方代码
      var aGConnectServicesConfig = {
        // ...
      };
  2. 通过onEvent接口记录定义事件。

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

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

示例代码

  1. 初始化配置拷贝成功后,创建接入脚本Analytics.js初始化Analytics SDK,获得HiAnalytics的实例。若拷贝的内容不正确,则无法进行埋点。
    // TODO: 编写Analytics.js文件内容
    cc.Class({
      extends: cc.Component,
     
      properties: {},
     
      onLoad() {
        // 获取当前场景名称
        this.curScreenName = cc.director.getScene().getName()
     
        // 用您应用的配置替换下方代码
        var aGConnectServicesConfig = {};
     
        if (!window.analytics) {
            // 配置agconnect实例
            agconnect.instance().configInstance(aGConnectServicesConfig);
            // 初始化分析实例
            window.analytics = agconnect.analytics();
        }
        // 配置pageStart事件
        window.analytics.pageStart(this.curScreenName)
      },
     
      onDestroy: function() {
        // 配置pageEnd事件
        window.analytics.pageEnd(this.curScreenName)
      }
    });
  2. 自定义事件埋点,在代码合适位置插入埋点代码。
    // 自定义事件埋点,在工程合适位置插入埋点代码
    let eventId = "Complete_Exam";
    let eventParams = {
      "Score": 95,
      "Level": "high"
    };
    window.analytics.onEvent(eventId, eventParams);
  3. 预置事件埋点,在代码合适位置插入埋点代码。
    // 预置事件埋点,在工程合适位置插入埋点代码
    let preDefineParams = agconnect.analytics.ParamName;
    let preDefineEvents = agconnect.analytics.EventName;
    let eventParams = {};
    eventParams[preDefineParams.PRODUCTID] = 'item_ID';
    eventParams[preDefineParams.PRODUCTNAME] = 'name';
    eventParams[preDefineParams.CATEGORY] =  'category';
    eventParams[preDefineParams.QUANTITY] =  100;
    eventParams[preDefineParams.PRICE] =  10.01;
    eventParams[preDefineParams.REVENUE] =  10;
    eventParams[preDefineParams.CURRNAME] =  'currency';
    eventParams[preDefineParams.PLACEID] =  'location_ID';
    window.analytics.onEvent(preDefineEvents.ADDPRODUCT2WISHLIST, eventParams);

查看实时概览数据

数据成功上报后,“华为分析 > 概览 > 实时概览”页面会展示出数据,如下图:

在AppGallery Connect网站查看上报数据,请参见实时概览。

接入调试

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

[h2]开启调试模式

在SDK初始化之前,添加以下代码以启用调试模式(切勿在生产环境使用调试模式)。

// 启用调试模式
agconnect.analytics.InitSettings.debugMode = true;
// 调试模式下,自定义终端标识
agconnect.analytics.InitSettings.terminalName = "custom terminal name";
// 初始化分析实例 
window.analytics = agconnect.analytics();

调试模式打开后,所有事件将实时上报,在“华为分析 > 应用调试”界面可实时查看上报的数据如下图:

在AGC系统上查看数据,请参见应用调试。

禁用控制台日志打印

快游戏SDK默认打印控制台日志,如果您想禁用日志打印功能,可以在SDK初始化之前添加如下启动配置项:

// 是否禁用日志打印
agconnect.analytics.InitSettings.logDisabled = true;
// 打印的最小日志级别,不区分大小写,支持的配置:INFO|WARN|ERROR
agconnect.analytics.InitSettings.logLevel = 'INFO';