# AppsFlyer Cohort API
WARNING
データ統合によって生成されたデータは、クラスターのデータ消費量にカウントすることに注意してください。
# 概要
| API名 | 統合タイプ | データ粒度 | アトリビューション | コスト | 収益 | 露出 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Cohort API | API | 集計 | ✅ | ✅ | ✅ |
Cohort API (opens new window) もデータの集計APIです。他のデータの集計APIと比べて、データ指標はAppsFlyerのCohort DashboardやTEシステムのリテンション分析モデルの結果に似た形式であり、つまり新規ユーザーのN日目（または累積N日目）の指標です。
# 統合プロセス
- AppsFlyerのバックエンドにログインし、V2.0 API TokenとApp IDを取得してください。
- TEバックエンドにログインし、サードパーティ統合に入り、AppsFlyer Cohort API プランを追加し、関連する設定を完了してください。
- TEシステムがデータを正常に受信し、レポートの構築が完了したかどうかを確認してください。
# API TokenとApp ID 取得
# 1.1 API Token取得
管理者アカウントにログインし、「API Access」をAppsFlyerのサイドバーメニューで見つけ、Pull APIのためのV2.0 API Tokenを取得してください。
# 1.2 App ID取得
AppsFlyerのバックエンド「My Apps」で、アプリのApp IDを見つけることができます。Androidではcom.から始まり、例えばcom.demoapp.taです。iOSではidから始まり、例えばid12345678です。
# プラン構成
AppsFlyerのAPI TokenとApp IDを取得した後、TEシステムにログインして、「サードパーティ」モジュールで新しいプランの設定を完了することができます。以下はAppsFlyer Cohort APIの設定画面です。この章の内容に従ってプランを作成してください：
# 2.1 認証情報の設定
「認証情报」ボタンをクリックし、ポップアップ内にAPI TokenとApp IDを入力してください。
# 2.2 定期取得
「定期取得」モジュールで、TEシステムがAppsFlyer Master APIデータを定期的に取得するルールを設定できます。特定の時間帯に毎日一定期間のデータを取得することができます。取得したデータもデータ量に含まれるため、長い時間のデータを定期的に取得しないようお勧めします。
# 2.3 格納設定
データがイベントの形式で書き込まれるかどうかを制御することができます。閉じると、データはイベントテーブルに書き込まれないため、この設定を閉じないでください。
# 2.5 統合構成
最後に、データの取得の詳細な設定を統合構成モジュールで制御することができます。データのタイプ、取得する次元、および格納後のイベント名などが含まれます。
統合設定の内容はJSON形式であり、以下の内容に従ってカスタム設定を行うことができます。
| API | 名称 | 意味 |
|---|---|---|
| sink_event | event_name | 格納されたイベント名，カスタマイズ可能 |
| source | metrics | データ内の指標、リストタイプはカスタマイズ可能 |
| group_by | データのグループ化、リストタイプはカスタマイズ可能 | |
| transfer | fields_whitelist | フィールドのフィルタリング、リスト型、もしリストが空でない場合、TEシステムはリストに含まれるフィールドのみをデータベースに格納し、リストに含まれないフィールドは破棄される |
| extra_params | double_columns | 数値タイプのフィールド定義は、ここに記述されたフィールドは数値タイプでデータベースに保存される。保存後のフィールド名を入力してください |
| aggregation_type | 累計データを返すかどうか、つまり N 日のデータを返す際には、N 日目のデータまたは累積した N 日目のデータを返す。既定値は「cumulative」または「on_day」 | |
| partial_data | デフォルトの日付データを返すかどうか、デフォルトは false であり、完全な日のデータのみが返される。true に設定すると、最大180日間の不完全な日のデータも含まれる |
以下はグループ化のディメンションです。調整が必要な場合は、source.group_byを変更してください。調整する際にはフィールド名を使用してください。
| フィールド意味 | フィールド名 | 格納名 | デフォルト |
|---|---|---|---|
| Ad | af_ad | ✓ | ✓ |
| Ad ID | af_ad_id | ✓ | |
| Campaign | c | ✓ | ✓ |
| Campaign ID | af_c_id | ✓ | |
| Channel | af_channel | ✓ | ✓ |
| Media Source | pid | ✓ | ✓ |
| Sub Param 1 | af_sub1 | ✓ | |
| Keywords | af_keywords | ✓ | |
| Agency | af_prt | ||
| Conversion Type | cohort_type | ||
| Site ID | site_id | ||
| Attributed Touch Type | attributed_touch_type | ||
| Adset | af_adset | ✓ | |
| Adset ID | af_adset_id | ✓ | |
| Country | geo | ✓ | |
| Date | date | ✓ | ✓ |
- 指標フィールド
注意すべきは、Cohort API は3つのデフォルト指標と1つの追加指標を返します。以下はデフォルトの指標フィールドですが、必要に応じて source.group_by を変更してください。変更する際にはフィールド名を使用してください。また、extra_params.double_columns および transfer.fields_whitelist に対応するフィールド名を追加する必要があります。
注意：「格納名」列において、N は N 日目の指標を示します。デフォルトでは、値の範囲は0から30です。したがって、このようなフィールドを正常に格納するためには、extra_params.double_columnsとtransfer.fields_whitelistに実際の格納名（revenue_count_day_7やroi_rate_day_30など）を追加する必要があります。
| フィールド名 | 格納名 | 説明 | デフォルト |
|---|---|---|---|
| users（デフォルト指標） | users | 総ユーザー数（時間ウィンドウに関係なし） | ✓ |
| ecpi（デフォルト指標） | ecpi | 総eCPI（時間ウィンドウに関係なし） | ✓ |
| cost（デフォルト指標） | cost | 総コスト（時間ウィンドウに関係なし） | ✓ |
| "event_name"（カスタムイベントの名前を使用） | "event_name"_unique_users_day_N | 第 N 日のカスタムイベントトリガーユーザー数 | |
| "event_name"_count_day_N | 第 N 日のカスタムイベント完了数 | ||
| "event_name"_rate_day_N | 第 N 日のカスタムイベントの完了率 | ||
| "event_name"_sum_day_N | 第 N 日のカスタムイベント収益額 | ||
| revenue | revenue_count_day_N | 第 N 日収益イベントトリガー数 | |
| revenue_sum_day_N | 第 N 日収益額 | ||
| roas | roas_rate_day_N | 第 N 日 ROAS | |
| roi | roi_rate_day_N | 第 N 日 ROI | |
| sessions | sessions_unique_users_day_N | 第 N 日のSessionトリガーユーザー数（累積指標の場合はこのデータは返されません） | |
| sessions_count_day_N | 第 N 日 Session 数 | ||
| sessions_rate_day_N | 第 N 日継続率（ Session ユニークユーザー数 / 総ユーザー数） | ||
| uninstalls | uninstalls_count_day_N | 第 N 日アンインストール数 | |
| uninstalls_rate_day_N | 第 N 日アンインストール率 |
# 2.6 データ格納ルール
デフォルトでは、取得したデータはイベント形式で TE プロジェクトに書き込まれます。
- Cohort APIの集計指標インターフェースは、集計データを返すため、ユーザー識別子として固定値を使用します。すべてのデータが仮想ユーザーにマウントされると考えてください。
- データ中のdateフィールド、つまりユーザーのアトリビューション/コンバージョン時間をイベントの#event_timeとして使用します。
- データイベント名：appsflyer_cohort_api
- 他のフィールドはすべてデータベースに保存されます。
# 2.7 標準化フィールド
| メタフィールド | 標準化フィールド | 説明 |
|---|---|---|
| media_source | te_ads_object.media_source | メディアソース |
| campaign | te_ads_object.campaign_name | キャンペーン名 |
| campaign_id | te_ads_object.campaign_id | キャンペーンID |
| adset | te_ads_object.ad_group_name | グループ名 |
| adset_id | te_ads_object.ad_group_id | グループID |
| ad | te_ads_object.ad_name | 広告名 |
| ad_id | te_ads_object.ad_id | 広告ID |
| app_id | te_ads_object.app_id | APP ID |
| geo | te_ads_object.country | 国家地域コード |
| impressions | te_ads_object.impressions | 露出量 |
| clicks | te_ads_object.clicks | クリック量 |
| installs | te_ads_object.installs | コンバージョン量（インストール） |
| cost | te_ads_object.cost | コスト |
| revenue | te_ads_object.revenue | 収益 |