AppLovin Basic Reporting API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Basic Reporting API | API | 集計データ | ✅ | ✅ | ✅ | ✅ | ✅ |
ユーザー粒度の収益データのほかに、AppLovinは集約指標のAPI、つまりBasic Reporting APIも提供しています。
統合の流れ
- AppLovin管理画面にログインし、Report Keyを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでAppLovin Basic Reporting APIプランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. Report Keyの取得
AppLovin Basic Reporting APIのデータを統合するには、まずReport Keyを取得する必要があります。AppLovin管理画面にログインし、「Account」-「Key」でReport Keyを取得してください。このKeyは大切に保管してください
2. プランの設定
Report Keyを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を行います。下図はAppLovin Basic Reporting APIの設定画面です。本章の内容に従ってプランを作成してください:
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに認証作業で取得した情報を入力します
API Keyは、先ほど取得したReport Keyです
2.2 定期取得
「定期取得」モジュールで、AEシステムがAppLovin Basic Reporting APIのデータを定期的に取得する方法を設定できます。毎日の特定の時刻、または1時間ごとに、一定期間のデータを取得するよう選択できます。
2.3 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、取得したデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
2.4 統合構成
統合構成モジュールで、データ取得の詳細な設定を制御できます。データの時間集計粒度、取得する指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます:
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
| source | report_types | データを取得する階層。リスト型です。要素は1つだけ入力すること、つまり一度に1つの階層のデータのみを取得することをお勧めします 選択可能な値: advertiser、publisher |
| metrics | データ内の指標。リスト型です。階層によって対応するmetricsが異なるため、入力時に注意が必要です | |
| group_by | データ内のグループ化ディメンション。リスト型です。階層によって対応するgroup_byが異なるため、入力時に注意が必要です |
Basic Reporting APIは、広告主レポート(advertiser)とパブリッシャーレポート(publisher)という、まったく異なる2種類のレポートを提供しています。以下の各節では、この2種類のレポートの設定方法をそれぞれ紹介します:
2.4.1 広告主レポート(advertiser)
広告主レポートのテンプレートは次のとおりです:
{
"sink_event":
{
"event_name": "applovin_advertiser"
},
"source":
{
"group_by":
[
"day",
"campaign",
"campaign_id_external",
"creative_set",
"creative_set_id",
"ad_id",
"ad",
"ad_type",
"campaign_ad_type",
"campaign_package_name",
"campaign_store_id",
"campaign_type",
"country",
"device_type",
"external_placement_id",
"platform",
"size",
"traffic_source"
],
"report_types":
[
"advertiser"
],
"metrics":
[
"impressions",
"clicks",
"ctr",
"conversions",
"conversion_rate",
"average_cpa",
"average_cpc",
"cost",
"sales"
]
}
}
- テンプレートで使用される時間粒度は日単位です(広告主レポートは時間単位の集計に対応していません)。システムはデータ内のdayフィールド、つまりデータの日付をデータの時刻として使用します
- テンプレートで使用されるイベント名は -- applovin_advertiser
- その他のフィールドはすべて格納されます
- 選択可能なディメンション
以下は広告主レポートで選択可能なディメンションです。実際の必要に応じて調整できます。必要なフィールドのフィールド名をsource.group_byに書き込んでください
| フィールド名 | デフォルトかどうか | 意味 |
|---|---|---|
| day | はい | レポートの日付 |
| campaign | はい | Campaign名 |
| campaign_id_external | はい | Campaignの一意の識別子 |
| creative_set | はい | 広告グループ名 |
| creative_set_id | はい | 広告グループID |
| ad_id | はい | 広告ID |
| ad | はい | 広告名 |
| ad_type | はい | 広告タイプ。値の例:GRAPHIC, VIDEO, REWARD, またはPLAY |
| application | トラフィック元のApp名 | |
| campaign_ad_type | はい | User Acquisition Campaignの場合、この値はuaです。Retargeting Campaignの場合、この値はrtです |
| campaign_package_name | はい | プロモーションするAppのパッケージ名。Androidではpackage name、iOSではBundle IDです |
| campaign_store_id | はい | プロモーションするAppのアプリストアID。Androidではpackage name、iOSではiTunes IDの数字部分です |
| campaign_type | はい | Campaignの最適化目標(PP, CPE, IAP ROAS, ad ROAS, or ROAS) |
| custom_page_id | 広告グループに関連付けられたiOSのカスタムプロダクトページ、またはAndroidのストア掲載情報ページ | |
| country | はい | 英字2文字のCountry Code |
| device_type | はい | デバイスタイプ。値の例:phone, tabletまたはother |
| external_placement_id | はい | エンコードされたアプリID |
| optimization_day_target | Campaignの目標最適化日(例:day 0またはday 7) | |
| platform | はい | デバイスプラットフォーム。値の例:android, ios, fireos, tvos |
| size | はい | 広告サイズ。値の例:INTER, BANNER, MREC, LEADER, またはNATIVE |
| target_event | Campaignの課金イベント(CPE Campaignのみ有効) | |
| traffic_source | はい | トラフィックソース。値はAppLovinまたはその他のexchangeチャンネル名です |
- 選択可能な指標
以下は広告主レポートで選択可能な指標です。実際の必要に応じて調整できます。必要なフィールドのフィールド名をsource.metricsに書き込んでください
| フィールド名 | デフォルトかどうか | 意味 |
|---|---|---|
| average_cpa | はい | 平均CPA(インストール) |
| average_cpc | はい | 平均CPC |
| clicks | はい | クリック数 |
| conversions | はい | コンバージョン数(つまりインストール数) |
| conversion_rate | はい | コンバージョン率(インストール数 / クリック数) |
| cost | はい | 広告コスト |
| ctr | はい | クリック率 |
| campaign_bid_goal | Campaignの入札目標 | |
| campaign_roas_goal | CampaignのROAS目標 | |
| first_purchase | 初回アプリ内課金のユーザー数(Revenueコールバックの設定が必要) | |
| impressions | はい | 露出数 |
| sales | はい | アプリ内課金の回数(Revenueコールバックの設定が必要) |
2.4.2 パブリッシャーレポート(publisher)
パブリッシャーレポートのテンプレートは次のとおりです:
{
"sink_event":
{
"event_name": "applovin_publisher"
},
"source":
{
"group_by":
[
"day",
"hour",
"country",
"ad_type",
"size",
"device_type",
"platform",
"application",
"package_name",
"store_id",
"placement",
"application_is_hidden",
"zone",
"zone_id",
"bidding_integration"
],
"report_types":
[
"publisher"
],
"metrics":
[
"impressions",
"clicks",
"ctr",
"revenue",
"ecpm"
]
}
}
- テンプレートで使用される時間粒度は時間単位です。つまり、データ内のday + hourフィールドをデータの時刻として使用します
- テンプレートで使用されるイベント名は -- applovin_publisher
- その他のフィールドはすべて格納されます
- 選択可能なディメンション
以下はパブリッシャーレポートで選択可能なディメンションです。実際の必要に応じて調整できます。必要なフィールドのフィールド名をsource.group_byに書き込んでください
| フィールド名 | デフォルトかどうか | 意味 |
|---|---|---|
| day | はい | レポートの日付 |
| hour | はい | レポートの時間の値(直近30日間のデータの取得のみ対応)。このフィールドを使用しない場合、データの時刻はdayのみとなります |
| country | はい | 英字2文字のCountry Code |
| ad_type | はい | 広告タイプ。値の例:GRAPHIC, PLAY, VIDEO, REWARD, またはMRAID |
| size | はい | 広告サイズ。値の例:INTER, BANNER, MREC, LEADER, またはNATIVE |
| device_type | はい | デバイスタイプ。値の例:phone, tabletまたはother |
| platform | はい | デバイスプラットフォーム。値の例:android, ios, fireos, tvos |
| application | はい | App名 |
| package_name | はい | Appのパッケージ名。Androidではpackage name、iOSではBundle IDです |
| store_id | はい | AppのアプリストアID。Androidではpackage name、iOSではiTunes IDの数字部分で、取得できない場合はBundle IDとなります |
| placement | はい | Placement名 |
| application_is_hidden | はい | そのAppがAppLovinのダッシュボードで非表示になっているかどうか |
| zone | はい | Zone名(アカウントでZonesが有効になっている場合のみ) |
| zone_id | はい | Zone ID(アカウントでZonesが有効になっている場合のみ) |
| bidding_integration | はい | 統合の入札方式(値の例:MAXまたはAdmob Open Bidding) |
- 選択可能な指標
以下はパブリッシャーレポートが返すフィールドです。実際の必要に応じて、返すフィールドを選択できます
| フィールド名 | デフォルトかどうか | 意味 |
|---|---|---|
| impressions | はい | 露出数 |
| clicks | はい | クリック数 |
| ctr | はい | クリック率 |
| revenue | はい | マネタイズの総収益 |
| ecpm | はい | ECPM |
2.5 標準化フィールド
以下はAppLovin Basic Reporting APIの標準化フィールドです:
- 広告主レポート
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| traffic_source | te_ads_object.media_source | マネタイズチャンネル |
| campaign | te_ads_object.campaign_name | 広告キャンペーン名 |
| campaign_id_external | te_ads_object.campaign_id | 広告キャンペーンID |
| creative_set | te_ads_object.ad_group_name | 広告グループ名 |
| creative_set_id | te_ads_object.ad_group_id | 広告グループID |
| ad | te_ads_object.ad_name | 広告名 |
| ad_id | te_ads_object.ad_id | 広告ID |
| campaign_package_name | te_ads_object.app_name | アプリ名 |
| campaign_store_id | te_ads_object.app_id | アプリID |
| country | te_ads_object.country | 国・地域コード |
| platform | te_ads_object.platform | プラットフォーム(Android、iOSなど) |
| 【USD】固定値 | te_ads_object.currency | 配信の通貨 |
| impressions | te_ads_object.impressions | 露出数 |
| clicks | te_ads_object.clicks | クリック数 |
| conversions | te_ads_object.installs | コンバージョン数(インストール) |
| cost | te_ads_object.cost | ユーザー獲得コスト |
- パブリッシャーレポート
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| country | te_ads_object.country | 国・地域コード |
| platform | te_ads_object.platform | プラットフォーム(Android、iOSなど) |
| application | te_ads_object.app_name | アプリ名 |
| package_name | te_ads_object.app_id | アプリID |
| placement | te_ads_object.placement | 広告の配置 |
| 【USD】固定値 | te_ads_object.currency | マネタイズ収益の通貨 |
| impressions | te_ads_object.impressions | 露出数 |
| clicks | te_ads_object.clicks | クリック数 |
| revenue | te_ads_object.revenue | マネタイズ収益 |

