cocos2d-x 接入指引

Cocos2d-x 是一套开源的跨平台游戏开发框架。引擎核心采用 C++ 编写,提供 C++、Lua、JavaScript 三种编程语言接口。目前 openinstall 提供 C++ 和 JavaScript 集成插件。Lua集成插件正在测试阶段,近期即将上线。

获取所有的 C++ 文档 和 插件

获取所有的 JavaScript 文档 和 插件

一. openinstall-cocos2dx-c++

cocos2d-x 集成 openinstall SDK

Android 集成

集成 openinstall SDK 到 cocos2d-x Android 项目中,请参考Android 集成指南

iOS 集成

集成 openinstall SDK 到 cocos2d-x iOS 项目中,请参考iOS 集成指南

使用指南

导入头文件

在所有需要使用到 openinstall api 的文件中,需要导入 openinstall 头文件

#include "OpenInstall.h"

注:请根据文件目录结构适当调整引用路径

初始化

AppDelegateinitGLContextAttrs的方法中进行初始化。

void AppDelegate::initGLContextAttrs()
{
    GLContextAttrs glContextAttrs = {8, 8, 8, 8, 24, 8, 0};

    GLView::setGLContextAttrs(glContextAttrs);

    // openinstall Initialize
    openInstall2dx::OpenInstall::init();

}

功能集成

1 快速下载

如果只需要快速下载功能,无需其它功能(携带参数安装、渠道统计、一键拉起),完成初始化即可(包括iOS.md和Android.md中的初始化配置工作)

2 一键拉起

一键拉起的配置见iOS.md和Android.md相关文档
获取拉起数据

同样,在AppDelegateinitGLContextAttrs方法中,OpenInstall::init();之后注册拉起回调,这样当 App 被拉起时,会回调方法,并可在回调中获取拉起数据

    openInstall2dx::OpenInstall::registerWakeUpHandler([](openInstall2dx::AppData appData){
        std::string channelCode = appData.getChannelCode();
        std::string bindData = appData.getBindData();
    });

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

获取安装参数

在应用需要安装参数时,调用以下 api 获取由 SDK 保存的安装参数,可设置超时时长,单位秒

    openInstall2dx::OpenInstall::getInstall(8,[](openInstall2dx::AppData appData){
        std::string channelCode = appData.getChannelCode();
        std::string bindData = appData.getBindData();
    });

4 渠道统计高级版功能

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

根据自身的业务规则,在确保用户完成 app 注册的情况下调用相关api

    openInstall2dx::OpenInstall::reportRegister();
4.2 效果点上报

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

    openInstall2dx::OpenInstall::reportEffectPoint("effect_test", 1);

二. openinstall-cocos2dx-javascript

cocos2d-x 集成 openinstall SDK

此仓库是根据 Cocos Creator 集成而写,直接使用cocos2d-js的用户请参考cocos2d-js集成修改相应文件后再集成

Android 集成

集成 openinstall SDK 到 cocos2d-x Android 项目中,请参考Android 集成指南

iOS 集成

集成 openinstall SDK 到 cocos2d-x iOS 项目中,请参考iOS 集成指南

使用指南

除了快速下载功能,其他功能都需要先引入 openinstall 脚本

Script文件夹中的OpenInstall.js拖入项目的脚本文件夹Script中,在组件中使用时,请先引入脚本

var openinstall = require("OpenInstall");

1 快速下载

如果只需要快速下载功能,无需其它功能(携带参数安装、渠道统计、一键拉起),完成初始化即可(包括iOS.md和Android.md中的初始化工作)

2 一键拉起

一键拉起的配置见iOS.md和Android.md相关文档

获取拉起数据

在组件脚本的onLoad方法中,注册拉起回调,这样当 App 被拉起时,会回调方法,并可在回调中获取拉起数据

    // 拉起回调方法
    _wakeupCallback : function(appData){
        cc.log("拉起参数:channelCode=" + appData.channelCode 
            + ", bindData=" + appData.bindData);
    },
    // 在 onLoad 中调用
    openinstall.registerWakeUpHandler(this._wakeupCallback);

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

获取安装数据

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

    //安装回调方法
    _installCallback : function(appData){
        cc.log("安装参数:channelCode=" + appData.channelCode 
            + ", bindData=" + appData.bindData);
    },
    //在 App 业务需要时调用
    openinstall.getInstall(10, this._installCallback);

_备注:

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

4 渠道统计高级版功能

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

4.1 注册上报

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

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

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

openinstall.reportEffectPoint("effect_test", 1);