AppLovin Revenue Reporting API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Revenue Reporting API | API | 集計データ | ✅ | ✅ |
AppLovinは、Maxのマネタイズに特化した集約指標のAPI、つまりRevenue Reporting APIも提供しています。
統合の流れ
- AppLovin管理画面にログインし、Report Keyを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでAppLovin Revenue Reporting APIプランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. Report Keyの取得
AppLovin Revenue Reporting APIのデータを統合するには、まずReport Keyを取得する必要があります。AppLovin管理画面にログインし、「Account」-「Key」でReport Keyを取得してください。このKeyは大切に保管してください
2. プランの設定
Report Keyを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を行います。下図はAppLovin Revenue Reporting APIの設定画面です。本章の内容に従ってプランを作成してください：
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに認証作業で取得した情報を入力します
API Keyは、先ほど取得したReport Keyです。ポップアップのAPI Keyはデフォルトでは直接入力できないため、先に右側の編集アイコンをクリックしてから入力してください。
2.2 定期取得
「定期取得」モジュールで、AEシステムがAppLovin Revenue Reporting APIのデータを定期的に取得する方法を設定できます。毎日の特定の時刻、または1時間ごとに、一定期間のデータを取得するよう選択できます。
2.3 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、コールバックされたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
2.4 統合構成
統合構成モジュールで、データ取得の詳細な設定を制御できます。データの時間集計粒度、取得する指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
| source | metrics | データ内の指標。リスト型です。階層によって対応するmetricsが異なるため、入力時に注意が必要です |
| group_by | データ内のグループ化ディメンション。リスト型です。階層によって対応するgroup_byが異なるため、入力時に注意が必要です |
- グループ化ディメンション
以下は対応しているグループ化ディメンションです。調整が必要な場合は、source.group_byを変更できます
| フィールド | デフォルトかどうか | 説明 |
|---|---|---|
| day | はい | 広告が露出した日付 |
| hour | はい | レポートの時間の値（直近30日間を取得する場合にのみこのフィールドが存在します） |
| has_idfa | はい | ユーザーの広告IDを取得できるかどうか。ユーザーがLATを有効にしている場合、またはGDPR適用地域でデータトラッキングをオフにしている場合、この値は0になり、それ以外の場合は1になります |
| max_ad_unit | はい | MAX広告名 |
| max_ad_unit_id | はい | MAX広告ID |
| max_ad_unit_test | はい | 広告テストグループの名前 |
| network_placement | はい | Ad NetworkのPlacement名 |
| max_placement | SDKでカスタマイズしたPlacement名 | |
| network | はい | 広告を表示したAd Network。値は（MAX Mediation Documentation）を参照してください |
| package_name | はい | パッケージ名。AndroidのApp Package NameとiOSのBundle ID (iOS) |
| platform | はい | プラットフォーム |
| ad_format | はい | 広告タイプ：INTER, BANNER, REWARD |
| ad_unit_waterfall_name | はい | 広告Waterfallの名前 |
| application | はい | アプリ名 |
| country | はい | 2文字のCountry Code |
| custom_network_name | はい | カスタマイズした広告Ad Network名 |
| device_type | はい | デバイスタイプ：PHONE, TABLET |
| store_id | プロモーションするAppのアプリストアID。Androidではpackage name、iOSではiTunes IDの数字部分です |
- 指標フィールド
以下は対応している指標フィールドです。調整が必要な場合は、source.metricsを変更できます
| フィールド | デフォルトかどうか | 説明 |
|---|---|---|
| impressions | はい | 広告露出数 |
| estimated_revenue | はい | 推定総収益（米ドル） |
| attempts | はい | Ad Networkの広告取得試行数（グループ化の取得フィールドにnetworkまたはnetwork_placementが存在する場合のみ使用可能。max_placementが存在する場合は使用不可） |
| ecpm | はい | 推定eCPM（米ドル） |
fill_rate | はい | 広告フィル率 = 広告レスポンス数 / 取得試行数（グループ化の取得フィールドにnetworkまたはnetwork_placementが存在する場合のみ使用可能。max_placementが存在する場合は使用不可） |
| responses | はい | 広告レスポンス数（グループ化の取得フィールドにnetworkまたはnetwork_placementが存在する場合のみ使用可能。max_placementが存在する場合は使用不可） |
| requests | 広告リクエスト数（network、network_placement、max_placementが存在する場合は使用不可） |
2.5 データの格納ルール
デフォルトでは、取得したデータはイベントとしてAEプロジェクトに書き込まれます：
- hourフィールドが存在しない場合（つまり30日より前のデータ）は、データ内のdayフィールド、つまりデータの日付を集計データの#event_timeとして設定します。hourが存在する場合は、dayとhourのフィールドを連結して集計データの#event_timeとします
- データのイベント名は applovin_maxreport です
- その他のフィールドはすべて格納されます
2.6 標準化フィールド
次のイベントプロパティは標準化処理されます：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| max_ad_unit | te_ads_object.ad_group_name | マネタイズ広告のUnit名 |
| max_ad_unit_id | te_ads_object.ad_group_id | マネタイズ広告のUnit ID |
| network_placement | te_ads_object.placement | 広告の配置 |
| network | te_ads_object.media_source | メディアチャンネルまたはマネタイズチャンネル |
| package_name | te_ads_object.app_id | アプリID |
| application | te_ads_object.app_name | アプリ名 |
| platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| country | te_ads_object.country | 国・地域コード |
| 【USD】固定値 | te_ads_object.currency | マネタイズ収益の通貨 |
| impressions | te_ads_object.impressions | 露出数 |
| estimated_revenue | te_ads_object.revenue | マネタイズ収益 |