AppLovin User Revenue API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| User Revenue API | API | ユーザーレベル | ✅ | ✅ |
AppLovinは、SDKとコールバックリンクのほかに、データ取得インターフェースであるUser Revenue APIも提供しており、ユーザー単位または表示単位の広告収益データの取得に対応しています。
統合の流れ
- AppLovin SDKとAE SDKを統合し、AppLovin SDKでAEのユーザー識別IDを設定します
- AppLovin管理画面にログインし、User Revenue APIに必要な認証情報を取得します
- AE管理画面にログインし、サードパーティ統合モジュールでAppLovin User Revenue APIプランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. クライアントSDKの設定
AppLovinデータを統合する最初のステップは、クライアント側でAE SDKとAppLovin SDKを連携させることです。
1.1 方法1(自動関連付け)
-
統合しているAndroid、iOS SDKについて
- SDKのバージョンが2.8.0~2.8.1の場合は、この方法をそのまま使用できます
- SDKのバージョンが2.8.2以上の場合は、サードパーティデータプラグインもインストールする必要があります。詳しくはAndroid SDKのサードパーティデータとiOS SDKのサードパーティデータを参照してください
AEのSDKの初期化と自動統合を有効にするコードは、AppLovinのSDKの初期化より前に完了する必要がありますのでご注意ください。次の手順に従って操作してください:
1. AE SDKを初期化します。
2. `enableThirdPartySharing`を呼び出して、ゲストIDを自動設定します。
3. AppLovin SDKを初期化します。
各プラットフォームのSDKのコードサンプルは次のとおりです:
- Android
- iOS
// 1、Android SDKを初期化
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2、enableThirdPartySharingインターフェースを呼び出し、ta_distinct_idをapplovinイベントに設定
TDAnalytics.enableThirdPartySharing(TDThirdPartyType.APPLOVIN_IMPRESSION)
// 3、applovin SDKを初期化
// 。。。
// 1、iOS SDKを初期化
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
[TDAnalytics startAnalyticsWithConfig:config];
// 2、enableThirdPartySharingインターフェースを呼び出し、ta_distinct_idをapplovinイベントに設定
[TDAnalytics enableThirdPartySharing:TDThirdPartyTypeAppLovin];
// 3、applovin SDKを初期化
// 。。。
この方法の仕組みは、内部でAppLovinSdk SDKのsetUserIdentifier()メソッドを自動的に呼び出し、AEプロジェクトのゲストIDを渡すというものです。
1.2 方法2(手動関連付け)
手動関連付けの方法では、AF AppLovinでsetUserIdentifier()インターフェースを使用して、AEプロジェクトのゲストIDを設定する必要があります。
AEのSDKの初期化とsetUserIdentifierインターフェースの呼び出しは、AppLovinのSDKの初期化より前に完了する必要がありますのでご注意ください。次の手順に従って操作してください:
1. AE SDKを初期化します。
2. `setUserIdentifier`を呼び出して、ゲストIDを設定します。
3. AppLovin SDKを初期化します。
各SDKの手動統合のコードサンプルは次のとおりです:
- Android
- iOS
- Unity
// 1、Android SDKを初期化
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2、AEのゲストIDを取得(AEの#distinct_idに対応)
String distinctId = TDAnalytics.getDistinctId();
// 3、ゲストIDをapplovinの収集イベントに設定
AppLovinSdk.getInstance(context).setUserIdentifier(distinctId);
// 4、applovin SDKを初期化
// 。。。
// 1、iOS SDKを初期化
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
[TDAnalytics startAnalyticsWithConfig:config];
// 2、AEのゲストIDを取得(AEの#distinct_idに対応)
NSString *distinctId = [TDAnalytics getDistinctId];
// 3、ゲストIDをapplovinの収集イベントに設定
[ALSdk shared].userIdentifier = distinctId;
// 4、applovin SDKを初期化
// 。。。
// 1、Unity SDKを初期化
TDConfig config = new TDConfig("APPID","SERVER");
TDAnalytics.Init(config);
// 2、AEのゲストIDを取得(AEの#distinct_idに対応)
var distinctId = TDAnalytics.GetDistinctId();
// 3、ゲストIDをApplovinの収集イベントに設定
MaxSdk.SetUserId(distinctId);
// 4、Applovin SDKを初期化
// 。。。
2. Report Keyの取得
次に、AppLovin管理画面にログインし、「Account」-「Key」でReport Keyを取得してください。このKeyは大切に保管してください
3. プランの設定
SDKの設定が完了し、Report Keyを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を行います。下図はAppLovin User Revenue APIの設定画面です。本章の内容に従ってプランを作成してください:
3.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに認証作業で取得した情報を入力します(API Keyは、先に右側の編集アイコンをクリックしてから入力する必要があります)
補足:
- APP ID:iOSプラットフォームのiTunes IDの数字部分、またはAndroidプラットフォームのアプリのパッケージ名
- Platform:ゲームのプラットフォーム。androidまたはiosを入力してください
- API Key:先ほど取得したReport Key
3.2 定期取得
「定期取得」モジュールで、AEシステムがAppLovin User Revenue APIのデータを定期的に取得する方法を設定できます。毎日の特定の時刻、または1時間ごとに、一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、長すぎる期間のデータを定期取得しないことをお勧めします
3.3 ユーザー識別フィールド
AppLovin User Revenue APIのデータはユーザーレベルのデータであるため、ユーザー識別ルール、つまりAppLovin User Revenue APIのデータ内で#distinct_idと#account_idに対応するフィールドを設定する必要があります。AEシステムはこの設定に基づき、取得したデータを変換する際に、これらのフィールドをデータのユーザー識別フィールドとして設定します。
本ドキュメントの前のステップに従ってクライアントSDKを設定した場合は、次の設定を使用してください:
- アカウントID関連フィールド:なし
- ゲストID関連フィールド:user_id
3.4 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、コールバックされたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
3.5 ユーザープロパティの格納設定
デフォルトでは、AEシステムはAppLovin User Revenue APIのデータをユーザープロパティに書き込みません。一部のフィールドをユーザーテーブルに書き込みたい場合は、まずルールをオンにして実行状態にしてから、プロパティのマッピング機能でユーザーテーブルに書き込むフィールドを追加してください。ソースプロパティ名にはフィールドの格納名を入力する必要があります:
3.6 統合構成
統合構成モジュールで、データ取得の詳細な設定を制御できます。たとえば、格納後のイベント名などです。
統合構成はJSONで、必要に応じて内容を調整できます
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
3.7 データの格納ルール
- データ内のuser_idをデータのゲストIDとして使用します。このフィールドはAEプロジェクトのゲストIDに対応している必要があります
- データ内のdateフィールド、つまり広告の表示時間をイベントの#event_timeとして使用します
- データのイベント名は applovin_ad_revenue_impression_level です
- その他のフィールドはすべて格納されます。返されるすべてのデータのフィールドの意味は次のとおりです:
| フィールド | 格納名 | 説明 | サンプル |
|---|---|---|---|
| Ad Format | ad_format | 広告タイプ | INTER, BANNER, REWARD |
| Ad Placement | ad_placement | SDKでカスタマイズしたPlacement名 | Launch%20Screen |
| Ad Unit ID | ad_unit_id | MAX広告ID | 9ad0816ac071552a |
| Ad Unit Name | ad_unit_name | MAX広告名 | Control |
| Country | country | 2文字のCountry Code | gb |
| Custom Data | custom_data | SDKで設定したカスタムデータ | gb |
| Date | date | 広告の露出時間 | 2019-07-29 15:53:07.39 |
| Device Type | device_type | デバイスタイプ | PHONE, TABLET |
| IDFA | idfa | iOSのIDFAまたはAndroidのGoogle Advertising ID | 860635ea-65bc-eaed-d355-1b5283b30b94 |
| IDFV | idfv | IDFV | 4CD1C3C4-3FD7-00F5-1635-7BC6D9387E60 |
| Network | network | 広告を表示したAd Network | 値は(MAX Mediation Documentation (applovin.com))を参照してください。APPLOVIN_NETWORK |
| Placement | placement | Ad NetworkのPlacement名 | MY_NATIVE_PLACEMENT |
| Revenue | revenue | 推定収益。FB Biddingの値を含む | 0.0121, 5.74466e-05 |
| User ID | user_id | SDKで設定したユーザーID。AEプロジェクトのゲストIDに対応します | 7634657898 |
| Waterfall | waterfall | 広告Waterfallの名前 | LAT |
3.8 標準化フィールド
次のイベントプロパティは標準化処理されます:
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| network_name | te_ads_object.media_source | メディアチャンネル |
| ad_mediation_platform | te_ads_object.media_source | マネタイズチャンネル |
| ad_unit_name | te_ads_object.ad_group_name | マネタイズ広告のUnit名 |
| ad_unit_id | te_ads_object.ad_group_id | マネタイズ広告のUnit ID |
| ad_placement | te_ads_object.placement | マネタイズ広告の配置 |
| app_id | te_ads_object.app_id | アプリID |
| country | te_ads_object.country | 国・地域コード |
| platform | te_ads_object.platform | プラットフォーム(Android、iOSなど) |
| 【USD】固定値 | te_ads_object.currency | マネタイズ収益の通貨 |
| revenue | te_ads_object.revenue | マネタイズ収益 |

