Pull API ローデータ

プレミアム機能

概要: このAPIを使用して、ローデータレポートをCSVファイルで取得します。

PullAPIRaw_us-en.png

Pull API ローデータ

  • Pull APIを使用すると、ローデータレポートをCSVファイルで取得できます(ローデータレポートの詳細)。
  • 利用可能なオプション(メディアソース、データ期間、アプリ内イベント名、地域)でフィルターします。
  • Pull APIの追加機能は次のとおりです:
    • 通貨を選択
    • タイムゾーンの選択

Pull API経由で利用可能なローデータレポート

Report 説明 更新頻度
ローデータレーポート(非オーガニック)
インストール 非オーガニックインストールを記録します。ユーザーがアプリを初回起動した際に記録が生成されます。
リアルタイム
アプリ内イベント ユーザーが実行したイベントを記録します。
リアルタイム
アンインストール ユーザーがアプリをアンインストールした際に記録します。
毎日
再インストール
アプリをアンインストールした後、UAメディアソースと接触し、リアトリビューション期間中にアプリを再インストールしたユーザーを記録します。 リアルタイム
ローデータレーポート(オーガニック)
オーガニックインストール
ユーザーがアプリを初回起動した際に記録します。
随時
オーガニックアプリ内イベント
ユーザーが実行したイベントに関する詳細を記録します。
随時
オーガニックアンインストール
ユーザーがアプリをアンインストールしたことを記録します。
毎日
オーガニック再インストール
リエンゲージメント期間中にリターゲティング媒体へアトリビューションされたユーザーからの広告収益を記録します。
毎日
広告収益ローデータ
非オーガニックインストールに紐づくアプリ内広告収入
メディアソースに紐づくユーザーの広告収益を記録します。 毎日
オーガニックインストールに紐づくアプリ内広告収入 メディアソースに紐づかないユーザーの広告収益を記録します。 毎日
Protect360不正
インストール 不正と識別されたためどのメディアソースの成果にも紐づいていないインストールを記録します。 リアルタイム
ポストアトリビューションのインストール 不正と識別されたため一切計測されなかったアプリ内イベントを記録します。 リアルタイム
アプリ内イベント Protect360により不正と識別されたアプリ内イベントを記録します。 毎日
ポストアトリビューションのアプリ内イベント 一度メディアソースへアトリビューションされたが不正と判断されたインストールに紐づくアプリ内イベント、もしくはインストール自体に関係なく不正と判定されたアプリ内イベントを記録します。 毎日
クリック Protect360によりブロックされたユーザーが実行したクリックを記録します。 毎日
ブロック済みインストールポストバック ブロックされたインストールと判断されたメディアソースに送信されたポストバックのコピーを記録します。 リアルタイム
ポストバック
インストールポストバック ユーザーがアプリを初回起動した際に生成されるインストールイベントを記録します。 毎日
アプリ内イベントのポストバック メディアソースに送信されたアプリ内イベントポストバックを記録します。 毎日
リターゲティング アプリ内イベントポストバック リエンゲージメント期間中にユーザーが実行したアプリ内イベントを記録します。 リアルタイム
リターゲティングコンバージョンポストバック リエンゲージメント期間中にユーザーが実行したアプリ内イベントを記録します。 リアルタイム

Pull API ローデータの使用

Pull APIローデータを使用するには:

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

パラメーター

パラメーター 説明
from
  • 日付範囲は、 fromと to パラメータで構成されています。日付はアクティビティ日を示しています。
  • 形式: yyyy-mm-ddyyyy-mm-dd hh:mm又は yyyy-mm-dd hh:mm:ss
    注:スペースは  from=2020-04-01%2001:00:00 のようにエンコードする必要があります- 通常、ブラウザはスペースをエンコードします。 
  • 例:2010-01-01 または 2010-01-01 20:15 (ローデータレポートでは、時間と分のパラメータが利用できます)。 
to 終了日。from を参照

media_source

media_source: コールを特定のメディアソースに制限(フィルター処理)します。

パラメーター category パラメーター media_source の両方を次のように設定します:

  • Meta広告:カテゴリとメディアソースを facebookに設定します
  • X Adsの場合は、カテゴリとメディアソースを twitter に設定します
  • その他すべてのメディアソースについては、カテゴリを standard に、メディアソースにメディアソース名を設定してください。
    • media_source=facebook&category=facebook
    • media_source=abc_example&category=standard
maximum_rows

1 回のAPI 呼び出しによって返される行の最大数。

  • [デフォルト] 値が送信されない場合は、最大20万行です。
  • 200000 : 最大20万行が表示されます
  • 1000000: 最大100万行が表示されます
  • 例: maximum_rows=1000000 を追加することで100万行を有効にします。
event_name

アプリ内イベントを特定のアプリ内イベントで絞り込みます。複数イベントを選択する場合は、カンマ区切りのリストを使用します。

event_name=af_purchase,ftd 

reattr

リターゲティングの計測データを設定します。

  • 【デフォルト】falseの場合、ユーザー獲得(UA)データが返されます。
  • true の場合は、リターゲティングデータが返されます。
  • reattr=true
additional_fields

デフォルト項目に加えて、追加項目を取得できます。 

: additional_fields=device_donwload_time,deeplink_url

currency

収益とコストの通貨

  • 【デフォルト】パラメータが送信されない場合、データはUSDで返されます。つまり、なにも設定しないと結果はUSDで返されます。
  • もし、 currency=preferredを送信すると、 アプリ固有の 通貨が使用されます。 つまり、アプリ設定で設定した通貨が使用されます。

:アプリ側で設定されている通貨単位がEURの場合、 currency=preferred を送信すると、値をEURで取得できます。

timezone

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

  • データを アプリ固有の タイムゾーンで取得するには、 timezone をこのセクションで示すようにコールに追加してください: 
  •  timezone=[数値] 
  • 例: タイムゾーン UTC+9:00(日本時間)の場合、timezone=+9:00
    注:記号 +,-: はエンコードする必要があります。
    例: +9:00 エンコード後 > 
    %2B9%3A00
geo

国別コードでデータを絞り込みます。

制限:1回のAPIコールで設定できる国コードフィルターは1つだけです。

例:geo=ZA

from_install time
  • 日付範囲は、 fromと to パラメータで構成されています。日付はアクティビティ日を示しています。
  • 形式:  yyyy-mm-dd
  • 例:2010-01-01 
to_install_time

終了日。 from_install timeを参照

agency

コールを特定の代理店に制限(フィルター)する。

時間枠の項目

APIの結果が最大値を超える場合は、時間と分を使用してレポートを分割します。
例は以下:

  • from/to: yyyy-mm-dd hh:mm 
  • from: 
    • 日付のみ = 選択した日付の開始(00:00)から
    • 日付と時刻 = 00:00以降
  • パラメータ to: 
    • 日付のみ = 選択した日付の終了(24:00)まで
    • 日付と時刻 = 表示する時刻まで(ただしその時刻を含まない)

例: あるアプリでは全メディアソースから、1日に30万件のインストールがあります。100万行の制限を解決するために、アプリ所有者は一日を12時間のURIコールに分割します。その方法について次の表を参照してください。 

APIコール From  To 
最初のAPIコール 

from=yyyy-mm-dd


例:

  • from=2019-12-29
  • この日の始めである00:00から始まります。

to=yyyy-mm-dd 12:00


例:

  • to=2019-12-29 12:00
  • 11:59:59 まで続行されますが、12:00は含まれません 

オプションA: 2番目のAPIコール 

 

例: 

&from=2019-12-29 12:00&to=2019-12-29

  • 2019年12月29日の正午から開始
  • 2019年12月29日の深夜に終了
 

from=yyyy-mm-dd 12:00


例:

  • from=2019-12-29 12:00
  • 12:00から開始(12:00を含む)

 

to=yyyy-mm-dd


例:

  • to=2019-12-29
  • 深夜に終了

 

オプション B: 2番目のAPIコール

from=yyyy-mm-dd 12:00


例:

  • from=2019-12-29 12:00
  • 12:00から開始(12:00を含む)

to=yyyy-mm-dd+1 00:00

+1 = 翌日の00:00


例:

  • to=2019-12-30 00:00
  • つまり時刻が12月30日になる前。

注意:オプションAとBは同じ結果になりますので、どちらかを使用してください。 

追加フィールド

追加のレポート項目は既定の項目の一覧に追加されないため、新しい項目が既存のインポートおよび取り込みプロセスに影響を与えることはありません。 additional_fields パラメータを使用して、デフォルト以外の項目を取得してください。

  • 項目は一度のみ記載します。
  • 利用できる項目リスト をご覧ください。
  • 例: additional_fields=device_download_time,deeplink_url

デフォルトの項目

デフォルト Pull API 項目
Attributed Touch Time
Install Time
Event Time
Event Name
Event Value
Event Revenue
Event Revenue Currency
Event Revenue USD
Event source
Is Receipt Validated
Partner
Media Source
Channel
Keywords
キャンペーン
Campaign ID
広告セット
Adset ID
Ad
Ad ID
Ad Type
サイトID
Sub Site ID
Sub Param 1
Sub Param 2
Sub Param 3
Sub Param 4
Sub Param 5
Cost Model
Cost Value
Cost Currency
Contributor 1 Partner
Contributor 1 Media Source
Contributor 1 Campaign
Contributor 1 Touch Type
Contributor 1 Touch Time
Contributor 2 Partner
Contributor 2 Media Source
Contributor 2 Campaign
Contributor 2 Touch Type
Contributor 2 Touch Time
Contributor 3 Partner
Contributor 3 Media Source
Contributor 3 Campaign
Contributor 3 Touch Type
Contributor 3 Touch Time
Region
Country Code
State
City
Postal code
DMA
IP
WIFI
演算子
Carrier
Language
AppsFlyer ID
Advertising ID
IDFA
Android ID
Customer User ID
imei
IDFV
Platform
Device Type
OS Version
App Version
SDK Version
App ID
アプリ名
Bundle ID
Is Retargeting
Retargeting Conversion Type
Attribution Lookback
Reengagement Window
Is Primary Attribution
User Agent
HTTP Referrer
Original URL

追加情報

特性と制限

特性 コメント 
必要なAPIトークンタイプ AppsFlyerAdmin_us-en.pngV2.0 トークン
アドネットワークのアクセス いいえ
代理店アクセス はい
代理店の運用媒体の開示設定 はい。ただし、代理店フィルターとメディアソースフィルターの両方を使用する場合、かつ、代理店アカウント側で「運用媒体の開示」設定がオフになっている場合、メディアソースフィルターは利用できません。これは、「運用媒体の開示」設定がオフの代理店経由のトラフィックの場合、すべてのデータが含まれることを意味します。フィルターされたメディアソースからのデータだけではありません。 
App-specific currency はい
アプリ固有のタイムゾーン はい
データの更新頻度
  • オーバービュー管理画面のデータ可用性と同じ。
  • 更新に数時間のタイムラグが生じるレポート:
    • オーガニックアプリ内イベント
  • 毎日更新されるレポート:
    • アンインストール
    • ポストアトリビューションのアプリ内イベント
    • 広告収益
過去データ はい。データ保持レート制限ポリシーに準拠。
非オーガニックデータ はい
オーガニックデータ はい
レート制限

ローデータに関するAPI 制限

サイズ制限
  • APIコールは、最大20万行または100万行のデータを返します。
  • レポートの行数が20万/100万ちょうどの場合、いくつかデータが不足していると考えてください。
  • 最大行数を選択するには、maximum_rows パラメータを使用します。
  • 時刻を含むfrom/toパラメータを使用して、複数のAPIコールに分けてデータを取得してください。  
Install_date_fromと install_date_to インストールの日付範囲は、アクティビティの日付範囲より前である必要があります。

トラブルシューティング

症状/メッセージ 解決策
選択された設定期間に対して期待されるデータがレポートに含まれていない、またはローデータレポートと集計データレポートの間に不一致がある状況です。 

timezoneのパラメータが設定されていることを確認してください。設定しない場合、データはアプリのタイムゾーンではなくUTCベースで送信されます。