概要:このAPIを使用すると、CSVファイルでローデータレポートを取得できます。
Pull APIローデータ
- Pull APIを使用すると、CSVファイルでローデータレポートを取得できます。ローデータレポートの詳細はこちら
- 利用可能なオプションでフィルターできます:メディアソース、日付範囲、アプリ内イベント名、地域。
- Pull APIの追加機能は次のとおりです:
- 通貨を選択
- タイムゾーンを選択
Pull APIで利用可能なローデータレポート
| レポート | 説明 | 更新頻度 |
|---|---|---|
ローデータレポート(非オーガニック) | ||
| インストール | 非オーガニックインストールを記録します。ユーザーが初めてアプリを起動したときに記録が生成されます。 |
リアルタイム |
| アプリ内イベント | ユーザーが実行したイベントを記録します。 |
リアルタイム |
| アンインストール | ユーザーがアプリをアンインストールしたときに記録します。 |
日次 |
|
再インストール |
アプリをアンインストールした後にUAメディアソースと接触し、リアトリビューション期間中にアプリを再インストールしたユーザーを記録します。 | リアルタイム |
ローデータレポート(オーガニック) | ||
|
オーガニックインストール |
ユーザーが初めてアプリを起動したときに記録します。 |
継続的 |
|
オーガニックアプリ内イベント |
ユーザーが実行したイベントの詳細を記録します。 |
継続的 |
|
オーガニックアンインストール |
ユーザーがアプリをアンインストールした記録。 |
日次 |
|
オーガニック再インストール |
ユーザーがアプリをアンインストールした後、再度インストールしたことを記録します。 | 日次 |
リターゲティング | ||
| コンバージョン | リターゲティングキャンペーンに接触した後にアプリを開いたユーザーの記録。 | リアルタイム |
| アプリ内イベント | リエンゲージメント期間中にユーザーが実行したアプリ内イベント。 | リアルタイム |
広告収益のローデータ | ||
|
帰属広告収益 |
メディアソースに帰属するユーザーの広告収益を記録します。 | 日次 |
| オーガニック広告収益 | メディアソースに帰属しないユーザーの広告収益を記録します。 | 日次 |
Protect360の不正防止 | ||
| インストール | 不正と識別されたため、どのメディアソースにも帰属されなかったインストールを記録します。 | リアルタイム |
| アトリビューション後のインストール | 不正なインストールから発生したため、まったく帰属されなかったアプリ内イベントを記録します。 | 日次 |
| アプリ内イベント | Protect360によって不正と識別されたアプリ内イベントを記録します。 | リアルタイム |
| アトリビューション後のアプリ内イベント | メディアソースに帰属された後に不正と識別されたインストール、またはインストール自体にかかわらず不正と判定されたインストールに関連するアプリ内イベントを記録します。 | 日次 |
| クリック | Protect360によってブロックされたユーザーのクリックを記録します。 | リアルタイム |
| ブロック済みインストールポストバック | インストールがブロックされた結果としてメディアソースに送信されたポストバックのコピーを記録します。 | リアルタイム |
| ポストバック | ||
| インストールポストバック | ユーザーが初めてアプリを起動したときに生成されたインストールイベントを記録します。 | 日次 |
| アプリ内イベントポストバック | メディアソースに送信されたアプリ内イベントポストバックを記録します。 | 日次 |
| リターゲティングアプリ内イベントポストバック | リエンゲージメント期間中にユーザーが実行したアプリ内イベントを記録します。 | リアルタイム |
| リターゲティングコンバージョンポストバック | リエンゲージメント期間中にユーザーが実行したアプリ内イベントを記録します。 | リアルタイム |
Pull APIローデータの使用
Pull APIローデータを使用するには:
-
APIトークンを取得します。管理者はトークンを取得する必要があります。
- 認証ヘッダーで使用するAPIトークンを開発者に渡します。
- 次のセクションで説明するように、APIコールを行う際に入力するパラメータを開発者に渡してください。パラメータは、レポートの対象と構成、およびレポートの期間を決定します。
- 開発者に、Developer HubのPull APIローデータの手順に従うよう伝えてください。
パラメータ
| パラメータ | 説明 |
|---|---|
| from |
|
| to | 終了日。 fromと同様です。
|
| media_source |
|
| maximum_rows |
1回のAPIコールで返される行数の上限です。
|
| event_name |
指定したイベントでアプリ内イベントをフィルタリングします。カンマ区切りのリストを使用して、複数のイベントを選択できます。 例: |
| reattr |
リターゲティングのアトリビューションデータを設定します。
|
| additional_fields |
デフォルトフィールドに加えて、追加フィールドを取得します。 例: |
| currency |
収益とコストの通貨
例:アプリ固有の通貨がEURの場合、 |
| timezone |
[デフォルト]データはUTCで返されます。
|
| geo |
国コードでデータをフィルタリングします。 制限:1回のAPIコールにつき、国コードのフィルターは1つだけ設定できます。 例: |
| from_install time |
|
| to_install_time | 終了日。 from_install timeと同様です。
|
| agency | 特定の代理店に絞り込む(フィルターする)ためのパラメータです。 |
Protect360のフィールド
時間枠のフィールド
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 例:
|
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パラメータを使用します。
- 各フィールドは1回だけ指定してください。
- 利用可能なフィールドの一覧を参照してください。
-
例:
additional_fields=device_download_time,deeplink_url
デフォルトフィールド
| 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トークンタイプ |
|
| アドネットワークのアクセス | いいえ |
| 代理店によるデータアクセス | はい |
| 運用媒体の開示設定 | はい。ただし、代理店フィルターとメディアソースフィルターの両方を使用する場合、メディアソースフィルターは非透明な代理店には適用されません。これは、非透明な代理店の場合、フィルタリングしたメディアソースのデータだけでなく、すべてのデータが含まれることを意味します。 |
| アプリ固有の通貨 | はい |
| アプリ固有のタイムゾーン | はい |
| データ更新頻度 |
|
| 過去データ | はい。 データ保持およびレート制限のポリシーに従います。 |
| 非オーガニックデータ | はい |
| オーガニックデータ | はい |
| レート制限 |
ローデータに関するAPIの制限です。 |
| サイズ制限 |
|
| install_date_fromとinstall_date_to | インストール日の日付範囲は、アクティビティの日付範囲より前である必要があります。 |
トラブルシューティング
| 症状/メッセージ | 解決策 |
|---|---|
| 選択した期間に対して期待されるデータがレポートに含まれていない、またはローデータレポートと集計データレポートの間に差異がある場合。 |
|