ironSource Impression Level Revenue API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Impression Level Revenue API | API | ユーザーデータ | ✅ | ✅ |
Impression Level Revenue APIは、ユーザー粒度の広告表示データを提供します。これらのデータから、ユーザーごとの収益状況や、ユーザーごとの広告表示状況を分析できます。
統合の流れ
- ironSource SDKでAE SDKのユーザー識別フィールドを設定します
- ironSourceの管理画面にログインし、App Key、Secret Key、Refresh Tokenを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでironSource Impression Level Revenue APIプランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. クライアントSDKの設定
ironSourceのユーザーデータをAEプロジェクトと関連付けるには、ironSourceのsetUserId()メソッドを使用して、AEのゲストIDをironSourceのUserIdとして設定する必要があります：
1.1 方法1（自動統合）
-
統合しているAndroid、iOS SDKについて
- SDKのバージョンが2.8.0~2.8.1の場合は、この方法をそのまま使用できます
- SDKのバージョンが2.8.2以上の場合は、サードパーティデータプラグインもインストールする必要があります。詳しくはAndroid SDKのサードパーティデータとiOS SDKのサードパーティデータを参照してください
-
統合しているUnity SDKのバージョンが2.4.0以上、Unreal SDKのバージョンが1.5.0以上の場合は、この方法をそのまま使用できます
AE SDKの初期化はironSourceのSDKの初期化より前に完了する必要があります。また、ironSourceのSDKの初期化後、すぐに自動統合コードを有効にしてください。次の手順に従って操作してください：
1. AE SDKを初期化します。
2. ironSource SDKを初期化します
3. `enableThirdPartySharing`を呼び出して、ゲストIDを自動設定します。
各プラットフォームのSDKのコードサンプルは次のとおりです：
- Android
- iOS
- Unity
- Unreal
// 1. Android SDKを初期化
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2. ironSource SDKを初期化
// 。。。
// 3. enableThirdPartySharingインターフェースを呼び出し、ta_distinct_idをironSourceイベントに設定
TDAnalytics.enableThirdPartySharing(TDThirdPartyType.IRON_SOURCE);
// 1. iOS SDKを初期化
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
config.mode = TDModeDebug;
[TDAnalytics startAnalyticsWithConfig:config];
// 2. ironSource SDKを初期化
// 。。。
// 3. enableThirdPartySharingインターフェースを呼び出し、ta_distinct_idをironSourceイベントに設定
[TDAnalytics enableThirdPartySharing:TDThirdPartyTypeIronSource];
// 1. Unity SDKを初期化
TDConfig config = new TDConfig("APPID","SERVER");
TDAnalytics.Init(config);
// 2. ironSource SDKを初期化
// 。。。
//3. enableThirdPartySharingインターフェースを呼び出し、ta_distinct_idをironSourceイベントに設定
TDAnalytics.EnableThirdPartySharing(TDThirdPartyType.IRONSOURCE);
// 1. Unreal SDKを初期化
UTDAnalytics::Initialize();
// 2. ironSource SDKを初期化
// 。。。
// 3. enableThirdPartySharingを呼び出し、ta_distinct_idをironSourceイベントに設定
TArray<FString> EventTypeList;
EventTypeList.Emplace(TEXT("TAThirdPartyShareTypeIRONSOURCE"));
UTDAnalytics::EnableThirdPartySharing(EventTypeList, AppID);
1.2 方法2（手動統合）
手動統合プランでは、ironSource SDKでsetUserId()インターフェースを使用して、AEプロジェクトのゲストIDを設定する必要があります。
AEのSDKの初期化はironSourceのSDKの初期化より前に完了する必要があり、setUserIdインターフェースの呼び出しはironSourceのSDKの初期化後に行う必要がある点にご注意ください。次の手順に従って操作してください：
1. AE SDKを初期化します。
2. ironSource SDKを初期化します。
3. `setUserId`を呼び出してゲストIDを設定します。
各SDKの手動統合のコードサンプルは次のとおりです：
- Android
- iOS
- Unity
// 1. Android SDKを初期化
TDConfig config = TDConfig.getInstance(this, APPID, TE_SERVER_URL);
TDAnalytics.init(config);
// 2. ironSource SDKを初期化
// 。。。
// 3. AEのゲストIDを取得（AEの#distinct_idに対応）
String distinctId = TDAnalytics.getDistinctId();
// 4. AEのゲストIDをironSourceのUser IDとして設定
IronSource.setUserId(distinctId);
// 1. iOS SDKを初期化
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
config.mode = TDModeDebug;
[TDAnalytics startAnalyticsWithConfig:config];
// 2. ironSource SDKを初期化
// 。。。
// 3. AEのゲストIDを取得（AEの#distinct_idに対応）
NSString *distinctId = [TDAnalytics getDistinctId];
// 4. ゲストIDをironSourceの収集イベントに設定
[IronSource setUserId:distinctId];
// 1. Unity SDKを初期化
TDConfig config = new TDConfig("APPID","SERVER");
TDAnalytics.Init(config);
// 2. ironSource SDKを初期化
// 。。。
// 3. AEのゲストIDを取得（AEの#distinct_idに対応）
var distinctId = TDAnalytics.GetDistinctId();
// 4. ゲストIDをironSourceの収集イベントに設定
IronSource.Agent.setUserId(distinctId);
2. 認証情報の取得
次に、ironSourceの管理画面にログインし、必要な認証情報を取得します
- まず、右上のユーザーメニューをクリックし、「My Account」ページの「Reporting API」タブに移動して、Secret KeyとRefresh Tokenを取得します
- 次に、ironSource管理画面の「Ad Unit」ページに移動し、「APPLICATIONS」リストで統合したいアプリを選択します。右側のカードにそのアプリのApp Keyが表示されるので、控えておきます（iOSとAndroidは別々になっている点に注意してください。両方のプラットフォームのデータを統合する場合は、プランを2つ設定し、それぞれのApp Keyを入力する必要があります）
3. プランの設定
SDKの設定が完了したら、次にAEシステムの管理画面にログインし、「サードパーティ統合」モジュールでironSource Impression Level Revenue APIの設定を行います。下図はironSourceの設定画面です：
3.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに認証作業で取得した情報を入力します（Refresh Tokenは、先に編集アイコンをクリックすると入力欄が表示されます）
3.2 定期取得
「定期取得」モジュールで、AEシステムがironSource Impression Level Revenue APIのデータを定期的に取得する方針を設定できます。毎日の特定の時刻、または1時間ごとに、一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
3.3 ユーザー識別フィールド
ironSource Impression Level Revenue APIが提供するのはユーザーレベルのデータであるため、ユーザー識別ルールを設定する必要があります。AEシステムはこの設定に基づき、取得したデータを変換する際に、これらのフィールドをデータ内のユーザー識別フィールドとして設定します。
本ドキュメントに従ってクライアントSDKを設定した場合は、以下の設定を使用してください：
- アカウントID関連フィールド：なし
- ゲストID関連フィールド：user_id
3.4 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、コールバックされたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
3.5 ユーザープロパティの格納設定
デフォルトでは、AEシステムはironSource Impression Level Revenue APIのデータをユーザープロパティに書き込みません。一部のフィールドをユーザーテーブルに書き込みたい場合は、まずルールをオンにして実行状態にし、次にプロパティのマッピング機能でユーザーテーブルに書き込むフィールドを追加します。ソースプロパティ名にはフィールドの格納名を入力してください：
3.6 統合構成
統合構成モジュールで、データ取得の詳細な設定を制御できます。たとえば、格納後のイベント名などです。
統合構成はJSONで、必要に応じて内容を調整できます
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
| transfer | double_columns | 数値型に変換される指標フィールドです。その他の格納フィールドはすべて文字列型で格納されます。調整はお勧めしません |
3.7 データの格納ルール
- データ内のuser_idをデータのゲストIDとして使用します。このフィールドはAEプロジェクトのゲストIDに対応している必要があります
- データ内のevent_timestampフィールド（広告表示時刻）を、イベントの#event_timeとして使用します
- データのイベント名は ironsource_ad_revenue_impression_level です
- その他のフィールドはすべて格納されます。以下はImpression Level Revenue APIが返すフィールドです：
- ディメンションフィールド
| フィールド名 | 説明 | 値の例 |
|---|---|---|
| event_timestamp | 露出のタイムスタンプ | 2021-09-01 11:26:46 |
| #zone_offset | タイムゾーン（AEプリセットプロパティ） | 0（固定値） |
| advertising_id | ユーザーの広告ID（GAID / IDFA） | 137cf2f0-609c-4ae3-ab64-ed5c0d7392fd |
| advertising_vendor_id | ユーザーのVendor ID（app Set ID / IDFV） | A0810F0B-16C2-474B-B765-77B3A3113AA2 |
| user_id | ユーザーが設定したUser ID（「1. クライアントSDKの設定」で設定したユーザーID） | c7d9fed7-aa40-4bfa-918f-8d4b155bfd4b |
| ad_unit | 広告ユニット | rewarded_video |
| ad_network | 広告メディア | Admob |
| instance_name | インスタンス名 | Bidding, High |
| country | 国（地域）コード | US |
| placement | プレースメント | Home_Screen |
| segment | ユーザーが割り当てられたトラフィックグループ名 | Tier 1 |
| AB_Testing | A/B Testタグ | A,B |
| app_key | アプリKey | |
| app_name | アプリ名 | |
| platform | プラットフォーム | iOS, android |
- 指標フィールド
| フィールド名 | 説明 | 値の例 |
|---|---|---|
| revenue | 収益額 | 0.5 |
3.8 標準化フィールド
次のイベントプロパティは標準化処理されます：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| ad_network | te_ads_object.media_source | マネタイズチャンネル |
| ad_unit | te_ads_object.ad_group_name | マネタイズ広告のUnit名 |
| placement | te_ads_object.placement | マネタイズ広告の配置 |
| app_name | te_ads_object.app_name | アプリ名 |
| country | te_ads_object.country | 国・地域コード |
| platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| 【USD】固定値 | te_ads_object.currency | マネタイズ収益の通貨 |
| revenue | te_ads_object.revenue | マネタイズ収益 |