menu
Is this helpful?

# AppLovin User Revenue API

TIP

データ統合によって生成されたデータは、クラスターのデータ消費量にカウントすることに注意してください。

# 概要

API名 統合タイプ データ粒度 アトリビューション コスト 収益 インプレッション クリック コンバージョン
User Revenue API API ユーザー ✅ ✅

AppLovinは、SDKとコールバックリンクに加えて、User Revenue API (opens new window)というデータ取得インターフェースも提供しており、ユーザーレベルまたはインプレッションレベルの広告収益データを取得することができます。

# 統合手順

  1. AppLovin SDKとTE SDKを連携し、TEのユーザ識別IDをAppLovin SDKで設定します。
  2. AppLovin のバックエンドにログインして、User Revenue API に必要な認証情報を入手します。
  3. TE のバックエンドにログインして、サードパーティー統合ページにてAppLovin User Revenue API プランを追加し、関連設定を完了します。
  4. TEシステムがデータを正常に受信後、レポートの構築が完了を確認します。

# クライアントSDK設定

AppLovin データを統合する最初のステップは、クライアント側で TE SDK と AppLovin SDK を連携させることです。

# 1.1 プラン①（自動統合）

  • TEのSDK のバージョンが2.8.0〜2.8.1である場合、このプランを直接使用することができます。
  • TEのSDK のバージョンが2.8.2以上であれば、サードパーティのデータプラグインをインストールする必要があります。詳細については、Android SDKとiOS SDKを参照してください。
// Initialize the TE SDK
ThinkingAnalyticsSDK instance = ThinkingAnalyticsSDK.sharedInstance(this, TA_APP_ID, TA_SERVER_URL);
// Enable AppLovinSdk id Association
instance.enableThirdPartySharing(TDThirdPartyShareType.TD_APPLOVIN_IMPRESSION);
// Initialize the AppLovinSdk SDK

このソリューションの原理は、内部でAppLovinSdk SDKのsetUserIdentifier()メソッドを自動的に呼び出し、TEプロジェクトのゲストIDを渡すことです。

# 1.2 プラン②（手動統合）

APIから取得したデータをTEプロジェクトのデータと関連付けるために、AppLovin SDKでTEシステムのゲストIDをAppLovinのカスタムユーザー識別子として渡す必要があります。以下はAndroidおよびiOS（Swift）向けのコード例です：

  • Android
// Get the guest ID of TE, corresponding to the #distinct_id in TE
String ta_distinct_id = ThinkingAnalyticsAPI.GetDistinctId();
AppLovinSdk.getInstance(context).setUserIdentifier(ta_distinct_id);
  • iOS 
ALSdk.shared()!.userIdentifier = ThinkingAnalyticsAPI.GetDistinctId()

# Report Key 取得

次に、AppLovinのバックエンドにログインし、「Account」-「Key」からReport Keyを取得してください。このキーはしっかり保管してください。

# TEのサードパーティ統合設定

SDKの設定が完了し、Report Keyを取得したら、TEシステムにログインして、「サードパーティ統合」モジュールで新しいソリューションの構成を完了することができます。以下はAppLovin User Revenue APIの構成画面です。このセクションの内容に従ってソリューションを作成してください。

# 3.1 認証情報の設定

「認証情報」ボタンをクリックし、ポップアップ内で取得した認証情報を入力してください。

  • APP ID：iOS プラットフォームの Tunes ID の数字部分、または Android プラットフォームのアプリパッケージ名
  • Platform：ゲームが存在するプラットフォーム android または ios
  • API Key：さっき取得した Report Key

# 3.2 定期取得

「定期取得」モジュールで、TE システムが AppLovin ユーザー収益 API データを定期的の取得を設定できます。特定の時間帯ごとや毎時など、データを一定期間ごとに取得することができます。取得したデータもデータ量に含まれるため、長時間のデータを定期的に取得しないようお勧めします。

# 3.3 ユーザー識別フィールド

AppLovin User Revenue APIはユーザーレベルのデータであるため、それに対するユーザー識別ルールを設定する必要があります。つまり、AppLovin User Revenue APIデータ内の#distinct_idおよび#account_idに対応するフィールドです。TEシステムはこの構成に基づいて、コールバックデータを変換する際にこれらのフィールドをデータ内のユーザー識別フィールドとして設定します。

前のステップに従ってクライアントSDKを構成した場合は、次の構成を使用してください：

  • アカウントID関連フィールド：なし
  • ゲストID関連フィールド：user_id

# 3.4 イベントテーブル格納設定

「イベントテーブルへのデー格納設定」を有効にすると、送信されたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納をお勧めします。

# 3.5 ユーザープロパティ格納

デフォルトでは、TE システムは AppLovin User Revenue API データをユーザープロパティに書き込みません。特定のフィールドをユーザーテーブルに書き込む場合は、最初にルールを有効化して実行し、その後プロパティマッピング機能を使用して必要なフィールドを追加する必要があります。ソースプロパティ名にはフィールドの格納名を記入してください：

# 3.6 統合構成

データの取り込みの詳細設定を統合構成モジュールで制御することができます。たとえば、イベント名などの格納後のイベントを指定できます。

統合構成はJSONであり、必要に応じてその内容を調整することができます。

モジュール 名称 意味
sink_event event_name 格納後のイベント名は、カスタマイズできます。

# 3.7 データ格納ルール

  • データ内のuser_idをデータ内のユーザーIDとして使用する。このフィールドはTEプロジェクト内のユーザー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 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 iOSIDFAまたはAndroidのGoogle広告ID 860635ea-65bc-eaed-d355-1b5283b30b94
IDFV idfv IDFV 4CD1C3C4-3FD7-00F5-1635-7BC6D9387E60
Network network 広告露出の Ad Network 参考（[MAX Mediation Documentation (applovin.com)](https://dash.applovin.com/documentation/mediation/features/ad-unit-automation-api#ad-networks)）APPLOVIN_NETWORK
Placement placement Ad Network の Placement 名 MY_NATIVE_PLACEMENT
Revenue revenue 見積もり収益には、FBBiddingの値 0.0121, 5.74466e-05
User ID user_id SDKの設定されたユーザーIDは、TEプロジェクトのゲスト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 収益

← AppLovin Basic Reporting API →