コホートAPI

概要：APIを使用して、コホートデータをBI、およびマーケティングオートメーションシステムに統合できます。

コホートAPI

コホートレポートAPIは、AppsFlyerプラットフォームからコホートキャンペーンパフォーマンスデータを取得するために使用されます。これはコホート管理画面と機能的に同等です。

収益、ROI、イベントコンバージョン率などのコホート指標が利用可能です。比較分析のために、コホートをキャンペーンまたはメディアソースなどのディメンション別に分類します。結果は CSV ファイルまたは JSON ファイルとして返されます。

altAppsFlyerAdmin_us-en.png APIトークンを取得します。管理者はトークンをダッシュボードで取得する必要があります。
認証ヘッダーで使用するためにAPIトークンをデベロッパーに渡します。
次のセクションで説明するように、APIコールを行うときに入力するパラメーターを開発者へ渡してください。パラメーターは、レポートが何に焦点を当て、どのように編成されるかを決定し、レポートの時間枠を定義します。
AppsFlyer公式デベロッパーハブの Master APIの手順に従うように開発者に伝えます。

次のフィルターパラメーターを使用して、必要なデータを取得します。

パラメーター名	説明	必須
Bearer \		はい
cohort _type	「全体」は、ユーザー獲得とリターゲティングキャンペーンのパフォーマンスを組み合わせます。リターゲティングとユーザー獲得キャンペーンの両方にイベントの成果が紐づいている場合、返されるKPIにはリターゲティングイベントのみが含まれます。つまり、is_primary=trueとなります。形式：文字列例：`"cohort_type": "user_acquisition"`	はい
min_cohort_size	形式：整数 1. デフォルト1 例：`"min_cohort_size": 50`	いいえ
開始	LTVアトリビューション日付期間の下限。過去データのサポート範囲は、現在から730日前までです。形式：String yyyy-mm-dd 例： `"from": "2020-01-02"`	はい
終了	LTVアトリビューション日付期間の上限。範囲内の日数：1～31日1-180日形式： yyyy-mm-dd	はい
granularity	形式：yyyy-mm-dd hh:mm:ss 例： `"granularity": "hour", "from": "2021-12-01 14:00:00", "to": "2021-12-03 11:00:00",`	いいえ
partial_data	データの歪みや誤解釈を避けるために、コホートは完全な日のデータを返します。ただし、日数未満のデータが役に立つことがあります。クエリに対する完全なコホート日数は、今日の日付と to の日付の差として計算されます。 [デフォルト] falseの場合、完全な日数が戻ります。 trueの場合、不完全なデータを持つ日を含む 180日までの日付が返されます。形式：ブール値フラットフォームUI版：false 例：例：5月10日に、4月1日～30日の間にコンバージョンがあったユーザーの完全なコホート日数は、10です。 false の場合 [デフォルト]、コホート日数0～9日が戻ります。これは、最後のコンバージョン日から今日までの日数 (10) です。 trueの場合、コホート日数1〜40が戻ります。11～40日は一部のデータのみが含まれ、データは戻りません。例えば、4月20日以降は、20日しか経過してない、等。　注：注：部分的なデータは、集計タイプが累積的な場合にのみ許可されます。	いいえ
フィルター	返されたデータと期間の日数を絞り込みます。フィルタのディメンション一覧からフィルタを選択します。形式：特定の地域に限定する例：`"filters": {"geo": ["US"]}`"filters": は米国に紐づくユーザーのみが含まれます。"filters":> 設定できる値：0-180。2024-02-26 デフォルトデフォルト：期間フィルタが設定されていない場合、日数は0-30、60、90、および180が返されます。期間フィルタの例	いいえ
groupings	グループ化を使用して、列を追加したり、レポートの粒度を低くします。グループ化のディメンション一覧から1～7のグループ化を選択してください。形式：例： `"groupings": ["af_ad", "c", "af_c_id", "af_prt"]`	はい
KPI	KPIはアプリの状況を確認するための指標となります。	はい
preferred_currency		いいえ
preferred_timezone		いいえ
aggregation_type		はい
per_user		いいえ

KPIの選択とフォーマット

この表では、利用できるKPIのリストとそれに関する関数を示しています。KPIを呼び出すとそのすべての関数が返されます。
次のKPIは常に返されます：users、ecpi、cost
コールごとに追加KPIを1つ選択します。
リクエストされた各KPIについて、全ての関数が返されます。
形式：
- 例A：
- 例B：

		関数
デフォルト/オプション	KPI (ディメンション名)	カウント	cvr (コンバージョン率)	レート	合計	ユニークユーザー数
デフォルト/オプション	KPI (ディメンション名)	数値	割合	割合	数値	数値
常に	ユーザー	Y	-	-	-	-
常に	eCPI	-	-	-	Y	-
常に	cost	-	-	-	Y	-
オプション	2024-02-26	Y	Y	-	Y (3)	Y
オプション	revenue	Y	-	-	Y	-
オプション	ROAS	-	-	Y	-	-
オプション	ROI	-	-	Y	-	-
オプション	sessions	Y	-	Y	-	Y(1)
オプション	uninstalls (2)	Y	-	Y	-	-
(1) aggregation_type=on_day の場合、ユニークセッションが返されます。 (2) cohort_type=unified の場合は利用できません。 (3) 合計とは、イベントで発生した収益の合計を意味します。注意イベント名では大文字と小文字が区別されます。

パラメータ	範囲外の値は	必須
preferred_currency	KPIの収益通貨 true の場合、プラットフォーム上で設定されているアプリ固有の通貨を使用して収益値が戻ります。 [デフォルト] false の場合、結果はUSDで返されます。形式：ブール値フラットフォームUI版：true	いいえ
preferred_timezone	データ範囲のタイムゾーン trueの場合、プラットフォームで設定されたアプリ固有のタイムゾーンを使用して表示されます。 [デフォルト] falseの場合、UTCタイムゾーンを使用して表示されます。形式：ブール値フラットフォームUI版：true	いいえ
aggregation_type	`cumulative` `on_day` `"aggregation_type": "cumulative"` `Format: String`	はい
per_user	KPI関数をアプリユーザー数で割ります。関連するKPIのみに適用されます。 trueの場合、KPI値はコホートのユーザー数で除算されます。 falseの場合、KPI値はユーザー数で除算されません。形式：ブール値 tureの場合の例：総収益が$1000で、アプリユーザー数が500の場合、値は$2で返されます。	いいえ

ディメンション名	ディメンションAPI値	グループ化	フィルタ
Ad	af_ad	Y	Y
Ad ID	af_ad_id	Y	Y
Campaign	c	Y	Y
Campaign ID	af_c_id	Y	Y
Channel	af_channel	Y	Y
Media Source	pid	Y	Y
Sub Param 1	af_sub1	Y	Y
Keywords	af_keywords	Y	Y
代理店	af_prt	Y	Y
コンバージョンタイプ (1)	cohort _type	Y	Y
Site ID	site_id	Y	Y
収益タイプ (2)	revenue_type	x	Y
アトリビューションタッチタイプ (3)	attributed_touch_type	Y	Y
Adset	af_adset	Y	Y
Adset ID	af_adset_id	Y	Y
国	geo	Y	Y
日付（選択したcohort_typeのコンテキストでのインストール／リアトリビューション／リエンゲージメント日）	date	Y	x
期間	ピリオド (.) 詳細な説明	x	Y
注：ディメンションのオプション：エクスポートする場合：収益タイプ* attributed_touch_type

追加情報

期間フィルタの使用

期間はアトリビューション後の日を指し、期間0はアトリビューション日です。例えば、ユーザーがアプリを1月1日にインストールします。これがアトリビューション日です。期間0に購入が発生した場合、この購入は1月1日に発生しました。期間0に購入が発生した場合、この購入は1月1日に発生しました。

レポートの期間範囲が1月1日から1月11日の場合、この期間にアトリビュート（インストール）されたユーザーがレポートに含まれます。その他のデータは含まれません。

期間の値は、0-180のうち1つまたは複数設定できます。例：0, 1, 2, 30, 180。
期間が指定されていない場合、デフォルト値である0、1、2…30まで、および、60、90、180 が戻ります。

期間フィルタの例

この例には、JSONクエリパラメータ、ローデータ、および結果のCSVファイルが含まれています。
クエリのフィルタ期間は、0、1、2で、選択されたKPIは収益です。
その結果、返されるデータには以下が含まれます。
- ユーザー、コスト、eCPIの測定は常に返されます。
- 収益の測定は、各期間、つまり期間 0、1、2の合計とカウントで構成されます。

クエリ

{
    "cohort_type": "user_acquisition",
    "min_cohort_size": 1,
    "preferred_timezone": false,
    "from": "2019-12-01",
    "to": "2020-01-01",
    "filters": {
        "period": [
            0,
            1,
            2
        ]
    },
    "aggregation_type": "cumulative",
    "per_user": false,
    "groupings": [
        "pid"
    ],
    "kpis": [
        "revenue"
    ]
}

ローデータ

結果

特性と制限

特性	備考
アドネットワークのアクセス	いいえ
代理店によるデータアクセス	いいえ
代理店の運用媒体の開示設定	いいえ：代理店が運用するメディアソースのトラフィックは常に代理店名であり、元のメディアソースではありません。
アプリ固有のタイムゾーン	はい
アプリ固有の通貨	はい
サイズ制限	なし
レート制限	クエリは最大 30,000 行のデータを取得します。
オーガニックデータ	利用可能
非オーガニックデータ	利用可能
コストデータの制限	コストデータは少なくとも1つのインストールが計測されているキャンペーンのデータです。 AppsFlyerは、コホートレポートまたはコホートAPIに大文字を含むキーワードのコストデータを報告しませんコストと一部のグループ化の組み合わせができません。たとえば、Meta広告には地域グループとチャネルグループのいずれかを設定できますが、両方を含めることはできません。グループ分けの正確な組み合わせは、アドネットワークにより異なります。
データ更新頻度	データ更新頻度は、以下の partial_data により異なります。 [デフォルト] falseの場合は毎日更新 trueの場合は継続的（リアルタイム）で更新コストとアンインストール指標は全てのインスタンスで毎日更新されます
過去データ	デイリーコホート：2年
アカウントユーザーのアクセス	認証トークンは、管理画面でアドミンユーザーが利用できます
広告収益	af_ad_revenueイベントの場合、集計の種類が次の場合ユニークユーザー数指標は使用できません： "累積" "当日" とは、2022年10月5日から 2023年2月16日までの日付を指します。
	週単位および月単位のディメンショングループは、コホートAPIでは使用できません。
	注意：AppsFlyerでは、コホート期間は特定のインストールタイムスタンプを考慮していません。これにより、AppsFlyerのコホートデータと、すべてのコホート期間が特定のインストールタイムスタンプによって決定される他のネットワークのコホートデータ（つまり、1時間はインストール後60分のタイムスタンプ、1日はインストールタイムスタンプから24時間後のタイムスタンプなど）と比較すると、不一致が生じる可能性があります。
日付	日付：日付または日付期間は生涯価値 (LTV) の日付であり、つまりユーザーが計測された日（コンバージョン日）で、アクティビティが発生した日ではありません。現在の日付から3-5日前（2年間） 1-180日
再インストール	再インストール後のイベントが未アトリビューションのオーガニックイベントと見なされる場合： 2024年5月26日現在のみ含まれている。詳細を知るインストール時間はdevice_download_timeフィールドに基づいています。ユニークユーザーやリテンション測定にはカウントされません。再インストール後のイベントが最初のインストールに起因する場合、それらは常に含まれる。詳細はこちら

どのようにお手伝いできますか?

コホートAPI プレミアム機能