SDK 基本信息

SDK名称：热力引擎 iOS SDK v1.3.0.3

开发者名称：汇量云（北京）科技有限公司

SDK版本号：1.3.0.3

支持Xcode版本：14.0或更高

主要功能：热力引擎是一站式增长分析与发行决策平台，致力于帮助开发者搭建便捷、高效的数据管理中台，洞察业务运营全链路数据，制定更优增长决策。热力引擎支持全球全渠道数据管理，帮助开发者实现归因分析、用户粒度 ROI 分析，能有效衡量渠道价值，为投放和变现策略调优提供全方位数据支持。同时，提供应用内埋点及参数管理，配合多种分析模型与 AB 测试功能，全面还原用户全生命周期旅程，挖掘用户需求及业务增长点，快速验证并推行产品迭代优化，为开发者提升业务运营效率，实现规模化增长赋能。

适用范围：适用于 iOS 11.0 及以上的操作系统。

隐私政策链接： https://www.solar-engine.com/privacyPolicy.html

合规指南：详见本页面底部合规指南内容。

第一步：获取 Appkey

Appkey 查询路径：资产管理-应用管理-16位 Appkey（即应用 ID）。

第二步：获取 SDK

如果您创建的产品数据存储区域是中国大陆，请下载

https://solar-sdk.oss-cn-beijing.aliyuncs.com/iOS/SolarEngine-iOSSDK-CN-v1.3.0.3.zip

如果您创建的产品数据存储区域是非中国大陆，请下载

https://solar-sdk.oss-cn-beijing.aliyuncs.com/iOS/SolarEngine-iOSSDK-US-v1.3.0.3.zip

获取 SDK Demo

SDK Demo下载地址

 https://solar-sdk.oss-cn-beijing.aliyuncs.com/iOS/SolarEngineSDKDemo.zip

下载SDK后需要做以下步骤才行运行Demo：

1、进入 SolarEngineSDKDemo 目录，打开Podfile文件，选择中国大陆 或 非中国大陆 放开注释(去掉其中一个pod 前面的#)

# 中国大陆
#  pod 'SolarEngineSDK'  , '~> 1.3.0.3'

# 非中国大陆
#  pod 'SolarEngineSDKiOSInter'  , '~> 1.3.0.3'

2、进入 SolarEngineSDKDemo 目录，在终端执行 pod install 命令拉取最新代码

3、双击SolarEngineSDKDemo.xcworkspace打开项目

4、AppDelegate.m文件中的"your_appKey" 需要设置成您自己的项目的appKey

第三步：SDK 集成

手动集成：添加 SDK 所需依赖框架

使用 Security.framework 来存储设备标识

使用 CoreTelephony.framework 来获取运营商信息

使用 AdSupport.framework 来获取 Advertising Identifier 信息

使用 SystemConfiguration.framework 来检查当前网络环境

使用 libsqlite3.dylib 用来存储数据

使用 AdServices.framework 获取广告归因数据
（如果需要使用 ASA 归因，务必添加 AdServices.framework 依赖，否则无法获取归因结果）

添加方法：

在工程目录中,选择 TARGETS-->Build Phases-->Link Binary With Libraries-->+ -->选择 Security.framework、CoreTelephony.framework、AdSupport.framework、SystemConfiguration.framework、libsqlite3.tbd、AdServices.framework等库文件。

如上动态库请全部配置，避免报错。

添加-ObjC参数

在工程的 TARGETS -> Build Settings -> Linking -> Other Linker Flags 中添加 -ObjC

Cocoapods集成

如果您创建的产品数据存储区域是中国大陆，请使用

pod 'SolarEngineSDK' , '~> 1.3.0.3'

如果您创建的产品数据存储区域是非中国大陆，请使用

pod 'SolarEngineSDKiOSInter' , '~> 1.3.0.3'

第四步：预初始化 SDK

在应用安装后首次冷启动时，需要先预初始化 SDK，预初始化时 SDK 不采集任何个人信息也不会向热力引擎上报数据,

请请确保用户同意《隐私政策》并且 SDK 预初始化成功后，再调用初始化函数正式初始化 SDK

- (void)preInitWithAppKey:(nonnull NSString *)appKey;

参数说明：

// 导入头文件
#import <SolarEngineSDK/SolarEngineSDK.h>


[[SolarEngineSDK sharedInstance] preInitWithAppKey:your_appKey];

第五步：初始化配置（可选）

此方法返回的 config 配置作为初始化方法的一个可选参数，如未设置则为默认值

初始化配置说明：

第六步：初始化 SDK

在正式初始化前，您应确保用户同意《隐私政策》并且 SDK 预初始化成功，再调用正式初始化函数初始化热力引擎 SDK

- (void)startWithAppKey:(nonnull NSString *)appKey config:(SEConfig *)config;

参数说明：

正式初始化调用示例：

SEConfig *config = [[SEConfig alloc] init];
config.logEnabled = YES; //开启本地调试日志
[[SolarEngineSDK sharedInstance] startWithAppKey:your_appKey config:config];

 [[SolarEngineSDK sharedInstance] setInitCompletedCallback:^(int code) {
      if (code == 0) {
            // 初始化成功
            NSLog(@"InitCompletedCallback success");
       } else {
            // 初始化失败
            NSLog(@"InitCompletedCallback code = %d",code);
       }
 }];

// 注：设置归因结果回调，请在初始化SDK前设置，因为可能初始化SDK时立即会给回调，在初始化后设置回调可能导致接受不到回调。
    [[SolarEngineSDK sharedInstance] setAttributionCallback:^(int code, NSDictionary * _Nullable attributionData) {
        if (code == 0) {
            NSLog(@"attributionData = %@",attributionData);
        } else {
            NSLog(@"code = %d",code)
        }
    }];

// 初始化SDK

// 此接口为同步获取归因结果信息，SDK还没归因结果信息的时候返回nil
- (NSDictionary *)getAttributionData;