基本信息

SDK名称：热力引擎 Cocos2d-lua SDK v1.0.0

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

SDK版本号：1.0.0

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

适用范围：适用于Android5.0（APILevel21）及以上的操作系统。

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

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

第一步：获取 Appkey

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

第二步：获取 SDK

如果您创建的产品数据存储区域是中国大陆，请下载: SolarEngineSDK-Cocos2dlua-CN-1.0.0

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

第三步：集成 SDK

集成SolarEngineSDK

下载好的SolarEngineSDK 有三部分：Android、iOS、Script

Android:
- SolarEngineProxy.java
iOS
- SolarEngineProxy.h
- SolarEngineProxy.mm
- SolarEngineSDK.xcframework
Script
- SolarEngineSDK.lua

SolarEngineSDK.lua 文件放在项目根目录下的 src/ 目录下

SolarEngineProxy.java 文件放在 frameworks/runtime-src/proj.android/app/src/org/cocos2dx/lua/ 目录下

整个iOS目录放在 frameworks/runtime-src/proj.ios_mac/ios/ 目录下

配置CMakeLists

在 CMakeLists.txt 中加入以下配置

if(ANDROID)
    list(APPEND GAME_SOURCE 
        ${RUNTIME_SRC_ROOT}/proj.android/app/src/org/cocos2dx/lua/SolarEngineProxy.java
	)
elseif(APPLE)
    if(IOS)
        list(APPEND GAME_HEADER
             ${RUNTIME_SRC_ROOT}/proj.ios_mac/ios/iOS/SolarEngineProxy.h
             )
        list(APPEND GAME_SOURCE
             ${RUNTIME_SRC_ROOT}/proj.ios_mac/ios/iOS/SolarEngineProxy.mm
             ${RUNTIME_SRC_ROOT}/proj.ios_mac/ios/iOS/SolarEngineSDK.xcframework
             )
    endif()
endif()

if(IOS)
    # [SolarEngine] 添加以下代码
    set(CMAKE_EXE_LINKER_FLAGS -ObjC)
endif()

# mark app complie info and libs info

if(IOS)
    # [SolarEngine] 添加以下代码
    target_link_libraries(${APP_NAME} ${RUNTIME_SRC_ROOT}/proj.ios_mac/ios/iOS/SolarEngineSDK.xcframework)
endif()

Android 配置

添加SolarEngine Android SDK 依赖

使用Android Studio 打开Android 项目编译

maven 仓库配置

需要在项目根目录的 build.gradle 文件中添加 maven 仓库配置，具体配置如下：

allprojects {
    repositories {
        google()
        jcenter()

        // SolarEngine SDK仓库地址
        maven { url "https://maven-android.solar-engine.com/repository/se_sdk_for_android/" }
        maven { url "https://developer.huawei.com/repo/" }
        maven { url "https://developer.hihonor.com/repo/" }
        maven { url 'https://artifact.bytedance.com/repository/pangle'}
    }
}

请将下方代码添加到 project 的 build.gradle 中

中国大陆，请使用大陆版SDK

implementation 'com.reyun.solar.engine.china:solar-engine-core:1.3.1.1'
implementation 'com.reyun.solar.engine.china:solar-remote-config:1.3.1.1'

非中国大陆，请使用海外版SDK

implementation 'com.reyun.solar.engine.oversea:solar-engine-core:1.3.1.1'
implementation 'com.reyun.solar.engine.oversea:solar-remote-config:1.3.1.1'

SolarEngineProxy.java 文件对应的位置

如果打包时需要增加混淆，请将下方代码增加到混淆配置文件中

-keep class com.reyun.** {*; }
-keep class route.**{*;}
-keep interface com.reyun.** {*; }
-keep interface route.**{*;}
-dontwarn com.reyun.**
-dontwarn org.json.**
-keep class org.json.**{*;}
# Google lib库
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
    com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
    java.lang.String getId();
    boolean isLimitAdTrackingEnabled();
}
-keep public class com.android.installreferrer.** { *; }
# 如果使用到了获取oaid插件，请添加以下混淆策略
-keep class com.huawei.hms.**{*;}
-keep class com.hihonor.**{*;}

iOS 配置

支持Xcode版本：14.0或更高

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

添加 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等库文件。

第四步：预初始化

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

local SolarEngineSDK = require("SolarEngineSDK")

SolarEngineSDK.preInit(seAppKey)

第五步：初始化

SDK初始化参数

参数名称	参数含义	参数类型	是否必传
config	sdk初始化配置	table	是

config

参数名称	参数含义	参数类型	是否必传
appKey	开发者在热力引擎后台申请的Appkey	string	是
logEnabled	是否开启日志打印，默认为关闭状态	boolean	否
isGDPRArea	是否为GDPR区域,默认为false	boolean	否
adPersonalizationEnabled	用户是否允许Google将其数据用于个性化广告，开发者自定义，不设置则默认不上报该字段，只有Android调用有效，iOS没有此字段，无需设置此字段	boolen	否
adUserDataEnabled	用户是否同意将其数据发送到Google，开发者自定义，不设置则默认不上报该字段，只有Android调用有效，iOS没有此字段，无需设置此字段	boolean	否
fbAppID	如果海外开发者需要用到meta归因，此处设置meta appid，只有Android调用有效，iOS没有此字段，无需设置此字段	string	否
attAuthorizationWaitingInterval	iOS首次上报事件支持设置ATT授权等待,最多支持等待120秒. 设置等待后SDK会等用户ATT授权或等待超时才上报Install等事件。单位：秒。 Android 没有此字段	int	否
isDebugModel	是否开启Debug调试模式，默认为关闭状态	boolean	否
isCoppaEnabled	是否支持coppa合规。默认为false	boolean	否
isKidsAppEnabled	是否支持Kids App。默认为false	boolean	否
enableDeferredDeeplink	是否开启延迟deeplink, 默认为false	boolean	否
remoteConfig	在线参数初始化配置	table	否

remoteConfig参数说明（在线参数功能）

参数名称	参数含义	参数类型	是否必传
enable	是否启用在线参数SDK，默认为关闭状态，必传字段	boolean	否
mergeType	SDK配置合并策略，默认情况下服务端配置跟本地缓存配置合并，具体释义参考下方参数解释,可选字段 0: app首次启动或版本更新时, 使用服务端配置跟用户默认配置合并，此方法可以清除本地缓存配置 1: 使用服务端配置跟用户本地已有缓存配置合并，在线参数SDK默认合并策略	int	否
customIDProperties	自定义ID，跟用户在后台设置的使用自定义ID匹配对应	table	否
customIDEventProperties	自定义ID事件属性值，跟用户在后台设置的使用自定义ID事件属性值匹配对应,可选字段	table	否
customIDUserProperties	自定义ID用户属性值，跟用户在后台设置的使用自定义ID用户属性值匹配对应,可选字段	table	否

初始化示例

local SolarEngineSDK = require("SolarEngineSDK")


-- 设置 SolarEngine 初始化回调
SolarEngineSDK.setInitCallback(function(code)
    if code == 0 then
        print("[SolarEngineSDK] 初始化成功")
    else
        print("[SolarEngineSDK] 初始化失败，错误码:", code)
    end
end)


SolarEngineSDK.initWithConfig({
    appKey = "您的 AppKey",
    logEnabled = true 
})

初始化回调 code 码：

0	初始化成功
101	SDK未预初始化
102	appkey非法
103	context为null（仅Android生效）
104	distinct_id生成失败（仅Android生效）

获取归因回调信息

初始化时获取归因结果

SDK提供获取归因结果信息接口，开发者可使用归因信息做埋点等逻辑处理

SDK提供两种方式获取归因结果信息

1、设置归因结果回调：当SDK获取归因结果成功或者失败时会给出回调（此接口为异步回调）

2、直接获取归因结果：直接从SDK缓存中获取归因结果，SDK还没归因结果时直接返回nil（此接口为同步返回）

监听归因结果示例代码：

SolarEngineSDK.setAttributionCallback(function(result)

    print("AttributionCallback data:", result)
    print("code:", result.code)
    print("data:", result.data)
    
    if result.code == 0 then
        for key, value in pairs(result.data) do
            print(key, ":", value)
        end
    end
end)

SolarEngineSDK.initWithConfig({
    appKey = "your se AppKey",
    logEnabled = true
})

直接获取归因结果

local SolarEngineSDK = require("SolarEngineSDK")
local attributionData = SolarEngineSDK.getAttributionData()
print("归因数据:", attributionData)

if attributionData and type(attributionData) == "table" then
    for key, value in pairs(attributionData) do
        print("归因字段:", key, "=", value)
    end
end

归因errorCode 描述及归因结果详情见：归因结果详情