ironSource Reporting API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Reporting API | API | 集約指標 | ✅ | ✅ | ✅ |
Reporting APIは、ironSourceの集約指標データのインターフェースです。このインターフェースを通じて、露出、収益、ユーザーのアクティブなどの集約された指標データを取得できます。
統合の流れ
- ironSourceの管理画面にログインし、App Key、Secret Key、Refresh Tokenを取得します
- AE管理画面にログインし、「サードパーティ統合」モジュールでironSource Reporting APIプランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. 認証情報の取得
まず、ironSourceの管理画面にログインし、必要な認証情報を取得します
- まず、右上のユーザーメニューをクリックし、「My Account」ページの「Reporting API」タブに移動して、Secret KeyとRefresh Tokenを取得します
- 次に、ironSource管理画面の「Ad Unit」ページに移動し、「APPLICATIONS」リストで統合したいアプリを選択します。右側のカードにそのアプリのApp Keyが表示されるので、控えておきます（iOSとAndroidは別々になっている点に注意してください。両方のプラットフォームのデータを統合する場合は、プランを2つ設定し、それぞれのApp Keyを入力する必要があります）
2. プランの設定
認証情報の取得が完了したら、次にAEシステムの管理画面にログインし、「サードパーティ統合」モジュールでironSource Reporting APIの設定を行います。下図はironSourceの設定画面です：
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに認証作業で取得した情報を入力します
2.2 定期取得
「定期取得」モジュールで、AEシステムがironSource Reporting APIのデータを定期的に取得する方針を設定できます。毎日の特定の時刻、または1時間ごとに、一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
2.3 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、コールバックされたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
2.4 統合構成
統合構成モジュールでは、データ取得の詳細な設定を制御できます。たとえば、格納後のイベント名、取得する指標、任意のディメンションなどです。
統合構成はJSONで、必要に応じて内容を調整できます
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
| source | metrics | データ内の指標ディメンション。リスト型で、カスタマイズ可能 |
| group_by | データ内のグループ化ディメンション。リスト型。カスタマイズ可能 |
- 選択可能なディメンション
以下はReporting APIで選択可能なディメンションです。分析ディメンションごとに対応できる指標は異なります。具体的な対応関係については、ironSource公式ドキュメントを参照してください。調整が必要な場合は、必要なディメンション名をsource.group_byに記述してください
| ディメンション名 | 格納フィールド名 | 説明 | デフォルトかどうか | 備考 |
|---|---|---|---|---|
| date | date | データ時間 | はい | |
| adUnits | adUnits | 広告ユニット | はい | |
app | appKey | アプリKey | はい | |
| bundleId | アプリID | はい | ||
| appName | アプリ名 | はい | ||
| platform | platform | アプリのプラットフォーム | はい | |
| adSource | providerName | 広告ソース | はい | |
| instance | instanceName | インスタンス名 | segment、placementと排他 | |
| instanceId | インスタンスID | |||
| country | countryCode | 国（地域）コード | はい | |
| segment | segment | ユーザーが割り当てられたトラフィックグループ名 | instance、placementと排他 | |
| placement | placement | プレースメント | instance、segmentと排他 | |
| osVersion | osVersion | OS バージョン | 最大4つから1つを選択 | |
| connectionType | connectionType | ネットワーク接続タイプ | ||
| sdkVersion | sdkVersion | SDKバージョン | ||
| appVersion | appVersion | アプリバージョン | ||
| att | att | ATTステータス | ||
| idfa | idfa | IDFAが利用可能かどうか | ||
| abTest | abTest | A/B Testタグ |
- 指標フィールド
以下はReporting APIが対応している指標のリストです。デフォルトではすべてのフィールドを取得します。利用可能な指標は分析ディメンションの影響を受けるため、実際に受信する指標は下表の内容より少なくなります。調整が必要な場合は、必要なフィールド名をsource.metricsに記述してください
| フィールド名 | 説明 |
|---|---|
| revenue | 総収益 |
| eCPM | eCPM |
| appFillRate | 広告フィル率（露出数 / リクエスト数） |
| appRequests | 広告リクエスト数 |
| impressions | 露出数 |
| completions | 完了数
|
| revenuePerCompletion | 平均完了収益額（収益 / 完了数） |
| appFills | 広告フィル数 |
| useRate | 広告の露出数とフィル数の比率 |
| activeUsers | DAU |
| engagedUsers | 広告エンゲージユーザー数 |
| engagedUsersRate | 広告エンゲージユーザーの割合 |
| impressionsPerEngagedUser | 広告エンゲージユーザーあたりの平均広告露出数 |
| revenuePerActiveUser | ARPU値（単位はセント） |
| revenuePerEngagedUser | 広告エンゲージユーザーのARPU値（単位はセント） |
| clicks | 総クリック数 |
| clickThroughRate | クリック率（CTR） |
| completionRate | 完了率 |
| adSourceChecks | 広告ソースが広告の利用可否を確認した回数 |
| adSourceResponses | 広告ソースがレスポンスを返した回数 |
| adSourceAvailabilityRate | 広告の利用可能率（露出数 / 広告レスポンス数） |
| sessions | Session数 |
| engagedSessions | 広告エンゲージがあったSession数 |
| impressionsPerSession | Sessionあたりの平均露出数 |
| impressionPerEngagedSessions | 広告エンゲージがあったSessionあたりの平均露出数 |
| sessionsPerActiveUser | ユーザーあたりの平均Session数 |
2.5 イベントの格納ルール
- データ内のdateフィールド（データ時間）を、イベントの#event_timeとして使用します
- データのイベント名は ironsource_reporting_level です
- その他のフィールドはすべて格納されます
2.6 標準化フィールド
次のイベントプロパティは標準化処理されます：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| providerName | te_ads_object.media_source | マネタイズチャンネル |
| adUnits | te_ads_object.ad_group_name | マネタイズ広告のUnit名 |
| placement | te_ads_object.placement | 広告の配置 |
| countryCode | te_ads_object.country | 国・地域コード |
| platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| bundleId | te_ads_object.app_id | アプリID |
| appName | te_ads_object.app_name | アプリ名 |
| impressions | te_ads_object.impressions | 露出数 |
| clicks | te_ads_object.clicks | クリック数 |
| revenue | te_ads_object.revenue | マネタイズ収益 |