全部产品
云市场

友盟IOS SDK使用方法

更新时间:2020-03-19 10:05:10

下载Sdk

重要说明:AIRec需要配合友盟基础组件库 2.1.2+版本和统计SDK 6.0.6+版本一起使用。

1.iOS SDK下载
2. 解压下载后的zip文件,将得到common目录下的基础组件库UMCommon.framework及analytics目录下的UMAnalytics.framework导入工程,并将其加入工程依赖。

12

3. 将最新版本智能推荐SDK包AIRec.framework导入工程中。

3

4. Targets->BuildSettings设置,Targets->BuildSettings 中 , Other Linker Flags增加-Objc,一定要添加此项,注意是大写C,不是小写c

基础SDK初始化

  1. 在友盟官网注册账号,并申请Appkey。友盟基础组件库的初始化函数需要传入此Appkey。
  2. 在目标工程- (BOOL)application:(UIApplication)application didFinishLaunchingWithOptions:(NSDictionary)launchOptions 中执行友盟基础组件库初始化函数,设置统计场景。下面的示例代码摘自AIRec SDK集成Demo工程。
    1. (BOOL)APPLICATION:(UIAPPLICATION *)APPLICATION DIDFINISHLAUNCHINGWITHOPTIONS:(NSDICTIONARY *)LAUNCHOPTIONS {
    2. // OVERRIDE POINT FOR CUSTOMIZATION AFTER APPLICATION LAUNCH.
    3. //初始化
    4. [UMCONFIGURE INITWITHAPPKEY:@"59C5EF6EB27B0A393E00002B" CHANNEL:@"APP STORE"];
    5. //设置场景
    6. [MOBCLICK SETSCENARIOTYPE:E_UM_NORMAL];
    7. //设置USERID
    8. [AIREC SETRECUSERID:@"SET USERID"];
    9. //设置是否登录
    10. [AIREC SETRECLOGIN:YES];
    11. RETURN YES;
    12. }
    如果需要使用友盟统计SDK高级功能,请参考如下链接:如果需要使用友盟统计SDK高级功能,请参考如下链接:
    友盟SDK集成文档

    智能推荐SDK集成

    SDK API说明

    请在完成友盟基础组件库初始化函数调用之后调用AIRec SDK初始化函数。 请在调用AIRec SDK初始化函数之后再调用其它功能接口函数。

设置UserId函数

  1. /** 设置userId
  2. @param userId 用户ID
  3. @return void.
  4. */
  5. + (void)setRecUserId:(NSString *)userId;

例子:

  1. [AIRec setRecUserId:@"set userId"];

设置是否登录函数

  1. /** 设置是否登录
  2. @param isLogin 是否登录,如传nil为未登录
  3. @return void.
  4. */

例子:

  1. [AIRec setRecLogin:YES];

推荐事件触发函数:

  1. /**
  2. * 行为事件类型
  3. */
  4. typedef NS_ENUM (NSUInteger, bhvType)
  5. {
  6. AI_REC_EXPOSE = 0, // 曝光
  7. AI_REC_STAY, // 停留
  8. AI_REC_CLICK, // 点击
  9. AI_REC_CART, // 加入购物车
  10. AI_REC_BUY, // 购买
  11. AI_REC_COLLECT, // 收藏
  12. AI_REC_LIKE, // 点赞
  13. AI_REC_UNLIKE, // 点衰
  14. AI_REC_COMMENT, // 写评论
  15. AI_REC_SHARE, // 分享
  16. AI_REC_SUBSCRIBE // 订阅
  17. };
  18. /**
  19. * 效果测试跟踪ID
  20. */
  21. static NSString * const AIREC_ALIBABA;
  22. static NSString * const AIREC_SELFHOLD;
  23. /** 发送时间方法
  24. bizId
  25. sceneId 默认值为1
  26. traceId NSString类型 ,(AIREC_ALIBABA值为Alibaba , AIREC_SELFHOLD值为Selfhold)
  27. traceInfo
  28. itemId
  29. itemType
  30. bhvType 枚举traceIdType
  31. bhvValue
  32. (注:1. 当bhvType=AI_REC_STAY时,bhvValue值能传数字,代表停留时间,单位为秒s,如传字符串默认值为0;
  33. 2. 当bhvType=AI_REC_CLICK时,bhvValue传1;
  34. 3. 其它情况:传null)
  35. parameters 自定义参数
  36. */
  37. + (void)onRecEvent:(NSString *)bizId sceneId:(NSString *)sceneId traceId:(NSString *)traceId traceInfo:(NSString *)traceInfo itemId:(NSString *)itemId itemType:(NSString *)itemType bhvType:(bhvType)bhvType bhvValue:(NSString *)bhvValue parameters:(NSDictionary *)parameters;

例子:

  1. [AIRec onRecEvent:@"bizID" sceneId:@"sceneID" traceId:AIREC_ALIBABA traceInfo:@"traceInfo111" itemId:@"itemID222" itemType:@"itemType33" bhvType:AI_REC_STAY bhvValue:@"bhvValue44" parameters:@{@"aa":@"bb"}];

SDK集成调试

AIRec SDK会输出相关调试信息。过滤TAG字段为”RecAgent”,如需查看发送数据log,需集成UMCommonLog.framework 和 UMCommonLog.bundle,具体集成参考文档:https://developer.umeng.com/docs/66632/detail/66891

  • 注意:App正式上线前请关闭SDK调试Log。