GDTSDKConfig.h 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. //
  2. // GDTSDKConfig.h
  3. // GDTMobApp
  4. //
  5. // Created by GaoChao on 14/8/25.
  6. // Copyright (c) 2014年 Tencent. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import "GDTSDKDefines.h"
  10. #import "GDTAdTestSetting.h"
  11. @interface GDTSDKConfig : NSObject
  12. /**
  13. SDK 注册接口,请在 app 初始化时调用。
  14. @param appId - 开发者平台注册得到的appId
  15. @return 注册是否成功。
  16. */
  17. + (BOOL)registerAppId:(NSString *)appId GDT_DEPRECATED_MSG_ATTRIBUTE("接口即将废弃,请使用initWithAppId和startWithCompletionHandler新接口");
  18. /**
  19. * SDK初始化
  20. * @param appId - 开发者平台注册得到的appId
  21. * @return 初始化是否成功
  22. * @note 调用initWithAppId接口后,请尽快调用startWithCompletionHandler接口;如果不调用startWithCompletionHandler接口,会影响SDK功能。
  23. */
  24. + (BOOL)initWithAppId:(NSString *)appId;
  25. /**
  26. * 启动SDK
  27. * @param handler - 启动成功|失败的结果回调
  28. * @note 请先调用initWithAppId接口,再调用startWithCompletionHandler接口。
  29. */
  30. + (void)startWithCompletionHandler:(void(^)(BOOL success, NSError *error))handler;
  31. /**
  32. * 提供给聚合平台用来设定SDK 流量分类
  33. */
  34. + (void)setSdkSrc:(NSString *)sdkSrc;
  35. /**
  36. * 查看SDK流量来源
  37. */
  38. + (NSString *)sdkSrc;
  39. /**
  40. * 获取 SDK 版本
  41. */
  42. + (NSString *)sdkVersion;
  43. /**
  44. * 设置流量渠道号
  45. 渠道号信息主要用来协助平台提升流量变现效果及您的收益,请如实填写,若渠道号无法满足您的诉求请联系平台负责商务
  46. 渠道号映射关系为:
  47. 1:百度
  48. 2:头条
  49. 3:广点通
  50. 4:搜狗
  51. 5:其他网盟
  52. 6:oppo
  53. 7:vivo
  54. 8:华为
  55. 9:应用宝
  56. 10:小米
  57. 11:金立
  58. 12:百度手机助手
  59. 13:魅族
  60. 14:AppStore
  61. 999:其他
  62. */
  63. + (void)setChannel:(NSInteger)channel;
  64. + (void)setSDKType:(NSInteger)type;
  65. /**
  66. 在播放音频时是否使用SDK内部对AVAudioSession设置的category及options,默认使用,若不使用,SDK内部不做任何处理,由调用方在展示广告时自行设置;
  67. SDK设置的category为AVAudioSessionCategoryAmbient,options为AVAudioSessionCategoryOptionDuckOthers
  68. */
  69. + (void)enableDefaultAudioSessionSetting:(BOOL)enabled;
  70. + (GDTAdTestSetting *)debugSetting;
  71. /**
  72. 设置开发阶段调试相关的配置
  73. */
  74. + (void)setDebugSetting:(GDTAdTestSetting *)debugSetting;
  75. + (void)forbiddenIDFA:(BOOL)forbiddened;
  76. /**
  77. 获取 buyerId 用于 Server Bidding 请求获取 token, 建议每次请求前调用一次, 并使用最新值请求
  78. */
  79. + (NSString *)getBuyerIdWithContext:(NSDictionary *)info;
  80. /**
  81. 获取用于 Server Bidding 请求SDK侧相关请求参数信息
  82. */
  83. + (NSString *)getSDKInfoWithPlacementId:(NSString *)placementId;
  84. /**
  85. 设置个性化推荐状态
  86. @param state 1为关闭个性化推荐,其他值或未设置为打开
  87. */
  88. + (void)setPersonalizedState:(NSInteger)state;
  89. /**
  90. 设置用户信息
  91. @param extraUserDictionary, 必须为有效的字符串格式的键值对
  92. 已支持的key有:
  93. @"lng",实时的地理位置经度,值为字符串格式的经度值,比如@“116.67765”
  94. @"lat", 实时的地理位置纬度,值为字符串格式的纬度值,比如@"39.365678"
  95. @"loc_time",实时的地理位置获取时间,值为字符串格式的unix时间戳,单位秒,比如@"1639450944"
  96. @"shakable",是否关闭摇一摇,值为字符串格式,”0“:关闭摇一摇;”1“:开启摇一摇
  97. */
  98. + (void)setExtraUserData:(NSDictionary <NSString *, NSString *> *)extraUserDictionary;
  99. /**
  100. 设置用户信息
  101. @param mediaExtDictionary, 必须为有效的字符串格式的键值对
  102. 已支持的key有:
  103. @"user_id",用户的id,比如QQ号
  104. @param overrideOld, 新的mediaExtDictionary是否覆盖之前设置的mediaExtDictionary
  105. */
  106. + (void)setMediaExtData:(NSDictionary <NSString *, NSString *> *)mediaExtDictionary overrideOldData:(BOOL)overrideOld;
  107. @end