UnityオファーウォールSDK。プレイヤーがゲーム内通貨を獲得。
オファーを完了したプレイヤーにゲーム内通貨を付与でき、ゲームにバナー広告を入れる必要はありません。1つのUnityパッケージでAndroidとiOSに対応し、すべての報酬は署名付きpostbackとしてゲームサーバーに届きます。
- 2022.3+Unity LTSまたはUnity 6
- 2.0.1現在のバージョン
- 2プラットフォームに1つのパッケージで対応
using MoonetixOfferwall;
void Awake()
{
Moonetix.Init("YOUR_APP_ID");
}
public void ShowOfferwall(string token)
{
Moonetix.Open(token);
}4つのステップで公開
コードをコピーし、プレースホルダーをダッシュボードの「オファーウォール」、対象のオファーウォール、「連携」にある値に置き換え、公開前にテストしてください。
-
パッケージをインストールする
Moonetixのscoped registryとパッケージをPackages/manifest.jsonに追加するか、Project Settingsでレジストリを追加してPackage ManagerからMoonetix Offerwallをインストールします。AndroidとiOSのSDKが同梱されています。
{ "scopedRegistries": [ { "name": "Moonetix", "url": "https://moonetix.com/upm", "scopes": ["com.moonetix"] } ], "dependencies": { "com.moonetix.offerwall": "2.0.1" } } -
サーバーにトークンエンドポイントを追加する
アプリが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']);session.js// POST /api/moonetix/session: a fresh token for the signed-in user app.post('/api/moonetix/session', requireLogin, async (req, res) => { const r = await fetch('https://api.moonetix.com/v1/session', { method: 'POST', headers: { Authorization: `Bearer ${process.env.MOONETIX_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ user_id: String(req.user.id) }), signal: AbortSignal.timeout(10000), }); const data = await r.json().catch(() => ({})); if (r.status === 201 && data.token) { return res.json({ token: data.token }); } const status = r.status === 403 ? 403 : 503; res.status(status).json({ error: 'offerwall_unavailable' }); });session.py# POST /api/moonetix/session: a fresh token for the signed-in user @app.post("/api/moonetix/session") @login_required def moonetix_session(): key = os.environ["MOONETIX_API_KEY"] r = requests.post( "https://api.moonetix.com/v1/session", data={"user_id": str(current_user.id)}, headers={"Authorization": f"Bearer {key}"}, timeout=10, ) data = r.json() if r.status_code == 201 and data.get("token"): return {"token": data["token"]} status = 403 if r.status_code == 403 else 503 return {"error": "offerwall_unavailable"}, status -
オファーウォールを開く
ダッシュボードのApp IDでInitを1回呼び出し、新しいトークンでOpenを呼び出します。すべてのイベントはUnityのメインスレッドで届くため、UIを直接更新できます。パッケージにはOfferwallデモのサンプルも含まれています。
using MoonetixOfferwall; using UnityEngine; public class EarnButton : MonoBehaviour { void Awake() => Moonetix.Init("YOUR_APP_ID"); void OnEnable() { Moonetix.OnClosed += RefreshBalance; Moonetix.OnError += HandleError; } void OnDisable() { Moonetix.OnClosed -= RefreshBalance; Moonetix.OnError -= HandleError; } public void ShowOfferwall(string token) => Moonetix.Open(token); void HandleError(MoonetixError error) { Debug.LogWarning(error.CodeName + ": " + error.Message); } void RefreshBalance() { } } -
postbackで報酬を加算する
すべての報酬は、署名付きpostbackとしてサーバーに届きます。ハッシュを確認し、トランザクションIDごとに1回だけ報酬を加算し、後のpostbackで取り消された場合は差し戻してください。失敗したpostbackは最大5回まで再送されます。
ダッシュボードのPostbackタブhttps://yoursite.com/postback?user={user_id}&tx={transaction_id}&status={status}&reward={reward}&hash={hash}postback.php<?php $tx = $_GET['tx'] ?? ''; $userId = $_GET['user'] ?? ''; $reward = $_GET['reward'] ?? ''; $status = $_GET['status'] ?? ''; $secret = getenv('MOONETIX_POSTBACK_SECRET'); $expected = hash_hmac('sha256', "$tx:$userId:$reward:$status", $secret); if (!hash_equals($expected, $_GET['hash'] ?? '')) { http_response_code(403); exit; } if ($status === '1') { credit_once($userId, $tx, $reward); // once per transaction ID } elseif ($status === '2') { reverse_if_credited($userId, $tx, $reward); } http_response_code(200);postback.jsconst crypto = require('crypto'); app.get('/postback', (req, res) => { const { tx, user, reward, status, hash } = req.query; const secret = process.env.MOONETIX_POSTBACK_SECRET; const expected = crypto.createHmac('sha256', secret) .update(`${tx}:${user}:${reward}:${status}`) .digest('hex'); const valid = typeof hash === 'string' && hash.length === expected.length && crypto.timingSafeEqual(Buffer.from(hash), Buffer.from(expected)); if (!valid) return res.sendStatus(403); if (status === '1') creditOnce(user, tx, reward); // once per transaction ID if (status === '2') reverseIfCredited(user, tx, reward); res.sendStatus(200); });postback.pyimport hmac, hashlib, os from flask import request, abort @app.get("/postback") def postback(): a = request.args parts = [a.get(k, "") for k in ("tx", "user", "reward", "status")] msg = ":".join(parts) secret = os.environ["MOONETIX_POSTBACK_SECRET"].encode() expected = hmac.new(secret, msg.encode(), hashlib.sha256).hexdigest() if not hmac.compare_digest(expected, a.get("hash", "")): abort(403) if a.get("status") == "1": credit_once(a["user"], a["tx"], a["reward"]) # once per transaction ID elif a.get("status") == "2": reverse_if_credited(a["user"], a["tx"], a["reward"]) return "", 200
Travel Townレベル15に到達+1,500
WPS Officeインストールして開く+2,000
Bus Escapeレベル20に到達+450
CapCutSign up in the app+800
ユーザーに表示される画面
アプリの上に開くネイティブ画面。タイトル、色、通貨は自社のものを使え、すべての報酬はpostbackで確定します。
パッケージが代わりに処理すること
- AndroidとiOSのビルド
Androidでは、MavenリポジトリとSDK、R8ルールをGradleプロジェクトに追加します。iOSでは、XcodeでiOS SDKをリンクして組み込みます。
- オファーは適切な場所で開きます
Google PlayやApp Storeへのオファーはストアアプリで開くため、インストールが正しく計測されます。
- ゲーム内にキーを含めない
ゲームが持つのはApp IDだけです。セッションはサーバーから取得し、1回だけ使えます。
- メインスレッドでのイベント
OnOpened、OnClosed、OnErrorはUnityのメインスレッドで発生するため、そのままUIで扱えます。
- ゲーム内通貨
報酬は自社の通貨で表示・加算され、交換レートとユーザーへの配分も自社で設定できます。
- 広告IDなし
SDKは広告識別子を使用せず、アプリをまたいだプレイヤーのトラッキングも行いません。
テストしてから公開しましょう。
実際のユーザーにオファーウォールを公開する前に確認すべきことを、ダッシュボードに組み込まれたツールとともにまとめました。
テストユーザーとして開く
「連携」タブの「連携ステータス」で、ユーザーowner-testとしてオファーウォールを開きます。テストのアクセスはユーザー数に含まれません。
実機で実行してください
AndroidまたはiOS向けにビルドし、毎回新しいトークンを使ってEarnボタンからオファーウォールを開きます。
テストpostbackを送信
ユーザー、ステータス、支払額を選ぶと、サーバーの応答内容をレスポンスコードと応答時間付きで正確に確認できます。テストのトランザクションIDはtest_で始まります。
通常の回線からテストする
VPN、プロキシ、Tor、クラウドネットワークはブロックされるため、オファーが配信されている国で、自宅のWi-Fiまたはモバイルデータ通信でテストしてください。
公開前チェックリスト
11項目中0項目が完了
公開の準備ができました。進捗はこのブラウザーに保存されています。
よくあるエラーをすばやく解決。
Unity SDKの連携中に表示される可能性のあるエラーと、その原因と対処法。
InvalidAppIdinitに渡した値がApp IDではありません。ここにAPIキーを渡してしまうのが最もよくある間違いです。
対処法「連携」タブから24文字のApp IDをもう一度コピーしてください。
InvalidTokenアプリがトークン以外のものを渡したか、別のアプリのAPIキーで作成したトークンを渡しました。
対処法sst_で始まるtokenフィールドだけを渡し、同じアプリのApp IDとAPIキーを使ってください。
TokenExpiredOrUsedトークンが作成から10分以上経過しているか、すでに使用されています。たとえば以前のタップで作成したトークンを使い回した場合です。
対処法開くたびに、ユーザーがEarnをタップした時点で新しいトークンを作成してください。
NotInitializedinitの前にopenが呼び出されました。
対処法最初のシーンのAwakeでMoonetix.Initを呼び出してください。
UnsupportedゲームがUnity Editor、デスクトップ、またはWebGLで実行されています。
対処法AndroidまたはiOS向けにビルドし、ボタンを表示する前にMoonetix.IsSupportedを確認してください。
iOS build stops on the iOS versionPlayer Settingsの最小iOSバージョンが13.0未満になっています。
対処法13.0以上に設定してください。
403 from /v1/sessionapp_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 302URLがリダイレクトされています(例:httpからhttpsへ)。
対処法最終的なURLを使ってください。postbackはリダイレクトをたどりません。
一致するものがありません。ドキュメントで全リストを見るか、お問い合わせください。
概要
- Unityのバージョン
- Unity 2022.3 LTS、またはUnity 6(6000.0)以降
- プラットフォーム
- Android、およびiOS 13以降
- パッケージ
- com.moonetix.offerwall 2.0.1(moonetix.com/upmから配布)
- 言語
- C#
- サンプル
- Earnボタン付きのオファーウォールデモ(Package Manager内)
- 料金
- 承認済みパブリッシャーは無料
その他の連携方法
- ウェブサイトリンク、iframe、またはフローティングのEarnボタン。SDKは不要です。
- Offers APIオファーをJSONで取得し、独自のデザインで表示できます。
- Android SDKKotlinおよびJavaアプリ向けのネイティブオファーウォール画面。
- iOS SDKSwift、SwiftUI、Objective-C向けのネイティブオファーウォール。
- Flutter SDK1つのDartプラグインでAndroidとiOSに対応。
- React Native SDKReact NativeとExpoアプリ向け。TypeScriptの型定義付き。
- すべての連携方法並べて比較してください。
対応しているUnityのバージョンは?
Unity 2022.3 LTS、またはUnity 6(6000.0)以降。iOSでは、Player Settingsで最小iOSバージョンを13.0以上に設定してください。
AndroidとiOSのビルドで動作しますか?
はい。1つのパッケージで両方に対応します。Unityが、エクスポートしたプロジェクトやカスタムGradleテンプレートも含め、Android SDKをGradleプロジェクトに、iOS SDKをXcodeプロジェクトに自動で追加します。
Moonetix Unityパッケージのインストール方法は?
Moonetixのscoped registryとcom.moonetix.offerwallをPackages/manifest.jsonに追加するか、Package ManagerのMy Registriesからインストールします。tarballからインストールすることもできます。
オファーウォールはPay-to-winですか?
いいえ。プレイヤーは、広告主のアプリやゲームを試すことで、プレイして得られるのと同じ通貨を獲得します。課金しないプレイヤーにも、ゲームにバナー広告を入れずに進行する手段を提供できます。
プレイヤーに安全に報酬を付与するには?
報酬は、クライアントのイベントではなく、署名付きpostbackに基づいてゲームサーバーで加算してください。プレイヤーがイベントを偽装できるためです。OnClosedが発生したら、サーバーからプレイヤーの残高を読み込みます。
Unity Editorでテストできますか?
フローのテストは可能です。Editor、デスクトップ、WebGLでは、OpenはApp IDとトークンをチェックした後にUnsupportedを返し、Moonetix.IsSupportedはfalseになります。オファーウォール自体を確認するには、AndroidまたはiOS向けにビルドし、スマートフォンかiOS Simulatorでテストしてください。
トラフィックを収益に変えましょう。
無料のパブリッシャーアカウントを作成し、ウェブサイト、アプリ、ゲーム、コミュニティでユーザーが完了したすべてのオファーから収益を得ましょう。