帮助中心

IOS管理SDK集成

更新时间:2019-07-17 14:52:48

第一部分:基础SDK集成:

 

1.  导入SDK

您可以选择如下任意一种方式,将SDK导入App工程:

1.1  拖拽导入

直接拖拽下载下来的相关SDK(正式版为: PtTrackSDK.framework)到App工程中的Frameworks目录下,并选中”Copy item if needed”,点击Finish,以保证SDK拷贝到当前工程目录中,如图:

1.2  右键导入

选中App工程中的Frameworks文件夹或者工程文件,右键菜单选择”Add Files to ‘demo.project’””, 以保证SDK(正式版为: PtTrackSDK.framework)拷贝到当前工程目录中,如图:

  • 2.  添加依赖框架

在App -> TARGETS -> Build Phases 配置项中通过+号加入图示中的依赖框架,并在Other Linker Flag配置项中添加-ObjC(此处务必添加,否则可导致SDK部分功能不可用):



 配置 AppKey 和 渠道

Appkey,即Ptengine for App中获取的AppID。

当app启动时,需要先通过SDK接口注册appKey,此方法必须调用:

  1. image.png

请确保该方法在application didFinishLaunchingWithOptions:的第一行处调用,已确保在程序启动时要加载的所有ViewController都被成功监听。

AppKey:为后台创建应用后生成的key值,不能为空, 此处可替换为相应的值。

channel:为app发布的渠道名称,如果传nil, 则使用默认值“AppStore”, 如果app要发布到其他渠道,请填写相关渠道名称。

 

第二部分:自定义代码集成

您可以通过调用如下接口,实现pageView、自定义事件和App错误信息的统计监测。

4. 自定义事件接口

4.1  部署自定义事件并添加属性接口

如果想要部署自定义事件,并给该事件设置自定义属性,可通过调用如下接口实现。

  1. image.png

4.2 自定义事件开始时间接口,用于统计事件时长

开始记录时间接口与结束记录时间接口的事件名要保持一致,用于统计某一个事件的执行时间

  1. /**

  2. * Mark the begin time for defined event.

  3. */

  4. - (void)PTBeginEvent:(NSString *)eventName;

4.3自定义事件结束时间接口,用于统计事件时长

开始记录时间接口与结束记录时间接口的事件名要保持一致,用于统计某一个事件的执行时间。

结束记录时间接口也可传递其他的变量值作为自定义属性。

image.png

4.4 自定义用户登录事件接口

登录成功之后请把当前的登入用户作为值传入

  1. image.png

  • 5. 虚拟PV接口

如果某个特殊业务场景或者一个自定义UIView想作为一个PV统计,可调用该接口实现。对于UIViewController容器类,SDK会自动采集PV数据,所以不要使用该接口对UIViewController类进行重复的PV数据采集。

  1. image.png

6.  自定义pageView name接口

基础SDK包已经默认采集了UIViewController 的PV数据,默认采集的页面名称为当前Controller类名,但如果您想要自定义当前ViewController的页面名称,可通过如下接口调用:

  1. image.png

7.  App错误信息统计接口

如果想要采集某些场景下的错误信息,比如app中请求http失败,或者登陆失败等等,请调用如下接口:

  1. image.png

8.  App中包含HTML界面的事件统计方式

SDK提供了支持对HTML界面的事件统计javascript接口,使用这些接口之前需要先进行简单的注册配置。如果你的App中包含UIWebView 或者WKWebView页面,想要自定义统计App中网页界面的事件信息,可以在App中想关的avaScript代码进行事件埋点。

8.1: 针对UIWebView,WKWebView分别在FinishLoad回调中注册Ptengine javascript bridge protocol, 如果使用的是第三方库,可在第三方库相关的抛出的回调中注册该接口。

具体参看接口注释中的代码示例

  • 8.2:注册完成之后,还需要针对UIWebView, WKWebView分别在StartLoad相关的回调中过滤掉关于ptengine的请求跳转,我们SDK提供了两个常量PT_WebView_Bridge_Scheme,  PT_WebView_Bridge_Host。具体参看接口注释中的代码示例

    8.3: 到此所以配置结束,可以在html中使用javascript接口来埋点事件了,具体参看如下代码示例

    1. image.png

9.  日志接口

当集成完SDK后,SDK 调试log默认关闭状态,可通过设置log接口关闭log输出。

  1. /**

  2. *  Set all level log disabled, default is NO

  3. */

  4. - (void)PTEnableLogOutput;

10.  IDFA声明

由于苹果系统的限制和某些API的不确定性,我们默认采用Advertising Identifier来作为设备的唯一标识,已最大化的保证数据的准确性,所以需要在开发者在上架AppStore时进行关于Advertising Identifier的简单配置:

  11. iOS SDK 电商模块接口使用说明

    11.1 
    /**
     * 用户注册具体信息接口,用于采集用户注册事件。
     *  pt_xxx字段为协议内定字段,不可随意改变,其他类型字段可根据业务随意变更。
     *  pt_xxx内定字段需要传哪些请参考协议接口文档中[是否必须]==是 && [传值方式] == 用户
     */
  1. image.png

    11.2
     /**
     * 用户登录接口,用于采集用户登录事件。
     */
  1. image.png

11.3

电商事件采集接口

  1. image.png