iOSオファーウォールSDK。Swift、SwiftUI、Objective-Cに対応。
1つのSwiftパッケージで、iPhone・iPadアプリにMoonetixのオファーウォールを表示できます。使用するのはUIKitとWebKitだけで、サードパーティ依存関係はなく、プライバシーマニフェストも同梱されています。
- 13+iOSとiPadOS
- 2.0.1現在のバージョン
- 0サードパーティ依存関係
import MoonetixOfferwall
Moonetix.configure(appId: "YOUR_APP_ID")
// When the user taps Earn
Moonetix.open(token: token)4つのステップで公開
コードをコピーし、プレースホルダーをダッシュボードの「オファーウォール」、対象のオファーウォール、「連携」にある値に置き換え、公開前にテストしてください。
-
SDKをインストールする
Xcodeの「File」から「Add Package Dependencies」でパッケージを追加するか、CocoaPodsを使います。xcframeworkをダウンロードして手動で組み込むこともできます。Xcode 16以降でビルドしてください。
Package.swiftdependencies: [ .package(url: "https://moonetix.com/ios/moonetix-ios.git", from: "2.0.1"), ], targets: [ .target(name: "MyApp", dependencies: [ .product(name: "MoonetixOfferwall", package: "moonetix-ios"), ]), ]Podfilepod 'MoonetixOfferwall', :podspec => 'https://moonetix.com/ios/2.0.1/MoonetixOfferwall.podspec' -
サーバーにトークンエンドポイントを追加する
アプリが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で一度だけ設定し、新しいトークンでオファーウォールを開きます。view controllerを指定しない場合、SDKはアプリの最前面の画面から表示するため、SwiftUIからも使えます。
EarnViewController.swiftMoonetix.configure(appId: "YOUR_APP_ID") Moonetix.onClosed = { [weak self] in self?.refreshBalance() } Moonetix.onError = { error in print(error.code.name, error.message) } Moonetix.open(token: token, from: self)EarnButton.swiftButton("Earn coins") { Task { let token = try await api.fetchMoonetixToken() Moonetix.open(token: token) } }EarnViewController.m@import MoonetixOfferwall; [Moonetix configureWithAppId:@"YOUR_APP_ID"]; [Moonetix openWithToken:token from:self options:nil]; -
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で確定します。
SDKが代わりに処理すること
- オファーは適切な場所で開きます
App Storeへのオファーはストアアプリで、それ以外のサイトはブラウザーで開くため、インストールが正しく計測されます。
- アプリ内にキーを含めない
アプリが持つのはApp IDだけです。セッションはサーバーで作成され、1回だけ使えるため、誰も他のユーザーとしてオファーウォールを開くことはできません。
- 制限された専用画面
内部で読み込まれるのはオファーウォールのページだけで、アプリへのJavaScriptブリッジもありません。
- ネイティブのナビゲーション
閉じるボタンでアプリに戻り、左端からのスワイプでオファーウォール内を戻ります。バックグラウンドから復帰しても、ユーザーがいた場所から再開します。
- アクセシビリティに標準対応
ライトモードとダークモード、大きな文字サイズ、VoiceOverに標準で対応しています。
- プライバシーマニフェスト同梱
SDKにはプライバシーマニフェストが同梱されており、デバイスフィンガープリンティングも広告識別子も使用しません。
テストしてから公開しましょう。
実際のユーザーにオファーウォールを公開する前に確認すべきことを、ダッシュボードに組み込まれたツールとともにまとめました。
テストユーザーとして開く
「連携」タブの「連携ステータス」で、ユーザーowner-testとしてオファーウォールを開きます。テストのアクセスはユーザー数に含まれません。
実機で実行してください
AndroidまたはiOS向けにビルドし、毎回新しいトークンを使ってEarnボタンからオファーウォールを開きます。
テストpostbackを送信
ユーザー、ステータス、支払額を選ぶと、サーバーの応答内容をレスポンスコードと応答時間付きで正確に確認できます。テストのトランザクションIDはtest_で始まります。
通常の回線からテストする
VPN、プロキシ、Tor、クラウドネットワークはブロックされるため、オファーが配信されている国で、自宅のWi-Fiまたはモバイルデータ通信でテストしてください。
公開前チェックリスト
11項目中0項目が完了
公開の準備ができました。進捗はこのブラウザーに保存されています。
よくあるエラーをすばやく解決。
iOS SDKの連携中に表示される可能性のあるエラーと、その原因と対処法。
INVALID_APP_IDinitに渡した値がApp IDではありません。ここにAPIキーを渡してしまうのが最もよくある間違いです。
対処法「連携」タブから24文字のApp IDをもう一度コピーしてください。
INVALID_TOKENアプリがトークン以外のものを渡したか、別のアプリのAPIキーで作成したトークンを渡しました。
対処法sst_で始まるtokenフィールドだけを渡し、同じアプリのApp IDとAPIキーを使ってください。
TOKEN_EXPIRED_OR_USEDトークンが作成から10分以上経過しているか、すでに使用されています。たとえば以前のタップで作成したトークンを使い回した場合です。
対処法開くたびに、ユーザーがEarnをタップした時点で新しいトークンを作成してください。
NOT_INITIALIZEDinitの前にopenが呼び出されました。
対処法アプリの起動時にMoonetix.configureを呼び出してください。
UNKNOWNオファーウォールがすでに開いているか、表示元となるview controllerが画面上にありませんでした。
対処法一度に1つだけ開き、open(token:from:)で表示中のview controllerを渡してください。
Delegate is never calledMoonetix.delegateは弱参照のため、オブジェクトがすでに解放されています。
対処法delegateへの強参照を保持するか、クロージャーを使ってください。
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はリダイレクトをたどりません。
一致するものがありません。ドキュメントで全リストを見るか、お問い合わせください。
概要
- 最小バージョン
- iOS 13、iPhoneとiPad、Xcode 16以降でビルド
- 言語
- Swift、SwiftUI、Objective-C
- インストール
- Swift Package Manager、CocoaPods、またはxcframework
- 依存関係
- UIKitとWebKitのみ
- プライバシー
- プライバシーマニフェスト同梱、広告識別子なし
- 料金
- 承認済みパブリッシャーは無料
その他の連携方法
Moonetix SDKはどのiOSバージョンに対応していますか?
Xcode 16以降でビルドした、iPhoneとiPadのiOS 13以降。SDKはUIKitとWebKitだけを使用し、サードパーティ依存関係はありません。
SwiftUIで使えますか?
はい。view controllerを指定せずにMoonetix.open(token:)を呼び出すと、SDKはアプリの最前面の画面から表示するため、SwiftUIのボタンからも使えます。
インストール方法は?
https://moonetix.com/ios/moonetix-ios.gitからSwift Package Managerで、podspecからCocoaPodsで、またはxcframeworkを手動で組み込んでインストールします。
App Storeのプライバシー情報では何を申告すればよいですか?
ユーザーID、デバイスID、おおよその位置情報、製品の操作状況。すべてユーザーに関連付けられ、トラッキングには使用されず、目的はアプリの機能です。SDKのプライバシーマニフェストにも同じデータが記載されています。
オファーウォールはApp Storeの審査ルールに違反しますか?
Appleには、ユーザーに報酬を与えるアプリについてのルールがあります。Academyには、報酬の表現方法も含め、そのルールの範囲内でiOSアプリにオファーウォールを導入するためのガイドがあります。
ユーザーはどのように報酬を受け取りますか?
サーバーは報酬ごとに署名付きpostbackを受信し、ユーザーに加算します。アプリのイベントは端末上で偽装できるため、それに基づいて加算しないでください。
トラフィックを収益に変えましょう。
無料のパブリッシャーアカウントを作成し、ウェブサイト、アプリ、ゲーム、コミュニティでユーザーが完了したすべてのオファーから収益を得ましょう。