AppsFlyer Cohort API
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Cohort API | API | 集約指標 | ✅ | ✅ | ✅ |
Cohort APIも集計データのAPIです。他の集計データのAPIと比べて、データ指標の形式がAppsFlyerのCohort DashboardやAEシステムのリテンション分析モデルのデータ結果に近く、新規ユーザーのN日目（または累計N日目）の指標となります。
統合の流れ
- AppsFlyer管理画面にログインし、V2.0 API TokenとApp IDを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでAppsFlyer Cohort APIプランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. API TokenとApp IDの取得
1.1 API Tokenの取得
Cohort APIに使用するV2.0 API Tokenを取得します
1.2 App IDの取得
AppsFlyer管理画面の「My Apps」で、アプリのApp IDを確認できます。Androidではcom.で始まり（例：com.demoapp.ta）、iOSではidで始まります（例：id12345678）
2. プランの設定
AppsFlyerのAPI TokenとApp IDを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を行います。下図はAppsFlyer Cohort APIの設定画面です。本章の内容に従ってプランを作成してください：
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップにAPI TokenとApp IDを入力します
2.2 定期取得
「定期取得」モジュールで、AEシステムがAppsFlyer Cohort APIのデータを定期的に取得する方法を設定できます。毎日の特定の時刻に一定期間のデータを取得するよう選択でき、1回あたり最大31日分を取得できます。取得したデータもデータ量に計上されるため、長すぎる期間のデータを定期取得しないことをお勧めします
2.3 格納設定
データをイベントとして書き込むかどうかを制御できます。オフにすると、データはイベントテーブルに書き込まれなくなるため、この設定はオフにしないでください。
2.4 統合構成
最後に、統合構成モジュールで、データ取得の詳細な設定を制御できます。データのタイプ、取得するディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
source | metrics | データ内の指標ディメンション。リスト型です。カスタマイズできますが、入力できるのは1つだけで、空にすることはできません |
| group_by | データ内のグループ化ディメンション。リスト型。カスタマイズ可能 | |
transfer | fields_whitelist | フィールドのフィルター。リスト型です。リストが空でない場合、AEシステムはリスト内のフィールドのみを格納し、リストにないフィールドは破棄されます |
double_columns | 数値型フィールドの定義。ここに記述したフィールドは数値型で格納されます。格納後のフィールド名を入力する必要があります | |
| extra_params | aggregation_type | 累計データかどうか。つまり、返されるN日データがN日目のデータか累計N日目のデータかを指定します。デフォルト値は：、cumulative、on_dayから選択できます |
| partial_data | 欠落した日付のデータを返すかどうか。デフォルトはfalseで、完全な日のデータのみを返します。trueに設定すると、不完全な日を含む最大180日分のデータが返されます。aggregation_typeがcumulativeの場合のみ使用できます |
- グループ化ディメンション
Cohort APIは最大7つの分析ディメンションに対応していることにご注意ください。以下はデフォルトの分析ディメンションです。調整が必要な場合は、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 | ✓ |
Facebook(Meta)のデータを取得する必要がある場合は、分析ディメンションでaf_channelとgeoを同時に選択しないでください。同時に選択すると、Facebookのコストデータを取得できなくなりますのでご注意ください
- 指標フィールド
Cohort APIは3つのデフォルト指標と、source.metricsに入力した1つの指標（デフォルトはrevenue）を返すことにご注意ください。以下はデフォルトの指標フィールドです。
| フィールド名 | 指標名 | 説明 | デフォルト |
|---|---|---|---|
| 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.5 取得する指標の調整
Cohort APIは大量のフィールドを返すため、フィールドの格納を制限しないと、プロジェクトのプロパティが過度に増加し、通常の利用に影響する可能性があります。そのため、取得する指標を調整する必要がある場合は、次の操作を行ってください：
- source.metricsの調整：取得する指標のフィールド名、つまり前節の表の1列目をsource.metricsに入力します。source.metricsには指標を1つしか入力できないことにご注意ください。デフォルトで取得される3つの指標、つまりusers、ecpi、costはsource.metricsに記述する必要はありません。下図のように、uninstallsの指標を取得したい場合は、"uninstalls"をsource.metricsに入力する必要があります
- transfer.fields_whitelistの調整：過剰なプロパティが作成されないように、フィールドをフィルタリングするためのtransfer.fields_whitelistを用意しています。ここに記述したフィールドのみが格納されます。Cohort APIが返すデータはリテンション分析モデルに似ており、デフォルトでは1つの指標について0~30日目、60日目、90日目、180日目などの値を返します（例：revenue_count_day_7、roi_rate_day_30など）。デフォルトの統合構成では、グループ化フィールド、revenue_count_day_0、revenue_sum_day_0以外のすべてのフィールドが除外されています。指標を調整したい場合や、より多くの日数のデータを格納したい場合は、格納する指標の指標名（詳しくは前節の表を参照）をtransfer.fields_whitelistに追加できます。下図のように、取得する指標をuninstallsに変更した後は、"uninstalls_count_day_0"、"uninstalls_rate_day_0"などの指標名をtransfer.fields_whitelistに追加して、格納できるようにする必要があります。
- 指標名をtransfer.double_columnsに追加：最後に、指標フィールドを数値型で格納できるように、前のステップで追加した指標名をtransfer.double_columnsにも追加する必要があります。下図のとおりです：
2.6 データの格納ルール
デフォルトでは、取得したデータはイベントとしてAEプロジェクトに書き込まれます：
- データ内のdateフィールド、つまりユーザーのアトリビューション/コンバージョン時間をイベントの#event_timeとして使用します
- データのイベント名：appsflyer_cohort_api
- フィルタリング後のフィールドはすべて格納されます。transfer.double_columnsに記述したフィールドは数値型で、その他のフィールドはテキスト型で格納されます
2.7 標準化フィールド
次のイベントプロパティは標準化処理されます：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| pid | te_ads_object.media_source | メディアチャンネル |
| c | te_ads_object.campaign_name | 広告キャンペーン名 |
| af_c_id | te_ads_object.campaign_id | 広告キャンペーンID |
| af_adset | te_ads_object.ad_group_name | 広告グループ名 |
| af_adset_id | te_ads_object.ad_group_id | 広告グループID |
| af_ad | te_ads_object.ad_name | 広告名 |
| af_ad_id | te_ads_object.ad_id | 広告ID |
| app_name | te_ads_object.app_name | アプリ名 |
| app_id | te_ads_object.app_id | アプリID |
| platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| currency | te_ads_object.currency | コストまたは収益の通貨 |
| geo | te_ads_object.country | 国・地域コード |
| users | te_ads_object.installs | コンバージョン数（インストール） |
| cost | te_ads_object.cost | 配信コスト |