SiteMaster SDK开发者帮助文档

概述

SiteMaster SDK 是AdMaster开发的一款帮助用户分析App使用情况的的一款SDK。开发者嵌入SiteMaster SDK成功后，可以通过AdMaster提供的Site网站后台查看App的相关统计信息，本文档旨在帮助开发者更好的完成SDK的嵌入

1. 获得应用ID

应用ID用于区分不同App的唯一标识符，开发者可以在SiteMaster后台的应用管理界面中获得对应应用ID。

2.获得开发包

开发者注册Site用户之后，会获得Site网站提供的用来标示App唯一性的唯一ID和相关zip开发包。开发包里面主要包括以下内容：

• Site SDK开发者帮助文档
• SiteSDKLib文件夹（内包含AdMasterTracker.h头文 件和libSiteSDK.a静态库文件）
• SiteTrackDemo示例程序

3. 导入SiteSDK

下载并解压Site提供的开发zip包后，将SiteSDKLib文件夹里的AdMasterTracker.h头文件和libSiteSDK.a静态库文件添加的开发者自己的app项目中，添加过程中注意确保在弹出的界面中勾选Copy items into destination group's folder(if needed), 并确保Add To Targets勾选相应的target。

4. 添加SDK需要的依赖框架（Framework）

在开发者需要添加SDK的项目Xcode开发环境中选择

TARGETS-->Build Phases-->Link Binary With Libraries--> + 添加以下framework框架：CoreLocation.framework，AdSupport.framework

5. 嵌入SiteSDK代码

i. 注册SiteSDK实例

打开AppDelegate.m 在-(BOOL)application:(UIApplication )application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions方法内添加如下语句：

[AdMasterTracker setTrackerInstance:@"XXXXX" SendPolicy:NO];

• 接口说明：实例化SiteSDK函数，开启siteSDk基本监测事件
• 参数说明：XXXXX是嵌入siteSDK的时候，admaster提供给给开发者用的唯一id，SendPolicy参数标示了监测事件的发送策略如果参数为no,则sdk监测到任何网络都会发送请求曝光时间，为yes，则只在监测到网络为wifi时才发送。
• 注意事项：为了不影响统计数据的准确性，建议开发者将此参数设置为No，保证数据的及时发送

ii. 页面监测事件

+(void)viewTracker:(NSString*)viewName

• 接口说明：页面监测是提供开发者使用监测app某一页面的用户访问情况的接口，开发使用这个函数来监测没有个页面的访问情况，
• 参数说明：viewName是开发者后台查看统计数据的时候用来标示相关页面的信息，为必填选项。这里开发者可以自定义viewName的名称，
• 注意事项：开发者需要在监测页面的时候，保证每次进入到所监测页面的时候，都调用一次本函数

iii.事件监测

+(void)eventTracker:(id)eventName CurrentView:(NSString*)currentViewName

• 接口说明：事件监测提供开发者使用监测app某一页面中某一特定事件（如点击事件）的使用情况，
• 参数说明：eventName是必填项，默认为字符串类型, currentViewName为当前事件所在页面的名称，为必填项
• 注意事项：特殊情况下SiteSDK提供更为灵活和详细的监测参数用来帮助用户监测详细信息。EventName可以设置为字典类型，siteSDK提供category，action，label，value四个关键KEY用来标示事件的具体行为。
• 如下为对button按钮的监测代码示例：

  -(void)buttonPress{
                   NSString *viewEvent = [NSString stringWithFormat:@"%@Event",self.title];
                   [AdMasterTracker eventTracker: [NSDictionary dictionaryWithObjectsAndKeys:
                   @"eventCategory",@"category",
                   @"eventAction",@"action",
                   @"eventLabel",@"label",
                   @"eventValue",@"value",
                   nil]
                   CurrentView:self.title];
  }

  • 通过部署如上代码，调用SiteMaster SDK的事件接口，我们能成功标记button点击事件
  • eventCategory标示当前事件名称
  • eventAction标示当前事件活动
  • eventLabel 标示当前事件标签
  • eventValue标示当前事件价值

iv.禁用地理位置信息

+(void)setLocationDisable:(BOOL)isDisable;

• 说明：开发者是否禁止使用地理位置坐标。
• 参数说明：isDisable=YES，表示禁用地理位置信息
• 注意事项：需要在调用初始化方法之前调用这个函数

如果在使用中遇到任何问题，如果你需要帮助，请联系我们: service@admaster.com.cn