No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
API.md
README.md

README.md

#SDKBOX: AdColony Installation with Cocos2d-x v2.x and C++#

##概要## このドキュメントではCocos2d-x SDKBOXのAdColonyの導入方法について説明します。正式版のドキュメント(英語)はこちらからご参照ください。

参照http://cocos2d-x.org/sdkbox/adcolony

##Contents##

##Step 0: Prerequisites##

  • Glossomにてapp ID、zone IDを発行しお渡し致します。

##Step 1: Integration

ターミナルを開いて以下のコマンドを実行し、SDKBOXのAdColonyプラグインをインストールしてください。SDKBOXのインストーラーが正しくセットアップされていることを確認してください。

$ cd ~/MyGame
$ sdkbox import adcolony

###iOS 9サポート### Xcode 7をご利用の場合、下記の手順を実装する必要があります。

####App Transport Securityを無効に#### 下記をplistに設定してください。

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

####Bitcodeを無効に#### Bitcodeサポートを無効にしてください。有効の場合cocos2d-xのビルドがエラーになります。

####Requires full screenを有効に#### アプリは全方向対応でない場合は、Targets -> General -> Deployment Info -> Requires full screen にチェックしてください。チェックをしない場合、ストア申請時にエラーになります。

####canOpenURLを許可するURLリストの設定#### こちらは、利用しているプラグインによりますが、AdColonyを利用してる場合、こちらを参照してください。

##Step 2: Configuration

SDKBOXが自動的に./Resource/sdkbox_config.jsonを作成してくれるので、アプリで使用をする前にその設定を修正しなければいけません。

以下がAdColonyの設定のサンプルです。<app id><zone id>をGlossomにて発行がされたものに置き換えてください。

{
    "android": {
        "AdColony": {
            "debug": true, 
            "id": "<app id>", 
            "ads": {
                "v4vc": {
                    "v4vc": true, 
                    "pre_popup": true, 
                    "zone": "<zone id>", 
                    "post_popup": true
                }, 
                "video": {
                    "v4vc": false, 
                    "zone": "<zone id>"
                }
            }
        }
    }, 
    "ios": {
        "AdColony": {
            "debug": true, 
            "id": "<app id>", 
            "ads": {
                "v4vc": {
                    "v4vc": true, 
                    "pre_popup": true, 
                    "zone": "<zone id>", 
                    "post_popup": true
                }, 
                "video": {
                    "v4vc": false, 
                    "zone": "<zone id>"
                }
            }
        }
    }
}

##Step 3: Usage

###3.1 Initialize AdColony

適当な場所でプラグインを初期化してください。AppDelegate::applicationDidFinishLaunching()もしくはAppController:didFinishLaunchingWithOptions()を推奨しています。適切なヘッダーファイルをインクルードするのを忘れないようにしてください。

#include "PluginAdColony/PluginAdColony.h"
AppDelegate::applicationDidFinishLaunching()
{
     sdkbox::PluginAdColony::init();
}

###3.2 Showing Ads

広告の種類を指定し、任意の場所で広告を表示してください。

sdkbox::PluginAdColony::show("video");

もしくは

sdkbox::PluginAdColony::show("v4vc");

###3.3 Catch AdColony events (optional)

プラグインはAdColonyのイベントをキャッチすることができるので、動画を見たユーザに対して報酬を付与するといったような処理を実行することができます。

  • 下記のように、sdkbox::AdColonyListenerを継承して実装してください。
#include "PluginAdColony/PluginAdColony.h"
class MyClass : public sdkbox::AdColonyListener
{
private:
  void onAdColonyChange(const sdkbox::AdColonyAdInfo& info, bool available);
  void onAdColonyReward(const sdkbox::AdColonyAdInfo& info,
        const std::string& currencyName, int amount, bool success);
  void onAdColonyStarted(const sdkbox::AdColonyAdInfo& info);
  void onAdColonyFinished(const sdkbox::AdColonyAdInfo& info);
};
  • コールバックを処理するリスナーを作成してください。
sdkbox::PluginAdColony::setListener(this);

##Manual Integration

もしSDKBOXのインストーラーが正常に処理を完了しない場合、SDKBOXをマニュアルで統合することが可能です。インストーラーが正常に処理を完了した場合は、これ以降のドキュメントの内容は必要ありません。

この手順は殆ど必要とされないのでドキュメントの最後に記載をしています。以下の手順を行った場合、完了されたあとに、その他の統合項目について、再度上記のドキュメントの確認をお願いいたします。

###Manual Integration For iOS

  • plugins/iosフォルダーから下記のフレームワークをXcodeプロジェクトにドラッグ&ドロップしてください。追加するときに、Copy items if neededをチェックしてください。

    • sdkbox.framework

    • PluginAdColony.framework

    • AdColony.framework

      import frame-works image

  • 上記のフレームワークは下記のシステムフレームワークに依存していますので、プロジェクトに追加されなかったら追加をしてください。

    • libz.1.2.5.dylib

    • AdSupport.framework (Set to Optional)

    • AudioToolbox.framework

    • AVFoundation.framework

    • CoreGraphics.framework

    • installation_guide-html.html

    • CoreMedia.framework

    • CoreTelephony.framework

    • EventKit.framework

    • EventKitUI.framework

    • MediaPlayer.framework

    • MessageUI.framework

    • QuartzCore.framework

    • Security.framework

    • Social.framework (Set to Optional)

    • StoreKit.framework (Set to Optional)

    • SystemConfiguration.framework

    • WebKit.framework (Set to Optional)

      import frame-works image

  • Target > Build Settings > Linking > Other Linker Flagsを開いて、下記の二つのフラグを設定してください。

      -force_load AdColony.framework/AdColony
      -fobjc-arc (AdColonyではARCを設定していないプロジェクトでも利用することができます。)
    

###Manual Integration For Android.

2.1 Copy Files

  • plugin/android/libsフォルダーから下記のjarファイルをプロジェクトのproj.android/libs下にコピーしてください。

    • adcolony.jar
    • PluginAdColony.jar
    • sdkbox.jar
  • plugin/android/jniからpluginadcolony and sdkboxフォルダーをプロジェクトの**proj.android/jni/**にコピーしてください。

2.2 Edit AndroidManifest.xml

  • AndroidManifest.xmlファイルに下記のパーミッションを追加してください。

      <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.VIBRATE" /\>
    
  • applicationタグに下記のようにハードウェアアクセラレーションを有効にしてください。

      <android:hardwareAccelerated="true" /\>
    
  • 下記のように、Acitivityの設定をapplicationタグの間にコピーしてください。

      <activity android:name="com.jirbo.adcolony.AdColonyOverlay"
      	android:configChanges="keyboardHidden|orientation"
      	android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" /\>
      <activity android:name="com.jirbo.adcolony.AdColonyFullscreen"
      	android:configChanges="keyboardHidden|orientation"
      	android:theme="@android:style/Theme.Black.NoTitleBar.Fullscreen" /\>
      <activity android:name="com.jirbo.adcolony.AdColonyBrowser"
      	android:configChanges="keyboardHidden|orientation"
      	android:theme="@android:style/Theme.Black.NoTitleBar.Fullscreen" /\>
    

注意: アプリがAPI レベル13以下に対応している場合、上記configChanges設定からscreenSizeを消してください。

2.3 Edit Android.mk

下記の通りに、proj.android/jni/Android.mk ファイルを設定してください。

  • LOCAL_STATIC_LIBRARIES の設定:

      LOCAL_STATIC_LIBRARIES += PluginAdColony
      LOCAL_STATIC_LIBRARIES += sdkbox
    
  • 下記を一番最初のimport-moduleコードの前に追加してください。

      $(call import-add-path,$(LOCAL_PATH))
    
  • 一番後ろに下記の*import-module**コードを追加してください。

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

注意: 既存に$(call import-module,./prebuilt-mk)がある場合、上記をその前に追加してください。

2.4 Application.mkの設定

proj.android/jni/Application.mk を開いて、APP_PATFORMを下記のように設定してください。

APP_PLATFORM := android-9

2.5 Cocos2dxActivity.javaの設定

注意: Cocos2d-xのインストール方法によってCocos2dxActivity.javaは二つの場所にある可能性があります。プリービルドされたライブラリーを利用してる場合proj.android/src/org/cocos2dx/lib/Cocos2dxActivity.javaにあります。 ソースコードからインストールした場合、cocos2d/cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.javaにあります。

  • まず、Cocos2dxActivity.javaに必要なパケージをインポート:

      import android.content.Intent;
    
      import org.cocos2dx.plugin.PluginWrapper;
    
  • 次に、Cocos2dxActivityonCreate(final Bundle savedInstanceState)に下記のようにプライグインの初期化コードを記述してください。 PluginWrapper.init(this); は必ず onLoadNativeLibraries();の後に記述する必要があります。

    onLoadNativeLibraries(); PluginWrapper.init(this);

  • 最後に、下記のようにオバーライド関数を実装してください。

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

Step 2.6: Proguardの設定 (リリース版, 任意)

  • 下記のように、project.properties にProguardの設定ファイルを指定してください。

      proguard.config=proguard.cfg
    

*指定されたファイルに下記を追加してください。

    -dontwarn android.webkit.**

注意: Proguardはリリース版のビルドにしか利用することが出来ません。

##よくある質問 ###基本情報に関して

  • Q:各設定情報はどんな意味ですか
  • A:
    • App ID: こちらは各アプリを指します。
    • Zone ID: こちらはアプリの下に紐づく、各掲載枠を指します。
    • Call Back URL: 動画再生の成果等を送るURLになります。設定していただかなくても本サービスはご利用頂けます。
    • Custom ID: CustomIDは、mediaのユーザーidを設定していただきます。設定した値はcall backを使用する場合、custom_idとして返します。
    • UDID: 端末に紐づく固有のIDです。 UDIDはAppleで取得を禁じられているため、AdColonyでは取得しておりません。

###SDK仕様に関して

  • Q: 縦画面の再生は可能か?

  • A: AdColonyでは、スキップなし横画面フルサイズの再生となります。

  • Q: AdColonyダイアログででポップアップの国別で表記を可能か?

  • A: アプリの配信国に沿った各々の表記を行う場合、アプリ内でダイアログのご実装をご自身でして頂く必要がございます。

  • Q: 上限回数は何回ですか?

  • A: 上限回数は変更可能です。変更希望の場合、担当者もしくは(video-ad@glossom.co.jp)までご連絡下さい。

  • Q: インセンティブはコイン以外でも可能か?

  • A: 可能です。御社側で、動画視聴の成果通知に合わせてご実装して頂く必要がございます。

  • Q: custom_idの設定する方法おしえてください。

  • A: CustomIDの設定は下記の関数を利用して設定してください。

       static void setCustomID ( const std::string & customID ) ;
       http://sdkbox-doc.github.io/en/plugins/adcolony/v2-cpp/#api-reference
    
  • Q: V4VCのサーバー側のレスポンスと再送信

  • A: 下記でございます。

      - "vc_success"
      正常に処理が終わり、ユーザーへのコイン付与が成功した場合、AdColony側から再送信を行いません。
    
      - "vc_decline" または "vc_noreward"
      正常に処理が終わったが、uidの誤り/不正と判断された場合、AdColony側から再送信を行いません。
    
      - [上記以外に、他にレスポンスされる場合]
      AdColonyは定期的に再送信行います。異常な場合以外は、こちら利用は控えて下さい。
    

###動画再生に関して

  • Q: 動画再生ができない場合どうすればいいですか

  • A: 下記をチェックしてください。

    • 正しいIDは使われているか?
      • 発行されたApp ID/Zone IDの対象OSをお誤りのないよう、ご利用下さい。
    • IDと実装マニュアルの形式は同様か?
      • 動画リワードの場合[Showing V4VC Videos]
      • interstisialの場合[Showing Interstitial Videos]をご利用下さい。
    • 広告がダウンロードされていない
      • 再生を行うにあたって、動画をダウンロードする時間が必要です。
      • 広告準備が確認された後、再生を行って下さい。
      • 広告の再生可否をの検出方法を参考してください。
  • Q: 広告の再生可否を検出するためには?

  • A: 下記のリスナーを実装して頂くと、動画再生可能な状態になると通知を受けることが可能になります。再生準備が終わるまで、再生ボタンを非表示する処理を追加で行って頂くことを推奨致します。

          void onAdColonyChange ( const AdColonyAdInfo & info , bool available );
          http://sdkbox-doc.github.io/en/plugins/adcolony/v2-cpp/#api-reference
    
  • Q: 配信可能な広告がない(少ない)ですが、どうすればいいですか

  • A: 広告在庫は様々なロジックで配信制限を行っております。詳細は下記を参考にして下さい。

    • ユーザーが不正と判断された場合
    • 1ユーザあたりの配信上限回数への到達
    • eCPMが極端に低い
    • ユーザー数が極端に少ない、リリース前もしくはリリース直後
    • androidの場合、GoogleのAdvertising IDを取得するため、プロジェクトの中にGoogle Play Services 4.0+ を追加してください。

###ストア申請に関して

  • Q: App内で広告を消した方が良いか(iOS)?
  • A: 審査する場合も、広告を出してください。IDFAについては下記をチェックを必ず行って下さい。
    • Does this app use the Advertising Identifier (IDFA)?
      • Yes
    • Serve advertisements within the app
      • チェック
  • Q: テスト切り替えの際の連絡はいつしたら良いか?
  • A: ストア通過後(iOS)に、またはリリース前(Android)に担当者へ配信切り替えのご連絡をして下さい。