どのようにお手伝いできますか?

Pull APIローデータ プレミアム機能

  • 更新

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

PullAPIRaw_us-en.png

Pull APIローデータ

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

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

レポート 説明 更新頻度

ローデータレポート(非オーガニック)

インストール 非オーガニックインストールを記録します。ユーザーが初めてアプリを起動したときに記録が生成されます。
 
リアルタイム
アプリ内イベント ユーザーが実行したイベントを記録します。
 
リアルタイム
アンインストール ユーザーがアプリをアンインストールしたときに記録します。
 
日次
再インストール
 
アプリをアンインストールした後にUAメディアソースと接触し、リアトリビューション期間中にアプリを再インストールしたユーザーを記録します。 リアルタイム

ローデータレポート(オーガニック)

オーガニックインストール
 
ユーザーが初めてアプリを起動したときに記録します。
 
継続的
オーガニックアプリ内イベント
 
ユーザーが実行したイベントの詳細を記録します。
 
継続的
オーガニックアンインストール
 
ユーザーがアプリをアンインストールした記録。
 
日次
オーガニック再インストール
 
ユーザーがアプリをアンインストールした後、再度インストールしたことを記録します。 日次
 

リターゲティング

コンバージョン リターゲティングキャンペーンに接触した後にアプリを開いたユーザーの記録。 リアルタイム
アプリ内イベント リエンゲージメント期間中にユーザーが実行したアプリ内イベント。 リアルタイム

広告収益のローデータ

帰属広告収益
 
メディアソースに帰属するユーザーの広告収益を記録します。 日次
オーガニック広告収益 メディアソースに帰属しないユーザーの広告収益を記録します。 日次

Protect360の不正防止

インストール 不正と識別されたため、どのメディアソースにも帰属されなかったインストールを記録します。 リアルタイム
アトリビューション後のインストール 不正なインストールから発生したため、まったく帰属されなかったアプリ内イベントを記録します。 日次
アプリ内イベント Protect360によって不正と識別されたアプリ内イベントを記録します。 リアルタイム
アトリビューション後のアプリ内イベント メディアソースに帰属された後に不正と識別されたインストール、またはインストール自体にかかわらず不正と判定されたインストールに関連するアプリ内イベントを記録します。 日次
クリック Protect360によってブロックされたユーザーのクリックを記録します。 リアルタイム
ブロック済みインストールポストバック インストールがブロックされた結果としてメディアソースに送信されたポストバックのコピーを記録します。 リアルタイム
ポストバック
インストールポストバック ユーザーが初めてアプリを起動したときに生成されたインストールイベントを記録します。 日次
アプリ内イベントポストバック メディアソースに送信されたアプリ内イベントポストバックを記録します。 日次
リターゲティングアプリ内イベントポストバック リエンゲージメント期間中にユーザーが実行したアプリ内イベントを記録します。 リアルタイム
リターゲティングコンバージョンポストバック リエンゲージメント期間中にユーザーが実行したアプリ内イベントを記録します。 リアルタイム

Pull APIローデータの使用

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

  1. AppsFlyerAdmin_us-en.pngAPIトークンを取得します。管理者はトークンを取得する必要があります。
  2. 認証ヘッダーで使用するAPIトークンを開発者に渡します。
  3. 次のセクションで説明するように、APIコールを行う際に入力するパラメータを開発者に渡してください。パラメータは、レポートの対象と構成、およびレポートの期間を決定します。
  4. 開発者に、Developer HubのPull APIローデータの手順に従うよう伝えてください。

パラメータ

パラメータ 説明
from
  • 日付範囲はfromパラメータとtoパラメータで構成されます。日付はアクティビティ日に基づきます。
  • 形式:yyyy-mm-dd、yyyy-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:特定のメディアソースに絞り込む(フィルターする)ためのパラメータです。

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

  • Meta広告の場合、categoryとmedia sourceをfacebookに設定します。
  • X広告の場合、categoryとmedia sourceをtwitterに設定します。
  • その他のメディアソースの場合は、categoryをstandardに、media sourceをメディアソース名に設定します。
  • 例
    • media_source=facebook&category=facebook
    • media_source=abc_example&category=standard
maximum_rows

1回のAPIコールで返される行数の上限です。

  • [デフォルト]値を指定しない場合は最大200K行
  • 200000:最大200K行が返されます
  • 1000000:最大1M行が返されます
  • 例:maximum_rows=1000000を指定すると、最大1M行を取得できます。 
event_name

指定したイベントでアプリ内イベントをフィルタリングします。カンマ区切りのリストを使用して、複数のイベントを選択できます。

例:event_name=af_purchase,ftd 

reattr

リターゲティングのアトリビューションデータを設定します。

  • [デフォルト]falseの場合、ユーザー獲得(UA)キャンペーンのデータが返されます。
  • trueの場合、リターゲティングのアトリビューションデータが返されます。
  • 例:reattr=true
additional_fields

デフォルトフィールドに加えて、追加フィールドを取得します。 

例:additional_fields=device_download_time,deeplink_url

currency

収益とコストの通貨

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

例:アプリ固有の通貨がEURの場合、currency=preferredを指定すると値はEURで返されます。

timezone

[デフォルト]データはUTCで返されます。

  • アプリ固有のタイムゾーンでデータを取得するには、このセクションに記載されている方法で、timezoneをAPIコールに追加します。 
  •  timezone=[Numerical value] 
  • 例:タイムゾーンがUTC+10:00の場合はtimezone=+10:00を使用します。注意:+、-、:はエンコードする必要があります。例:+10:00は%2B10%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から(00:00を含む)
  • パラメータto:
    • 日付のみ = 選択した日の終了時刻(24:00)まで
    • 日付と時刻 = 表示された時刻まで(その時刻は含まない)

例:あるアプリ所有者が、すべてのソースから毎日130万件のインストールを受信しているとします。 100万行の上限を超えないように、アプリ所有者は1日を12時間ずつに分けて2回のURIコールを行います。次の表に示す方法を使用できます。 

APIコール From  To 
1回目のAPIコール 

from=yyyy-mm-dd

例:

  • from=2019-12-29
  • この日の00:00に開始します。

to=yyyy-mm-dd 12:00

例:

  • to=2019-12-29 12:00
  • 12:00ではなく、11:59:59まで続きます。 

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

 

例: 

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

  • 2019年12月29日12:00から開始します。
  • 2019年12月30日00:00に終了します。

from=yyyy-mm-dd 12:00

例:

  • from=2019-12-29 12:00
  • 12:00から開始し、12:00を含みます。

 

to=yyyy-mm-dd

例:

  • to=2019-12-29
  • 00:00に終了します。

 

オプション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日の00:00になる前を意味します。
注意:オプションAまたはBを使用してください。どちらも同じ結果になります。 

追加フィールド

新しいフィールドによって既存のインポートおよび取り込み処理に影響が出ないよう、追加のレポートフィールドはデフォルトのフィールド一覧には追加されません。デフォルト以外のフィールドを取得するには、additional_fieldsパラメータを使用します。

デフォルトフィールド

Pull APIのデフォルトフィールド
アトリビューションタッチタイプ
アトリビューションタッチ時間
インストール時間
イベント時間
イベント名
イベント値
イベント収益
イベント収益通貨
イベント収益(USD)
イベントソース
レシート検証済み
パートナー
メディアソース
チャネル
キーワード
キャンペーン
キャンペーンID
広告セット
広告セットID
広告
広告ID
広告タイプ
サイトID
サブサイトID
サブパラメータ1
サブパラメータ2
サブパラメータ3
サブパラメータ4
サブパラメータ5
コストモデル
コスト値
コスト通貨
コントリビューター1のパートナー
コントリビューター1のメディアソース
コントリビューター1のキャンペーン
コントリビューター1のタッチタイプ
コントリビューター1のタッチ時間
コントリビューター2のパートナー
コントリビューター2のメディアソース
コントリビューター2のキャンペーン
コントリビューター2のタッチタイプ
コントリビューター2のタッチ時間
コントリビューター3のパートナー
コントリビューター3のメディアソース
コントリビューター3のキャンペーン
コントリビューター3のタッチタイプ
コントリビューター3のタッチ時間
地域
国コード
州
市
郵便番号
DMA
IP
WIFI
オペレーター
キャリア
言語
AppsFlyer ID
Advertising ID
IDFA
Android ID
Customer User ID
IMEI
IDFV
プラットフォーム
デバイスタイプ
OSバージョン
アプリバージョン
SDKバージョン
アプリID
アプリ名
バンドルID
リターゲティング
リターゲティングコンバージョンタイプ
アトリビューションルックバック期間
リエンゲージメント期間
プライマリアトリビューション
ユーザーエージェント
HTTPリファラ
元のURL

追加情報

特性と制限事項

特性 備考 
必要なAPIトークンタイプ AppsFlyerAdmin_us-en.pngV2.0トークン
アドネットワークのアクセス いいえ
代理店によるデータアクセス はい
運用媒体の開示設定 はい。ただし、代理店フィルターとメディアソースフィルターの両方を使用する場合、メディアソースフィルターは非透明な代理店には適用されません。これは、非透明な代理店の場合、フィルタリングしたメディアソースのデータだけでなく、すべてのデータが含まれることを意味します。 
アプリ固有の通貨 はい
アプリ固有のタイムゾーン はい
データ更新頻度
  • オーバービュー管理画面でのデータの利用可能状況と同等です。
  • 数時間のタイムラグで更新されるレポート:
    • オーガニックアプリ内イベント
  • 日次で更新されるレポート:
    • アンインストール
    • アトリビューション後のアプリ内イベント
    • 広告収益
過去データ はい。  データ保持およびレート制限のポリシーに従います。 
非オーガニックデータ はい
オーガニックデータ はい
レート制限

ローデータに関するAPIの制限です。 

サイズ制限
  • APIコールでは最大200K行または1M行が返されます。
  • レポートの行数が200K行または1M行ちょうどの場合、データが欠落していると考えてください。
  • 最大行数を指定するには、maximum_rowsパラメータを使用します。
  • 時刻を含むfrom/toパラメータを使用して、複数のAPIコールを実行します。
install_date_fromとinstall_date_to インストール日の日付範囲は、アクティビティの日付範囲より前である必要があります。 

トラブルシューティング

症状/メッセージ 解決策
選択した期間に対して期待されるデータがレポートに含まれていない、またはローデータレポートと集計データレポートの間に差異がある場合。 

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