Offers API。デザインは自社で、オファーは私たちが。

画像、ステップ、自社の通貨で表した報酬を含むオファーを、ユーザーごとにJSONで取得し、独自のカードでコンテンツの隣に表示できます。報酬はオファーウォールと同じく、postbackで届きます。

  • JSONHTTPS経由のREST
  • 6001分あたりのリクエスト数
  • OpenAPI仕様書付き
Offers APIREST、JSON
ターミナル
curl -G "https://api.moonetix.com/v1/offers" \
  -d user_id=user_1234 -d country=US -d device=android \
  -H "Authorization: Bearer $MOONETIX_API_KEY"

3つのステップで公開

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

  1. 1人のユーザー向けのオファーを取得する

    アプリのAPIキー、ユーザーID、ユーザーがいる国、デバイスまたはユーザーエージェントを指定して、サーバーからAPIを呼び出します。リストには、ユーザーがすでに完了したオファーや、まだ再度実行できないオファーは含まれません。

    ターミナル
    curl -G "https://api.moonetix.com/v1/offers" \
      -d user_id=user_1234 -d country=US -d device=android \
      -H "Authorization: Bearer $MOONETIX_API_KEY"
  2. 独自のデザインで表示

    各オファーには、タイトル、画像、ステップ、自社の通貨で表した報酬が含まれます。好きな形で表示し、ユーザーがオファーを選んだらそのオファーのstart_urlに移動させてください。オファーページはMoonetix上で開き、そこから広告主へ案内します。

    JSON
    {
      "ok": true,
      "currency": "Coins",
      "offers": [
        {
          "id": 58,
          "title": "Nova Quest: reach level 10",
          "reward": 975,
          "payout_usd": 1.5,
          "start_url": "https://wall.moonetix.com/..."
        }
      ]
    }
  3. 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}
GET /v1/offers
{
  "title": "Nova Quest: reach level 10",
  "goals": [
    { "name": "Create an account", "reward": 325 },
    { "name": "Reach level 10", "reward": 650 }
  ],
  "reward": 975,
  "start_url": "https://wall.moonetix.com/..."
}
自社のデザイン
Nova Questレベル10に到達
  1. アカウントを作成+325
  2. レベル10に到達+650
合計975コインオファーを開始

JSONから自社のデザインへ

各オファーは、ステップと報酬が通貨換算済みの状態で届くため、そのまま表示できます。

APIで得られるもの

  • ユーザーごとのオファー

    オファーは送信した国とデバイスに合わせて選ばれ、ユーザーが完了済みのものは除外されます。

  • 自社通貨での報酬

    すべての報酬は、換算レート、ユーザーへの配分、端数処理、実施中のボーナスを反映して計算済みです。

  • ステップと画像

    マルチステップオファーでは各ステップとその報酬が一覧表示されるため、何に報酬が出るかを正確に表示できます。

  • Sub ID

    独自の値を最大5つまで送信できます。値はすべてのstart_urlに追加され、postbackで返されます。

  • 非表示にしたオファーは非表示のまま

    「オファー」ページで非表示にしたオファーはAPIからも除外されるため、オファーウォールと同じ内容になります。

  • OpenAPI仕様

    機械可読なopenapi.jsonにすべてのフィールドが記述されており、コードジェネレーターやAIコーディングエージェントでそのまま使えます。

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

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

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

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

  2. curlでAPIを呼び出す

    テスト用のユーザーIDとオファーが配信されている国でリストを取得し、start_urlを1つブラウザーで開いてください。

  3. テストpostbackを送信

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

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

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

公開前チェックリスト

10項目中0項目が完了

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

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

  • 400 invalid_country

    パラメーターが不足しているか誤っています:invalid_user_id、invalid_country、invalid_device。

    対処法エラーコードに示されたパラメーターを修正してください。

  • 401 invalid_api_key

    キーがないか、誤っているか、置き換えられています。

    対処法AuthorizationヘッダーでBearerとして送信し、「連携」タブからもう一度コピーしてください。

  • 403 app_not_live

    アプリが一時停止中か、アカウントが未承認または無効です。

    対処法通知を確認してください。user_blockedの場合、そのユーザーにはオファーを表示しないでください。

  • 429 rate_limited

    このアプリで1分間に600件を超えるリクエストがありました。

    対処法Retry-Afterの秒数だけ待ち、各ユーザーのリストを1〜5分間キャッシュしてください。

  • Empty offers list

    これは正常な応答で、現時点でそのユーザーが利用できるオファーがないことを示します。

    対処法わかりやすい空の状態を表示し、送信している国とデバイスを確認してください。

  • VPN detected on start_url

    オファーページを開いたときに、ユーザーがVPN、プロキシ、またはクラウドネットワークに接続しています。

    対処法ユーザーにオフにするよう依頼してください。サーバーからのAPIリクエストはチェックされません。

  • 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はリダイレクトをたどりません。

概要

エンドポイント
GET https://api.moonetix.com/v1/offers
認証
Bearer APIキー、アプリごとに1つ、サーバー側でのみ使用
必須パラメーター
user_id、country、およびdeviceまたはua
レート制限
アプリごとに1分あたり最大600リクエスト
フォーマット
JSON(OpenAPI定義付き)
料金
承認済みパブリッシャーは無料

その他の連携方法

Offers APIのよくある質問

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

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

オファーウォールではなくOffers APIを使うべきなのはどんなときですか?

最も早く公開するならオファーウォールのリンクを使ってください。ほかのソースのオファーと並べたり、独自のリワードストアに組み込んだりと、自社のサイトやアプリ内で独自のデザインでオファーを表示したい場合はOffers APIを使います。

ブラウザーやモバイルアプリからOffers APIを呼び出せますか?

いいえ。リクエストにAPIキーが含まれるため、必ずサーバーからのみ呼び出してください。キーが漏えいした場合は、「連携」タブで新しいキーを作成すると、古いキーはすぐに使えなくなります。

どの国を送信すればよいですか?

ユーザーが実際にいる国を、USのような2文字のコードで指定します。オファーと報酬はこれによって決まり、ユーザーがオファーを開始する際に国とデバイスが再度チェックされます。

報酬はオファーウォールと異なりますか?

いいえ。APIはオファーウォールと同じオファーを同じ報酬で返し、完了したすべてのステップは同じ署名付きpostbackでサーバーに届きます。

レート制限はありますか?

はい、アプリごとに1分あたり最大600リクエストです。リストを頻繁に表示する場合は、ユーザーごとに短時間キャッシュしてください。

同じキーをほかの用途にも使えますか?

はい。アプリのAPIキーは、Reporting APIとモバイルSDKのセッションにも使えます。

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

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

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