Master API — APIによるユーザー獲得メトリック

プレミアム機能

推奨

マーケター 開発者

最終更新: 2023年06月29日 11:42

概要： 選択した LTV、アクティビティ、リテンション、コホート、Protect360キャンペーンのパフォーマンスKPIを、APIを利用して CSV または JSON 形式で取得します。データ対象のアプリは1つ以上選択可能です。

Master API — APIによるユーザー獲得メトリック

Master API:

選択した LTV、アクティビティ、リテンション、コホート、Protect360 キャンペーンのパフォーマンス KPI を取得できます。使用可能な KPI は、概要、アクティビティ、リテンション、コホート、および Protect360 ダッシュボードにある KPI と同等の KPI です。
デイリーで計算処理されます（リアルタイムではありません）。更新されたデータは、アプリ固有のタイムゾーンに応じて、24 ~ 48 時間以内に利用できます。
AppsFlyerのピボットテーブルで構築されるインフラストラクチャです。

マスターAPI を使用するには、表示するデータを定義します ( Pull APIの実装と同様)。結果は CSV ファイルまたは JSON ファイルとして返されます。

Master APIを使用する：

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

API パラメータ

パラメータ名	パラメータの値	必須？
app_id	AppsFlyerに表示されるアプリ識別子 AppsFlyerに表示されているとおりにアプリIDを挿入します。 iOSアプリの先頭にidを付与してください。すべてのアプリ ID を使用してすべてのアプリを照会する	はい
from	LTVアトリビューション日付期間の下限形式：文字列 yyyy-mm-dd 例： `from: 2020-01-02`	はい
活用	LTVアトリビューション期間の上限範囲内の日数：1～31日 1日のみの場合：`from` と `to` の値は同一になります。形式: yyyy-mm-dd 例： `from: 2021-01-01, to: 2021-01-31` ＝31日	必須
グループ化	パラメーターでグループ化し、コンマで区切ります。使用可能なリストについては、グループ化の表を参照してください。例：`groupings=pid,geo`	必須
KPI	含めるKPIのリスト（それぞれをコンマで区切って指定）KPIリストについては、以下の KPI表を参照してください。例：`kpis=installs,clicks, impressions,sessions,retention_day_7`	必須
フィルタ	データは、1つ以上のフィルターオプションを使用してフィルター処理できます。	いいえ
通貨設定	アプリ固有の通貨を設定するには currency=preferred とセットしてください。	いいえ
タイムゾーン	アプリ固有のタイムゾーンを使用してデータを返すには、timezone=preferred を設定します。参照：ローカリゼーションルール	いいえ
形式	デフォルトでは、レスポンスデータは CSV ファイル形式で受信されます。JSON 形式でデータを取得する場合は、`format=json`を選択します。	いいえ

グループ化

これらのディメンションを使うことで、データをグループで表示し、情報をより簡単に、より正確に精査することが可能になります。詳細はこちらをご覧ください。

グループ化 API 名	表示名でグループ化	LTV KPI	リテンションKPI	アクティビティKPI	Protect360	コホート
app_id	アプリID	はい	はい	はい	はい	はい
pid	Media source	はい	はい	はい	はい	はい
af_prt	代理店	はい	はい	はい	はい	いいえ
C	キャンペーン	はい	はい	はい	はい	はい
af_adset	Adset	はい	はい	はい	いいえ	いいえ
af_ad	広告	はい	はい	はい	いいえ	いいえ
af_channel	Channel	はい	はい	はい	はい	いいえ
af_siteid	パブリッシャーID	はい	はい	はい	はい	はい
af_keywords	Keywords	はい	はい	はい	いいえ	いいえ
is_primary	Is primary attribution	はい	いいえ	はい	はい	いいえ
af_c_id	Campaign ID	はい	いいえ	はい	はい	いいえ
af_adset_id	Adset ID	はい	いいえ	はい	いいえ	いいえ
af_ad_id	Ad ID	はい	いいえ	はい	いいえ	いいえ
install_time	インストール時間	はい	はい	はい*	はい	はい
attributed_touch_type	タッチタイプ	はい	はい	はい	はい	いいえ
国	Geo	はい	はい	はい	はい	はい
* アクティビティKPIのコンテキストでは、インストール時間をイベント時間と見なします。

KPI

KPIはアプリの状況を確認するための指標となります。KPIは、以下のタブでタイプ別にグループ化されています。

生涯価値 - インストールされた日から本日までのイベント集計値

KPI API名	説明
インプレッション	選択した期間におけるインプレッション数
クリック	選択した期間におけるクリック数
インストール数	選択した期間におけるインストール数
cr	コンバージョン率
sessions	選択した期間にインストールしたユーザーのセッション数
loyal_users	選択した期間にインストールしたロイヤルユーザー数
loyal_users_rate	ロイヤルユーザー率（ロイヤルユーザー数 ÷ インストール数）
cost	選択した期間の総コスト参照：制限事項
収益	選択した期間にインストールしたユーザーの生涯収益
ROI	選択した期間における投資対効果
arpu_ltv	選択した期間にインストールしたユーザーの１ユーザーあたりの平均収益
average_ecpi	特定の期間におけるeCPI コストとインストールがコールに含まれている場合にのみ使用できます。
アンインストール	特定の期間にアンイストールしたユーザー
uninstalls_rate	アンインストール率
event_counter_[event_name]	イベントの発生数
unique_users_[event_name]	イベントが発生したユニークユーザー数
sales_in_usd_[event_name]	レポートされたイベントの収益

リテンションとは、アクティブなユーザー数を把握する指標です。

注意：

最大リテンション日数はインストール後 30日で、0日はインストール日です。つまり、値 [x] は 30 を超えることはできません。
retention_day_1 をリクエストすると、その日のデータが利用可能になる前に、返されるメトリックは前日にインストールしたユーザーに関連しています。
たとえば、1月2日に、1月1日にインストールしたユーザーの retention_day_1 をリクエストします。
メトリックはまだ使用できないため、返されるメトリックは 12月31日にインストールしたユーザーに関連しています。

KPI	説明
retention_day_[x]	X日後のアクティブユーザー数
retention_rate_day_[x]	インストールしたユーザーのうち、X日後のアクティブユーザー数

選択した期間におけるアプリ内アクティビティ

KPI	説明
activity_average_dau	選択した期間における平均DAU
activity_average_mau	選択した期間における平均MAU（1MAU日：過去30日におけるユニークユーザー数）
activity_average_dau_mau_rate	平均DAU/MAU率
activity_average_arpdau	1DAUあたりの平均収益：その1日のすべてのユニークユーザーあたりの平均収益
activity_sessions	選択した期間におけるセッション数
activity_revenue	選択した期間における収益
activity_event_counter_[event_name]	選択した期間におけるユーザーによるイベント数
activity_sales_in_usd_[event_name]	選択した期間における収益イベントからの収益
activity_average_unique_users_[event_name]	選択した期間における特定のイベントを実施した平均ユニークユーザー数

AppsFlyerのコホートレポートでは、異なる期間の複数のコホートレポートを異なる指標を使って比較することが可能です。

注記：

四捨五入： ユーザーごとのコホートKPI は、小数点以下4桁を使用して計算されます。つまり、ユーザーあたりの計算値が 0.0001 未満の場合、0と表示されます。
例：ユーザー数が100,000人で総収益が9ドルだとします。1ユーザーあたりの収益は 9 ÷ 100000=0.00009 です。0.00009 は 0.0001 より少ないため、値は0と表示されます。
コホート日数：コホート日の最大数は、インストール後 90日で、0日がインストール日です。コホートの日の値 [x] は、1 ~ 90 の範囲である必要があります。注： cohort_day_0 は、コホートダッシュボードでサポートされていますが、Mater API ではサポートされていません。
Master APIとコホートAPIおよびコホートダッシュボード：再インストールの処理とタイミングの問題が異なるため、結果が異なる場合があります。

セッション

KPI

説明

cohort_day_[x]_total_sessions_per_user

コホート X日：X日目までのユーザー毎の累積セッション数（X日目を含む）

cohort_day_[x]_sessions_per_user

コホート X日：X日目のみのセッション数

cohort_[x]_days_total_sessions_per_user

X日目までのセッション数を日別で取得できます。

例えば、URLでcohort_3_days_total_sessions_per_userと指定するとレポートに以下の3列を生成します：
Cohort_day_1_total_sessions_per_user+ Cohort_day_2_total_sessions_per_user+Cohort_day_3_total_sessions_per_user

収益

KPI	説明
cohort_day_[x]_total_revenue_per_user	コホートX日：ユーザーあたりの累積収益 (X日目を含む)
cohort_day_[x]_revenue_per_user	コホートX日：X日目のみのARPU
cohort_[x]_days_total_revenue_per_user	指定した KPI Cohort_day_1_total_revenue_per_user を Cohort_day_x_total_revenue_per_userに置き換えます。例えば、URLでcohort_3_days_total_revenue_per_userを指定するとレポートでは以下の3列を生成します: Cohort_day_1_total_revenue_per_user+ Cohort_day_2_total_revenue_per_user+Cohort_day_3_total_revenue_per_user
cohort_day_[x]_total_event_[eventname]_revenue_per_user	コホートの Day Xの特定のアプリ内イベントに応じたユーザーあたりの累積収益
cohort_day_[x]_event_[eventname]_revenue_per_user	コホートの Day Xの特定のアプリ内イベントに応じたユーザーあたりの収益

イベント

KPI

説明

cohort_day_[x]_total_event_[eventname]_per_user

コホートX日：X日目までのユーザーあたりの累積イベント数 (X日目を含む)

cohort_day_[x]_event_[eventname]_per_user

コホートX日：X日目のみのイベント数

cohort_[x]_days_total_event_[eventname]_per_user

指定したKPIイベントを Cohort_day_x_total_events_per_user に置き換えます。

例えば、URLでcohort_3_days_total_events_per_user と指定すると、レポートでは以下の３つの列を生成します。:
Cohort_day_1_total_events_per_user、Cohort_day_2_total_events_per_user、Cohort_day_3_total_events_per_user

Protect360 KPI

説明	KPI
インストール
合計	protect360_total_installs
ブロック済み	blocked_installs
ブロック率	blocked_installs_rate
ポストアトリビューション不正	post_attribution_installs
ポストアトリビューション不正率	post_attribution_installs_rate
不正インストールの合計	total_fraudulent_installs
不正インストール	fraudulent_installs_rate
フェイクインストール
リアルタイムブロック	real_time_fake_installs
ポストアトリビューション不正	post_attribution_fake_installs
ハイジャックされたインストール
リアルタイムブロック	real_time_hijacked_installs
ポストアトリビューション不正	post_attribution_installs_hijacked_installs
検証ルール
ブロック済みインストール	validation_rules_blocked_installs
ブロック済みアトリビューション	validation_rules_blocked_attribution
フェイクインストールブロックの内訳
ブロック済みサイトIDブラックリスト	blocked_installs_siteid_blacklist
ポストアトリビューションサイトIDブラックリスト	post_attribution_installs_siteid_blacklist
ブロック済みボット	blocked_installs_bots
ポストアトリビューションボット	post_attribution_installs_bots
ブロック済み異常行動	blocked_installs_behavioral_anomalies
ポストアトリビューション行動異常	post_attribution_installs_behavioral_anomalies
バリデーションルールによりブロックしたインストール数	blocked_installs_install_validation
ハイジャックされたインストールのブロック内訳
ブロック済みインストールハイジャック数	blocked_installs_install_hijacking
ポストアトリビューションインストールハイジャック	post_attribution_installs_installs_hijacking
ブロック済みCTIT異常の数	blocked_installs_ctit_anomalies
ポストアトリビューション CTIT異常	post_attribution_installs_ctit_anomalies
ブロック済みクリック洪水	blocked_installs_click_flood
ポストアトリビューションクリック洪水	post_attribution_installs_click_flood
クリック
合計	protect360_total_clicks
ブロック済み	blocked_clicks
%	blocked_clicks_rate
アプリ内イベント
合計	protect360_total_in_apps
ブロック済み	blocked_in-app-events
%	blocked_in-app-events_rate
デバイスファームの指標 - 新規端末
インストール	install_fraud_new_devices_total
インストール率	install_fraud_new_devices_total_installs_rate
ロイヤルユーザー率 %	install_fraud_new_devices_total_loyal_user_rate
デバイスファームの指標 - LAT端末
インストール	install_fraud_lat_devices_total
インストール率	install_fraud_lat_devices_total_installs_rate
ロイヤルユーザー率 %	install_fraud_lat_devices_total_loyal_user_rate
クリック洪水の指標
コンバージョン率	conversion_rate
クリック洪水の指標 - CTIT
60分以上	click_flood_over_1_hour_rate
5時間以上	click_flood_over_5_hours_rate

算出KPI

Master APIレポートでは、上記のKPIに加え、算出KPIを追加することが可能です。これにより、独自の計算レポートをMaster API レポートに含めることができます。

KPI計算式の中には、いくつでもKPIを挿入いただいても構いません。各計算 KPI オブジェクトには、キーと値が含まれます。キーは KPI に付ける名前で、値は KPI の式です。

標準の算術演算子がサポートされています：％2bとしてエンコードされた加算（+）、減算（-）、乗算（*）、％2fとしてエンコードされた除算（/）。

計算式を挿入するKPIは、小目名は必ず "calculated_kpi_" から始め、そのあとに有用な文字列で続けてください。
例："calculated_kpi_purchaserate"

例

最初の３日間の合算リテンション

kpis=installs,loyal_users_rate&calculated_kpi_3days_retention=
retention_day_1%2Bretention_day_2%2Bretention_day_3

インプレッション毎の平均収益

kpis=installs&calculated_kpi_rev_per_impression=revenue%2Fimpression

コホート7日目のROI

kpis=installs,roi,arpu_ltv,cost,revenue&calculated_kpi_roi_day_7=
(cohort_day_7_total_revenue_per_user-average_ecpi)%2Faverage_ecpi

フィルター（オプション）

パラメータ名	説明	例	必須?
pid	メディアソースの絞り込みに利用します。カンマ区切りで複数指定可能です。	pid=organic,applovin_int	いいえ
C	キャンペーン名のフィルターに使用されます。カンマ区切りで複数指定可能です。	c=my_sample_campaign	いいえ
af_prt	代理店名のフィルターに使用されます。カンマ区切りで複数指定可能です。	af_prt=moburst	いいえ
af_channel	チャネル名のフィルターに使用されます。カンマ区切りで複数指定可能です。	af_channel=Instagram	いいえ
af_siteid	パブリッシャーIDのフィルターに使用されます。カンマ区切りで複数指定可能です。	af_siteid=12345678	いいえ
国	国ごとのフィルターに使用されます。カンマ区切りで複数指定可能です。	geo=US,DE	いいえ

ローカライゼーション

現地通貨とアプリ固有のタイムゾーンは、アプリ設定ページから設定します。Master APIのデータは、システムの既定の通貨とタイムゾーン、またはアプリ固有のタイムゾーンと通貨を使用してデータを抽出できます。

以下が適用されます：

アプリ固有のタイムゾーン/通貨の使用は、すべてのアプリが同じタイムゾーン/通貨を持つ場合にのみサポートされます。それ以外の場合は、UTC と USD が使用されます。タイムゾーンと通貨は別々です。つまり、すべてのアプリの通貨が同じでタイムゾーンが同じでない場合は、アプリ固有の通貨を使用できますが、アプリ固有のタイムゾーンは使用できません。
リクエストされた時間範囲内にダッシュボードでリクエストされたタイムゾーンが変更された場合、生成されたレポートには、最新のタイムゾーンの変更から始まる値が含まれます。

次のパラメーターを使用して、アプリ固有の設定を選択します。注意：preferredパラメーターを使用しない場合は、通貨の場合は USD、タイムゾーンの場合は UTCという既定の設定が適用されます。

パラメータ名	説明	例	必須?
currency	金額はアプリ設定画面で設定された通貨です。	currency=preferred	いいえ
timezone	使用されるタイムゾーンは、アプリ設定画面で設定されたタイムゾーンに従います。	timezone=preferred	いいえ

追加情報

特性と制限

特性	備考
コストデータ	さまざまなコストディメンションが利用可能であることから、広告セット、広告、地域、チャンネル、サイトIDは広告ネットワークによって異なります。 eCPIを取得するには：コストデータが利用可能な場合は、インストールとコストの両方をコールに含めます。基本的に、オウンドメディアを含むAppsFlyerのURLを使う全てのメディアソースで、リクエストするディメンションに関わらずコストデータが提供可能です。ただし、URLにコストパラメータが存在する必要があります。独自のAPIをもつセルフレポーティングネットワークは一部のディメンションのコストデータのみに対応しています。たとえば、 Meta広告では、同じコールでの地域とチャネルによるグループ化はサポートされていません。これらのいずれかによる個別のグループ化がサポートされています。コストデータはあるが、最近のインストールデータがないキャンペーン（約7日間）はマスターAPIではご利用いただけません。
グループ化	特定のグルーピングはLTV、アクティビティ、リテンションのKPIでのみ利用可能です。特定のKPIが利用不可の場合、”N/A” とAPIから返答されます。例えば、retention_rate_day_7 を af_channel でグループするようにリクエストをすると、“N/A” と返します。
レポートあたりの最大行数	200K
複数のイベント名	Master API は現在、スラッシュ `/` を含むイベント名をサポートしていません。この制限を克服するには、イベント名に含まれる `/` を避けます。
処理時間	複数のアプリを選択すると、処理時間が長くなり、応答に時間がかかる場合があります。
期間	時間枠の粒度はデイリー（各日）です。
代理店	Master APIではご利用いただけません
アドネットワーク	Master APIではご利用いただけません
過去データ	LTVデータ：5年コホートデータ（デイリーコホート）：2年アクティビティデータ：3年
Retargeting（リターゲティング）	サポートされておらず、計測対象外です