AliMobileAnalytics

立即使用

概述

此模块封装了阿里云的Mobile Analytics iOS SDK,是阿里云面向移动开发者提供的iOS平台下的数据统计与监控服务。通过该该模块,开发者可以在自己的APP中便捷地进行数据埋点,监控日常的业务数据与性能数据,并通过阿里云控制台界面观察对应的数据报表展现。另外,用户可以通过设定自定义的数据解析规则实现定制化的数据图表展现

iOS授权

此模块开发者需要自己从开发者中心下载AliyunEmasServices-Info.plist文件(https://mhub.console.aliyun.com/?spm=0.0.0.0.Wy7e7f#/product/3716110/overview),然后将AliyunEmasServices-Info.plist打包成一个附加自定义模块上传 APICloud 平台。制作方法如下:下载 AliMobileAnalyticsAppendix 模块 zip 包并解压,把 zip 包内 target 目录下的AliyunEmasServices-Info.plist 文件替换为自己从开发者中心下载的AliyunEmasServices-Info.plist文件。然后重新压缩为 zip 包文件上传自定义模块,云编译时勾选该模块。

如下图所示:

使用此模块之前iOS端需先获取Mobile Analytics服务,获取到AppKey和AppSecret。然后在 config.xml文件配置基础环境属性,方法如下

  • 名称:AliMobileAnalytics
  • 参数:appKey
  • 参数:appSecret
  • 配置示例:
    <feature name="AliMobileAnalytics">
        <param name="appKey" value="111"/>
        <param name="appSecret" value="11111"/>
    </feature>
  • 字段描述: 如下图所示:

android 使用此模块之前需先配置 config.xml 文件,如下**

    <feature name="AliMobileAnalytics">
        <param name="androidAppKey" value="*****"/>
        <param name="androidAppSecret" value="*******"/>
    </feature>

regist

注册

regist({params}, callback(ret))

params

userRegister:

  • 类型:字符串类型
  • 描述:注册的账号

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnregist(){
    var name = api.require('AliMobileAnalytics');
    name.regist({
        userRegister:'username'
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

login

登录

login({params}, callback(ret))

params

userNick:

  • 类型:字符串类型
  • 描述:账号

userId:

  • 类型:字符串类型
  • 描述:id

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnlogin(){
    var name = api.require('AliMobileAnalytics');
    name.login({
        userNick:'',
        userId:''
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

pageAppear

页面进入

pageAppear(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnpageAppear(){
    var name = api.require('AliMobileAnalytics');
    name.pageAppear(function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

pageDisAppear

页面离开

pageDisAppear(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnpageDisAppear(){
  var name = api.require('AliMobileAnalytics');
  name.pageDisAppear(function(ret) {
      if (ret) {
         alert(JSON.stringify(ret));
      }
  });
}

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

updatePageProperties

设置页面事件扩展

updatePageProperties({params}, callback(ret))

params

dictionary:

  • 类型:JSON 对象
  • 描述:设置页面事件扩展参数
  • 内部字段:
{

}

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnupdatePageProperties(){
    var name = api.require('AliMobileAnalytics');
    name.updatePageProperties({
         dictionary:{
          pageValue:'pageKey'
         }
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setGlobalProperty

设置上报数据的全局字段(键值对)(近iOS支持)

setGlobalProperty({params}, callback(ret))

params

dictKey:

  • 类型:字符串类型
  • 描述:key值

dictValue:

  • 类型:字符串类型
  • 描述:value值

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetGlobalProperty(){
    var name = api.require('AliMobileAnalytics');
    name.setGlobalProperty({
        dictKey:'',
        dictValue:''
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统

可提供的1.0.0及更高版本

removeGlobalProperty

删除已上报数据的全局字段(近iOS支持)

removeGlobalProperty({params}, callback(ret))

params

dictKey:

  • 类型:字符串类型
  • 描述:key值 (添加过的)

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnremoveGlobalProperty(){
    var name = api.require('AliMobileAnalytics');
    name.removeGlobalProperty({
        dictKey:'',
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统 可提供的1.0.0及更高版本

initALBBMANPageHitBuilder

初始化ALBBMANPageHitBuilder 用来进行页面事件的埋点

initALBBMANPageHitBuilder(callback(ret))

parameter

pageName:

  • 类型:字符串类型
  • 描述:页面名称(仅android支持)

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fninitALBBMANPageHitBuilder(){
    var name = api.require('AliMobileAnalytics');
    name.initALBBMANPageHitBuilder(function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setPageName

设置页面名称 (initALBBMANPageHitBuilder之后调用,且必须调用)(仅iOS支持)

setPageName({params}, callback(ret))

params

pageName:

  • 类型:字符串类型
  • 描述:页面名称

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetPageName(){
    var name = api.require('AliMobileAnalytics');
    name.setPageName({
         pageName:''
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统 可提供的1.0.0及更高版本

setReferPage

设置页面 refer (initALBBMANPageHitBuilder之后调用,非必须调用)

setReferPage({params}, callback(ret))

params

referPageName:

  • 类型:字符串类型
  • 描述:页面refer名称

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetReferPage(){
    var name = api.require('AliMobileAnalytics');
    name.setReferPage({
         referPageName:''
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setDurationOnPage

设置页面停留时间 (initALBBMANPageHitBuilder之后调用,非必须调用)

setDurationOnPage({params}, callback(ret))

params

durationTime:

  • 类型:数字类型
  • 描述:页面停留时间

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetDurationOnPage(){
    var name = api.require('AliMobileAnalytics');
    name.setDurationOnPage({
        durationTime:2
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setProperty

设置页面事件扩展参数 (initALBBMANPageHitBuilder之后调用,非必须调用)

setProperty({params}, callback(ret))

params

pageKey:

  • 类型:字符串
  • 描述:key值

pageValue:

  • 类型:字符串
  • 描述:value值

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetProperty(){
    var name = api.require('AliMobileAnalytics');
    name.setProperty({
         pageKey:'',
         pageValue:''
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

build

组装单条日志 (initALBBMANPageHitBuilder之后调用,非必须调用)

build(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnbuild(){
    var name = api.require('AliMobileAnalytics');
    name.build(function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

initALBBMANCustomHitBuilder

自定义事件埋点初始化

initALBBMANCustomHitBuilder(callback(ret))

paramer

eventName:

  • 类型:字符串类型
  • 描述:页面名称(仅android支持)

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fninitALBBMANCustomHitBuilder(){
    var name = api.require('AliMobileAnalytics');
    name.initALBBMANCustomHitBuilder(function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setEventLabel

设置自定义事件的标签(initALBBMANCustomHitBuilder之后调用,必须调用)(仅iOS支持)

setEventLabel({params}, callback(ret))

params

eventId:

  • 类型:字符串
  • 描述:key值

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetEventLabel(){
    var name = api.require('AliMobileAnalytics');
    name.setEventLabel({
        eventId:''
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统 可提供的1.0.0及更高版本

setEventPage

设置自定义事件的页面名称(initALBBMANCustomHitBuilder之后调用,非必须调用)

setEventPage({params}, callback(ret))

params

pageName:

  • 类型:字符串
  • 描述:页面名称

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetEventPage(){
    var name = api.require('AliMobileAnalytics');
    name.setEventPage({
        pageName:''
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setDurationOnEvent

设置自定义事件停留时间(initALBBMANCustomHitBuilder之后调用,非必须调用)

setDurationOnEvent({params}, callback(ret))

params

durationTime:

  • 类型:数字类型
  • 描述:停留时间

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetDurationOnEvent(){
    var name = api.require('AliMobileAnalytics');
    name.setDurationOnEvent({
        durationTime:
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setEventProperty

设置自定义事件扩展参数(initALBBMANCustomHitBuilder之后调用,非必须调用)

setEventProperty({params}, callback(ret))

params

pageKey:

  • 类型:字符串
  • 描述:key值

pageValue:

  • 类型:字符串
  • 描述:value值

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnsetEventProperty(){
    var name = api.require('AliMobileAnalytics');
    name.setEventProperty({
        pageKey:'',
        pageValue:''
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

buildEvent

组装单条日志(initALBBMANCustomHitBuilder之后调用,非必须调用)

buildEvent(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status : true  //布尔类型;是否成功,true|false  
}

示例代码

function fnbuildEvent(){
    var name = api.require('AliMobileAnalytics');
    name.buildEvent(function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });
}

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本