AppsFlyer Pull API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Pull API | API | 集約指標 | ✅ | ✅ | ✅ | ✅ | ✅ |
AppsFlyer Pull APIの集約指標インターフェースは、さまざまなタイプの集約指標データを提供しています。現在、AEシステムはPartnersデータとGeoデータの取得に対応しています。
統合の流れ
- AppsFlyer管理画面にログインし、V2.0 API TokenとApp IDを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでAppsFlyer Pull APIプランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. API TokenとApp IDの取得
1.1 API Tokenの取得
Pull API用のV2.0 API Tokenを取得します
1.2 App IDの取得
AppsFlyer管理画面の「My Apps」で、アプリのApp IDを確認できます。Androidではcom.で始まり（例：com.demoapp.ta）、iOSではidで始まります（例：id12345678）
2. プランの設定
AppsFlyerのAPI TokenとApp IDを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を行います。下図はAppsFlyer Pull APIの設定画面です。本章の内容に従ってプランを作成してください：
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップにAPI TokenとApp IDを入力します
2.2 定期取得
「定期取得」モジュールで、AEシステムがAppsFlyer Pull APIのデータを定期的に取得する方針を設定できます。毎日の特定の時刻に直近数日分のデータを取得するよう選択できます。取得できるのは最大で過去1000日分で、1回あたり最大31日分を取得できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
2.3 格納設定
データをイベントとして書き込むかどうかを制御できます。オフにすると、データはイベントテーブルに書き込まれなくなるため、この設定はオフにしないでください。
2.4 統合構成
最後に、統合構成モジュールで、データ取得の詳細な設定を制御できます。データのタイプ、取得するディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_mapping | 格納後のイベント名。カスタマイズ可能 |
| source | report_types | 取得するデータのタイプ。カスタマイズ可能ですが、選択できるのは1つだけです。partnerまたはgeoを選択でき、それぞれメディアチャンネル別、地域別のデータを取得できます |
transfer | double_columns | 数値型フィールドの定義。ここに記述したフィールドは数値型で格納されます。格納後のフィールド名を入力する必要があります |
| fields_whitelist | フィールドのフィルター。リスト型です。リストが空でない場合、AEシステムはリスト内のフィールドのみを格納し、リストにないフィールドは破棄されます | |
| extra_params | media_source | 通常は設定不要です。Facebookのデータを個別に取得する必要がある場合のみ設定し、その際はfacebookと入力してください |
2.4.1 Partnerデータ
この節ではPartnerタイプのデータについて説明します。このレポートはLTVデータに基づいており、指定した期間内にインストールした新規ユーザーのその後のデータを取得します。
| フィールドの意味 | フィールド名 | 備考 |
|---|---|---|
| データ時間 | #event_time | |
| 代理店 | agency_pmd_af_prt | |
| メディアチャンネル | media_source_pid | |
| 広告キャンペーン名 | campaign_c | |
| ARPU | arpu | 指標フィールド。数値型のため、transfer.double_columnsに記述してください |
| 平均eCPI | average_ecpi | |
| クリック数 | clicks | |
| コンバージョン率 | conversion_rate | |
| CTR | ctr | |
| Impressions | impressions | |
| Installs | installs | |
| Loyal Users | loyal_users | |
| Loyal Users/Installs | loyal_users_installs | |
| ROI | roi | |
| Sessions | sessions | |
| Total Cost | total_cost | |
| Total revenue | total_revenue |
Facebookのデータ形式は他のメディアチャンネルと異なるため、Facebookのデータのみを取得したい場合は、extra_paramsに "media_source":"facebook" という設定を1つ追加できます。この場合、以下のフィールドが追加されます：
| フィールドの意味 | フィールド名 |
|---|---|
| 広告キャンペーン名 | campaign_name |
| 広告キャンペーンID | campaign_id |
| 広告ID | adgroup_id |
| 広告名 | adgroup_name |
| 広告グループID | adset_id |
| 広告グループ名 | adset_name |
2.4.2 Geoデータ
この節ではGeo タイプのデータについて説明します。このレポートはLTVデータに基づいており、指定した期間内にインストールした新規ユーザーのその後のデータを取得します。
Facebookのデータ形式は他のメディアチャンネルと異なるため、AEシステムはFacebookのみのデータと全プラットフォームのデータを別々に取得します。以下はGeoで取得できるフィールドです：
| フィールド | 格納名 | 備考 |
|---|---|---|
| 国・地域 | country | |
| データ時間 | #event_time | |
| 代理店 | agency_pmd_af_prt | |
| メディアチャンネル | media_source_pid | |
| 広告キャンペーン名 | campaign_c | |
| ARPU | arpu | 指標フィールド。数値型のため、transfer.double_columnsに記述してください |
| クリック数 | clicks | |
| コンバージョン率 | conversion_rate | |
| インストール数 | installs | |
| ロイヤルユーザー数 | loyal_users | |
| Sessions数 | sessions | |
| 総収入 | total_revenue |
Facebookのデータ形式は他のメディアチャンネルと異なるため、Facebookのデータのみを取得したい場合は、extra_paramsに "media_source":"facebook" という設定を1つ追加できます。この場合、以下のフィールドが追加されます：
| フィールドの意味 | フィールド名 |
|---|---|
| 広告キャンペーン名 | campaign_name |
| 広告キャンペーンID | campaign_id |
| 広告ID | adgroup_id |
| 広告名 | adgroup_name |
| 広告グループID | adset_id |
| 広告グループ名 | adset_name |
2.5 データの格納ルール
デフォルトでは、取得したデータはイベントとしてAEプロジェクトに書き込まれます：
-
Pull APIの集約指標インターフェースは集計データを返すため、ユーザー識別子として固定値を使用します。すべてのデータが1人の仮想ユーザーに紐づいていると考えてください
-
データ内のDateフィールド（ユーザーのインストール日）を、イベントの#event_timeとして使用します
-
データのイベント名は次のとおりです：
- Partner
- appsflyer_partner_data
- Geo
- appsflyer_geo_data
- Partner
-
その他のフィールドはすべて格納されます
2.6 標準化フィールド
次のイベントプロパティは標準化処理されます：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| media_source_pid | te_ads_object.media_source | メディアチャンネル |
| campaign_c（全プラットフォーム） | te_ads_object.campaign_name | 広告キャンペーン名 |
| campaign_id（Facebook） | te_ads_object.campaign_id | （Facebook）キャンペーンID |
| campaign_name（Facebook） | te_ads_object.campaign_name | （Facebook）キャンペーン名 |
| adset_id（Facebook） | te_ads_object.ad_group_id | （Facebook）広告グループID |
| adset_name（Facebook） | te_ads_object.ad_group_name | （Facebook）広告グループ名 |
| adgroup_id（Facebook） | te_ads_object.ad_id | （Facebook）広告ID |
| adgroup_name（Facebook） | te_ads_object.ad_name | （Facebook）広告名 |
| country | te_ads_object.country | 国・地域コード |
| platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| app_id | te_ads_object.app_id | アプリID |
| app_name | te_ads_object.app_name | アプリ名 |
| currency | te_ads_object.currency | 通貨 |
| impressions | te_ads_object.impressions | 露出数 |
| clicks | te_ads_object.clicks | クリック数 |
| installs | te_ads_object.installs | コンバージョン数（インストール） |
| total_cost | te_ads_object.cost | 配信コスト |