ユーザーレベル広告収益API

このAPIを使用して、ユーザーレベルの収益データを取得します。 このデータは、特定のユーザー向けに集計された状態、またはインプレッションごとに1行の状態で取得できます。

User-Level Ad Revenue API

ユーザーレベルの収益データは、UTCの1日の終了から8時間後に利用可能になります。 例えば、UTC 2019‒01‒01のデータは、UTC 2019‒01‒02の08:00以降に利用可能になります。

ユーザーレベルおよびインプレッションレベルの広告収益データは、Adjust、AppsFlyer、GameAnalytics、Singularなど、サポートされているすべてのネットワークにおいて、お好みのモバイル計測パートナー(MMP)と共有できます。 また、クライアント側でインプレッションレベルのユーザー収益データにアクセスすることも可能です。 詳細については、SDK統合ガイド > Platform > 概要 > 詳細設定 をご覧ください。

MAXは、MAXインプレッションを記録するたびに、Server-to-Server Impression Revenue APIを使用して、お客様が選択したトラッキングURLにデータをポストします。 詳細については、S2SインプレッションレベルAPIのドキュメントページを参照してください。

リクエスト形式

このAPIを使用するには認証が必要です。 認証を行うには、URLパラメータ api_key の値にお客様の Report Key を設定してください。

ターゲットURL

https://r.applovin.com/max/userAdRevenueReport?api_key=«report-key»&date=«report-day»&platform=«app-platform»&application=«app-package-name»&store_id=«app-store-ID»&aggregated=«is-aggregated»

リクエストパラメータ

名前説明
aggregatedAPIがデータを集計するか(ユーザーごと)、しないか(インプレッションごと)を指定します。デフォルトは true です。false
api_key認証用のReport Key。tgCe3d7SFRU0S…304ZKs6ba
applicationアプリケーションのパッケージ名(Androidの場合)またはバンドルID(iOSの場合)。(store_id を定義している場合は、このパラメータを使用できませんcom.mycompany.application
date1データを取得する日。«YYYY»-«MM»-«DD» 形式で指定します。2019-02-06
platformアプリケーションのプラットフォーム:androidfireos、または iosandroid
store_idiOSの場合はiTunes IDの数値部分、Androidの場合はアプリのパッケージ名。iTunes IDが不明な場合は、代わりにバンドルIDを使用してください。application を定義している場合は、このパラメータを使用できません1207472156

1 このAPIのリクエスト可能期間は45日間です。 日付パラメータが過去45日以内であることを確認してください。

レスポンス形式

レスポンスボディ

{
  "status": 200,
  "url": "https://applovin-externalreports.s3.amazonaws.com/%2Fmediation_reports/report_date%3D1549756800/pub_id%3D12345/mediation_app_id%3D12345/user_report.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190216T000208Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=dataio.amazon.s3.access_key%2F20190216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e45bdfbd88cbcf4e[…]927dd",
  "ad_revenue_report_url": "https://applovin-externalreports.s3.amazonaws.com/%2Fmediation_reports/report_date%3D1549756800/pub_id%3D12345/mediation_app_id%3D12345/user_report.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190216T000208Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=dataio.amazon.s3.access_key%2F20190216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e45bdfbd88cbcf4e[…]927dd",
  "fb_estimated_revenue_url": "https://applovin-externalreports.s3.amazonaws.com/%2Fmediation_reports/report_date%3D1549756800/pub_id%3D12345/mediation_app_id%3D12345/user_report.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190216T000208Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=dataio.amazon.s3.access_key%2F20190216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e45bdfbd88cbcf4e[…]927dd"
}

レスポンスパラメータ

名前説明
ad_revenue_report_url推定されるMeta Audience Network Biddingデータを含む、すべての収益が記載されたCSVファイルの場所。
fb_estimated_revenue_url推定されるMeta Audience Network Biddingデータのみが記載されたCSVファイルの場所。Meta Audience Network Biddingデータは推定収益データを使用して計算されているため、これらの数値は実際の数値と異なる場合があることにご注意ください。
statusリクエストのステータス:ユーザーレポートにアクセス可能な場合は 200
url推定されるMeta Biddingデータを除外したCSVファイルの場所。

ユーザーレベル収益データ CSV形式

Ad Unit ID,Placement,IDFA,IDFV,User Id,Impressions,Revenue
da39a3ee5e6b4b0,home_screen,04034992-E5AA-4BA1-890C-5075B2504050,4F2A07BC-315B-11E9-B210-D663BD873D93,20349,27,5.000025
da39a3ee5e6b4b0,level_end,12309422-331C-41A3-9BF5-2D7D1C04A4E0,4F2A0A6E-315B-11E9-B210-AD023491FF20,,11,0.006100

フィールド

名前説明
Ad FormatINTERBANNERREWARD(未集計のみ)。
Ad Placement広告を表示した外部広告ネットワークの配置ID(未集計のみ)。
Ad Unit ID収益を発生させたMAX広告ユニットのID。
Ad Unit Name収益を発生させたMAX広告ユニットの名前(未集計のみ)。
Countryインプレッションが発生した国の2文字の国コード(未集計のみ)。
Custom Data統合から渡されたカスタムデータ。
Dateインプレッションが発生した日時(未集計のみ)。
Device TypePHONETABLET(未集計のみ)。
IDFA広告識別子:iOSデバイスの場合はIDFA、Androidデバイスの場合はGAID。
IDFVベンダー向け識別子。
Impressionsユーザーに表示された広告の数(集計済みのみ)。
Networkインプレッションを発生させた広告ネットワーク。こちらの表の「Network API Name」列で広告ネットワークの値を確認できます。(未集計の ad_revenue_report_url のみ)
Placementユーザーがインプレッションと収益を発生させた広告の配置名。
Revenueユーザーによって発生した収益(米ドル、小数点以下6桁の精度で表示)。
User IDAppLovin SDKを介して設定された、オプションのユーザーID。(下記の「内部ユーザーIDの設定」セクションを参照してください。)
WaterfallMAX広告ユニットのウォーターフォール名(未集計のみ)。

広告配置名の設定

以下のコードスニペットは、広告ユニットに配置名を追加する方法を示しています。 配置名の値は、ポストバックリクエスト内の {PLACEMENT} マクロを置き換えます:

    ActionScript

    AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);
    

    Blueprint

    Ad Unit Identifier. Create Banner: Ad Unit Identifier. Banner Position: Bottom Center. Set Banner Placement: Ad Unit Identifier, Placement: YOUR_BANNER_PLACEMENT.

    C++

    UAppLovinMAX::CreateBanner(«ad-unit-ID», «position»);
    UAppLovinMAX::SetBannerPlacement(«ad-unit-ID», «placement»);
    

    C#

    MaxSdk.CreateBanner(«ad-unit-ID», «position»);
    MaxSdk.SetBannerPlacement(«ad-unit-ID», "«placement»");
    

    Dart

    AppLovinMAX.createBanner(«ad-unit-ID», «position»);
    AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);
    

    GDScript

    AppLovinMAX.createBanner(«ad-unit-ID», «position»);
    AppLovinMAX.set_banner_placement(«ad-unit-ID», «placement»);
    

    Java

    adViewAd.setPlacement( "«placement»" );
    

    JavaScript (Cordova)

    AppLovinMAX.createBanner(«ad-unit-ID», «position»);
    AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);
    

    JavaScript (React Native)

    AppLovinMAX.createBanner(«ad-unit-ID», «position»);
    AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);
    

    Kotlin

    adView.setPlacement( "«placement»" )
    

    Lua

    applovin.create_banner(«ad-unit-ID», «position»)
    applovin.set_banner_placement(«ad-unit-ID», «placement»)
    

    Objective-C

    adView.placement = @"«placement»";
    [adView loadAd];
    

    Swift

    adView.placement = "«placement»"
    adView.loadAd()
    

内部ユーザーIDの設定

以下のコードスニペットは、独自の内部ユーザーIDをユーザーにタグ付けする方法を示しています。 ユーザーID文字列の最大サイズは8192文字です。

AppLovinMAX.setUserId("«user-ID»");

カスタムデータ

以下のコードスニペットは、ポストバックにカスタム文字列データを追加する方法を示しています。 この文字列データは、これらのポストバック内の {CUSTOM_DATA} マクロを置き換えます。 AppLovinでは、文字列の長さを8192文字未満にすることを推奨しています。

カスタムデータは、バナー広告またはMREC広告をロードする前に設定する必要があります。 そうしないと、そのデータは広告に関連付けられたポストバックに表示されません。

    バナー&MREC

    MaxSdk.SetBannerCustomData("«ad-unit-ID»", "«custom-data»"); // Banners
    MaxSdk.SetMRecCustomData("«ad-unit-ID»", "«custom-data»"); // MRECs
    

    インタースティシャル

    MaxSdk.ShowInterstitial(«adUnitIdentifier», «placement», «custom data»);
    

    レウォード広告

    MaxSdk.ShowRewardedAd(«adUnitIdentifier», «placement», «custom data»);
    

    ネイティブ広告

    nativeAdLoader.setCustomData( "«custom data»" );
    

search