AndroidオファーウォールSDK。数行のKotlinでネイティブに。

Androidアプリで、Moonetixのオファーウォールをネイティブ画面として開けます。Gradleの依存関係を1つインストールし、サーバーでセッションを作成してopenを呼び出すだけです。Kotlin、Java、Jetpack Composeから使えます。

  • 5.0+Android、API 21
  • 2.0.1現在のバージョン
  • 0追加の権限
Android SDKバージョン2.0.1
EarnActivity.kt
// Once, in your Application class
Moonetix.init(applicationContext, "YOUR_APP_ID")
 
// When the user taps Earn
Moonetix.open(activity, token)

4つのステップで公開

コードをコピーし、プレースホルダーをダッシュボードの「オファーウォール」、対象のオファーウォール、「連携」にある値に置き換え、公開前にテストしてください。

  1. SDKをインストールする

    MoonetixのMavenリポジトリと依存関係を1つ追加します。SDKはインターネット権限と自身の画面をマニフェストに自動で追加し、R8とProGuardのルールも同梱しています。

    settings.gradle.kts
    dependencyResolutionManagement {
        repositories {
            google()
            mavenCentral()
            maven { url = uri("https://moonetix.com/maven") }
        }
    }
     
    // app/build.gradle.kts
    dependencies {
        implementation("com.moonetix:offerwall:2.0.1")
    }
  2. サーバーにトークンエンドポイントを追加する

    アプリがAPIキーを持つことはありません。ユーザーがEarnをタップすると、アプリはサーバーにセッションを要求し、サーバーはログイン中のユーザー用の使い捨てトークンをMoonetixに要求します。トークンは1回だけ、10分間有効です。

    session.php
    <?php
    // POST /api/moonetix/session: a fresh token for the signed-in user
    $user = current_user();
    if (!$user) {
        http_response_code(401);
        exit;
    }
     
    $key = getenv('MOONETIX_API_KEY');
    $ch  = curl_init('https://api.moonetix.com/v1/session');
    curl_setopt_array($ch, [
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => http_build_query(['user_id' => (string)$user->id]),
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_TIMEOUT        => 10,
        CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . $key],
    ]);
    $data = json_decode((string)curl_exec($ch), true);
    $code = (int)curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
     
    header('Content-Type: application/json');
    if ($code === 201 && !empty($data['token'])) {
        echo json_encode(['token' => $data['token']]);
        exit;
    }
    http_response_code($code === 403 ? 403 : 503);
    echo json_encode(['error' => 'offerwall_unavailable']);
  3. オファーウォールを開く

    ダッシュボードのApp IDでinitを1回呼び出し、サーバーから取得したトークンでオファーウォールを開きます。エラーが例外として投げられることはなく、すべてイベントとして届きます。onClosedは、ユーザーの残高を更新するのに適したタイミングです。

    EarnActivity.kt
    Moonetix.init(applicationContext, "YOUR_APP_ID")
     
    Moonetix.setListener(object : MoonetixListener {
        override fun onClosed() {
            refreshBalance()
        }
        override fun onError(error: MoonetixError) {
            Log.w("Earn", "${error.code}: ${error.message}")
        }
    })
     
    lifecycleScope.launch {
        val token = fetchMoonetixToken(authToken)
        Moonetix.open(this@EarnActivity, token)
    }
  4. postbackで報酬を加算する

    すべての報酬は、署名付きpostbackとしてサーバーに届きます。ハッシュを確認し、トランザクションIDごとに1回だけ報酬を加算し、後のpostbackで取り消された場合は差し戻してください。失敗したpostbackは最大5回まで再送されます。

    Postbackのマクロと再送

    ダッシュボードのPostbackタブ
    https://yoursite.com/postback?user={user_id}&tx={transaction_id}&status={status}&reward={reward}&hash={hash}
9:41
コインを獲得12,450コイン
EarnMy offers
  • Travel Townレベル15に到達+1,500
  • WPS Officeインストールして開く+2,000
  • Bus Escapeレベル20に到達+450
  • CapCutSign up in the app+800
報酬を加算しましたTravel Town · +1,500コイン
ネイティブ画面
Postback 200 OK

ユーザーに表示される画面

アプリの上に開くネイティブ画面。タイトル、色、通貨は自社のものを使え、すべての報酬はpostbackで確定します。

SDKが代わりに処理すること

  • オファーは適切な場所で開きます

    Google Playへのオファーはストアアプリで、それ以外のサイトはブラウザーで開くため、インストールが正しく計測されます。

  • アプリ内にキーを含めない

    アプリが持つのはApp IDだけです。セッションはサーバーで作成され、1回だけ使えるため、誰も他のユーザーとしてオファーウォールを開くことはできません。

  • 制限された専用画面

    内部で読み込まれるのはオファーウォールのページだけで、アプリへのJavaScriptブリッジもありません。

  • ネイティブのナビゲーション

    戻るボタンでオファーウォール内を戻り、画面の回転やメモリ不足による再起動の後も、ユーザーは元の場所から再開できます。

  • 自社のデザインを追加コードなしで

    画面にはダッシュボードの「デザイン」タブで設定したタイトルと色が使われ、変更は数分以内に反映されます。

  • 広告IDなし

    SDKは広告識別子を使用せず、アプリをまたいだユーザーのトラッキングも行いません。

テストしてから公開しましょう。

実際のユーザーにオファーウォールを公開する前に確認すべきことを、ダッシュボードに組み込まれたツールとともにまとめました。

  1. テストユーザーとして開く

    「連携」タブの「連携ステータス」で、ユーザーowner-testとしてオファーウォールを開きます。テストのアクセスはユーザー数に含まれません。

  2. 実機で実行してください

    AndroidまたはiOS向けにビルドし、毎回新しいトークンを使ってEarnボタンからオファーウォールを開きます。

  3. テストpostbackを送信

    ユーザー、ステータス、支払額を選ぶと、サーバーの応答内容をレスポンスコードと応答時間付きで正確に確認できます。テストのトランザクションIDはtest_で始まります。

  4. 通常の回線からテストする

    VPN、プロキシ、Tor、クラウドネットワークはブロックされるため、オファーが配信されている国で、自宅のWi-Fiまたはモバイルデータ通信でテストしてください。

公開前チェックリスト

11項目中0項目が完了

よくあるエラーをすばやく解決。

Android SDKの連携中に表示される可能性のあるエラーと、その原因と対処法。

  • INVALID_APP_ID

    initに渡した値がApp IDではありません。ここにAPIキーを渡してしまうのが最もよくある間違いです。

    対処法「連携」タブから24文字のApp IDをもう一度コピーしてください。

  • INVALID_TOKEN

    アプリがトークン以外のものを渡したか、別のアプリのAPIキーで作成したトークンを渡しました。

    対処法sst_で始まるtokenフィールドだけを渡し、同じアプリのApp IDとAPIキーを使ってください。

  • TOKEN_EXPIRED_OR_USED

    トークンが作成から10分以上経過しているか、すでに使用されています。たとえば以前のタップで作成したトークンを使い回した場合です。

    対処法開くたびに、ユーザーがEarnをタップした時点で新しいトークンを作成してください。

  • NOT_INITIALIZED

    initの前にopenが呼び出されました。

    対処法Application.onCreateでMoonetix.initを呼び出してください。

  • UNKNOWN

    Android System WebViewがないか無効になっている、または渡したActivityがすでに終了処理中です。

    対処法ユーザーにAndroid System WebViewを更新してもらい、画面に表示中のActivityを渡してください。

  • onClosed never arrives

    リスナーがonStopでクリアされたか、すでに閉じた画面のものでした。

    対処法onCreateで設定してonDestroyでクリアするか、Applicationで一度だけ設定してください。

  • 403 from /v1/session

    app_not_liveは、アプリが一時停止中か、アカウントが有効でないことを意味します。user_blockedは、このユーザーをブロックしたことを意味します。

    対処法オファーウォールを表示しないでください。app_not_liveの場合は通知を確認してください。

  • VPN or Proxy detected

    端末がVPN、プロキシ、またはクラウドネットワークに接続されており、オファーを計測できません。

    対処法オファーが配信されている国で、通常の自宅回線またはモバイル回線からテストしてください。

  • Postback log shows 403 or 404

    スクリプトがpostbackを拒否したか、URLが誤っています。

    対処法ログのURLをブラウザーで開き、ハッシュの生成コードを確認してください。

  • Postback log shows a timeout

    スクリプトの応答に6秒以上かかっています。

    対処法まず200で応答し、時間のかかる処理はバックグラウンドで実行してください。

  • Postback log shows 301 or 302

    URLがリダイレクトされています(例:httpからhttpsへ)。

    対処法最終的なURLを使ってください。postbackはリダイレクトをたどりません。

Androidのよくある質問

Android SDKを導入する前に、開発者からよく寄せられる質問。

お困りですか?お問い合わせ

Moonetix SDKはどのAndroidバージョンに対応していますか?

Android 5.0(API 21)以降で、端末にAndroid System WebViewまたはChromeが必要です。依存関係はKotlin標準ライブラリだけなので、KotlinとJavaのどちらのアプリでも動作します。

ProGuardやR8のルールを追加する必要がありますか?

いいえ。SDKにはR8とProGuardのルールが同梱されており、インターネット権限とオファーウォール画面もマニフェストに自動で追加されます。

APIキーをアプリに入れる必要がありますか?

いいえ。アプリが持つのはApp IDだけです。サーバーがAPIキーでセッションを作成し、トークンをアプリに渡します。トークンは1回限り、10分間のみ有効なため、アプリ内の何を使っても他のユーザーのオファーウォールを開くことはできません。

SDKは広告IDを使用しますか?

いいえ。広告IDは使用せず、インターネットアクセス以外の権限は求めず、アプリをまたいだユーザーのトラッキングも行いません。Google Playのデータセーフティフォームで申告すべき内容はドキュメントに記載しています。

アプリでユーザーに報酬を付与するには?

報酬は、アプリ内のイベントではなく、サーバーで受け取る署名付きpostbackに基づいて加算してください。イベントは端末上で偽装できるためです。ユーザーがオファーウォールを閉じたら、サーバーから新しい残高を読み込みます。

オファーウォール画面をアプリのデザインに合わせられますか?

はい。ダッシュボードの「デザイン」タブで設定したタイトルと色が使われます。MoonetixOptionsで独自のタイトルやツールバーの色を渡したり、マークを非表示にしたりすることもできます。

トラフィックを収益に変えましょう。

無料のパブリッシャーアカウントを作成し、ウェブサイト、アプリ、ゲーム、コミュニティでユーザーが完了したすべてのオファーから収益を得ましょう。

世界中をターゲティング
その他
ログイン