TradPlus総合レポートクエリAPI
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| 総合レポートクエリAPI | API | 集約指標 | ✅ | ✅ | ✅ |
総合レポートクエリAPIは、広告マネタイズの集約指標データを提供します。広告表示回数、クリック回数、収益などの指標が含まれます。
統合の流れ
- TradPlusの管理画面にログインし、Access TokenとアプリIDを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでTradPlus総合レポートクエリAPIの統合プランを追加します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. TradPlus管理画面での情報取得
まずTradPlusの管理画面にログインし、Access TokenとアプリIDを取得する必要があります
- Access tokenは、TradPlus管理画面の「マイアカウント」-「レポートAPI key」で「key を生成」をクリックして取得できます
- アプリIDは「アプリ管理」-「アプリ & 広告枠」で確認できます
2. プランの設定
Access TokenとアプリIDを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を完了できます。下図はTradPlus総合レポートクエリAPIの設定画面です。この章の内容に従ってプランを作成してください：
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに認証作業で取得した情報を入力します
2.2 定期取得
「定期取得」モジュールで、AEシステムがTradPlus総合レポートクエリAPIのデータを定期的に取得する方針を設定できます。毎日の特定の時刻、または1時間ごとに、一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
2.3 取得タイムゾーン
取得するデータのタイムゾーンも設定できます。デフォルトはUTC+8です
2.4 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、コールバックされたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
2.5 統合構成
統合構成モジュールでは、データ取得の詳細な設定を制御できます。データ取得の指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
| source | metrics | データ内の指標。リスト型です。階層によって対応するmetricsが異なるため、入力時に注意が必要です |
| group_by | データ内のグループ化ディメンション。リスト型です。階層によって対応するgroup_byが異なるため、入力時に注意が必要です |
- グループ化ディメンション
下表は総合レポートクエリAPIが対応しているすべてのグループディメンションです。一部のディメンションを追加すると、一部の指標フィールドをクエリできなくなる場合がありますのでご注意ください。調整が必要な場合は、グループ項目をsource.group_byに追加してください：
| グループ項目 | フィールド | デフォルト | 備考 |
|---|---|---|---|
| date | date | はい | 日付。形式：YYYY-mm-dd |
| appId | app_id | はい | アプリID（TradPlus） |
| platform | はい | アプリのシステムプラットフォーム（1 Android、2 iOS） | |
| package_name | はい | パッケージ名 | |
| placementId | placement_id | はい | 広告枠ID（TradPlus） |
| placement_name | はい | 広告枠名（TradPlus） | |
| adFormat | ad_format | はい | 広告枠タイプ |
| ad_format_name | はい | 広告枠タイプ名 | |
| area | area | はい | 国・地域コード（ISO 3166-1の2文字の国・地域コード） |
| network | network | はい | 広告ネットワークID |
| network_name | はい | 広告ネットワーク名 | |
| networkPlacementId | network_placement_id | はい | 広告ネットワークの広告枠ID情報 |
| network_placement_name | はい | 広告ネットワークの広告ソース名（TradPlus） | |
| network_placement_info | はい | 広告ネットワークの広告枠の詳細情報 | |
| adSceneId | ad_scene_id | 広告シナリオID | |
| ad_scene_name | 広告シナリオ名 | ||
| sdk | sdk | SDKバージョン | |
| channel | channel | チャネル | |
| appVersion | app_version | アプリバージョン | |
| idfa | idfa | IDFA許可 | |
| bucketId | bucket_id | A/Bテストグループ |
- 指標フィールド
デフォルトでは、一部のフィールドを選択して格納します。調整が必要な場合は、指標フィールド名をsource.metricsに入力してください：
| 指標フィールド | 格納名 | デフォルト | 備考 |
|---|---|---|---|
| dau | dau | はい | TradPlusが集計した1日のアクティブユーザー数（appレベル） |
| deu | deu | はい | TradPlusが集計した1日あたりの広告視聴ユーザー数 |
| arpu | arpu | はい | TradPlusが集計したユーザーあたりの平均収益 |
| newUsers | new_users | はい | TradPlusが集計した新規ユーザー（appレベル） |
| newUserRate | new_user_rate | はい | TradPlusが集計した新規ユーザーの割合（appレベル） |
| bidRequestApi | bid_request_api | サードパーティ広告ネットワークの入札リクエスト数 | |
| bidResponseApi | bid_response_api | サードパーティ広告ネットワークの入札レスポンス数 | |
| bidResponseRateApi | bid_response_rate_api | サードパーティ広告ネットワークの入札レスポンス率 | |
| bidWinRateApi | bid_win_rate_api | サードパーティ広告ネットワークの入札勝率 | |
| requestApi | request_api | はい | サードパーティ広告ネットワークのリクエスト数 |
| fillApi | fill_api | はい | サードパーティ広告ネットワークのフィル数 |
| fillrateApi | fillrate_api | はい | サードパーティ広告ネットワークのフィル率 |
| impressionApi | impression_api | はい | サードパーティ広告ネットワークの表示数 |
| clickApi | click_api | はい | サードパーティ広告ネットワークのクリック数 |
| ctrApi | ctr_api | はい | サードパーティ広告ネットワークのクリック率 |
| ecpmApi | ecpm_api | はい | サードパーティ広告ネットワークのECPM |
| revenue | revenue | はい | サードパーティ広告ネットワークの収益 |
| appRequest | app_request | TradPlusが集計したアプリのリクエスト数 | |
| enterAdScene | enter_ad_scene | TradPlusが集計した広告シナリオへの進入回数 | |
| enterAdSceneUsers | enter_ad_scene_users | TradPlusが集計した広告シナリオへの進入ユーザー数 | |
| bidRequest | bid_request | TradPlusが集計した入札リクエスト数 | |
| bidResponse | bid_response | TradPlusが集計した入札レスポンス数 | |
| bidResponseRate | bid_response_rate | TradPlusが集計した入札レスポンス率 | |
| bidWinRate | bid_win_rate | TradPlusが集計した入札勝率 | |
| request | request | はい | TradPlusが集計したリクエスト数 |
| fill | fill | はい | TradPlusが集計したフィル数 |
| fillrate | fillrate | はい | TradPlusが集計したフィル率 |
| impression | impression | はい | TradPlusが集計した表示回数 |
| impressionRatio | impression_ratio | はい | TradPlusが集計した表示の割合 |
| click | click | はい | TradPlusが集計したクリック回数 |
| clickUsers | click_users | はい | TradPlusが集計したクリックユーザー数 |
| ctr | ctr | はい | TradPlusが集計したクリック率 |
| estimateRevenue | estimate_revenue | はい | TradPlusが集計した推定収益 |
| eventRevenue | event_revenue | はい | TradPlusが集計したトラッキング収益 |
2.6 データの格納ルール
デフォルトでは、取得したデータはイベントとしてAEプロジェクトに書き込まれます：
- データ内のdateフィールド、つまりデータの日付を、イベントの#event_timeとして使用します
- データのイベント名は tradplus_allreport です
- その他のフィールドはすべて格納されます
2.7 標準化フィールド
TradPlusデバイスレベルデータレポートの一部のフィールドについて、AEシステムは標準化処理を行います
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| network_name | te_ads_object.media_source | マネタイズチャンネル |
| package_name | te_ads_object.app_id | アプリID |
| platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| package_name | te_ads_object.placement | 広告の配置 |
| area | te_ads_object.country | 国・地域コード |
| impression | te_ads_object.impressions | 露出数 |
| click | te_ads_object.clicks | クリック数 |
| revenue | te_ads_object.revenue | マネタイズ収益 |