Page tree
Skip to end of metadata
Go to start of metadata

1.基本设置指南

1.1 获取AppKey

安装好Web Server后,到管理后台注册应用,填写应用的相关信息。App建立成功后,可获得该App的Appkey。

1.2 SDK使用步骤

1.2.1 导入UMSAgent.dll(简称SDK)

导入Windows phone SDK到工程中:

 下载最新版本的sdk的压缩包,解压将其中的UMSAgent.dll释放到本地目录。

 VS用户右键工程选“Reference”选项,然后选择“Add Reference”选项,子目录下选择“Browse”,选择指向UMSAgent.dll的路径。最后,点击OK,导入成功。

1.2.2 集成说明

建议在所有页面调用

UmsAgent. UMSApi.onPageBegin(“page_name”);

UmsAgent. UMSApi.onPageEnd("page_name ");

如果在某些页面中不添加也可以,但会造成相应页面的使用时间等相关信息统计不到。

1.2.3 注意事项

  • 确认AppKey正确
  • 在其他方法调用前最先调用UmsAgent.UMSApi.onAppstart(String appkey,string url)方法。
  • SDK可以帮您捕捉用户在使用应用过程中出现的异常退出(FC),并将错误报告发送给服务器,错误报告包含应用程序版本、操作系统版本和设备型号以及程序出现异常时的Stacktrace,这些数据将帮助您修改应用程序的Bug。
  • 不同的渠道AppKeys须不同。

2.API 参考

2.1 初始化 SDK

UMSAgent.UMSApi.onAppStart(string appKey,string url);

Appkey: 服务器端生成的应用的KEY。

url: 服务器的URL。

确认在APP.xmal.cs 文件中的Application_Launching(object sender, LaunchingEventArgs e)方法中调用了该方法。否则,其他的方法将无法使用。

2.2 输出日志

UMSAgent.UMSApi.setDebugMode(boolean  isDebugMode);

isDebugMode

true:输出日志

false:不输出

如果需要查看异常或者错误报告,可以在任何地方调用该API,不过只能查看到那些在调用该API之后的异常和错误。

2.3 在线配置

UmsAgent.UMSApi.updateOnlineConfig();

Application_Launching(object sender, LaunchingEventArgs e)方法中调用,SDK将联网检测您的在线配置,将这些信息保存在本地。否则,SDK将按照默认发送策略上传数据到服务器。

版本号为WMAppManifest.xml中的Version值。

2.4 APP更新

UMSAgent.UMSApi.getNewVersion();

如果开发了新的应用,请在服务端创建新的应用版本。 调用该方法应用将会自动检测是否有更高版本的应用。如果有新的版本会提示用户更新,如果用户选择更新应用,系统会自动为用户更新应用(根据应用的版本号检查是否更新)。

2.5 页面访问

UmsAgent. UMSApi.onPageBegin(string pagename);

pagename: 需要统计的页面名

在页面的OnNavigatedTo()方法中调用该方法,该方法将会记录用户进入该页面的时间。

UmsAgent. UMSApi.onPageEnd(“page name “)

在页面的OnNavigatedFrom()方法中调用该方法,该方法将会记录用户离开该页面的时间。

注:上述两个方法应成对的调用。

2.6 自定义事件

除了基本统计分析功能外,我们还支持您自定义的事件统计分析,例如您可以统计广告点击次数或者视频被播放的次数等等,这里我们将提供几个简单而通用的接口。

UMSAgent.UMSApi.onEvent(string event_id,string pagename);

page:为当前页面的引用,

event_id:为当前统计事件的ID。

在您需要发送事件报告的代码段,调用如下方法就可以向服务器发送事件记录,将统计event_id对应事件发送次数,变化趋势,例如广告点击,短信发送量等等。event_id在服务器后端定义。

比如,监测应用程序里“MainPage”页面的广告的点击次数,事件ID为“ad_click”。那么需要在程序里每次广告点击时调用UMSAgent.UMSApi.onEvent(“ad_click“, “MainPage”)通知服务器一个广告点击事件发生。

UMSAgent.UMSApi.onEvent(string event_id, string pagename,string label);

这是UMSAgent.UMSApi. onEvent(string event_id,string pagename)的一个重载方法。

除了能够统计event_id所对应事件的发生次数,变化趋势外,还能统计事件中具体标签所占的比例,label为当前标签,同样这里的event_id字符串中不能含有空格。例如:在应用程序中省份对应一个event_id,每个城市对应一个label,这样我们可以在生成的统计分析表中看到不同城市的比例。

UMSAgent.UMSApi.onEvent(string event_id, string pagename, int acc);

对于程序中的某些可能被频繁触发的事件,开发者可以在程序中维护一个计数器,这样事件被多次触发只需要生成一个到服务器的消息,这个消息包括该事件被触发的次数,这里我们做了重载:

UMSAgent.UMSApi.onEvent (string event_id,string pagename,int acc);
UMSAgent.UMSApi.onEvent(string event_id, string pagename, string label, int acc);

label:该事件的label属性。

acc:是对应事件被触发的次数。

2.7 绑定用户

UMSAget.UMSApi. bindUserIdentifier(string userid);

调用该方法可以把用户的账号,如社交网络帐号,手机号等跟应用进行绑定。

2.8 绑定Tags

UMSAgent.UMSApi.postTag(string tag);

绑定用户的tag并发送至后台。

 

  • No labels