TopOn総合レポートクエリAPI
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| 総合レポートクエリAPI | API | 集約指標 | ✅ | ✅ | ✅ |
総合レポートとは、TopOnのデータレポートクエリAPIにおける総合レポートデータのことで、集約された広告マネタイズデータを提供します。表示、クリック、収益の指標が含まれます。
統合の流れ
- TopOnの管理画面にログインし、Publisher KeyとAPP IDを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでTopOn統合を追加して統合プランを作成し、一回取得を実行してデータを同期します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. TopOn管理画面での情報取得
データを取得する前に、まずTopOnの担当者にデータレポートクエリAPIの権限の開通を申請する必要があります。開通後、開発者管理画面のアカウント管理ページでPublisher Keyを確認できます。
次に、TopOn管理画面のアプリページで、データを統合するアプリのアプリIDを取得してください
2. プランの設定
Publisher KeyとApp IDを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を完了できます。下図はTopOn総合レポートクエリAPIの設定画面です。この章の内容に従ってプランを作成してください：
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに認証作業で取得した情報を入力します
補足：
-
APP ID：先ほど取得したアプリID
-
Publisher Key：先ほど取得したPublisher Key
-
Brand：旧TopOnは傘下の事業を分割しています（詳しくはこちらの記事を参照）。使用している具体的な事業ブランドを入力する必要があります
- Takuを使用している場合（公式サイトのアドレスはtakuad.com）は、
takuを入力します（入力しない場合もtakuとみなされます） - TopOnを使用している場合（公式サイトのアドレスはwww.toponad.com）は、
toponを入力します
- Takuを使用している場合（公式サイトのアドレスはtakuad.com）は、
2.2 定期取得
「定期取得」モジュールで、AEシステムがTopOn総合レポートクエリAPIのデータを定期的に取得する方針を設定できます。毎日の特定の時刻、または1時間ごとに、一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
2.3 取得タイムゾーン
取得するデータのタイムゾーンも設定できます。デフォルトはUTC+8です
2.4 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、コールバックされたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
2.5 統合構成
統合構成モジュールでは、データ取得の詳細な設定を制御できます。データ取得の指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
| source | metrics | データ内の指標。リスト型です。階層によって対応するmetricsが異なるため、入力時に注意が必要です |
| group_by | データ内のグループ化ディメンション。リスト型です。階層によって対応するgroup_byが異なるため、入力時に注意が必要です |
- グループ化ディメンション
下表は総合レポートクエリAPIが対応しているすべてのグループディメンションです。10日以内のデータをクエリする場合は最大6つ、10日より前のデータをクエリする場合は最大3つのグループディメンションを選択できます。time_zoneとcurrencyはグループディメンションの数に含まれません。調整が必要な場合は、グループディメンションをsource.group_byに追加してください：
| グループ化ディメンション | 格納フィールド名 | タイプ | デフォルトかどうか | 備考 |
|---|---|---|---|---|
| date | date | 文字列 | はい | 日付。形式：YYYYmmdd |
app | app_id | 文字列 | はい | 開発者管理画面のアプリID |
| app_name | 文字列 | はい | アプリ名 | |
| app_platform | 文字列 | はい | アプリのシステムプラットフォーム | |
| app_pkg_name | 文字列 | はい | アプリのパッケージ名 | |
| placement | placement_id | 文字列 | はい | 開発者管理画面の広告枠ID |
| placement_name | 文字列 | はい | 広告枠名 | |
adsource | adsource_network | 文字列 | はい | 広告ソースが属する広告プラットフォームの名前 |
| adsource_token_position_id | 文字列 | はい | 広告ソースの位置ID | |
| adsource_token_orientation | 文字列 | はい | 広告ソースの向き | |
| adsource_token_video_muted | 文字列 | はい | 広告がミュートかどうか | |
| adsource_token_app_id | 文字列 | はい | 広告ソースのApp ID | |
| adsource_token_app_name | 文字列 | はい | 広告ソースのApp名 | |
| adsource_id | 文字列 | はい | 広告ソースid | |
| adsource_name | 文字列 | はい | 広告ソース名 | |
| network_firm_id | network_firm_id | 文字列 | はい | 広告プラットフォームID |
| network_firm | 文字列 | はい | 広告プラットフォーム名 | |
必須 | time_zone | 文字列 | はい | タイムゾーン。列挙値：UTC+8、UTC+0、UTC-8 |
| currency | 文字列 | はい | 開発者アカウントの通貨。このフィールドとrevenueフィールドで構成される収益は、開発者管理画面のレポートの収益と一致する必要があります | |
adformat | adformat | 文字列 | 広告フォーマット。列挙値：Rewarded Video、Interstitial、Banner、Native、Splash | |
| area | area | 文字列 | 国（地域）コード | |
network | network | 文字列 | 広告プラットフォームのアカウントID | |
| network_name | 文字列 | 広告プラットフォームのアカウント名 | ||
| scenario | scenario_id | 文字列 | 広告シナリオID | |
| scenario_name | 文字列 | 広告シナリオ名 | ||
traffic_group | traffic_group_id | 文字列 | トラフィックグループid | |
| traffic_group_name | 文字列 | トラフィックグループ名 | ||
| traffic_group_segment_id | 文字列 | トラフィックグループの数値ID。注意：デフォルトのトラフィックグループの場合はsegment_id = 0で、返されません | ||
| channel | channel | 文字列 | チャンネル名 | |
| sdk_version | sdk_version | 文字列 | SDKバージョン | |
| app_version | app_version | 文字列 | アプリバージョン |
- 指標フィールド
デフォルトでは、以下のすべてのフィールドを格納します。調整が必要な場合は、source.metricsを変更してください：
| フィールド | 備考 |
|---|---|
| new_user_rate | 新規ユーザーの割合 |
| deu | DEU |
| engaged_rate | 浸透率 |
| imp_dau | 表示 / DAU |
| imp_deu | 表示 / DEU |
| impression_rate | 表示率 |
| dau | group_byの条件に応じて返されます |
| arpu | dauがある場合のみ返されます |
| request | リクエスト数 |
| fillrate | フィル率 |
| impression | 表示数 |
| click | クリック数 |
| ctr | クリック率 |
| ecpm | TopOnがレポートAPIを通じて広告プラットフォームから取得した実際の収益と、TopOnが集計した表示からeCPMを算出します。計算式：（収益/TopOnが集計した表示）*1000。注：eCPMは1日遅れで提供されます |
| revenue | サードパーティ広告プラットフォームの収益。通貨は開発者アカウントの通貨です |
| request_api | サードパーティ広告プラットフォームのリクエスト数 |
| fillrate_api | サードパーティ広告プラットフォームのフィル率 |
| impression_api | サードパーティ広告プラットフォームの表示数 |
| click_api | サードパーティ広告プラットフォームのクリック数 |
| ctr_api | サードパーティ広告プラットフォームのクリック率 |
| ecpm_api | TopOnがレポートAPIを通じて広告プラットフォームから取得した実際の収益と表示APIから、eCPM APIを算出します。計算式：（収益/表示API）*1000。注：eCPM APIは1日遅れで提供されます |
| estimate_revenue | 推定収益。通貨：米ドル |
estimate_revenue_ecpm | 推定収益とTopOnが集計した表示から推定eCPMを算出します。計算式：（推定収益/TopOnが集計した表示）*1000。注：1. 推定eCPMは当日提供されます。2. 通常の広告ソースは手動入力したeCPM価格に基づいて計算され、入札広告ソースはリアルタイムの入札価格に基づいて計算されます |
| ready_request | isReady呼び出し回数 |
| ready_rate | isReady成功率 |
| cy_estimate_revenue | 開発者アカウントの通貨で返される推定収益 |
| cy_estimate_revenue_ecpm | 開発者アカウントの通貨で返される推定eCPM。計算方法はestimate_revenue_ecpmと同じです |
2.6 イベントの格納ルール
デフォルトでは、取得したデータはイベントとしてAEプロジェクトに書き込まれます：
- 総合レポートクエリAPIが返すのは集約データであるため、固定値をユーザー識別子として使用します。すべてのデータが1人の仮想ユーザーに紐付けられていると考えてください
- データ内のdateフィールド、つまりデータの日付を、集計データの#event_timeとして設定します
- データのイベント名は topon_fullreport です
- その他のフィールドはすべて格納されます
2.7 標準化フィールド
TopOn総合レポートクエリAPIの一部のフィールドについて、AEシステムは標準化処理を行います
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| adsource_name | te_ads_object.ad_name | 広告名 |
| adsource_id | te_ads_object.ad_id | 広告ID |
| placement_name | te_ads_object.placement | 広告の配置 |
| network_firm | te_ads_object.media_source | マネタイズチャンネル |
| app_pkg_name | te_ads_object.app_id | アプリID |
| app_name | te_ads_object.app_name | アプリ名 |
| app_platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| area | te_ads_object.country | 国・地域コード |
| currency | te_ads_object.currency | コストまたは収益の通貨 |
| impression | te_ads_object.impressions | 露出数 |
| click | te_ads_object.clicks | クリック数 |
| revenue | te_ads_object.revenue | マネタイズ収益 |