レポートAPI
このReporting APIを使用して、集計されたキャンペーンデータをJSONまたはCSVフォーマットで取得します。
リクエスト形式
以下のベースURLにHTTPGET
リクエストを送信して、レポートをリクエストします。
https://r.applovin.com/report
必要なパラメーター
パラメーター | 目的 |
---|---|
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 | レポート用の列をコンマで区切ったリスト 許可される列については以下を参照してください(例: day,campaign )。 |
report_type | advertiser (必須) |
1 このAPIで設定できるリクエスト期間は90日間です。日付パラメータが90日以内に設定されていることを確認してください。
オプションのパラメーター
パラメーター | 目的 |
---|---|
day_column | 指標はデフォルトでリアルタイムです。コホートで指標を取得したい場合は、これをday に設定してください(指標は配信時間に遡ってアトリビュートされます)。 |
limit | 返される行数の制限。例:500 |
offset | 行の取得を開始するオフセット位置。例:100 |
having | 数値に対する複雑なフィルターを許可します。 このパラメーターでは、数値列のURLエンコードされた値、比較演算子、および論理演算子を指定できます。例: impressions%20%3E%200%20AND%20cost%20%3E%200 (「impressions > 0 AND cost > 0」)。注:これにより応答が遅くなり、タイムアウトが発生する可能性が高まります。 |
not_zero | すべての数値指標の値が0である結果をフィルタリングするには、これを1 に設定します。 |
推奨列
列名 | 内容 |
---|---|
campaign | キャンペーン名 |
campaign_id_external | キャンペーンを一意に識別する参照値 キャンペーン名を変更してもこの値は変わりません。 {CAMPAIGN_ID} クリックマクロと同じ値です。 |
cost | 広告主支出 |
country | 2文字の国コード |
creative_set | クリエイティブセット名 |
creative_set_id | クリエイティブセットID。クリエイティブセット名を変更してもこの値は変わりません。 |
day | レポートデータの日付 |
hour | レポートデータの時間(過去30日間のみ利用可能) |
オプション列
列名 | 内容 |
---|---|
ad_creative_type | GRAPHIC 、PLAYABLE 、VIDEO 、またはVIDEO_PLAYABLE |
ad_type | APPOPEN 、GRAPHIC 、PLAY 、REWARD 、またはVIDEO |
average_cpc | 平均クリック単価 |
campaign_bid_goal | CPPおよびCPEキャンペーンの入札目標はドル値 ($) で表されます。この列をリクエストする際には、campaign 列も同時にリクエストする必要があります。 |
chka_0d | インプレッション時刻から24時間以内に発生し、アトリビュートされたチェックアウト |
chka_1d | インプレッション時刻から48時間以内に発生し、アトリビュートされたチェックアウト |
chka_2d | インプレッション時刻から72時間以内に発生し、アトリビュートされたチェックアウト |
chka_3d | インプレッション時刻から96時間以内に発生し、アトリビュートされたチェックアウト |
chka_7d | インプレッション時刻から192時間以内に発生し、アトリビュートされたチェックアウト |
chka_usd_0d | インプレッション時刻から24時間以内に発生し、アトリビュートされたチェックアウト収益の合計 |
chka_usd_1d | インプレッション時刻から48時間以内に発生し、アトリビュートされたチェックアウト収益の合計 |
chka_usd_2d | インプレッション時刻から72時間以内に発生し、アトリビュートされたチェックアウト収益の合計 |
chka_usd_3d | インプレッション時刻から96時間以内に発生し、アトリビュートされたチェックアウト収益の合計 |
chka_usd_7d | インプレッション時刻から192時間以内に発生し、アトリビュートされたチェックアウト収益の合計 |
clicks | クリック数 |
cost_per_chka_0d | インプレッション時刻から24時間以内のCPP |
cost_per_chka_1d | インプレッション時刻から48時間以内のCPP |
cost_per_chka_2d | インプレッション時刻から72時間以内のCPP |
cost_per_chka_3d | インプレッション時刻から96時間以内のCPP |
cost_per_chka_7d | インプレッション時刻から192時間以内のCPP |
ctr | クリック数÷インプレッション数 |
custom_page_id | 特定のランディングページ |
impressions | インプレッション数 |
placement_type | APP_OPEN 、ARRAY 、BANNER 、CTV 、INTER 、LEADER 、MREC 、NATIVE 、またはREWARDED_INTER |
platform | android 、ios 、fireos 、またはtvos |
roas_0d | インプレッション時刻から24時間以内に生成されたチェックアウトROAS |
roas_1d | インプレッション時刻から48時間以内に生成されたチェックアウトROAS |
roas_2d | インプレッション時刻から72時間以内に生成されたチェックアウトROAS |
roas_3d | インプレッション時刻から92時間以内に生成されたチェックアウトROAS |
roas_7d | インプレッション時刻から192時間以内に生成されたチェックアウトROAS |
sales | アトリビューションされた販売イベントの数 |
size | 広告サイズ(BANNER 、INTER 、LEADER 、MREC 、NATIVE 、またはPRELOAD ) |
列をフィルター
レポートを任意の列でフィルターできます。 この操作を行うと、いずれかのフィルターに直接一致するものを検索します。
列でフィルターするには、次の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=2024-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,cost,sales&format=json&report_type=advertiser