Pull API ローデータの使用

概要:URIを使用して、AppsFlyerローデータレポートをCSVファイルで取得しましょう。

PullAPIRaw_us-en.png

 集計データのPull APIをお探しですか?

Pull API aggregated data(集計データのPull API)

Pull API ローデータの特性

  • ローデータレポートの内容についての説明
  • レポートはCSVファイルとして取得されます。
  • オプションごとのフィルタ:メディアソース、日付範囲、アプリ内イベント名、地域。
  • 選択可能なタイムゾーンと通貨
  • Pull APIは、チームメンバーとBI開発者が使用するのに適しています。
    • チームメンバー は ブラウザにURIを貼り付けることでレポートを取得できます。URIテンプレートは、管理画面上でご確認いただけます。 AppsFlyerにて、インテグレーション > APIアクセス へ進みます。
    • BI開発者向けPull API はスクリプトにURIを埋め込むことでレポートを取得できます。

URIテンプレートの例

TemplateURL_us-en.jpg

 関連記事:適切なデータ配信ツール / レポートAPIの選択

用語

用語 説明
Pull API 

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

APIコールまたは呼び出し

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

URI
  • レポートの詳細を含むウェブアドレス(URL)のような一意のリソース識別子。
  • URIテンプレートは管理画面のAPIページにてご確認いただけます。

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

URIテンプレートについて

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

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

はじめに:
  • 管理者に管理画面で確認できる Pull APIトークン についてお問い合わせください。

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

  1. [インテグレーション] > [APIアクセス] へ進みます。
    APIアクセスページが開きます。rawdatareports_en-us.jpg
  2. レポートタイプを選択します。例えば、[ローデータレポート] > [リターゲティングコンバージョン]
    URIテンプレートが表示されます。 
  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パラメータ

パラメータ名 説明
api_token API認証トークン例のコールでは、次のとおり表示されます:<API TOKEN HERE>
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 の両方のパラメータを次のように設定してください:

  • Facebookについては、カテゴリとメディアソースを facebookに設定します。
  • Twitterについては、カテゴリとメディアソースを 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+10:00の場合、次のように設定します:timezone=+10:00 注意!:「 +-、そして : はエンコードされる必要があります。例:「+10:00」は次のようにエンコードされます: %2B10%3A00
geo

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

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

例:geo=ZA

日付と時刻による期間範囲

結果が最大値を超えた場合は、時間と分を使用してレポートを分割します。 以下を適用してください:

  • 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 パラメータを使用して、デフォルト以外の項目を取得してください。

  • 項目は一度のみ記載します。
  • 利用できる項目リスト をご覧ください。
  • いくつかの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 項目

デフォルト 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集計データの記事をご参照ください。 

追加情報

API V4からV5への移行について

ローデータ: 2021年12月1日をもってV4 API は終了し、プラットフォームから削除されます。この日までにV4の使用を中止し、V5に移行する必要があります。 

API V4からV5への移行について

V4からV5に移行する際には、V5には常に返されるデフォルトカラムと、オプションとしての 追加カラムがあり、これらをPull APIのコールに明示的に追加する必要があります。必要なカラムを取得するために、APIコールの内容を調整してください。なおAppsFlyerの管理画面上では、いくつかの追加カラムを追加したテンプレートを用意していますが、必要に応じてこのテンプレートを編集し、希望するデータを取得できるようにしてください。詳細はこちら

特性と制限

特性
特性 コメント 
必要なAPIトークンタイプ AppsFlyerAdmin_us-en.pngV1.0 token
アドネットワークのアクセス いいえ
代理店アクセス はい
代理店への運用詳細の開示 はい
アプリ固有の通貨 はい
アプリ固有のタイムゾーン はい
データの更新頻度
  • オーバービュー管理画面のデータ可用性と同じ。
  • 更新に数時間のタイムラグが生じるレポート:
    • オーガニックアプリ内イベント
  • 毎日更新されるレポート:
    • アンインストール
    • アトリビューション後のアプリ内イベント
    • 広告収益
ヒストリカルデータ はい。データ保持レート制限ポリシーに準拠。
非オーガニックデータ はい
オーガニックデータ はい
レート制限

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

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

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

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

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

OK 200 Empty CSV file(CSVファイルが空です)

addtional_fieldsがURIに複数含まれています

OK

200

Empty CSV file(CSVファイルが空です)

開始日と終了日の両方が、yyyy-mm-ddの形式であることを確認してください

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コールの上限に達しました)

-
Bad request 400

無効な制限タイプ

report_rows は、200000 または 1000000 の値を指定可能です
Unauthorized

401

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

最新のトークンについてアドミンアカウントに確認してください
Unauthorized

401

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

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

Not found

404

 

トークンがアプリと一致しません。最新のトークンについて管理者へお問い合わせください。

この記事は役に立ちましたか?