マスターAPI - カスタマイズ可能な集計データAPI

マスターAPIはAppsFlyerのピボットテーブルの元となる機能となります。AppsFlyerのプレミアム機能として、セットでご利用する形となります。

マスターAPIの構造

マスターAPIのURLは必須部分とオプショナルの部分に分かれます。詳細は下記を参照ください。 マスターAPIのベースエンドポイント、必須パラメーター、グルーピング、KPI、計算後KPI、フィルター、期間、そしてローカライゼーションに関する値が含まれます。

1.マスターAPIのベースエンドポイント

マスターAPIへの通信はすべて下記のエンドポイントから始まる必要があります。

https://hq.appsflyer.com/export/master_report/v4?

マスターAPIのURLに含める可変パラメーターはすべて'?' の文字に続けて入力します。

2. 必須パラメーター

マスターAPIのURLの基本フォーマットは以下の通りとなります。

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=[app_id]&from=[from_date]&to=[to_date]&groupings=[list]&kpis=[list]

下表は必須のパラメーターとなります。

3. 利用可能なグルーピング

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

4. KPI

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

5. 計算後KPI

マスターAPIレポートでは、上記のKPIに加え、計算後KPIを追加することが可能です。この方法により、自動的に必要なKPIをマスターAPIレポートで確認することができるようになります。

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

6. フィルター

7. 期間選択

• 日単位
• 週単位

8.ローカライゼーション

管理画面のアプリ設定画面にて、ご希望の通貨及びタイムゾーンを設定できます。以下のパラメーターを利用することで、同じ設定をマスターAPIレポートに反映することができます。

• デフォルトの設定のままかどうかに関わらず、もしすべてのアプリが同じ設定の場合は、その設定が使用されます。アプリ毎に設定が異なる場合は、UTC±00:00 とUSDが使用されます。
• ローカライゼーション（タイムゾーンと通貨の設定）は週単位のリテンションKPIには対応していません。
• 選択した期間中に、管理画面でタイムゾーン設定を変更した場合、生成されたレポートには変更した時点以降のデータしか含まれません。

レスポンスフォーマット

レスポンスはすべてV5フォーマットとなります。

デフォルト設定で、レスポンスデータはすべてCSVファイル形式となります。JSONフォーマットでの受け取りを希望する場合は、&format=jsonをURLに追加ください。

リクエストサンプル

マスターAPIで利用できるURLを用意しました。コピーペーストでぜひご活用ください。URLを使う前に以下の点をお気をつけください。

1. アプリの名前を「com.greatapp」からご自身のアンドロイドまたはiOSのアプリIDに変更ください。
2. [TOKEN]の箇所をご自身のアカウントのAPIトークンをご入力ください。
3. ご希望の期間に変更ください（from_date, to_dateの箇所を変更）
4. ご希望に応じて、KPIを変更ください。
5. アプリがデフォルト設定（UTC±00:00 とUSD）とは異なる場合は、 &timezone=preferredと&currency=preferredをクエリーURLに追加ください。

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=com.greatapp&from=[from_date]&to=[to_date]&groupings=is_primary&kpis=revenue

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

制限事項

コストデータ

eCPIを含むコストデータは、常に利用可能とは限りません。ネットワークがコストデータを提供できるかどうかは、ネットワークの種類によります。例えば、AppsFlyerのリンクなのかセルフレポーティングなのか、またどのディメンションを利用したいのか、などによります。

基本的に、オウンドメディアを含むAppsFlyerのURLを使う全てのメディアソースで、リクエストするディメンションに関わらずコストデータが提供可能です。ただし、URLにコストパラメータが存在する必要があります。独自のAPIをもつセルフレポーティングネットワークは一部のディメンションのコストデータのみに対応しています。

例えば、FacebookはGeoとChannelで同時にグループ化することができません。（どちらか1つのみであれば可能です）

コストデータ連携が可能なアドネットワークの全リストをご覧になりたい場合は こちらをご確認ください。