概要: URIを使用してローデータレポートをCSVファイルで取得しましょう。
集計データのPull APIをお探しですか?
Pull API ローデータの特性
- ローデータレポートの内容についての説明
- レポートはCSVファイルとして取得されます。
- データの鮮度は「データエクスポート」ページの同等レポートと同じです。
- データを絞り込むオプションは、「データエクスポート」と同じで、メディアソース、日付範囲、アプリ内インベント名です。
- Pull APIの追加機能は次のとおりです:
- タイムゾーンは選択可能です。
- ローデータレポートの通貨は選択可能です。
- Pull APIは、チームメンバーとBI開発者が使用するのに適しています。
- チームメンバー は ブラウザにURIを貼り付けることでレポートを取得できます。URIテンプレートは、管理画面上でご確認いただけます。 AppsFlyerにて、インテグレーション > APIアクセス へ進みます。
- BI開発者向けPull API はスクリプトにURIを埋め込むことでレポートを取得できます。
URIテンプレートの例
関連記事:
- Selecting the right data delivery tool/reporting API(適切なデータ配信ツール/レポートAPIの選択)
- Push APIとPull APIを一緒に使用する
用語
用語 | 説明 |
---|---|
Pull API |
URIを使用してCSVレポートをダウンロードするためのソリューション。 |
APIコールまたは呼び出し |
ブラウザのアドレスバーに貼り付けるか、スクリプトを使用して、URIをAppsFlyerに送信すること。 |
URI |
|
チームメンバー向けご利用ガイド
URIテンプレートについて
- 管理画面から確認できるURIテンプレートには、アプリIDとレポートタイプが既に入力されています。
- APIトークンとレポート期間(from/to)用のプレースホルダが含まれていますので、それらを編集する必要があります。
- URIのクエスションマーク(?)より右側の部分は、パラメータを含んでいます。各パラメータはアンパサンド(&)で始まります。 パラメータは、フィルタの設定、追加フィールドの追加、通貨やタイムゾーンの指定に使用されます。例えば、ローデータレポートで特定のメディアソースを指定(フィルタリング)する場合、「media_source」パラメータを使います:
&media_source=facebook
- Pull API の理解を深めるには、次のチュートリアルを実行してください。
初めてPull APIを使用する際のチュートリアル
はじめに:- 管理者に管理画面で確認できる Pull APIトークン についてお問い合わせください。
管理画面からレポートをダウンロードするには:
-
[インテグレーション] > [APIアクセス] へ進みます。
APIアクセスページが開きます。 - レポートタイプを選択します。例えば、[ローデータレポート] > [リターゲティングコンバージョン]
URIテンプレートが表示されます。 - クリックしてURIをコピーします。
- ブラウザの新しいタブを開き、URIを貼り付けます。
- URIを編集します:
- トークンプレースホルダを、管理者から提供されたPull APIトークンに置き換えます。
例:次のようにトークンプレースホルダを置き換えます。&api_token=12345678-1234-1234-1234-123456789012
. 注意! スペースや点等は含みません。 - from/to プレースホルダを日付に置き換えます。
例:&from=2020-01-20&to=2020-01-31
注意!スペースは含みません。「&」を削除しないでください。
- トークンプレースホルダを、管理者から提供されたPull APIトークンに置き換えます。
- EnterキーをクリックしてAPIコールを送ります。
レポートがダウンロードされます。
ローデータのPull APIパラメータ
ローデータのURIパラメータ
パラメータ名 | 説明 |
---|---|
api_token | API認証トークン。例のコールでは、次のとおり表示されます:<API TOKEN HERE> |
from |
|
to |
終了日。from を参照
|
パラメータ名 | 説明 |
---|---|
media_source |
|
maximum_rows |
1 回のAPI 呼び出しによって返される行の最大数。
|
event_name |
アプリ内イベントを特定のアプリ内イベントで絞り込みます。複数イベントを選択する場合は、カンマ区切りのリストを使用します。 例: |
reattr |
リターゲティングの計測データを設定します。
|
additional_fields |
デフォルト項目に加えて、追加項目を取得できます。 例: |
currency |
収益とコストの通貨
例:アプリ固有の通貨がEURの場合、 |
timezone |
【デフォルト】UTCタイムゾーンでデータが返されます。
|
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://hq.appsflyer.com/export/<APP ID HERE>/installs_report/v5?
api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
&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 |
Campaign ID |
Adset |
Adset ID |
Ad |
Ad ID |
Ad Type |
Site 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 |
Operator |
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 |
App Name |
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集計データの記事をご参照ください。
追加情報
Pull API V4とV5の違い
ローデータ: API V4は引き続き利用可能です。ファイル形式とヘッダーに変更はありません。
特性と制限
特性 | コメント |
---|---|
必要なAPIトークンタイプ |
![]() |
アドネットワークのアクセス | N |
代理店アクセス | Y |
代理店への運用詳細の開示 | Y |
アプリ固有の通貨 | Y |
アプリ固有のタイムゾーン | Y |
データ鮮度 |
|
ヒストリカルデータ | Yリテンションポリシーの対象 |
非オーガニックデータ | Y |
オーガニックデータ | Y |
レート制限 |
ローデータに関する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 |
|
トークンがアプリと一致しません。最新のトークンについて管理者へお問い合わせください。 |