Fyber 集成指南
For the C++ version of cocos2d-x v3.x - (all other versions)
前提条件
-
Android 系统, Fyber 最低系统要求是 4.0.3.
-
Fyber 不能 SOOMLA GROW 在一个工程中同时存在.
集成
用如下命令来集成 SDKBOX Fyber 插件,请确保您可以正常执行的 SDKBOX 安装器.
$ sdkbox import fyber
重点注意事项
如果您升级到了 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 对工程的配置修改. 所以可以有以下做法(任选其一):
- 保存导出工程中的修改, 对于 SDKBox 来说可能有这些文件(mk, gradle, gradle.properties, AppDelegate.cpp, ...), 导出后再恢复对应该文件
- 在每一次 Creator 导出工程后, 重新 import 插件.
推荐第一种, 但是第一种的麻烦点在于, 对于第一次(或很久没接触的人)可能会有露掉某个文件 第二种, 很方便, 它的麻烦点在于, 如果你对工程有自己的修改, SDKBox 的重新 import 不能帮你恢复.
额外步骤
- 获取 Fyber 开发者账号
- 在 Fyber 网站创建 APP
iOS
- 配置您的 APP: iOS Quick Start Guide
Android
java -version
>= 1.7- 配置您的 APP: Android Quick Start Guide
- 编辑
project.properties
, 设置 target 目标target=android-15
JSON 配置
SDKBOX 安装器会自动在您的工程中添加一个样例配置文件sdkbox_config.json
.
下面给出一个 Fyber 的配置样例
"Fyber":
{
"debug":true,
"appid":"12345",
"token":"34a9643edf4d3052d2bc1928b2e34d00"
}
使用
初始化 Fyber
- 在您的代码合适的地方初始化插件, 我们建议您在
AppDelegate::applicationDidFinishLaunching()
或AppController:didFinishLaunchingWithOptions()
中完成初始化.
#include "PluginFyber/PluginFyber.h"
AppDelegate::applicationDidFinishLaunching()
{
sdkbox::PluginFyber::init();
}
使用 Fyber
Offer Wall
使用显示 Offer Wall
sdkbox::PluginFyber::showOfferWall();
使用自定义的 placementId 显示 Offer Wall
sdkbox::PluginFyber::showOfferWall("coins");
Rewarded Video
- iOS 参考 rewarded-video-iOS
- Android 参考 rewarded-video-android
向服务器请求一个视频:
sdkbox::PluginFyber::requestOffers();
向服务器请求一个 placementId 的视频:
sdkbox::PluginFyber::requestOffers("coins");
显示奖励视频, 先调用 requestOffers()
, 然后 showOffers()
:
sdkbox::PluginFyber::requestOffers();
sdkbox::PluginFyber::showOffers();
Interstitials
请求一个广告
sdkbox::PluginFyber::requestInterstitial();
显示广告. 请先调用 requestInterstitial
:
sdkbox::PluginFyber::showInterstitial();
获取奖励
sdkbox::PluginFyber::requestDeltaOfCoins();
或者:
sdkbox::PluginFyber::requestDeltaOfCoins("currencyId")
接收 Fyber 事件 (可选)
- 让您的类继承
sdkbox::FyberListener
:
#include "PluginFyber/PluginFyber.h"
class MyClass : public sdkbox::FyberListener
{
private:
void onVirtualCurrencyConnectorFailed(int error,
const std::string& errorCode,
const std::string& errorMsg);
void onVirtualCurrencyConnectorSuccess(double deltaOfCoins,
const std::string& currencyId,
const std::string& currencyName,
const std::string& transactionId);
void onCanShowInterstitial(bool canShowInterstitial);
void onInterstitialDidShow();
void onInterstitialDismiss(const std::string& reason);
void onInterstitialFailed();
void onBrandEngageClientReceiveOffers(bool areOffersAvailable);
void onBrandEngageClientChangeStatus(int status, const std::string& msg);
void onOfferWallFinish(int status);
};
- 创建一个监听类来接收回调:
sdkbox::PluginFyber::setListener(this);
API Reference
Methods
static void init ( ) ;
initialize the plugin instance.
static void setListener ( FyberListener * listener ) ;
Set listener to listen for fyber events
static FyberListener * getListener ( ) ;
Get the listener
static void removeListener ( ) ;
Remove the listener, and can't listen to events anymore
static void showOfferWall ( const std::string & placementId = "" ) ;
Presents the SponsorPay Mobile OfferWall as a child view controller of your own view controller.
static void requestOffers ( const std::string & placementId = "" ) ;
Queries the server for BrandEngage offers availability.
static void showOffers ( ) ;
Starts running an available engagement.
static void requestInterstitial ( ) ;
Check if interstitial ads are available
static void showInterstitial ( ) ;
Shows an interstitial ad. Check first that one is ready to be shown with requestInterstitial.
static void requestDeltaOfCoins ( const std::string & currencyId = "" ) ;
Fetches the amount of a given currency earned since the last time this method was invoked for the current user ID / app ID combination.
Listeners
void onVirtualCurrencyConnectorFailed ( int error ,
const std::string & errorCode ,
const std::string & errorMsg );
void onVirtualCurrencyConnectorSuccess ( double deltaOfCoins ,
const std::string & currencyId ,
const std::string & currencyName ,
const std::string & transactionId );
void onCanShowInterstitial ( bool canShowInterstitial );
void onInterstitialDidShow ( );
void onInterstitialDismiss ( const std::string & reason );
void onInterstitialFailed ( );
void onBrandEngageClientReceiveOffers ( bool areOffersAvailable );
void onBrandEngageClientChangeStatus ( int status , const std::string & msg );
void onOfferWallFinish ( int status );
手动集成
如果 SDKBOX 安装器 安装插件失败了,那么需要手动集成插件.如果安装器安装插件成功了,那么不需要,也没必要,按文档再手动集成一次.
下面列出的的步骤一般很少用到.如果你按下面的步骤完成了集成,请在完成集成后,再按步骤检查一次.
iOS 平台手动集成
拖拽下列 framework 从 Fyber
插件包的 plugins/ios 目录到您的 Xcode 工程中,在添加 frameworks 的时候,请勾选 Copy items if needed
。
sdkbox.framework
PluginFyber.framework
上面的 frameworks 依赖于大量其他 frameworks。如果您没有添加它们,您也需要添加下列这些系统 frameworks:
AdSupport.framework
CoreGraphics.framework
CoreLocation.framework
CoreTelephony.framework
MediaPlayer.framework
QuartzCore.framework
StoreKit.framework
SystemConfiguration.framework
Security.framework
CFNetwork.framework
GameController.framework
在以下位置添加两个单独的链接选项: Target -> Build Settings -> Linking -> Other Linker Flags:
-ObjC
Android 手动集成
SDKBox 支持三种 Android 工程, command-line, eclipse 和 Android Studio.
- command-line 和 eclipse 类型的项目,
<project_root>
指代proj.android
. - Android Studio 类型的项目,
<project_root>
指代proj.android-studio
.
拷贝文件
从插件安装包中的 plugin/android/libs
目录拷贝下列 jar 文件到您的工程的 proj.android/libs 目录。
PluginFyber.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
拷贝 jni 库
从 plugin/android/jni/
拷贝并覆盖 <your_project_root>/jni/
目录.
- 从
plugin/android/libs
拷贝fyber_lib
目录到<project_root>/libs/
directory.
编辑 AndroidManifest.xml
在标签 application tag 上添加下列权限:
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
在接近文件底部的位置,拷贝并且粘贴下列定义到 application tags 标签结尾处。
<activity
android:name="com.fyber.ads.ofw.OfferWallActivity"
android:configChanges="screenSize|orientation" />
<activity
android:name="com.fyber.ads.videos.RewardedVideoActivity"
android:configChanges="screenSize|orientation"
android:hardwareAccelerated="true"
android:theme="@android:style/Theme.Translucent" />
<activity
android:name="com.fyber.ads.interstitials.InterstitialActivity"
android:configChanges="screenSize|orientation"
android:theme="@android:style/Theme.Translucent" />
<activity
android:configChanges="screenSize|orientation"
android:name="com.fyber.cache.CacheVideoDownloadService"
android:hardwareAccelerated="true"/>
<service android:name="com.fyber.cache.CacheVideoDownloadService" android:exported="false" />
编辑 Android.mk
编辑 <project_root>/jni/Android.mk
:
为 LOCAL_STATIC_LIBRARIES 添加额外的库:
LOCAL_WHOLE_STATIC_LIBRARIES += PluginFyber
LOCAL_WHOLE_STATIC_LIBRARIES += sdkbox
在所有 import-module 语句之前添加一条 call 语句:
$(call import-add-path,$(LOCAL_PATH))
在最后添加额外的 import-module 语句:
$(call import-module, ./sdkbox)
$(call import-module, ./pluginfyber)
这意味着您的语句顺序看起来像是这样:
$(call import-add-path,$(LOCAL_PATH))
$(call import-module, ./sdkbox)
$(call import-module, ./pluginfyber)
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
- 为 APP_PATFORM 添加版本:
APP_PLATFORM := android-14
修改 AppActivity.java
插件版本 >= 2.4.0.3
- 找到 AppActivity.java 文件
find . -name "AppActivity.java"
- 把
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();
}
}
混淆 (release, 可选)
- 编辑
project.properties
,写入一个Proguard
配置. Example:
proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt
- 编辑这个文件,填入以下内容:
# Fyber
-keep class com.fyber.** { *; }
-dontwarn com.fyber.**
-keep class com.sponsorpay.mediation.** { *;}
-keepattributes JavascriptInterface
-keep class com.sponsorpay.publisher.mbe.mediation.SPBrandEngageMediationJSInterface {
void setValue(java.lang.String);
}
-keep class android.webkit.JavascriptInterface
# cocos2d-x
-keep public class org.cocos2dx.** { *; }
-dontwarn org.cocos2dx.**
-keep public class com.chukong.** { *; }
-dontwarn com.chukong.**
# google play service
-keep class com.google.android.gms.** { *; }
-dontwarn com.google.android.gms.**
-keep class * extends java.util.ListResourceBundle {
protected Object[][] getContents();
}
-keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
public static final *** NULL;
}
-keepnames @com.google.android.gms.common.annotation.KeepName class *
-keepclassmembernames class * {
@com.google.android.gms.common.annotation.KeepName *;
}
-keepnames class * implements android.os.Parcelable {
public static final ** CREATOR;
}
#sdkbox
-keep class com.sdkbox.** { *; }
-dontwarn com.sdkbox.**
注意: 混淆只在 Release 模式下有效 (比如 cocos run -m release
), 在 debug 模式下,不会调到混淆规则.