Reporting APIはJSONまたはCSVの形式で全体的なキャンペーンのデータを収集することができるツールです。
リクエストのフォーマット
レポートのリクエストは、下記のベースURLにHTTP GETリクエストを送ってください。
https://r.applovin.com/report
必要なパラメータ
-
api_key は、レポートのための広告主のAPIキーです(Report Keyとも呼ばれます)。レポートAPI認証に使われるReport Keyはアカウントページの“Keys”のタブにあります。数値が出てこない場合は、お客様がアカウント登録しているメールアドレスを添えてsupport@applovin.comまでご連絡ください。
-
start はレポートの最初の日付です。“YYYY-MM-DD”またはUnixのタイムスタンプで日付を決めてください(例:2012-10-05または1336608000)。過去90日より先には遡れません。
-
end はレポートの最後の日付です。“YYYY-MM-DD”またはUnixのタイムスタンプで日付を決めてください(例:2012-10-05、1336608000、またはnow)
-
format はレポートのフォーマットです。jsonまたはcsvの形式にしてください。リクエストのフォーマットの詳細は以下をご参照ください
-
columns はカンマ区切りされた項目のリストです。使用可能な項目は下の一覧をご覧ください(例:ad_id,date,campaign_name)
-
report_type は、レポートタイプが“パブリッシャー”あるいは“広告主”向けかをAPIに伝えます。パラメータが外されている場合、APIの初期設定はreport type=publisherとなります
その他のパラメータ
- limit は行の折り返しを設定するパラメータです(例:500)
- offset は行の読み込み開始地点を設定するパラメータです
- having は数値の複雑なフィルタリングが可能になるパラメータです。このツールでは、数値や比較演算子、論理演算子などがコード化された下記のようなURLを受理します:impressions%20%3E%200%20AND%20revenue%20%3E%200 ("impressions > 0 AND revenue > 0"). 注:レスポンスが遅れ、タイムアウトの可能性が高くなります。
使用できる項目(パブリッシャー様向け)
- day - レポートデータの日付
- hour - レポートデータの時間(過去30日分まで可能)
- impressions - インプレッション数
- clicks - クリック数
- ctr - クリック数÷インプレッション数
- revenue - 収益
- ecpm - 1,000インプレッション当たりの収益
- country - 2文字のカントリーコード
- ad_type - GRAPHIC、PLAY、VIDEO、REWARD、MRAIDなど
- size - 広告サイズ(INTER、BANNER、MREC、LEADER、NATIVEなど)
- device_type - スマートフォン、タブレット、その他
- platform - Android、iOS、fireos、tvos
- application - アプリ名
- package_name - アプリのパッケージ名またはバンドルID
- placement - プレースメント名
- application_is_hidden - 管理画面内に隠れているアプリ
- zone - zone名(お客様のアカウントでzone機能が利用可能な場合)
- zone_id - お客様のアカウントでzone機能が利用可能な場合。Zone機能にご興味のあるお客様は担当営業までご連絡ください。
使用可能な項目(広告主様向け)
- day - レポートデータの日付
- impressions - インプレッション数
- clicks - クリック数
- ctr - クリック数÷インプレッション数
- conversions - コンバージョン(インストール)の数
- conversion_rate - コンバージョン数÷クリック数
- average_cpa - 平均CPA
- average_cpc - 平均CPC
- ad - 広告名
- country - 2文字のカントリーコード
- campaign - キャンペーン名
- app_id_external - ハッシュ化されたアプリID(通常“Site ID”と呼ばれます)
- traffic_source - “AppLovin”またはアドエクスチェンジの名称
- ad_type - GRAPHIC、VIDEO、REWARD、PLAY
- cost - 広告費
- sales - 効果のあった売上イベントの数(revenue postbacksの設定が必要)
- size - 広告サイズ(INTER、BANNER、MREC、LEADER、NATIVE)
- device_type - スマートフォン、タブレット、その他
- platform - Android、iOS、fireos、tvos
- campaign_package_name - プロモーションしているアプリのパッケージ名またはバンドルID
- campaign_id_external - キャンペーンのユニークID。キャンペーン名が変わっても変更されない。クリックマクロ({CAMPAIGN_ID})と同じ値
- campaign_ad_type - ユーザー獲得で'ua'、リターゲティングで'rt'をそれぞれ返す
項目をフィルタリングする
AppLovinのReporting APIでは、どの項目でもフィルタがかけられます。
各項目でフィルタをかけるには次のURLパラメータを加えてください: filter_columnname=onefilter,anotherfilter,thirdfilter
例えば広告主のお客様がAndroidだけのデータを確認されたい場合は次のようなURL パラメータを設定してください:filter_platform=Android
全ての項目でフィルタをかけることができます
コラムの並べ替え
レポートの並べ替えはフィルタリングと同様に機能します。
例えば、campaign_nameで並べ替えする場合は次のURLパラメータを追加してくだ さい:sort_campaign_name=ASC
‘ASC’ は昇順、‘DESC’は降順です。並べ替えは全て辞書型です。
レポートのフォーマット
レポートの形式はJSONまたはCSVです。
タイムゾーン
Reporting APIの全てのデータはUTC(世界標準時)になります。
リクエスト例
広告主様のリクエスト例:
https://r.applovin.com/report?api_key=YOUR_API_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_API_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