Pull API集計データの使用

概要: URIを使用して、CSVファイルで集計レポートを取得します。

PullAPIAverage_us-en.png

 Pull API ローデータをお探しですか?

Pull API ローデータ

Pull API集計データの特性

  • レポートはCSVファイルとして生成されます。
  • データの鮮度は「データエクスポート」ページ内の同等のレポートと同じです。
  • 利用できるオプションによるフィルタ:メディアソースと日付範囲。
  • Pull APIの追加機能は次のとおりです:
    • アトリビューションタッチタイプ で絞り込む機能
    • 選択可能なタイムゾーン 
  • Pull APIは、チームメンバーとBI開発者による使用に適しています。
    • チームメンバーは、ブラウザにURIを貼り付けることでレポートを取得できます。URIテンプレートは、管理画面上でご確認いただけます。 
    • BI開発者は、URIをスクリプトに埋め込むことでレポートを取得できます。 

URI テンプレートの例 TemplateURL_us-en.jpg

カテゴリ ユーザー獲得 リターゲティング Protect360
パートナー(メディアソース)

パートナー(日付別)

日別

地域別

地域別レポート (日付別)

* リターゲティングレポートの場合は、URIに &reattr=true を追加します。 

Pull APIで利用できる集計パフォーマンスレポート

 関連記事:

用語

用語 説明
Pull API

URIを使用してCSVレポートをダウンロードするためのソリューション。

APIコールまたは呼び出し

ブラウザのアドレスバーに貼り付けるか、スクリプトを使用して、URIをAppsFlyerに送信すること。

URI
  • レポートの詳細を含むウェブアドレス (URL) のようなユニフォームリソースアイデンティファイア (URI)。
  • URIテンプレートは管理画面のAPIページにてご確認いただけます。

チームメンバー向けご利用ガイド

URIテンプレートについて

  • 管理画面から確認できるURIテンプレートには、アプリIDとレポートタイプが既に入力されています。
  • API V1.0トークンとレポート期間(from/to)用のプレースホルダが含まれていますので、それらを編集する必要があります。
  • URIのクエスションマーク(?)より右側の部分は、パラメータを含んでいます。各パラメータはアンパサンド(&)で始まります。 パラメータは、フィルタの設定、追加フィールドの追加、通貨やタイムゾーンの指定に使用されます。例えば、ローデータレポートで特定のメディアソースを指定する(絞り込む)場合、「media_source」パラメータを使います: &media_source=facebook
  • Pull API の理解を深めるには、次のチュートリアルを実行してください。

初めてPull APIを使用する際のチュートリアル

はじめに:

管理画面からレポートをダウンロードするには:

  1. [インテグレーション] > [APIアクセス] へ進みます。
    APIアクセスページが開きます。PullAPIPartnersReport_us-en.jpg
  2. レポートタイプを選択します。例:パフォーマンスレポート > パートナーレポート(日付別) 
    URLテンプレートが表示されます。
  3. クリックしてURIをコピーします。
  4. ブラウザの新しいタブを開き、URIを貼り付けます。
  5. URIを編集します:
    1. トークンプレースホルダを、管理者から提供されたPull APIトークンに置き換えます。
      例:トークンプレースホルダを置き換えます。 &api_token=12345678-1234-1234-1234-123456789012 注!スペースや句読点等は含みません。
    2. from/to プレースホルダを日付に置き換えます。
      例: &from=2020-01-20&to=2020-01-31 注意!スペースは含みません。「&」を削除しないでください。 
  6. EnterキーをクリックしてAPIコールを送ります。 
    レポートがダウンロードされます。
    追加パラメータを設定して、レポートをカスタマイズできます。たとえば、特定のメディアソースを選択したり、リターゲティングデータを返したり、などです。次のセクションには利用できるパラメーターの一覧が含まれています。

集計データPull APIパラメーター

パフォーマンスレポートのURIとパラメーター

パフォーマンスレポートURIの必須パラメーター
パラメーター 説明
api_token V1.0 API トークン APIコールの例では、次のように表示されています: <API TOKEN HERE>
from
  • 日付範囲は、 fromと to パラメーターで構成されています。この範囲はLTV(顧客生涯価値)(インストール)の日付範囲です。
  • 形式: yyyy-mm-dd, 
  • 例: 2010-01-01 or 2010-01-01
to 終了日。from を参照
Protect360レポートを除く、パフォーマンスデータに関するオプションのフィルタリングと表示パラメータ
パラメーター 説明
media_source

特定のメディアソースに制限(フィルタ)するために使用します。

  • 例:media_source=facebook
 attribution_touch_type

このパラメーターを例に示すように設定して、ビュースルーアトリビューション (VTA) のKPI を取得します。

例:attribution_touch_type=impression

currency

収益とコストの通貨

集計Pull APIレポートは常にアプリ固有の通貨を使用します。

reattr

リターゲティングのコンバージョンデータを取得します。

  • [デフォルト] false の場合、ユーザー獲得 (UA) キャンペーンのデータが返されます。
  • true の場合は、リターゲティングコンバージョンデータが返されます。
  • reattr=true
timezone

[デフォルト] UTC を使用してデータが返されます。

  • テンプレートURIには、アプリケーション固有のタイムゾーンに設定されたタイムゾーンパラメーターが入力されます。
  • [デフォルト]パラメーターが送信されない場合は、UTC を使用してデータが返されます。
  • timezone=[Joda-Time] を送信すると、アプリ固有のタイムゾーンを使用してデータが返されます。

タイムゾーンの選択に関する注意点

  • Joda-Timeタイムゾーンは、夏時間が考慮されます。
  • Joda-Timeの値は、アプリ設定のページで設定されている値と同じである必要があります。たとえば、タイムゾーン設定がParisの場合、Pull APIのURL のタイムゾーンの値は、timezone=Europe%2fParis である必要があります
  • 選択したタイムゾーンのデータを取得することは、タイムゾーン設定が行われた日付から可能です。変更日以前のデータでは、タイムゾーンとしてUTCが使用されます。

Google Adsのフィルタリングされたレポート

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&media_source=googleadwords_int

Facebookのフィルタリングされたレポート

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&media_source=facebook
Protect360 レポートのオプションパラメーター
parameter 説明
URI
  • 管理画面からProtect360のURIを取得します。
  • ここで説明するように URI を変更します。
 pid

特定のメディアソースでレポートをフィルタリングするには、pid パラメーターを使用します。たとえば、abc_net のデータを取得するには、pid=abc_net と入力します。

timezone

生成されるデータで使用するタイムゾーンを選択します。

timezone が送信されない場合、データではUTCが使用されます。

タイムゾーン パラメータを含むテンプレート。

例:timezone=preferred アプリケーション固有のタイムゾーンを使用してデータを取得するために使用します。

KPI

Protect360のパラメーターは、Pull APIとMaster APIと同じです。

ビュースルー計測 (VTA) KPI

  • ビュースルーのKPIを取得するには、次の例で詳しく説明されているように、パラメーター attribution_touch_type=impression をパフォーマンスレポートPull APIのURIに追加します。
  • どの集計レポートでもパラメーターを使用することができます。ユーザーインターフェイスからURIをコピーし、パラメーターを追加するだけです。
  • 次の例に示すように、&media_source パラメーターを追加して、レポートを特定のメディアソースに絞り込むこともできます。
  • クリック数、インプレッション数、コスト API など、一部のビュースルーKPI には値が関連付けられていないため、代わりにN/Aという値が表示されます。
URIの例
ビュースルーのみ https://hq.appsflyer.com/export/{app_id}/partners_report/v5?api_token={API token}&from=yyyy-mm-dd&to=yyyy-mm-dd&attribution_touch_type=impression

ビュースルーとメディアソース

https://hq.appsflyer.com/export/{app_id}/partners_report/v5?api_token={API token}&from=yyyy-mm-dd&to=yyyy-mm-dd&attribution_touch_type=impression&media_source=example_ad_network

開発者向け Pull API

実装の原則

前提条件:

チームメンバー向けのPull APIガイドをご参照ください。

次の点を考慮してください

  • 使用可能なレポートタイプごとに、管理画面にテンプレートURIが表示されます。
  • テンプレートを変更して、必要なデータを取得します。たとえば、日付範囲を設定し、パラメーターでデータを絞り込みます。
  • ローデータレポートと集計データレポートのパラメータは異なり、レポートセクションで詳しく説明します。
Pull APIの基本
パス

https://hq.appsflyer.com/export/app_id/report_type/v5

パスのパラメーター

app_id

  • AppsFlyerに表示されるアプリ識別子
  • AppsFlyerに表示されているとおりにアプリIDを挿入します。
  • iOSアプリの先頭に id を付けます。

report_type 

  • レポートのタイプを定義します。レポートおよび関連するURIの一覧は、管理画面に表示されます。 インテグレーション > APIアクセスへ進みます。
HTTP method

GET

必須のクエリパラメータ
パラメーター 説明
URIの例

GET 'https://hq.appsflyer.com/export/app_id/installs_report/v5? from=2020-01-01?&to=2020-01-10&api_token=api_token&currency=preferred

api_token

api_token:認証用のPull APIトークン

その他のパラメーター

パラメータは次により異なります:

 例

URIコールの例には追加パラメーターが含まれます:

https://hq.appsflyer.com/export/example.app.com/installs_report/v5?
        api_token={Account owner API key should be used}&from=yyyy-mm-dd
&to=yyyy-mm-dd&additional_fields=keyword_id,store_reinstall,
deeplink_url,oaid,install_app_store,contributor1_match_type,
contributor2_match_type,contributor3_match_type,match_type

スクリプトのサンプル

Pull APIをスクリプトに統合してデータを取得します。

  • 必要に応じて、レポートの種類、日付範囲、およびフィルタに関してスクリプトを編集します。
  • これらの例では、インストールレポートを使用します。
JavaNode JSPythonC#PHP
import okhttp3.*;

import java.io.BufferedWriter;
import java.io.FileWriter;

import java.util.concurrent.TimeUnit;

public class PullApi {
  public static void main(String[] args){

    String appID = "<APP_ID>";
    String reportType = "<REPORT_TYPE>";
    String apiToken = "<API_TOKEN>";
    String from = "<FROM_DATE>";
    String to = "<TO_DATE>";
    String requestUrl = "https://hq.appsflyer.com/export/" + appID + "/" + reportType + "/v5?api_token=" + apiToken + "&from=" + from + "&to=" + to;

    OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(30, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)

        .build();

    Request request = new Request.Builder()
        .url(requestUrl)
        .addHeader("Accept", "text/csv")
        .build();

    try {
      Response response = client.newCall(request).execute();

      if(response.code() != 200) {
        if(response.code() == 404) {
          System.out.println("There is a problem with the request URL. Please make sure it is correct");
        }
        else {
          assert response.body() != null;
          System.out.println("There was a problem retrieving the data: " + response.body().string());
        }
      } else {
        assert response.body() != null;
        String data = response.body().string();
        BufferedWriter writer;

        writer = new BufferedWriter(new FileWriter(appID + "-" + reportType + "-" + from + "-to-" + to + ".csv"));
        writer.write("");
        writer.write(data);
        writer.close();
      }
      System.exit(0);
    } catch (Exception e) {
      e.printStackTrace();
      System.exit(1);
    }
  }
}

追加情報

Pull API V4とV5の違い 

ローデータ: API V4は引き続き利用可能です。ファイル形式とヘッダーに変更はありません。

集計データ (V5):

V5.0では、media_source=facebook の場合、次の追加フィールドが提供されます。

  • Campaign ID
  • 広告セット名
  • Adset Id
  • Ad (Adgroup) Name
  • Ad (Adgroup) Id

特性と制限

特性
特性 コメント 
必要なAPIトークンタイプ AppsFlyerAdmin_us-en.pngV1.0 token
アドネットワークのアクセス N
代理店アクセス Y
代理店への運用詳細の開示 Y
アプリ固有の通貨 Y
アプリ固有のタイムゾーン Y
データ鮮度 リアルタイムで受け取ることができます。
過去データ Y
非オーガニックデータ Y
オーガニックデータ Y
レート制限

制限事項

サイズ制限
  • APIコールは、最大20万行のデータを返します。
  • もしレポートにちょうど20万行含まれている場合、追加の行のデータが不足していると考えてください。
  • 時刻を含むfrom/toパラメータを使用して、複数のAPIコールに分けてデータを取得してください。  

APIエラーコードとトラブルシューティング

エラーコードと解決策
ステータス コード 症状/メッセージ 解決策
OK 200 Empty CSV file(CSVファイルが空です)
  • addtional_fieldsがURIに複数含まれています
  • 開始日と終了日の両方の形式がyyyy-mm-ddであることを確認してください
OK

200

 

URIにAPIトークンが見つかりません

Bad request

400

Raw Reports historical lookback is limited to 90 days.(ローデータレポートの過去データは90日間に制限されています)

 to と from を使用して、3か月以下の期間を選択してください

Bad request

400

Your API calls limit has been reached for report type(このレポートタイプについてAPIコールの上限に達しました)

-
Unauthorized

401

Supplied API token is invalid(指定されたAPIトークンが無効です) 

最新のトークンについて管理者にお問い合わせください
Unauthorized

401

Account may be suspended.(アカウントが停止されている可能性があります)

管理画面にログインしアカウントのステータスを確認してください 

Not found

404

AppsFlyer 404エラーメッセージページが表示されます

  • アプリIDが正しいことを確認します。iOSアプリは id で始まる必要があります。
  • トークンがアプリと一致しません。正しいトークンを使用していますか?
この記事は役に立ちましたか?