概要:URIを使用してローデータレポートをCSVファイルで取得しましょう。
Pull API ローデータの特性
- ローデータレポートの内容についての説明
- レポートはCSVファイルとして取得されます。
- オプションごとのフィルタ:メディアソース、日付範囲、アプリ内イベント名、地域。
- 選択可能なタイムゾーンと通貨
- Pull APIは、アカウントユーザーや BI開発者に適しています。
- アカウントユーザー: ブラウザにURIを貼り付けることでレポートを取得することができます。このURIは、ディベロッパーハブで作成されます。
- BI開発者向けPull API はスクリプトにURIを埋め込むことでレポートを取得できます。
- レート制限: クォータメカニズムにより、1日に生成できるレポートの数が制限されます。
用語
用語 | 説明 |
---|---|
Pull API |
URIを使用してCSVレポートをダウンロードするためのソリューション。 |
APIコールまたは呼び出し |
ブラウザのアドレスバーに貼り付けるか、スクリプトを使用して、URIをAppsFlyerに送信すること。 |
URI |
|
アカウントをお持ちの方へのご案内
URIテンプレートについて
- AppsFlyer公式デベロッパーハブで使用できるURIテンプレートには、アプリIDとレポートの種類が入力されます。
- 編集する必要がある開始 (from) /終了 (to) 日のプレースホルダーがあります。
- URIのクエスションマーク(?)より右側の部分は、パラメータを含んでいます。各パラメータはアンパサンド(&)で始まります。 パラメータは、フィルタの設定、追加フィールドの追加、通貨やタイムゾーンの指定に使用されます。例えば、ローデータレポートで特定のメディアソースを指定(フィルタリング)する場合、「media_source」パラメータを使います:
&media_source=facebook
- Pull API の理解を深めるには、次のチュートリアルを実行してください。
- ポストバックURIは、管理画面からは確認できません。ポストバックのURIはスプレッドシート内に表示します。
初めてPull APIを使用する際のチュートリアル
ディベロッパーハブを使用すると、カスタムマイズされたデータを簡単に入力し、レポートをダウンロードしてテストできます。
はじめに:- 管理画面で確認できるPull APIトークンをアドミンユーザーに依頼して取得してください。
ディベロッパーハブからレポートをダウンロードする方法:
-
AppsFlyer Dev HubのAPIリファレンスを開いてください。
-
左側のメニューからレポートタイプを選択してください。
例:ローデータレポート(非オーガニック)> インストール。
すべてのレポートの種類の一覧については、以下の表を参照してください。 - 必要な項目を全て入力してください。
- 右側にURIテンプレートが表示されます。
- コピーアイコンをクリックしてURIをコピーしてください。
- ブラウザの新しいタブを開き、URIを貼り付けてください。
- EnterキーをクリックしてAPIコールを送ります。
レポートがダウンロードされます。
Report | 説明 | 更新頻度 |
---|---|---|
ローデータレーポート(非オーガニック) | ||
インストール | 非オーガニックインストールを記録します。ユーザーがアプリを初回起動した際に記録が生成されます。 |
リアルタイム |
アプリ内イベント | ユーザーが実行したイベントを記録します。 |
リアルタイム |
アンインストール | ユーザーがアプリをアンインストールした際に記録します。 |
毎日 |
再インストール |
アプリをアンインストールした後、UAメディアソースと接触し、リアトリビューション期間中にアプリを再インストールしたユーザーを記録します。 | リアルタイム |
ローデータレーポート(オーガニック) |
||
オーガニックインストール |
ユーザーがアプリを初回起動した際に記録します。 |
随時 |
オーガニックアプリ内イベント |
ユーザーが実行したイベントに関する詳細を記録します。 |
随時 |
オーガニックアンインストール |
ユーザーがアプリをアンインストールしたことを記録します。 |
毎日 |
オーガニック再インストール |
リエンゲージメント期間中にリターゲティング媒体へアトリビューションされたユーザーからの広告収益を記録します。 |
毎日 |
広告収益ローデータ |
||
非オーガニックインストールに紐づくアプリ内広告収入 |
メディアソースに紐づくユーザーの広告収益を記録します。 | 毎日 |
オーガニックインストールに紐づくアプリ内広告収入 | メディアソースに紐づかないユーザーの広告収益を記録します。 | 毎日 |
Protect360不正 | ||
インストール | 不正と識別されたためどのメディアソースの成果にも紐づいていないインストールを記録します。 | リアルタイム |
ポストアトリビューションのインストール | 不正と識別されたため一切計測されなかったアプリ内イベントを記録します。 | リアルタイム |
アプリ内イベント | Protect360により不正と識別されたアプリ内イベントを記録します。 | 毎日 |
ポストアトリビューションのアプリ内イベント | 一度メディアソースへアトリビューションされたが不正と判断されたインストールに紐づくアプリ内イベント、もしくはインストール自体に関係なく不正と判定されたアプリ内イベントを記録します。 | 毎日 |
クリック | Protect360によりブロックされたユーザーが実行したクリックを記録します。 | 毎日 |
ブロック済みインストールポストバック | ブロックされたインストールと判断されたメディアソースに送信されたポストバックのコピーを記録します。 | リアルタイム |
ポストバック | ||
インストールポストバック | ユーザーがアプリを初回起動した際に生成されるインストールイベントを記録します。 | 毎日 |
アプリ内イベントのポストバック | メディアソースに送信されたアプリ内イベントポストバックを記録します。 | 毎日 |
リターゲティング アプリ内イベントポストバック | リエンゲージメント期間中にユーザーが実行したアプリ内イベントを記録します。 | リアルタイム |
リターゲティングコンバージョンポストバック | リエンゲージメント期間中にユーザーが実行したアプリ内イベントを記録します。 | リアルタイム |
ローデータのPull APIパラメータ
ローデータのURIパラメータ
ローデータの必須パラメータ
パラメーター | 説明 |
---|---|
api_token | API bearer 認証トークン。 |
from |
|
to |
終了日。from を参照
|
ローデータの任意パラメータ
パラメーター | 説明 |
---|---|
media_source |
|
maximum_rows |
1 回のAPI 呼び出しによって返される行の最大数。
|
event_name |
アプリ内イベントを特定のアプリ内イベントで絞り込みます。複数イベントを選択する場合は、カンマ区切りのリストを使用します。 例: |
reattr |
リターゲティングの計測データを設定します。
|
additional_fields |
デフォルト項目に加えて、追加項目を取得できます。 例: |
currency |
収益とコストの通貨
例:アプリ側で設定されている通貨単位がEURの場合、 |
timezone |
[デフォルト] UTC を使用してデータが返されます。
|
geo |
国別コードでデータを絞り込みます。 制限:1回のAPIコールで設定できる国コードフィルターは1つだけです。 例: |
Protect360
日付と時刻による期間範囲
結果が最大値を超えた場合は、時間と分を使用してレポートを分割します。
以下を適用してください:
- 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
|
to=yyyy-mm-dd 12:00
|
オプションA: 2番目のAPIコール
例:
|
from=yyyy-mm-dd 12:00
|
to=yyyy-mm-dd
|
オプション B: 2番目のAPIコール |
from=yyyy-mm-dd 12:00
|
to=yyyy-mm-dd+1 00:00 +1 = 翌日の00:00
|
注意!オプションAとBは同じ結果になりますので、どちらかを使用してください。 |
追加フィールド
新しい項目がインポートおよび取り込みプロセスに影響を与えないように、レポート項目はデフォルトの項目リストには追加されません。 additional_fields
パラメータを使用して、デフォルト以外の項目を取得してください。
- 項目は一度のみ記載します。
- 利用できる項目リスト をご覧ください。
- いくつかのURIの例には、追加項目が含まれます。必要に応じて、さらに項目を追加します。
-
例:
additional_fields=device_download_time,deeplink_url
- 次の表に示す項目の結果は、常に返されます。
例
追加項目を含むURIコールの例:
https://hq1.appsflyer.com/api/raw-data/export/app/<APPID HERE>/installs_report/v5?
from=yyyy-mm-dd&to=yyyy-mm-dd
&additional_fields=device_download_time,deeplink_url
デフォルト Pull API 項目
デフォルト 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 |
開発者向け Pull API
スクリプトを使用してPull APIローデータを実装するには、Pull API集計データの記事をご参照ください。
追加情報
API V4からV5への移行について
ローデータ: 2021年12月1日をもってV4 API は終了し、プラットフォームから削除されます。この日までにV4の使用を中止し、V5に移行する必要があります。
API V4からV5への移行について
V4からV5に移行する際には、V5には常に返されるデフォルト項目と、オプションとしての追加項目があり、これらをPull APIのコールに明示的に追加する必要があります。必要な項目を取得するために、APIコールの内容を調整してください。AppsFlyerは、ユーザーインターフェイスのいくつかの追加項目で構成されるテンプレートを提供します。必要に応じてテンプレートを編集する必要があります。詳細はユーザーインターフェイスのAPIテンプレートを取得をご参照ください。
特性と制限
特性 | コメント |
---|---|
必要なAPIトークンタイプ |
![]() |
アドネットワークのアクセス | いいえ |
代理店アクセス | はい |
代理店の運用媒体の開示設定 | はい |
App-specific currency | はい |
アプリ固有のタイムゾーン | はい |
データの更新頻度 |
|
過去データ | はい。データ保持とレート制限ポリシーに準拠。 |
非オーガニックデータ | はい |
オーガニックデータ | はい |
レート制限 |
ローデータに関するAPI 制限 |
サイズ制限 |
|
APIエラーコードとトラブルシューティング
ステータス | コード | 症状/メッセージ | 解決策 |
---|---|---|---|
選択された設定期間に対して期待されるデータがレポートに含まれていない、またはローデータレポートと集計データレポートの間に不一致がある状況です。 |
|
||
OK | 200 | Empty CSV file(CSVファイルが空です) |
|
OK |
200 |
Empty CSV file(CSVファイルが空です) |
開始日と終了日の両方が、yyyy-mm-ddの形式であることを確認してください |
Bad request |
400 |
Raw Reports historical lookback is limited to 90 days.(ローデータレポートの過去データは90日間に制限されています) |
|
Bad request |
400 |
Your API calls limit has been reached for report type(このレポートタイプについてAPIコールの上限に達しました) |
- |
Bad request | 400 |
無効な制限タイプ |
report_rows は、200000 または 1000000 の値を指定可能です |
Unauthorized |
401 |
Supplied API token is invalid(指定されたAPIトークンが無効です) |
管理者に現在のトークンを問い合わせる |
Unauthorized |
401 |
Account may be suspended.(アカウントが停止されている可能性があります) |
管理画面にログインしアカウントのステータスを確認してください |
Not found |
404 |
|
トークンがアプリと一致しません。管理者に依頼して、現在のトークンを渡してもらってください。 |