Reporting API
このReporting APIを使用して、集計されたキャンペーンデータをJSONまたはCSVフォーマットで取得します。
リクエスト形式
以下のいずれかのベースURLにHTTPGET
リクエストを送信して、レポートをリクエストします。
https://r.applovin.com/report
https://r.applovin.com/probabilisticReport
(広告専用。インストールと支出の値は確率的インストールデータに基づいています。)https://r.applovin.com/skaReport
(広告専用。このエンドポイントはSKAdNetworkの値を反映しており、ディメンションと指標に制限があります。2024年8月1日以降、コストの値は確率的データに基づくものとなります。)
必要なパラメーター
パラメーター | 目的 |
---|---|
api_key | レポートキー レポートキーはAppLovinダッシュボードのアカウントページのKeysタブで確認できます。 |
start 1 | レポートの開始日 YYYY-MM-DD形式またはUnixタイムスタンプを指定できます。例えば、 2012-10-05 または 1336608000 です。 |
end 1 | レポートの終了日 YYYY-MM-DD形式またはUnixタイムスタンプを指定できます。例えば、 2012-10-05 、1336608000 、またはnow です。 |
format | レポートのフォーマットjson またはcsv を指定できます。リクエストフォーマットの詳細は以下を参照してください。 |
columns | レポート用の列をコンマで区切ったリスト 許可される列については以下を参照してください(例: ad_id,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メディエーション、Google はAdMob Mediation Open BiddingまたはGoogle アド マネージャー/GAM、None はノンビディング/ゾーン統合) |
clicks | クリック数 |
country | 2文字の国コード |
ctr | クリック数÷インプレッション数 |
day | レポートデータの日付 |
device_type | phone 、tablet 、またはother |
ecpm | インプレッション1000回あたりの収益 |
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名(アカウントで利用可能な場合) |
zone_id | Zone ID(アカウントで利用可能な場合) ゾーンのご利用を希望される場合は、アカウントマネージャーにお問い合わせください。 |
許可された広告主列
列名 | 内容 |
---|---|
ad | 広告名 |
ad_creative_type | GRAPHIC , PLAYABLE , VIDEO , VIDEO_PLAYABLE |
ad_id | 広告ID。広告名が変更されても、これは変わりません |
ad_revenue_ x | 特定の期間の広告収益(xは0d 、1d 、2d 、3d 、7d 、14d 、28d 、30d 、90d 、または1y のいずれか) |
ad_roas_ x | 特定の期間の広告費用対効果(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 | 平均クリック単価 |
campaign | キャンペーン名 |
campaign_ad_type | ua (ユーザー獲得)、またはrt (リターゲティング) |
campaign_bid_goal | CPPおよびCPEキャンペーンの入札目標はドル値 ($) で表されます。この列をリクエストする際には、campaign 列も同時にリクエストする必要があります。 |
campaign_id_external | キャンペーンに対する一意の参照。キャンペーンの名前を変更しても、これは変わりません。これは、{CAMPAIGN_ID} クリックマクロと同じ値です。 |
campaign_package_name | プロモーション中のアプリのパッケージ名またはバンドルID |
campaign_roas_goal | IAP ROAS、広告ROAS、およびROASキャンペーンの広告費用対効果 (ROAS) 目標は、パーセンテージ値 (%) で表されます。この列をリクエストする際は、campaign 列も同時にリクエストする必要があります。 |
campaign_store_id | iOSでプロモーションされているアプリのiTunes IDの数値部分、それ以外の場合はcamaign_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(APIソース入札で使用) |
first_purchase | 初回購入を行ったユーザーのカウント数(収益ポストバックの設定が必要) |
hour | レポートデータの時間(過去30日間のみ利用可能) |
iap_rev_ x | 特定の期間中のIAP収益(x は 0d 、1d 、2d 、3d 、7d 、14d 、28d 、30d 、90d 、または1y のいずれか) |
iap_roas_ x | 特定の期間中のIAPの広告費用対効果 (xは0d 、1d 、2d 、3d 、7d 、14d 、28d 、30d 、90d 、または1y のいずれか) |
impressions | インプレッション数 |
installs 1 | 以前の、redownload =false に該当するSKAdNetwork由来のインストール数(対象は/skaReport のみ)。他のレポートにはconversions を使用してください。 |
optimization_day_target | キャンペーンでターゲットに設定した最適化日(例:Day0 またはDay7 ) |
placement_type | APP_OPEN 、ARRAY 、BANNER 、CTV 、INTER 、LEADER 、MREC 、NATIVE 、またはREWARDED_INTER |
platform | android 、fireos 、ios 、またはtvos |
redownloads 1 | redownload =true に該当するSKAdNetwork由来のインストール数(対象は/skaReport のみ)。他のレポートにはconversions を使用してください。 |
ret_ x | 特定の期間中のリテンション(x は 1d 、2d 、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 、30d 、90d 、または1y のいずれか) |
- 2024 年 8 月 2 日より、SKAdNetwork 由来のインストールと再ダウンロードは国レベルのレポートから移行されます。/skaReport` にのみ影響します。
列をフィルター
任意の列でレポートをフィルターできます。この操作を行うと、いずれかのフィルターに直接一致するものを検索します。
列でフィルターするには、次の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
です。すべてのソートは辞書式順序で実行されます。
レポートのフォーマット
レポートはJSONまたはCSVの2つのフォーマットでリクエストできます。
タイムゾーン
レポート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