このReporting APIを使用すると、集計されたキャンペーンデータをJSONまたはCSV形式で取得できます。
レポートのリクエストは、次のベースURLに対してHTTP GETリクエストを送信して行います:https://r.applovin.com/report
| パラメータ | 用途 |
|---|---|
api_key | お客様のReport Key Report Keyは、AppLovin dashboardの右上にあるアカウントをクリックし、Keysを選択することで確認できます。 |
start1 | レポートの開始日«YYYY-MM-DD»形式の日付、またはUnixタイムスタンプを受け付けます。例:2012-10-05、1336608000。 |
end1 | レポートの終了日«YYYY-MM-DD»形式の日付、Unixタイムスタンプ、またはnowを受け付けます。例:2012-10-05、1336608000、now。 |
format | レポートのフォーマットjsonまたはcsvを受け付けます。リクエスト形式の詳細については以下を参照してください。 |
columns | レポートに含めるカラムのカンマ区切りリスト 指定可能なカラムは以下を参照してください。例: day,campaign。 |
report_type | APIがpublisher(パブリッシャー)またはadvertiser(広告主)のどちらのデータを返すかを指定しますこのパラメータを省略した場合、APIはデフォルトで report_type=publisherになります。 |
1このAPIのリクエスト可能期間は45日間です。日付パラメータが過去45日以内であることを確認してください。
| パラメータ | 用途 |
|---|---|
day_column | 指標はデフォルトでリアルタイムです。コホート配下の指標を取得したい場合は、これをdayに設定してください。 |
limit | 返す行数の上限。例:500(結果をページネーションするにはlimitとoffsetを使用します) |
offset | 行の取得を開始するオフセット位置。例:100(結果をページネーションするにはlimitとoffsetを使用します) |
having | 数値に基づいて結果をフィルタリングできます このパラメータは、数値カラム、比較演算子、論理演算子のURLエンコードされた値を受け付けます。例: impressions%20%3E%200%20AND%20revenue%20%3E%200(「impressions > 0 AND revenue > 0」)。注意: これを使用するとレスポンスが遅くなり、タイムアウトの可能性が高くなります。 |
not_zero | すべての数値指標の値が0である結果を除外するには、これを1に設定します。 |
| カラム名 | 含まれる内容 |
|---|---|
ad_type | APPOPEN、GRAPHIC、MRAID、PLAY、REWARD、またはVIDEO |
application | アプリ名 |
application_is_hidden | アプリがダッシュボードで非表示になっているかどうか |
bidding_integration | AppLovinがビッドを行うメディエーションプロバイダー(MAXメディエーションの場合はMAX、AdMobメディエーションのOpen BiddingまたはGoogleアド マネージャー/GAMの場合はGoogle、ビッディング以外のゾーン連携の場合はNone) |
clicks | クリック数 |
country | 2文字の国コード |
ctr | クリック数 ÷ インプレッション数 |
day | レポートデータの対象日 |
device_type | phone、tablet、またはother |
ecpm | インプレッション1,000回あたりの獲得収益 |
hour | レポートデータの対象時間(過去30日間のみ利用可能) |
impressions | インプレッション数 |
package_name | アプリのパッケージ名またはバンドルID |
placement_type | APP_OPEN、BANNER、INTER、LEADER、MREC、NATIVE、またはREWARDED_INTER |
platform | android、fireos、ios |
revenue | 獲得収益 |
size | 広告サイズ(BANNER、INTER、LEADER、MREC、またはNATIVE) |
store_id | iOSではiTunes IDの数値部分、Androidではpackage_name。iTunes IDがAppLovinに認識されていない場合は、代わりにバンドルIDが使用されます。 |
zone | ゾーン名(アカウントで利用可能な場合) |
zone_id | ゾーンID(アカウントで利用可能な場合) ゾーンの使用を希望される場合は、担当のアカウントマネージャーにお問い合わせください。 |
| カラム名 | 含まれる内容 |
|---|---|
ad | 広告名 |
ad_creative_type | GRAPHIC、PLAYABLE、VIDEO、VIDEO_GRAPHIC、またはVIDEO_PLAYABLE |
ad_rev_«x» | 特定の期間における広告収益(«x»は0d、1d、2d、3d、7d、14d、28d、30d、90d、または1yのいずれか) |
ad_roas_«x» | 特定の期間における広告費用対効果(ROAS)(«x»は0d、1d、2d、3d、7d、14d、28d、30d、90d、または1yのいずれか) |
ad_type | APPOPEN、GRAPHIC、PLAY、REWARD、またはVIDEO |
app_id_external | ハッシュ化されたアプリケーションID(一般に「サイトID」と呼ばれます) |
application | 配信元アプリケーション名 |
average_cpa | コンバージョンあたりの平均単価 |
average_cpc | クリックあたりの平均単価 |
bidding_and_billing_method | 入札戦略。AUTO_BIDDING_WITH_CPM_BILLING、CAPPED_GOAL_BIDDING_WITH_CPM_BILLING、FIXED_GOAL_BIDDING_WITH_CPI_BILLING、またはFIXED_GOAL_BIDDING_WITH_CPM_BILLINGのいずれか |
campaign | キャンペーン名 |
campaign_ad_type | ユーザー獲得の場合はua、リターゲティングの場合はrt |
campaign_bid_goal | CPPおよびCPEキャンペーンにおける、ドル値($)で表されるキャンペーン入札目標。このカラムをリクエストする場合は、campaignカラムも同時にリクエストする必要があります。 |
campaign_id_external | キャンペーンの一意の参照ID。キャンペーン名が変更されてもこの値は変わりません。{CAMPAIGN_ID}クリックマクロと同じ値です。 |
campaign_package_name | プロモーション対象アプリのパッケージ名またはバンドルID |
campaign_roas_goal | IAP ROAS、Ad ROAS、およびROASキャンペーンにおける、パーセンテージ値(%)で表される広告費用対効果(ROAS)目標。このカラムをリクエストする場合は、campaignカラムも同時にリクエストする必要があります。 |
campaign_store_id | iOSではプロモーション対象アプリのiTunes IDの数値部分、それ以外の場合はcampaign_package_name |
campaign_type | キャンペーンの最適化タイプ(CPP、CPE、ad ROAS、IAP ROAS、またはROAS) |
clicks | クリック数 |
conversions | コンバージョン数(インストール数) |
conversion_rate | コンバージョン数 ÷ インプレッション数 |
cost | 広告主の消費額 |
cost_per_target_event_«x» | 特定の期間におけるターゲットイベントのイベントあたり単価(«x»は0d、1d、2d、3d、7d、14d、30d、90d、または1yのいずれか) |
country | 2文字の国コード |
cpp_«x» | 特定の期間における購入あたり単価(«x»は0d、1d、2d、3d、7d、14d、30d、90d、または1yのいずれか) |
creative_set | クリエイティブセット名 |
creative_set_id | クリエイティブセットID。クリエイティブセット名が変更されてもこの値は変わりません。 |
ctr | クリック数 ÷ インプレッション数 |
custom_page_id | クリエイティブセットに関連付けられたiOSカスタムプロダクトページまたはAndroidストアの掲載情報 |
day | レポートデータの対象日 |
device_type | phone、tablet、またはother |
external_placement_id | 暗号化されたアプリケーションID |
optimization_day_target | キャンペーンでターゲットとして選択した最適化対象日(例:0日目または7日目) |
placement_type | APP_OPEN、BANNER、CTV、INTER、LEADER、MREC、NATIVE、またはREWARDED_INTER |
platform | android、fireos、ios、またはtvos |
ret_«x» | 特定の期間における継続率(«x»は1d、3d、7d、14d、または28dのいずれか) |
roas_«x» | 特定の期間における合計ROAS(«x»は0d、1d、2d、3d、7d、14d、28d、30d、90d、または1yのいずれか) |
sales | アトリビューションされた売上イベントの数(売上ポストバックが必要です) |
sales_«x» | 特定の期間における売上(«x»は0d、1d、2d、3d、7d、14d、30d、90d、または1yのいずれか) |
size | 広告サイズ(BANNER、INTER、LEADER、MREC、NATIVE、またはPRELOAD) |
target_event | キャンペーンがターゲットとするカスタムイベント(CPEキャンペーンにのみ適用されます) |
target_event_count | ユニークターゲットイベント数 |
target_event_count_«x» | 特定の期間におけるユニークターゲットイベント数(«x»は0d、1d、2d、3d、7d、14d、30d、90d、または1yのいずれか) |
total_rev_«x» | 特定の期間における合計収益(«x»は0d、1d、2d、3d、7d、14d、28d、30d、90d、または1yのいずれか) |
traffic_source | AppLovin、またはエクスチェンジの名前 |
unique_purchasers_«x» | 特定の期間におけるユニーク購入者数(«x»は0d、1d、2d、3d、7d、14d、28d、30d、90d、または1yのいずれか) |
任意のカラムでレポートをフィルタリングできます。 フィルタリングを行うと、指定したフィルターのいずれかに完全一致するデータが検索されます。
カラムでフィルタリングするには、次のURLパラメータを追加します:filter_«columnname»=«onefilter,anotherfilter,thirdfilter»
例えば、Androidプラットフォームのデータのみを表示したい場合は、次のURLパラメータを設定します:filter_platform=Android
すべてのカラムの一覧については、上記の表を参照してください。
一部のカラムでは、filter_not_«columnname»=«onefilter,anotherfilter»による除外フィルターをサポートしています。
また、custom_page_idディメンションは、filter_null_custom_page_id、filter_blank_custom_page_id、filter_not_null_custom_page_id、およびfilter_not_blank_custom_page_idオプションもサポートしています。
これらのオプションには値を指定する必要はありません。例:…&filter_not_null_custom_page_id=&filter_not_blank_custom_page_id=&…
レポートのソートは、フィルタリングと同様の方法で行います。
例えば、レポートをcampaignでソートするには、次のURLパラメータを追加します:sort_campaign=ASC
指定可能な値は、昇順の場合はASC、降順の場合はDESCです。
すべてのソートは辞書順(lexicographical sort)で行われます。
レポートはJSONまたはCSVの2つの形式でリクエストできます。
Reporting APIのすべてのデータはUTC(協定世界時)です。
広告主のリクエスト例:
https://r.applovin.com/report?api_key=«your-report-key»&start=2015-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,conversions,conversion_rate,app_id_external,cost,sales&format=json&report_type=advertiser
パブリッシャーのリクエスト例:
https://r.applovin.com/report?api_key=«your-report-key»&start=2016-07-01&end=2016-07-07&columns=day%2Cplatform%2Ccountry%2Capplication%2Cpackage_name%2Csize%2Cad_type%2Cimpressions%2Cclicks%2Crevenue,device_type&having=impressions%20%3E%200%20AND%20revenue%20%3E%200&format=csv