# AppLovin MAX S2S Impression Revenue API
TIP
データ統合によって生成されたデータは、クラスターのデータ消費量にカウントすることに注意してください。
# 概要
| API名 | 統合タイプ | データ粒度 | アトリビューション | コスト | 収益 | インプレッション | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| MAX S2S Impression Revenue API | コールバック | ユーザーレベル | ✅ | ✅ |
AppLovinは、MAX S2S Impression Revenue API (opens new window)を使用してコールバックデータを送信する方法を提供しており、収益広告が表示されるたびに、AppLovinはインプレッションレベルの収益データを事前に設定されたコールバックリンクに送信します。
# 統合手順
- AppLovin SDKとTE SDKへ接続後、AppLovin SDKでTEのユーザー識別IDを設定
- TEへログイン後、サードパーティー統合ページにてAppLovin MAX S2S Impression Revenue API の統合を設定
- AppLovinのバックエンドへログイン後、コールバックを設定
- 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);
// Turn on 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 ユーザー定義識別 ID として指定する必要があります。以下は Android と iOS (Swift) のコード例です：
- Android
// 获取 TE 的ゲスト ID, 对应 TE 中的 #distinct_id
String ta_distinct_id = ThinkingAnalyticsAPI.GetDistinctId();
AppLovinSdk.getInstance(context).setUserIdentifier(ta_distinct_id);
- iOS
ALSdk.shared()!.userIdentifier = ThinkingAnalyticsAPI.GetDistinctId()
# TEのサードパーティ統合設定
完成 SDK 配置后，接下来需要您登录 TE 系统后台，在「三方集成」模块中完成 AppLovin MAX S2S Impression Revenue API 的配置。下图是 AppLovin 的配置界面：
SDKの設定が完了したら、次にTEシステムのバックエンドにログインし、「サードパーティー統合」モジュールでAppLovin MAX S2S Impression Revenue APIの設定を完了する必要があります。以下はAppLovinの設定画面です：
# 2.1 ユーザーの識別と関連付け
AppLovin がユーザーレベルデータを転送するため、ユーザー識別ルールを設定する必要があります。すなわち、AppLovin が転送するデータと #distinct_id および #account_id に対応するフィールドです。TE システムは、この設定に基づいて、転送されたデータを変換する際に、これらのフィールドをデータ内のユーザー識別フィールドに設定します。
もし本ガイドの前の手順でクライアント SDK の設定を行っているなら、次の設定を使用してください：
- アカウント ID 関連フィールド：なし
- ゲスト ID 関連フィールド：user_id
# 2.2 イベントテーブル格納設定
「イベントテーブル格納設定」有効にすると、送信されたデータはすべてイベントテーブルに書き込まれます。イベントデータの入力をお勧めします。
# 2.3 ユーザープロパティ格納
TE システムはデフォルトで、AppLovin コールバックデータをユーザープロパティに書き込むことはありません。ルールを有効にしてから、プロパティマッピング機能を使用してユーザーブームに書き込みたいフィールドを追加できます。ソースプロパティ名はフィールドの格納名を入力してください。3.1章 (opens new window)の内容を参照してください。
# 2.4 統合構成
データの取り込みの詳細設定を統合構成モジュールで制御することができます。たとえば、データベースに格納された後のイベント名などです。
| モジュール | 名称 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名は、カスタマイズできます。 |
# 2.5 ターミナルアドレス
ターミナルアドレスには、TE システムが AppLovin のコールバックデータを受け取るアドレスが表示されています。そのアドレスを直接コピーしてください。次に AppLovin のコールバック設定を行う際に、このアドレスを主な戻りアドレスとして使用してください。
このアドレスが表示されていない場合、右上のメニュー「プロジェクト管理」-「アクセス設定」-「データ送信先アドレス」へ進み、パブリックアドレスを設定してください。 このアドレスはTE SDKで設定されたデータ送信先アドレスです。 設定後AppLovin設定画面へ戻り「データソース」からアドレスをコピーしてください。
# AppLovin の callback の設定を完了
# 3.1 コールバックマクロの設定
最後に、コールバック アドレスの設定を完了する必要があります。コールバックデータで受け取れるフィールドを「マクロ」と呼びます。デフォルトでは、すべてのフィールド（すなわち、すべてのマクロを設定する）を取得することをおすすめします。次の表は MAX S2S Impression Revenue API がサポートするすべてのマクロです：
| マクロ | 格納名 | 説明 | 必須 |
|---|---|---|---|
| {AD_UNIT_ID} | ad_unit_id | MAX 広告 ID | |
| {AD_UNIT_NAME} | ad_unit_name | MAX 広告名 | |
| {AD_UNIT_TEST_NAME} | ad_unit_test_name | 広告テストグループ名 | |
| {ALL_REVENUE} | all_revenue | 見積もり収益には、FB Biddingの収益も含まれる | yes |
| {CC} | cc | Country Code | |
| {CUSTOM_DATA} | custom_data | SDKで設定されたカスタムデータ | |
| {EVENT_ID} | event_id | イベントユニークID | |
| {EVENT_TOKEN} | event_token | イベント Token（イベントのユニークのIDから生成） | |
| {EVENT_TOKEN_ALL} | event_token_all | グローバルイベントToken（イベントのユニークIDとすべてのリクエストパラメータマクロによって生成） | |
| {FORMAT} | format | 広告タイプ | |
| {IDFA} | idfa | iOSのIDFAまたはAndroidのGoogle広告ID | |
| {IDFV} | idfv | IDFV | |
| {IP} | ip | ユーザーのIP | |
| {NETWORK} | network | 広告表示のAd Network | |
| {NETWORK_PLACEMENT} | network_placement | Ad Network の内部 Placement 名 | |
| {PACKAGE_NAME} | package_name | パッケージ名、Android アプリのパッケージ名とiOSアプリのバンドルID（iOS） | |
| {PLACEMENT} | placement | SDK内でカスタムされたPlacement 名 | |
| {PLATFORM} | platform | プラットフォーム | |
| {PRECISION} | precision | 収益データの精度は、データのソースによって異なります： 1. publisher_defined：パブリッシャーが設定した価格 1. exact：リアルタイム入札の結果値 1. estimated：Auto CPMまたはFB Biddingからの推定値 1. undefined：収益を見積もるための十分なデータがありません | |
| {REVENUE} | revenue | 見積もり収益、FB Bidding時にその値は0 | yes |
| {TS} | ts | 広告露出時間 | yes |
| {USER_ID} | user_id | SDKの設定されたユーザーIDは、TEプロジェクトのゲストID | yes |
| {WATERFALL_NAME} | waterfall_name | 広告 Waterfall の名称 |
以下2.5章で入手したリターンURLの前半部分である、弊社がお勧めするコールバックアドレスです。「?」とその後の部分を端末 URL の後に追加して、AppLovin スタッフにて URL の設定（Server-to-Server Impression Revenue API を使用してください）を完了させてください。
https://{receiver-host}/attribution/callback/applovin/{app-id}?ad_unit_id={AD_UNIT_ID}&ad_unit_name={AD_UNIT_NAME}&ad_unit_test_name={AD_UNIT_TEST_NAME}&all_revenue={ALL_REVENUE}&cc={CC}&custom_data={CUSTOM_DATA}&event_id={EVENT_ID}&event_token={EVENT_TOKEN}&event_token_all={EVENT_TOKEN_ALL}&format={FORMAT}&idfa={IDFA}&idfv={IDFV}&ip={IP}&network={NETWORK}&network_placement={NETWORK_PLACEMENT}&package_name={PACKAGE_NAME}&placement={PLACEMENT}&platform={PLATFORM}&precision={PRECISION}&revenue={REVENUE}&ts={TS}&user_id={USER_ID}&waterfall_name={WATERFALL_NAME}
# 3.2 データの格納ルール
- データの中のuser_idをデータの中のゲストIDとして、このフィールドはTEプロジェクトの中のゲストIDに対応する必要があります。
- Ts フィールド、つまり広告表示时间をイベントの#event_timeとして使用します。
- デフォルトの设定を使用する场合、イベント名は--applovin_max_s2s_impression_revenueです。
- コールバックリンクに设定されている他のフィールドはすべて格納します。
# 3.3 標準化フィールド
以下のイベントプロパティは標準化処理されます：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| network_name | te_ads_object.media_source | メディアソース |
| ad_mediation_platform | te_ads_object.media_source | マネタイズチャネル |
| campaign_name | te_ads_object.campaign_name | 広告キャンペーン名 |
| google_ads_campaign_name | te_ads_object.campaign_name | 広告キャンペーン名（Google Adsのみ） |
| google_ads_campaign_id | te_ads_object.campaign_id | 広告キャンペーンID（Google Adsのみ） |
| adgroup_name | te_ads_object.ad_group_name | 広告グループ名 |
| google_ads_adgroup_name | te_ads_object.ad_group_name | 広告グループ名（Google Adsのみ） |
| google_ads_adgroup_id | te_ads_object.ad_group_id | 広告グループID（Google Adsのみ） |
| creative_name | te_ads_object.ad_name | 広告名 |
| google_ads_creative_id | te_ads_object.ad_id | 広告 ID（ Google Ads のみ） |
| ad_revenue_placement | te_ads_object.placement | 広告プレース |
| google_ads_placement | te_ads_object.placement | 広告プレース（Google Adsのみ） |
| cost_amount | te_ads_object.cost | コスト |
| cost_currency | te_ads_object.currency | コストの通貨 |
| revenue_usd | te_ads_object.revenue | 収益 |
| 【USD】固定値 | te_ads_object.currency | 収益の通貨 |
| country | te_ads_object.country | 国家地域コード |
| os_name | te_ads_object.platform | プラットフォームAndroid、iOSなど |
| app_id | te_ads_object.app_id | アプリ ID |
| app_name | te_ads_object.app_name | アプリ名 |