概要: 選択したLTV、アクティビティ、Protect360、およびリテンションなど、キャンペーンのパフォーマンスKPI をAPIでCSVまたはJSON 形式で取得します。アプリを1つ以上選択してください。
重要:
- このAPIのサポートは、2023年4月30日で終了し、Master API V2のみがサポートされている方法になります。
- Master API V2は2023年2月9日に使用できるようになります。
Master API — APIによるユーザー獲得メトリック
- 使用可能な KPI は、オーバービュー、アクティビティ、および Protect360 ダッシュボードにある同等の KPI です。
- Master API を使用するには、表示するデータを定義するURI を作成します。これは、 Pull API の実装に似ています。結果は CSV または JSON ファイルとして返されます。
- Master API:
- AppsFlyerのピボットテーブル で構築されるインフラストラクチャです。
- 代理店やパートナーはご利用いただけません。
Master APIの仕様
オーバービュー | APIコールは、パス、ヘッダー、データクエリを含むJSONで構成されます。デフォルトでは、データはCSVファイルで出力されます。 |
パス | https://hq.appsflyer.com/export/master_report/v4? |
HTTPメソッド | GET |
データの更新頻度 |
データ更新頻度エンドポイント:
|
API パラメータ
https://hq.appsflyer.com/export/master_report/v4?api_token=api_token
&app_id=app_id&from=yyyy-mm-dd&to=yyyy-mm-dd&groupings=groupings&kpis=kpis
パラメータ名 |
パラメータの値 | 必須? |
---|---|---|
api_token |
![]() |
はい |
app_id |
|
はい |
from |
LTVアトリビューション日付期間の下限。
|
はい |
活用 |
LTVアトリビューション日付期間の上限。
|
必須 |
groupings |
パラメーターでグループ化し、コンマで区切ります。使用可能なリストについては、グループ化の表を参照してください。 例: |
必須 |
KPI |
含めるKPIのリスト(それぞれをコンマで区切って指定)KPIリストについては、以下の KPI表を参照してください。 例: |
必須 |
フィルター |
データは、1つ以上のフィルターオプションを使用してフィルター処理できます。 |
いいえ |
currency | アプリ固有の通貨を設定するには currency=preferred とセットしてください。 | いいえ |
timezone |
アプリ固有のタイムゾーンを使用してデータを返すには、timezone=preferred を設定します。参照:ローカリゼーションルール |
いいえ |
形式 |
デフォルト設定で、レスポンスデータはすべてCSVファイル形式となります。JSONフォーマットでの受け取りを希望する場合は、 |
いいえ |
グループ化
これらのディメンションを使うことで、データをグループで表示し、情報をより簡単に、より正確に精査することが可能になります。詳細はこちらをご覧ください。
グループ化 API 名 |
表示名でグループ化 | LTV KPI | リテンションKPI | アクティビティKPI | Protect360 | コホート |
---|---|---|---|---|---|---|
app_id |
アプリID |
はい |
はい |
はい |
はい |
はい |
pid |
メディアソース |
はい |
はい |
はい |
はい |
はい |
af_prt |
代理店 |
はい |
はい |
はい |
はい |
いいえ |
C |
キャンペーン |
はい |
はい |
はい |
はい |
はい |
af_adset |
Adset |
はい |
はい |
はい |
いいえ |
いいえ |
af_ad |
広告 |
はい |
はい |
はい |
いいえ |
いいえ |
af_channel |
Channel |
はい |
はい |
はい |
はい |
いいえ |
af_siteid |
パブリッシャーID |
はい |
はい |
はい |
はい |
はい |
af_keywords |
Keywords |
はい |
はい |
はい |
いいえ |
いいえ |
is_primary |
プライマリーアトリビューション |
はい |
いいえ |
はい |
はい |
いいえ |
af_c_id |
Campaign ID |
はい |
いいえ |
はい |
はい |
いいえ |
af_adset_id |
Adset ID |
はい |
いいえ |
はい |
いいえ |
いいえ |
af_ad_id |
Ad ID |
はい |
いいえ |
はい |
いいえ |
いいえ |
install_time |
インストール時間 |
はい |
はい |
はい* |
はい |
はい |
attributed_touch_type |
タッチタイプ |
はい |
はい |
はい |
はい |
いいえ |
国 |
国 |
はい |
はい |
はい |
はい |
はい |
* アクティビティのコンテキストでは、KPIはインストール時間をイベント時間と見なします。 |
KPI
KPIはアプリの状況を確認するための指標となります。KPIは、以下のタブでタイプ別にグループ化されています。
KPI API名 | 説明 |
---|---|
インプレッション | 選択した期間におけるインプレッション数 |
クリック | 選択した期間におけるクリック数 |
インストール数 | 選択した期間におけるインストール数 |
cr | コンバージョン率 |
sessions | 選択した期間にインストールしたユーザーのセッション数 |
loyal_users | 選択した期間にインストールしたロイヤルユーザー数 |
loyal_users_rate | ロイヤルユーザー率(ロイヤルユーザー数 ÷ インストール数) |
cost |
選択した期間の総コスト |
収益 | 選択した期間にインストールしたユーザーの生涯収益 |
ROI | 選択した期間における投資対効果 |
arpu_ltv | 選択した期間にインストールしたユーザーの1ユーザーあたりの平均収益 |
average_ecpi | 特定の期間におけるeCPI コストとインストールがコールに含まれている場合にのみ使用できます。 |
アンインストール | 特定の期間にアンイストールしたユーザー |
uninstalls_rate | アンインストール率 |
event_counter_[event%20name]* | イベントの発生数 |
unique_users_[event%20name]* | イベントが発生したユニークユーザー数 |
sales_in_usd_[event%20name]* | レポートされたイベントの収益 |
* イベント名は小文字にする必要があります。 |
リテンションとは、アクティブなユーザー数を把握する指標です。
制限事項:
- 最大リテンション日数はインストール後 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%20name]* | 選択した期間におけるユーザーによるイベント数 |
activity_sales_in_usd_[event%20name]* | 選択した期間における収益イベントからの収益 |
activity_average_unique_users_[event%20name]* |
選択した期間における特定のイベントを実施した平均ユニークユーザー数 |
* イベント名では大文字と小文字が区別されます。 |
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列を生成します: |
収益
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 |
X日目までのユーザーあたりの総収益を日別で取得できます。 例えば、URLでcohort_3_days_total_revenue_per_userを指定するとレポートでは以下の3列を生成します: |
cohort_day_[x]_total_event_[eventname]_revenue_per_user |
特定のアプリ内イベントにおけるコホートX日目のユーザーあたりの累積収益 |
cohort_day_[x]_event_[eventname]_revenue_per_user | コホート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 |
X日目までのユーザーあたりの総イベント数を日別で取得できます。 例えば、URLでcohort_3_days_total_events_per_user と指定すると、レポートでは以下の3つの列を生成します。: |
説明 |
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を挿入いただいても構いません。
標準の算術演算子がサポートされています:%2bとしてエンコードされた加算(+)、減算(-)、乗算(*)、%2fとしてエンコードされた除算(/)。
計算式を挿入するKPIは、フィールド名は必ず 「calculated_kpi_」から始め、そのあとに有用な文字列で続けてください。例:calculated_kpi_purchaserate
例
最初の3日間の合算リテンション
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 |
いいえ |
時間枠の項目
次の時間粒度オプションを使用できます:デイリー
時間枠項目の To と From を仕様して、選択した時間範囲で必要な粒度を決定してください。
例
- 日単位の粒度: 次のような日付範囲を選択します。
From=2017-08-15&to=2017-08-17
ローカライゼーション
現地通貨とアプリ固有のタイムゾーンは、 アプリ設定ページから設定します。Master APIのデータは、システムの既定の通貨とタイムゾーン、またはアプリ固有のタイムゾーンと通貨を使用してデータを抽出できます。
以下が適用されます:
- アプリ固有のタイムゾーン/通貨の使用は、すべてのアプリが同じタイムゾーン/通貨を持つ場合にのみサポートされます。それ以外の場合は、UTC と USD が使用されます。タイムゾーンと通貨は別々です。つまり、すべてのアプリの通貨が同じでタイムゾーンが同じでない場合は、アプリ固有の通貨を使用できますが、アプリ固有のタイムゾーンは使用できません。
- リクエストされた時間範囲内にダッシュボードでリクエストされたタイムゾーンが変更された場合、生成されたレポートには、最新のタイムゾーンの変更から始まる値が含まれます。
次のパラメーターを使用して、アプリ固有の設定を選択します。注意:preferredパラメーターを使用しない場合は、通貨の場合は USD、タイムゾーンの場合は UTCという既定の設定が適用されます。
パラメータ名 | 説明 | 例 | 必須? |
---|---|---|---|
currency |
金額はアプリ設定画面で設定された通貨です。 |
currency=preferred |
いいえ |
timezone |
使用されるタイムゾーンは、アプリ設定画面で設定されたタイムゾーンに従います。 |
timezone=preferred |
いいえ |
タイムゾーンに対応してレポートが表示されるためには、timezone=preferredパラメーターは必ず使用する必要があります。
コール例
Master APIで利用できるURLを用意しました。コピーペーストでご活用ください。
URLを使う前に以下の点をお気をつけください:
- アプリ名 com.greatapp をアプリIDのアプリ名に置き換えます。
- [api_token] を 御社アカウントのAPIトークンに置き換えてください。
- 開始日付と終了日付を必要な日付範囲に置き換えてください。
- 要件に応じて KPIを変更してください。
- アプリ固有のタイムゾーンと通貨を使用して、次のものやクエリURLを使用してレポートを取得できます。
&timezone=preferred
¤cy=preferred
Facebook広告のパフォーマンスを比較する:
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp&from=[from_date]&to=[to_date]&pid=facebook
&groupings=pid,c,af_adset_id,af_ad_id
&kpis=installs,clicks,impressions,sessions,loyal_users,cost,revenue,arpu_ltv,roi
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp,id123456789&from=[from_date]&to=[to_date]&pid=googleadwords_int
&groupings=pid,c,af_adset_id,af_ad_id
&kpis=installs,sessions,loyal_users,cost,revenue,arpu_ltv,roi
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=all&from=[from_date]&to=[to_date]&groupings=geo,pid,c&kpis=
installs,clicks,impressions,sessions,loyal_users,cost,revenue,arpu_ltv,
roi&geo=us,ca
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp&from=[from_date]&to=[to_date]&groupings=af_keywords
&kpis=roi,arpu_ltv,average_ecpi,installs,loyal_users_rate,cost,revenue
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp,id123456789&from=[from_date]&to=[to_date]&groupings=af_prt,pid,c&kpis=installs,
loyal_users_rate
(アフィリエイトのインストール計測についての詳細はこちら)
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp&from=[from_date]&to=[to_date]&groupings=af_siteid&pid=affiliates
&kpis=installs,loyal_users_rate,arpu_ltv,retention_day_1,retention_rate_day_1,
retention_day_7,retention_rate_day_7,retention_day_15,retention_rate_day_15,
retention_day_30,retention_rate_day_30
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp,id123456789&from=[from_date]&to=[to_date]&groupings=attributed_touch_type
&kpis=installs,sessions,loyal_users_rate,arpu_ltv
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=all&from=[from_date]&to=[to_date]&groupings=pid,c
&kpis=installs,loyal_users_rate,retention_day_1,retention_rate_day_1,
retention_day_7,retention_rate_day_7,retention_day_15,retention_rate_day_15,
retention_day_22,retention_rate_day_22,retention_day_30,retention_rate_day_30
制限事項とトラブルシューティング
制限事項
-
コストデータ:
- さまざまなコストディメンションが利用可能であることから、広告セット、広告、地域、チャンネル、サイトIDは 広告ネットワークによって異なります。
- eCPIを取得するには:コストデータが利用可能な場合は、インストールとコストの両方をコールに含めます。
- 基本的に、オウンドメディアを含むAppsFlyerのURLを使う全てのメディアソースで、リクエストするディメンションに関わらずコストデータが提供可能です。ただし、URLにコストパラメータが存在する必要があります。独自のAPIをもつセルフレポーティングネットワークは一部のディメンションのコストデータのみに対応しています。
たとえば、 Facebook は同じコールでGeoとChannelによるグループ化をサポートしていません。これらのいずれかによる個別のグループ化がサポートされています。 - コストデータはあるが、最近のインストールデータがないキャンペーン(約7日間)はマスターAPIではご利用いただけません。
- グループ化:特定のグループ化は、LTV KPI、アクティビティ、またはリテンションKPI でのみ使用できます。特定のKPIが利用不可の場合、”N/A” とAPIから返答されます。例えば、retention_rate_day_7 を af_channel でグループするようにリクエストをすると、“N/A” と返します。
- レポートあたりの最大行数: 20万行
-
イベント名: Master API は現在、スラッシュ
/
を含むイベント名をサポートしていません。この制限を克服するには、イベント名のユーザー/
を避けます。 - 処理時間:複数のアプリを選択すると、処理時間が長くなり、応答に時間がかかることがあります。
トラブルシューティング
メッセージ |
備考 |
|
---|---|---|
200 OK |
|
|
401 Unauthorized | The Supplied API Token is Invalid |
|
404 | Not found |
|
416 | No Groupings Selected |
|
403 | Unrecognized date format. | 日付を確認して修正してください。 |
403 | From date can't be after To date. (from の日付は to の日付より後に設定できません) |
日付を確認して修正してください。 |
403 | From and To dates must have the same granularity format. (From と To の日付は同じ粒度形式にする必要があります。) |
日付を確認して修正してください。 |
403 | No KPIs provided.(KPIが指定されていません。) | |
403 | One or more of the formula's operators are not supported when not Unicode. (数式の 1つ以上の演算子は、Unicode でない場合、サポートされません。) |
|
403 | No calculated KPI name provided. (計算されたKPI名が指定されていません。) |
|
416 | Something went wrong(不具合が発生しました)Please re-try to download in a minute, choose a narrower time range, or contact AppsFlyer support. (1分後に再試行するか、より狭い時間範囲を選択するか、AppsFlyerサポートにお問い合わせください。) |
|
416 | The requested time range is in UTC only (prior to the timezone change) (リクエストされた時刻範囲はUTCのみ(タイムゾーン変更前)です。) |
|
403 | Not authorized app-ids: <app_id> (アプリID <app_id> は承認されていません。) |
|
416 | Please select authorized app-id (承認されたアプリIDを選択してください) |
|
416 | No Groupings Selected | |
416 | 間違ったAPIフィールド |
項目が存在しないか、許可されていません。 |
416 | Other reason(その他の理由) |
レポートのサイズが 200Kを超えています。 |