‹ Chartboost Doc Home

Chartboost 集成指南

For the Javascript version of cocos2d-x v3.x - (all other versions)

集成

用如下命令来集成 SDKBOX Chartboost 插件,请确保您可以正常执行的 SDKBOX 安装器.

sdkbox import chartboost

重点注意事项

如果您升级到了 Xcode7, 则需要以下额外步骤来确保插件工作正常:

禁用应用程序安全传输策略

添加以下项到 plist:

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

添加后的文件内容看起来就像这样：

禁止 Bitcode 支持

您必须禁止 Bitcode 的支持，否则将会编译失败。

游戏全屏配置

如果您的游戏不同时支持横竖屏，则必须在 Xcode 中选中 Requires full screen，否则将不会通过 Apple 的审核。

canOpenURL 白名单

取决于您使用哪些插件。需要在 info.plist 的 LSApplicationQueriesSchemes 下添加名单。

关于 Creator 工程

Creator 导出工程会修改工程的配置, 这可能会影响 SDKBox 对工程的配置修改. 所以可以有以下做法(任选其一):

1. 保存导出工程中的修改, 对于 SDKBox 来说可能有这些文件(mk, gradle, gradle.properties, AppDelegate.cpp, ...), 导出后再恢复对应该文件
2. 在每一次 Creator 导出工程后, 重新 import 插件.

推荐第一种, 但是第一种的麻烦点在于, 对于第一次(或很久没接触的人)可能会有露掉某个文件 第二种, 很方便, 它的麻烦点在于, 如果你对工程有自己的修改, SDKBox 的重新 import 不能帮你恢复.

JSON 配置

SDKBOX 安装器会自动在您的工程中添加一个样例配置文件 sdkbox_config.json.在您编译工程前,请用您自己的应用信息修改里面的参数值

下面给出一个 Chartboost 的配置样例,您需要在Chartboost注册帐号,然后用对应的信息替换 <CHARTBOOST ID> 和 <CHARTBOOST SIGNATURE>.

"Chartboost":{
    "id":"<CHARTBOOST ID>",
    "signature":"<CHARTBOOST SIGNATURE>",
    "ads":{
        "Default":{
            "type":"interstitial"
        },
        "Level Complete":{
            "type":"rewarded_video"
        },
        "MoreApp":{
            "type":"more_app"
        }
    }
}

使用

初始化 Chartboost

• 在您的代码中合适的地方调用 init(), 我们建议在 app.js 初始化,比如:

sdkbox.PluginChartboost.init();

• 修改 ./frameworks/runtime-src/Classes/AppDelegate.cpp 包含以下头文件:

#include "PluginChartboostJS.hpp"
#include "PluginChartboostJSHelper.h"

• 修改 ./frameworks/runtime-src/Classes/AppDelegate.cpp 调用以下函数:

sc->addRegisterCallback(register_all_PluginChartboostJS);
sc->addRegisterCallback(register_all_PluginChartboostJS_helper);

显示广告

在您的代码中任何地方都可以显示广告:

// To use the Chartboost predefined locations
sdkbox.PluginChartboost.show("Default");
// To use customized location
sdkbox.PluginChartboost.show("your_ad_name");

接收 Chartboost 事件 (可选)

您可以接收 Chartboost 事件, 当玩家观看了广告过,您可以在代码中做某些操作,比如奖励玩家.

• 创建一个监听 (用logging来显示返回内容):

sdkbox.PluginChartboost.setListener({
    onChartboostCached : function (name) { cc.log("onChartboostCached " + name) },
    onChartboostShouldDisplay : function (name) { cc.log("onChartboostShouldDisplay " + name) },
    onChartboostDisplay : function (name) { cc.log("onChartboostDisplay " + name) },
    onChartboostDismiss : function (name) { cc.log("onChartboostDismiss " + name) },
    onChartboostClose : function (name) { cc.log("onChartboostClose " + name) },
    onChartboostClick : function (name) { cc.log("onChartboostClick " + name) },
    onChartboostReward : function (name, reward) { cc.log("onChartboostReward " + name + " reward " + reward) },
    onChartboostFailedToLoad : function (name, e) { cc.log("onChartboostFailedToLoad " + name + " load error " + e) },
    onChartboostFailToRecordClick : function (name, e) { cc.log("onChartboostFailToRecordClick " + name + " click error " + e) },
    onChartboostConfirmation : function () { cc.log("onChartboostConfirmation") },
    onChartboostCompleteStore : function () { cc.log("onChartboostCompleteStore") },
})

API Reference

Methods

sdkbox.PluginChartboost.init();

initialize the plugin instance.

sdkbox.PluginChartboost.show(name);

show ad by specifying ad name.

sdkbox.PluginChartboost.setListener(listener);

creates the an optional listener.

sdkbox.PluginChartboost.isAnyViewVisible();

check to see if any views are visible.

sdkbox.PluginChartboost.isAvailable(name);

is the specified ad available?

sdkbox.PluginChartboost.cache(name);

sdkbox.PluginChartboost.setAutoCacheAds(shouldCache);

set to enable and disable the auto cache feature (Enabled by default).

sdkbox.PluginChartboost.getAutoCacheAds();

get the current auto cache behavior (Enabled by default).

sdkbox.PluginChartboost.closeImpression();

close any visible Chartboost impressions (interstitials, more apps, rewarded video, etc..) and the loading view (if visible).

sdkbox.PluginChartboost.setStatusBarBehavior(behavior);

set to control how the fullscreen ad units should interact with the status bar. (CBStatusBarBehaviorIgnore by default).

sdkbox.PluginChartboost.didPassAgeGate(pass);

confirm if an age gate passed or failed. When specified Chartboost will wait for call before showing the IOS App Store.

sdkbox.PluginChartboost.setShouldPauseClickForConfirmation(shouldPause);

decide if Chartboost SDK should block for an age gate.

sdkbox.PluginChartboost.handleOpenURL(url, sourceApp);

opens a "deep link" URL for a Chartboost Custom Scheme.

sdkbox.PluginChartboost.setCustomID(customID);

set a custom identifier to send in the POST body for all Chartboost API server requests.

sdkbox.PluginChartboost.getCustomID();

get the current custom identifier being sent in the POST body for all Chartboost API server requests.

sdkbox.PluginChartboost.setShouldRequestInterstitialsInFirstSession(shouldRequest);

decide if Chartboost SDK should show interstitials in the first session.

sdkbox.PluginChartboost.setShouldDisplayLoadingViewForMoreApps(shouldDisplay);

decide if Chartboost SDK should show a loading view while preparing to display the "more applications" UI.

sdkbox.PluginChartboost.setShouldPrefetchVideoContent(shouldPrefetch);

decide if Chartboost SDK will attempt to fetch videos from the Chartboost API servers.

Listeners

onChartboostCached(name);

there is cached content

onChartboostShouldDisplay(name);

should Chartboost display

onChartboostDisplay(name);

Charboost ad has displayed

onChartboostDismiss(name);

Chartboost ad has been dismissed

onChartboostClose(name);

Chartboost is not running

onChartboostClick(name);

Chartboost ad was clicked on

onChartboostReward(name, reward);

Chartboost reward was given

onChartboostFailedToLoad(name, e);

Chartboost failed to load

onChartboostFailToRecordClick(name, e);

Chartboost failed to record click

onChartboostConfirmation();

Chartboost confirmation

onChartboostCompleteStore();

Chartboost complete store

手动集成

如果 SDKBOX 安装器 安装插件失败了，那么需要手动集成插件.如果安装器安装插件成功了,那么不需要，也没必要,按文档再手动集成一次.

下面列出的的步骤一般很少用到.如果你按下面的步骤完成了集成，请在完成集成后，再按步骤检查一次.

iOS 平台手动集成

拖拽下列 framework 从 Chartboost 插件包的 plugins/ios 目录到您的 Xcode 工程中，在添加 frameworks 的时候，请勾选 Copy items if needed 。

sdkbox.framework

PluginChartboost.framework

Chartboost.framework

上面的 frameworks 依赖于其他 frameworks。如果您没有添加它们，您也需要添加下列这些 frameworks：

Security.framework

StoreKit.framework

Foundation.framework

CoreGraphics.framework

UIKit.framework

把 plugin/jsbindings 文件夹中所有的头文件和源文件都拷贝到你的工程的 Classes 文件夹中.

把刚刚拷贝的文件拖动到 Xcode 中或使用 File -> Add files to... 来添加.

Android 平台手动集成

拷贝文件

从插件安装包中的 plugin/android/libs 目录拷贝下列 jar 文件到您的工程的 proj.android/libs 目录。

chartboost.jar

PluginChartboost.jar

sdkbox.jar

• 如果你使用 cocos2d-x 源码，拷贝 jar 文件到：

  Android command-line: cocos2d/cocos/platform/android/java/libs

  Android Studio: cocos2d/cocos/platform/android/libcocos2dx/libs

• 如果你使用 cocos2d-js 或者 lua ，拷贝 jar 文件到:

  Android command-line: frameworks/cocos2d-x/cocos/platform/android/java/libs

  Android Studio: frameworks/cocos2d-x/cocos/platform/android/libcocos2dx/libs

• 如果你使用 cocos2d-x 预编译包，拷贝 jar 文件到：

  Android command-line: proj.android/libs

从 plugin/android/jni 目录拷贝 pluginchartboost 以及 sdkbox 目录到您的工程的 proj.android/jni 目录。如果 sdkbox 目录在工程中已经存在，请覆盖它。

编辑 AndroidManifest.xml

在标签 application tag 上添加下列权限：

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

使 hardware acceleration 属性生效。这一标签是一个在新版本 sdk 上的选项，不能用于2.3.3版本。

<android:hardwareAccelerated="true" />

编辑 Android.mk

编辑 proj.android/jni/Android.mk：

为 LOCAL_STATIC_LIBRARIES 添加额外的库：

LOCAL_STATIC_LIBRARIES += PluginChartboost
LOCAL_STATIC_LIBRARIES += sdkbox

在所有 import-module 语句之前添加一条 call 语句：

$(call import-add-path,$(LOCAL_PATH))

在最后添加额外的 import-module 语句：

$(call import-module, ./sdkbox)
$(call import-module, ./pluginchartboost)

这意味着您的语句顺序看起来像是这样：

$(call import-add-path,$(LOCAL_PATH))
$(call import-module, ./sdkbox)
$(call import-module, ./pluginchartboost)

Note: 如果您使用的是 cocos2d-x 预编译库，那么保证这些语句在已有的 $(call import-module,./prebuilt-mk) 语句之上非常重要。

编辑 Application.mk （只限 Cocos2d-x v3.0 到 v3.2 版本）

编辑 proj.android/jni/Application.mk 保证 APP_STL 的定义正确。如果 Application.mk 包含了 APP_STL := c++_static 语句，那么这条语句应该被改为：

APP_STL := gnustl_static

把 plugin/jsbindings 文件夹中所有的头文件和源文件都拷贝到你的工程的 Classes 文件夹中.

把你刚刚拷贝的 .cpp 文件添加到 Android.mk 文件的的 LOCAL_SRC_FILES 项.比如

LOCAL_SRC_FILES := hellocpp/main.cpp \
                  ../../Classes/AppDelegate.cpp \
                  ../../Classes/HelloWorldScene.cpp \
                                    ../../Classes/NewSourceFile.cpp

修改 AppActivity.java

插件版本 >= 2.4.0.3

1. 找到 AppActivity.java 文件

find . -name "AppActivity.java"

1. 把 extends Cocos2dxActivity 替换为 extends com.sdkbox.plugin.SDKBoxActivity

以下是 AppActivity.java 不同版本的引擎所在的目录：

cpp
  - proj.android/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android-studio/app/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android/app/src/org/cocos2dx/cpp/AppActivity.java ( from cocos2d-x 3.17)

lua
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android-studio/app/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/lua/AppActivity.java (from cocos2d-x 3.17)

js
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/javascript/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/javascript/AppActivity.java ( from cocos2d-x 3.17)

插件版本 < 2.4.0.3

• 如果您使用 cocos2d-x 源代码，假设您在 proj.android 目录下，那么您可以在如下位置找到 Cocos2dxActivity.java 文件：

  ../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/ lib/Cocos2dxActivity.java

• 如果您使用 cocos2dx-x 预编译库， 假设您在 proj.android 目录下，那么您可以在如下位置找到 Cocos2dxActivity.java 文件：

  ./src/org/cocos2dx/lib/Cocos2dxActivity.java

Note: 当你使用 cocos2d-x 源代码时，不同的版本中 Cocos2dxActivity.java 文件的位置也不同。一个确定该文件位置的方法是查看 proj.android/project.properties 。比如：

android.library.reference.1=../../cocos2d-x/cocos/platform/android/java

在这个例子中， Cocos2dxActivity.java 文件应该在如下位置：

../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java

• 修改 Cocos2dxActivity.java 文件，导入如下包：

import android.content.Intent;
import com.sdkbox.plugin.SDKBox;

• 然后，修改 Cocos2dxActivity 类的 onCreate(final Bundle savedInstanceState) 函数，添加一个调用语句 SDKBox.init(this); 。添加的位置非常重要，必须在调用 onLoadNativeLibraries(); 之后。如下：

onLoadNativeLibraries();
SDKBox.init(this);

• 最后, 我需要提供合适的 overrides 方法的代码。这里有一些约定如下。

  • 如果这个被列出的方法没有在 SDKBox 中定义，那么__定义它__。

  • 如果这个被列出的方法已经被定义在 SDKBox 中，那么请调用这个在 SDKBox 中的__同名方法__。

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
          if(!SDKBox.onActivityResult(requestCode, resultCode, data)) {
            super.onActivityResult(requestCode, resultCode, data);
          }
    }
    @Override
    protected void onStart() {
          super.onStart();
          SDKBox.onStart();
    }
    @Override
    protected void onStop() {
          super.onStop();
          SDKBox.onStop();
    }
    @Override
    protected void onResume() {
          super.onResume();
          SDKBox.onResume();
    }
    @Override
    protected void onPause() {
          super.onPause();
          SDKBox.onPause();
    }
    @Override
    public void onBackPressed() {
          if(!SDKBox.onBackPressed()) {
            super.onBackPressed();
          }
    }

Proguard (release, optional)

• 修改 project.properties 加入您的 Proguard 配置文件. 比如:

proguard.config=proguard.cfg

• 修改这个您的配置文件,并在其中加下以下代码:

-keep class com.chartboost.** { *; }

注意: 混淆只在 Release 编译模式下有效 (i.e cocos run -m release) debug 编译下不会调用到混淆规则.