adPOPcornオファーウォール
adPOPcornはアプリ内にオファーウォールを表示して、ユーザーが広告に参加完了した件数に対してデベロッパー様に追加収益をご提供するサービスです。
adPOPcornに関する詳細は、以下のガイドをご確認ください。
注意事項
- adPOPcorn add-onを連携する前に、IGAW基本連携を完了してください。「IGAW基本連携:Android」
- adPOPcorn連携のために、IgawAdpopcorn~*.jarファイルをAndroidプロジェクトに追加する必要があります。「SDKインストール:Android」
- 現金型のリワードを提供する場合、以下の検証基準を必ず確認してください。(2016年1月1日より適用)
「adPOPcorn現金型リワード媒体に対する検証基準のご案内」
AndroidManifest.xml
AdPOPCornの連携のため、Android Manifestファイルを修正します。
基本連携で設定した App key、Hash Key、Permission以外に追加パーミッション、リワードサーバータイプと必須アクティビティを追加します。
パーミッション追加
<manifest></manifest> で以下のようなパーミッションを追加します。
GET_ACCOUNT / WRITE_EXTERNAL_STORAGE パーミッションは同じ広告に対するアビューズをGoogleアカウント情報で防ぐためなので、必ず追加してください。
<uses-permission android:name="android.permission.GET_ACCOUNTS"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.GET_ACCOUNTS"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
*GET_ACCOUNTパーミッションはadPOPcorn 4.0.5から適用されます。
リワードサーバータイプの設定
<application></application> 次のように、(*)リワードサーバーの連携方法を設定します。自体サーバーを利用する際には、「server」で設定します。
<meta-data android:name="igaworks_reward_server_type" android:value="server"/>
(*)リワードサーバーの連携方法
IGAWリワードサーバーで渡すリワード情報を受信する方法を設定します。デベロッパー様にてポストバックサーバーを構築していただき、ポストバックを受信することをお勧めします。
自体サーバーの場合、セキュリティの管理及びCS処理などの維持管理に便利です。
自体サーバーの構築が難しい場合は、IGAWリワードサーバーを利用して、クライアントからポストバックの受信も可能です。この場合、igaworks_reward_server_typeをclientで設定して、追加APIの連携が必要となります。
必須アクティビティの追加
<application></application> タグの中に、必須Activityを追加します。オファーウォールが正常に起動するために必ず追加してください。
<activity android:name="com.igaworks.adpopcorn.activity.ApOfferWallActivity_NT"
android:theme="@android:style/Theme.Translucent.NoTitleBar"/>
<activity android:name="com.igaworks.adpopcorn.activity.ApVideoAdActivity"
android:theme="@android:style/Theme.NoTitleBar"
android:screenOrientation="landscape"/>
<!-- adPOPCorn 4.1.0からは ApCSActivity_NT を利用しません。 -->
<activity android:name="com.igaworks.adpopcorn.activity.ApCSActivity_NT"
android:theme="@android:style/Theme.NoTitleBar" />
<activity android:name="com.igaworks.adpopcorn.activity.ApOfferWallActivity_NT"
android:theme="@android:style/Theme.Translucent.NoTitleBar"/>
<activity android:name="com.igaworks.adpopcorn.activity.ApVideoAdActivity"
android:theme="@android:style/Theme.NoTitleBar"
android:screenOrientation="landscape"/>
<!-- adPOPCorn 4.1.0からは ApCSActivity_NT を利用しません。 -->
<activity android:name="com.igaworks.adpopcorn.activity.ApCSActivity_NT"
android:theme="@android:style/Theme.NoTitleBar" />
+ もし、リワード広告プラットフォーム「adPOPcorn」をご利用しますか?
adPOPcorn広告プラットフォームでCPI(起動型)以上のキャンペーン実施をご希望の場合は、Googleインストールレシーバーを登録してください。
[IGAWorksGoogleインストールレシーバー登録ガイド]
adPOPcorn API
基本連携を完了すると、adPOPcorn APIを利用できます。以下のAPIを利用して、adPOPcornオファーウォールを表示するための連携を進めます。
ユーザー識別値の入力
ユーザー識別値は、キャンペーンを完了したユーザーを識別してリワードを付与するために利用する情報です。
注意事項
- 1名に1つの固有識別値を設定してください。また変更される数値は利用できません。
- 個人情報(メールアドレス、名前、電話番号、識別できるユーザーIDなど)を含んではいけません。
- 日本語、記号、スペースなどが含まれている場合、必ずURL Encording処理を行ってください。
- ユーザーがオファーウォールに入る前に設定してください。
上記の注意事項を確認し、ユーザー識別値を入力します。
IgawCommon.setUserId(getApplicationContext(),"user10001");
IgawCommon.setUserId(getApplicationContext(),"user10001");
オファーウォールの表示
openOfferWall APIを呼び出し、オファーウォールを表示します。オファーウォールにアクセスするためのボタンやバナー、イメージなどのクリックイベントで呼び出します。
offerwallBtn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
//オファーウォールを表示します。
IgawAdpopcorn.openOfferWall(MainActivity.this);
}
});
Load/Show Video AD APIの追加
配信中の動画広告を読み込むためには下記APIを呼び出します。
//API : public static void loadVideoAd(Context context,IAPLoadVideoAdEventListener loadVideoAdListener)
IgawAdpopcorn.loadVideoAd(context,loadVideoAdListener);
IAPLoadVideoAdEventListenerは、2つのイベントコールバックを返却します。
■ OnLoadVideoAdSuccess : 動画広告のロード成功
■ OnLoadVideoAdFailure(APVideoError apVideoError) : 動画広告のロード失敗
◆ public static final int EXCEPTION = 200
◆ public static final int ADID_ABUSING = 500
◆ public static final int CAN_NOT_FIND_AVAILABLE_CAMPAIGN = 1000
◆ public static final int INVALID_MEDIA_KEY = 1400
◆ public static final int USER_IDENTIFIER_MISSING = 2250
ロードした動画広告を表示するため、下記APIを呼び出します。
//API : public static void showVideoAd(Context context, IAPShowVideoAdEventListener showVideoAdListener)
IgawAdpopcorn.showVideoAd(context,showVideoAdListener);
IAPShowVideoAdEventListenerは3つのイベントコールバックを返却します。
■ OnShowVideoADSuccess : 動画広告の再生成功
■ OnVideoAdClose : 動画広告を閉じる
■ OnShowVideoAdFailure : 動画広告の再生の失敗
※ 動画広告の場合、広告を読み込み表示する地点に広告予算が消化されると表示されない場合がございます。
◆ public static final int TERMINATED_OR_INVALID_CAMPAIGN = 980;
◆ public static final int TERMINATED_OR_INVALID_CAMPAIGN = 999;
◆ public static final int ALREADY_COMPLETED_CAMPAIGN = 2000;
横画面のアプリの場合、デバイスの上下回転に対応するために setSensorLandscapeEnable APIを利用して設定します。
//true:回転モード, false:固定モード
IgawAdpopcorn.setSensorLandscapeEnable(MainActivity.this, true);
オプション : イベントリスナー
オファーウォール終了に関するイベントリスナーを提供します。オファーウォール終了時に、ご希望のアクションを定義して利用することができます。
IgawAdpopcorn.setEventListener(MainActivity.this, new IAdPOPcornEventListener() {
@Override
public void OnClosedOfferWallPage() {
//オファーウォールを終了する時に起動するアクションを定義することができます。
}
});
adPOPcorn オファーウォール スタイルAPI
adPOPcornオファーウォールのスタイルを変更することができます。ApStyleManager APIを呼び出してスタイルを変更します。
// オファーウォールの全体テーマのカラーコード指定
ApStyleManager.setThemeColor(ApStyleManager.BLUE_THEME);
// オファーウォールの全体フォントのカラーコード指定
ApStyleManager.setTextThemeColor(ApStyleManager.BLUE_THEME);
// オファーウォールリワードボックスのカラーコードの指定
ApStyleManager.setRewardThemeColor(ApStyleManager.BLUE_THEME);
// オファーウォールのリワード確認ボックスのカラーコードの指定
ApStyleManager.setRewardCheckThemeColor (ApStyleManager.BLUE_THEME);
// オファーウォールタイトルのカラーコードの指定
ApStyleManager.setOfferwallTitleColor(Color.parseColor(“#000000”);
// オファーウォールタイトルの指定
ApStyleManager.setOfferwallTitle(“ポイントショップ”);
// オファーウォールタイトルロゴの指定
// ** setOfferwallTitleと同時に利用できません。**
ApStyleManager.setOfferwallTitleLogo(R.drawable.logo);
ApStyleManager APIであらかじめ定義されたテーマは以下の通りになります。
直接カラーコードを入力して利用する場合にも、以下の形式通りにコードを指定してください。
public static int RED_THEME = 0xff9d261c;
public static int BLUE_THEME = 0xff3d7caf;
public static int YELLOW_THEME = 0xffffba03;
リワードサーバーの連携及び検収
アプリでオファーウォールを表示するための連携が完了しました。
これより、以下のガイドを参考の上、キャンペーンを完了したユーザーにリワードを付与するためのリワードサーバーの連携を進めてください。
リワードサーバーの連携を完了した後、テスト広告を通じて広告の参加・リワードの付与が正常に行われるか確認し、検収の申し込みを行ってください。
adPOPcornオファーウォールをご利用いただくためには、必ず検収が必要となります。
adPOPcorn管理画面の検収の申し込みでAPKファイルをご送付いただくか、担当者まで検収をお申し込みください。1~2営業日以内に検収結果をご連絡致します。
検収に関するお問い合わせ : QA@igaworks.com
その他の連携に関するお問い合わせ:bizdev-jp@igaworks.com