Tenjin Reporting Metrics API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Reporting Metrics API | API | 集約指標 | ✅ | ✅ | ✅ | ✅ | ✅ |
Tenjinは、集約指標データを取得するインターフェース――Reporting Metrics APIも提供しており、以下のデータを取得できます：
- コストデータ：広告主データと考えることができ、コスト、クリック、露出、総収益などのデータが含まれます
- 収益データ：パブリッシャーデータと考えることができ、マネタイズ広告の露出、クリック、およびより詳細な収益データが含まれます
統合の流れ
- Tenjinの管理画面にログインし、Access Tokenを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでTenjin Reporting Metrics APIを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. Access Tokenの取得
Tenjinデータを統合する最初のステップとして、Tenjinの管理画面にログインし、ナビゲーションバーでAUTOMATE -> API Access Tokensを順にクリックします。
下図のページでAccess tokenキーを作成します。Tokenの作成時には名前を付けることができ、そのTokenの用途を名前にすることができます。名前は後から変更でき、使用には影響しません。
Access tokenキーを作成した後は、この画面でいつでもキーをコピーできます。アクセスの取り消しもこの画面で行います。このTokenをコピーしてください。
2. プランの設定
TenjinのAccess Tokenを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を完了できます。下図はTenjin Reporting Metrics APIの設定画面です。この章の内容に従ってプランを作成してください
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに前の手順で取得したAccess Tokenを入力します：
2.2 定期取得
「定期取得」モジュールで、AEシステムがTenjin Reporting Metrics APIのデータを定期的に取得する方針を設定できます。毎日の特定の時刻に一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
2.3 格納設定
データをイベントとして書き込むかどうかを制御できます。オフにすると、データはイベントテーブルに書き込まれなくなるため、この設定はオフにしないでください。
2.4 統合構成
最後に、統合構成モジュールでデータ取得の詳細設定を制御できます。データの時間集計粒度、取得する指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_mapping | 格納後のイベント名。カスタマイズ可能で、JSON型です。Keyはレポートタイプに対応し、Valueはそのレポートタイプの格納後のイベント名です。 |
| source | report_types | 取得するレポートタイプ。Tenjin Reporting Metrics APIは2種類のレポートタイプに対応しています。リスト型で、要素は1つだけ入力すること、つまり一度に1つのレポートのデータのみを取得することをお勧めします 選択可能な値：spend、ad_revenue。詳しくは以降の内容を参照してください |
| metrics | データ内の指標。リスト型。レポートタイプによって対応するmetricsが異なるため、入力時に注意が必要です | |
| group_by | データ内のグループ化ディメンション。リスト型。レポートタイプによって対応するgroup_byが異なるため、入力時に注意が必要です |
レポートタイプによってデータの設定が大きく異なるため、各レベルの設定テンプレートをそのまま使用するか、テンプレートを微調整することをお勧めします
2.4.1 Spendテンプレート
Spendテンプレートは、APIのコストデータ、つまり広告主データの取得に対応しています。以下はこのインターフェースのテンプレートで、全文をそのまま統合構成にコピーできます。調整が必要な場合は、この節の内容を参照してください：
{
"sink_event": {
"event_mapping": {
"spend": "tenjin_spend_data",
"ad_revenue": "tenjin_ad_revenue_data"
}
},
"source": {
"group_by": [
"campaign",
"country"
],
"report_types": [
"spend"
],
"metrics": [
"spend",
"cpc",
"cpi",
"tcpi",
"cpm",
"total_rev",
"revenues",
"pub_rev",
"clicks",
"tracked_clicks",
"impressions",
"installs",
"tracked_installs",
"ctr",
"cvr",
"users"
]
}
}
- 分析ディメンション
コストデータには以下の分析ディメンションがあります。デフォルトではcampaign, countryを分析ディメンションとして使用しますが、必要に応じて他の分析ディメンションを選択することもできます。調整が必要な場合は、分析ディメンションをsource.group_byに記述してください：
| 分析ディメンション | 含まれるディメンションフィールド | デフォルトかどうか |
|---|---|---|
| app | app_id, bundle_id | |
| channel | ad_network_name, ad_network_id, ad_network_icon_url | |
| country | country | |
| platform | platform | |
| site | site_id | |
| campaign | campaign_name, campaign_id, ad_network_name, ad_network_id, ad_network_icon_url, app_id, app_name, bundle_id, store_id, app_icon_url, channel, platform | |
campaign, country | campaign_name, campaign_id, ad_network_name, ad_network_id, ad_network_icon_url, app_id, app_name, bundle_id, store_id, app_icon_url, channel, platform, country | はい |
| channel, app | ad_network_name, ad_network_id, ad_network_icon_url, app_id, bundle_id | |
| channel, app, country | ad_network_name, ad_network_id, ad_network_icon_url, app_id, bundle_id, country |
- 対象指標
一部の主要指標にはレポート値とトラッキング値があります。デフォルトではレポート値を選択しています。トラッキング値に変更する必要がある場合は、データの論理的な一貫性を保つため、これらの指標をすべてトラッキング値に変更することをお勧めします。統合する指標を調整する場合は、APIフィールド名をsource.metricsに記述してください：
| APIフィールド | フィールド名 | 意味 | デフォルトかどうか |
|---|---|---|---|
| spend | 総費用 | 総支出額（$） | はい |
| cpc | CPC | 平均CPC（$） | はい |
| cpi | CPI | レポートされたインストールあたりのコスト（$） | はい |
| tcpi | トラッキングされたインストールのCPI | トラッキングされたインストールあたりのコスト（$） | はい |
| cpm | CPM | 平均CPM（$） | はい |
cp_ksessions_Nd | N日目の1000 Sessionsあたり平均コスト | N日目の1000 Sessionsあたりの平均コスト（$） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| cp_user_Nd | N日目の継続ユーザーあたりコスト | N日目の継続ユーザーの平均コスト（$） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| roas_Nd | N日目ROAS | N日目のROAS（%） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| roi_Nd | N日目ROI | N日目のROI（%） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| total_rev | 総収入 | 総収益額（$） | はい |
| total_arpu | 総ARPU値 | アプリ内課金と広告を含むARPU値（$） | |
| total_rev_Nd | N日目LTV | N日目のLTV（$） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| rpu_Nd | N日目総収益LTV / ユーザー数 | N日目のLTVをDAUで割った値（$） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| revenues | アプリ内課金収入 | アプリ内課金の収益（$） | はい |
| iap_arpu | アプリ内課金ARPU値 | アプリ内課金のみを含むARPU値（$） | |
| revenues_Nd | N日目アプリ内課金収益LTV | N日目のアプリ内課金収益のLTV（$） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| iap_rpu_Nd | N日目アプリ内課金収益LTV / User | N日目のIAPのみで計算したLTV値をDAUで割った値（$） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| pub_rev | 広告収入 | 広告総収益（$） | はい |
| pub_arpu | 広告収益ARPU値 | 広告収益のみを含むARPU値（$） | |
| pubrev_Nd | N日目広告収益LTV | N日目の広告収益のLTV（$） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| pub_rpu_Nd | N日目広告収益LTV / ユーザー数 | N日目の広告収益のLTVをDAUで割った値（$） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| fraud_purchases | 不正購入数 | 不正購入の回数 | |
| fraud_revenue | 不正収益 | ブロックされた不正購入の収益（$） | |
| clicks | レポートクリック数 | レポートされた総クリック数 | はい |
| clicks_difference | クリック差異数 | レポートクリックとトラッキングクリックの差 | |
| clicks_difference_pct | クリック差異の割合 | レポートクリックとトラッキングクリックの差異の割合（%） | |
| tracked_clicks | トラッキングクリック数 | トラッキングされたクリック数 | はい |
| blocked_clicks | ブロックされたクリック数 | ブロックされたクリックの回数 | |
| impressions | レポート露出数 | レポートされた露出数 | はい |
| tracked_impressions | トラッキング露出数 | トラッキングされた露出数 | |
| installs | レポートインストール数 | レポートされたインストール数 | はい |
| installs_difference | インストール差異数 | レポートインストールとトラッキングインストールの差 | |
| installs_difference_pct | インストール差異の割合 | レポートインストールとトラッキングインストールの差異の割合（%） | |
| tracked_installs | トラッキングインストール数 | トラッキングされたインストール数 | はい |
| ctr | CTR | 平均CTR（%） | はい |
| cvr | CVR | 平均CVR（%） | はい |
| all_fraud | 不正イベント数 | 不正イベントの総数 | |
| blocked_device_events | ブロックされたデバイスイベント数 | ブロックされたデバイスイベントの数 | |
| cpr | Completion Rate (CPR) | 平均CPR Percentage（%） | |
| sessions | Session数 | 平均Sessions数 | |
| sessions_Nd | N日目Session数 | N日目のSessions数 Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| users | DAU | 平均DAU | はい |
| retention_Nd | N日目継続率 | N日目の継続率（%） Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| users_Nd | N日目継続人数 | N日目の継続ユーザー数 Nの範囲：0, 1, 2, 3, 4, 5, 6, 7, 14, 30, 60, 90, 120 | |
| tracked_cvr | トラッキングコンバージョン率 | トラッキングされたコンバージョン率（%） |
- 格納ルール
データ内のdayフィールド、つまりデータの日付を、集計データの#event_timeとして設定します
テンプレートで使用されるイベント名は -- tenjin_spend_data です
2.4.2 Ad Revenueテンプレート
Ad Revenueテンプレートは、APIの収益データ、つまりパブリッシャーデータの取得に対応しています。以下はこのインターフェースのテンプレートで、全文をそのまま統合構成にコピーできます。調整が必要な場合は、この節の内容を参照してください：
{
"sink_event": {
"event_mapping": {
"spend": "tenjin_spend_data",
"ad_revenue": "tenjin_ad_revenue_data"
}
},
"source": {
"group_by": [
"channel",
"app",
"country"
],
"report_types": [
"ad_revenue"
],
"metrics": [
"ad_revenue",
"clicks",
"ecpc",
"ecpm",
"impressions"
]
}
}
- 分析ディメンション
収益データには以下の分析ディメンションがあります。デフォルトではchannel, app, countryを分析ディメンションとして使用しますが、必要に応じて他の分析ディメンションを選択することもできます。調整が必要な場合は、分析ディメンションをsource.group_byに記述してください：
| 分析ディメンション | デフォルトかどうか |
|---|---|
| app | |
| channel | |
| country | |
| channel, app | |
| channel, app, country | はい |
| ad_placement |
- 対象指標
一部の主要指標にはレポート値とトラッキング値があります。デフォルトではレポート値を選択しています。トラッキング値に変更する必要がある場合は、データの論理的な一貫性を保つため、これらの指標をすべてトラッキング値に変更することをお勧めします。統合する指標を調整する場合は、APIフィールド名をsource.metricsに記述してください：
| APIフィールド | デフォルトかどうか | 意味 |
|---|---|---|
| ad_revenue | はい | 総収益 |
| clicks | はい | 総クリック数 |
| ecpc | はい | eCPC（クリックあたりの収益） |
| ecpm | はい | eCPM（1000回表示あたりの収益） |
| impressions | はい | 総露出数 |
- 格納ルール
データ内のdayフィールド、つまりデータの日付を、集計データの#event_timeとして設定します
テンプレートで使用されるイベント名は -- tenjin_ad_revenue_data です
2.5 標準化フィールド
データに次のイベントプロパティが存在する場合は、自動的に標準化処理を行います：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| campaign_name | te_ads_object.campaign_name | 広告キャンペーン名 |
| campaign_id | te_ads_object.campaign_id | 広告キャンペーンID |
| ad_network_name | te_ads_object.media_source | メディアチャンネルまたはマネタイズチャンネル |
| store_id | te_ads_object.app_id | アプリID |
| app_name | te_ads_object.app_name | アプリ名 |
| platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| country | te_ads_object.country | 国・地域コード |
| 【USD】 | te_ads_object.currency | コストまたは収益の通貨 |
| impressions | te_ads_object.impressions | 露出数 |
| clicks | te_ads_object.clicks | クリック数 |
| installs | te_ads_object.installs | コンバージョン数（インストール） |
| spend | te_ads_object.cost | ユーザー獲得コスト |
| ad_revenue | te_ads_object.revenue | マネタイズ収益 |