接口说明
本文档提供了 MTA.h 头文件中大部分接口的使用方法。全部接口及使用方法请查看头文件 MTA.h。
头文件 MTA.h
启动 MTA
使用统计功能以前,需要先启动MTA。在UIApplicationDelegate的
- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions;
回调中调用 MTA 的 startWithAppkey 方法即可启动MTA。
(1)接口内容
/**
启动MTA
@param appkey 从网页申请的appKey
*/
+ (void)startWithAppkey:(NSString *)appkey;
/**
检测版本,并启动MTA。
如果当前MTA的版本小于ver参数,则MTA不启动。否则启动MTA。
@param appkey 从网页申请的appKey
@param ver 最低允许启动的版本
@return 如果MTA成功启动,返回YES,否则返回NO
*/
+ (BOOL)startWithAppkey:(NSString *)appkey checkedSdkVersion:(NSString *)ver;
(2)代码示例
- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[MTA startWithAppkey:@"ABCDEFG"];
}
统计次数
自定义事件分析,通过管理台事件配置,后台代码埋点,可完成用户行为追踪,如按钮点击次数等,详情见帮助文档
新建应用时,系统默认注册3个事件。在SDK接入时,按示例代码埋点即可,体验自定义事件功能。
(1)接口内容
/**
上报自定义事件
并且指定上报方式
@param event_id 事件的ID,ID需要先在MTA管理台配置好才能生效
@param kvs 事件的参数,参数需要先在MTA管理台配置好才能生效
@param appkey 需要上报的appKey,若传入nil,则上报到启动函数中的appkey
@param isRealTime 是否实时上报,若传入YES,则忽略全局上报策略实时上报。否则按照全局策略上报。
*/
+ (void)trackCustomKeyValueEvent:(NSString *)event_id
props:(NSDictionary *)kvs
appkey:(NSString *)appkey
isRealTime:(BOOL)isRealTime;
(2)代码示例
// 以下三个事件已在管理台由MTA预先为您配置完成,在相应位置完成代码埋点即可完成统计
// 进入首页事件,统计用户进入首页的次数
[MTA trackCustomKeyValueEvent:@"HomePage" props:nil];}
// 用户注册事件,统计用户点击注册按钮的次数
[MTA trackCustomKeyValueEvent:@"Register" props:nil]
// 用户登录事件,统计用户点击登录按钮的次数
[MTA trackCustomKeyValueEvent:@"Login" props:nil];
统计页面时长
页面时长可以统计某个页面的访问时长
(1)接口内容
/**
标记一次页面访问的开始
此接口需要跟trackPageViewEnd配对使用
多次开始以第一次开始的时间为准
@param page 页面ID,ID需要先在MTA前台配置好才能生效
*/
+ (void)trackPageViewBegin:(NSString *)page;
/**
标记一起页面访问的开始
并且指定上报方式
此接口需要跟trackPageViewEnd配对使用
多次开始以第一次开始的时间为准
@param page 页面ID,ID需要先在MTA前台配置好才能生效
@param appkey 若此参数不为nil,则上报到此appkey。否则,上报到startWithAppkey中传入的appkey
*/
+ (void)trackPageViewBegin:(NSString *)page appkey:(NSString *)appkey;
/**
标记一次页面访问的结束
此接口需要跟trackPageViewBegin配对使用
多次结束以第一次结束的时间为准
@param page 页面ID,ID需要先在MTA前台配置好才能生效
*/
+ (void)trackPageViewEnd:(NSString *)page;
/**
标记一起页面访问的结束
并且指定上报方式
此接口需要跟trackPageViewBegin配对使用
多次结束以第一次结束的时间为准
@param page 页面ID,ID需要先在MTA前台配置好才能生效
@param appkey 若此参数不为nil,则上报到此appkey。否则,上报到startWithAppkey中传入的appkey
@param isRealTime 是否实时上报,若传入YES,则忽略全局上报策略实时上报。否则按照全局策略上报。
*/
+ (void)trackPageViewEnd:(NSString *)page
appkey:(NSString *)appkey
isRealTime:(BOOL)isRealTime;
(2)代码示例
-(void) viewDidAppear:(BOOL)animated {
[MTA trackPageViewBegin:@"Page"];
[super viewDidAppear:animated];
}
- (void)viewWillDisappear:(BOOL)animated {
[MTA trackPageViewEnd:@"Page"];
[super viewWillDisappear:animated];
}
注意:trackPageViewBegin和trackPageViewEnd必须成对使用才能生效
使用时长统计
在UIApplicationDelegate的
- (void)applicationDidBecomeActive:(UIApplication *)application;
- (void)applicationWillResignActive:(UIApplication *)application;
两个回调中,分别添加对应的打点代码,即可上报app的使用时长。
(1)接口内容
/**
开始统计使用时长
建议在App进入前台时调用
*/
+ (void)trackActiveBegin;
/**
结束统计使用时长
建议在App离开前台时调用
*/
+ (void)trackActiveEnd;
(2)代码示例
// 开始打点
- (void)applicationDidBecomeActive:(UIApplication *)application {
[MTA trackActiveBegin];
}
// 结束打点
- (void)applicationWillResignActive:(UIApplication *)application {
[MTA trackActiveEnd];
}
头文件MTAConfig.h
头文件 MTAConfig.h 提供了一些方法来自定义MTA的上报行为,比如上报策略,一次上报的条数等等。若有需要,可以查看 MTAConfig.h 头文件,做适当修改。
注:必须在调用 MTA 启动函数之前修改 MTAConfig 中的配置。否则配置可能不生效并且可能会引发 SDK 的一些未定义行为。
更多内容可参考sdk zip包中的开发文档