Skip to content
方便 unity 集成使用 openinstall
Branch: master
Clone or download
cooper cooper
cooper and cooper SDK升级
Latest commit faa1410 Mar 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images 完善android平台集成配置文档 Aug 8, 2018
sample
.gitignore
README.md 更新文档 Feb 21, 2019
openinstall.unitypackage SDK升级 Mar 12, 2019

README.md

openinstall-unity-sdk

方便 unity 集成使用 openinstall

导入 openinstall.unitypackage

右击 Assets ,选择 Import Package 中的 Custom Package...

在文件选择框中选中 openinstall.unitypackage,导入所有文件

Assets/Plugins/OpenInstall 下的 OpenInstall.prefab 拖入对应的场景中使用 openinstall 实现业务逻辑

平台配置

请根据使用指南来做对应配置

iOS 平台

无需写一句Object-C代码,只需进行如下配置

_备注:

  • 如果用户使用了 IMPL_APP_CONTROLLER_SUBCLASS 宏生成自己的 customAppController,请在自己的 customAppController 中添加初始化方法和拉起回调方法,并删除掉 Assets/Plugins/iOS/libs 中的 CustomAppController.mm 文件;
  • 如果用户使用了 iOS9.0 新 API application:openURL:options:,请在新 API 中添加 if ([OpenInstallSDK handLinkURL:url]) return YES; 回调判断_
初始化配置

在 Info.plist 文件中配置 appKey 键值对,如下:

<key>com.openinstall.APP_KEY</key>
<string>从openinstall官网后台获取应用的appkey</string>

以下为iOS一键拉起功能相关配置

universal links配置(iOS9以后推荐使用)

对于iOS,为确保能正常跳转,AppID必须开启Associated Domains功能,请到苹果开发者网站,选择Certificate, Identifiers & Profiles,选择相应的AppID,开启Associated Domains。注意:当AppID重新编辑过之后,需要更新相应的mobileprovision证书。(图文配置步骤请看iOS集成指南),如果已经开启过Associated Domains功能,进行下面操作:

  • 在左侧导航器中点击您的项目
  • 选择 Capabilities 标签
  • 打开 Associated Domains 开关
  • 添加 openinstall 官网后台中应用对应的关联域名(openinstall应用控制台->iOS集成->iOS应用配置->关联域名(Associated Domains))
scheme配置

Info.plist 文件中,在 CFBundleURLTypes 数组中添加应用对应的 scheme,或者在工程“TARGETS-Info-URL Types”里快速添加,图文配置请看iOS集成指南
(scheme的值详细获取位置:openinstall应用控制台->iOS集成->iOS应用配置)

	<key>CFBundleURLTypes</key>
	<array>
	    <dict>
		<key>CFBundleTypeRole</key>
		<string>Editor</string>
		<key>CFBundleURLName</key>
		<string>openinstall</string>
		<key>CFBundleURLSchemes</key>
		<array>
		    <string>"从openinstall官网后台获取应用的scheme"</string>
		</array>
	    </dict>
	</array>

Android 平台

简单配置

sample/Android 目录中的 AndroidManifest.xml 文件拷贝到项目的 Assets/Plugin/Android/ 目录下,并修改文件内容:将 openinstall 为应用分配的 appkeyscheme 替换至相应位置
(scheme的值详细获取位置:openinstall应用控制台->Android集成->Android应用配置)

自定义配置
  1. 如果项目已存在自己的 AndroidManifest.xml 文件,根据下图标注的内容做相应的更改 AndroidManifest.xml修改

  2. 如果拥有自己的 Application ,可参考 sample/Android/src 目录中的 OiApplication.java 修改自己的 Application 对 openinstall 进行初始化,此时 AndroidManifest.xml 中的 application 设置仍然使用自己的 Application

  3. 如果需要使用自己的拉起 Activity ,可参考 sample/Android/src 目录中的 OiUnityActivity.java 在拉起 ActivityonCreate(Bundle savedInstanceState)onNewIntent(Intent intent) 中添加拉起处理代码

使用指南

除了快速下载功能,其他功能都需要先 导入空间命令并获取实例

使用 OpenInstall 之前,请先导入命名空间

using io.openinstall.unity;

然后通过 GameObject 获取 OpenInstall 实例

private OpenInstall openinstall;
void Start () {
    openinstall = GameObject.Find("OpenInstall").GetComponent<OpenInstall>();
}

1 快速下载

如果只需要快速下载功能,无需其它功能(携带参数安装、渠道统计、一键拉起),完成初始化相关工作即可

2 一键拉起

完成文档前面iOS和Android介绍的一键拉起相关配置
获取拉起数据

Start 方法中,获取到实例之后注册拉起回调,这样当 App 被拉起时,会回调方法,并可在回调中获取拉起数据

openinstall.RegisterWakeupHandler(getWakeupFinish);
public void getWakeupFinish(OpenInstallData wakeupData)
{
    Debug.Log("OpenInstallUnity getWakeupFinish : 渠道编号=" +wakeupData.channelCode 
            + ", 自定义数据=" + wakeupData.bindData);
}

3 携带参数安装(高级版功能)

获取安装数据

在应用需要安装参数时,调用以下 api 获取由 SDK 保存的安装参数,可设置超时时长(一般为8~15s),单位秒

openinstall.GetInstall(10, getInstallFinish);
public void getInstallFinish(OpenInstallData installData)
{
    Debug.Log("OpenInstallUnity getInstallFinish : 渠道编号=" + installData.channelCode 
            + ",自定义数据=" + installData.bindData);
}

_备注:

  • 注意这个安装参数尽量不要自己保存,在每次需要用到的时候调用该方法去获取,因为如果获取成功sdk会保存在本地
  • 该方法可重复获取参数,如需只要在首次安装时获取,可设置标记,详细说明可参考openinstall官网的常见问题

4 渠道统计(高级版功能)

SDK 会自动完成访问量、点击量、安装量、活跃量、留存率等统计工作。其它业务相关统计由开发人员代码埋点上报
4.1 注册上报

在用户注册成功后,调用接口上报注册量

openinstall.ReportRegister();
4.2 效果点上报

统计终端用户对某些特殊业务的使用效果,如充值金额,分享次数等等。调用接口前,请先进入 openinstall 管理后台 “效果点管理” 中添加效果点,第一个参数对应管理后台 效果点ID

openinstall.ReportEffectPoint("effect_test", 1);
You can’t perform that action at this time.