Push API V2.0
Push API ニュース
-
Push API V2.0は、AppsFlyer ローデータ V5.0 の仕様に準拠しています。
- 追加フィールド: Push API V1.0と比較して40以上のフィールドを追加
- フィールドの選択: Push APIメッセージのサイズを小さくするために送信するフィールドを選択します。
- 空のフィールドは送信されません : 将来的には、null/値なしのフィールドとそれに関連するキーの送信が停止される予定です。
- アプリ内イベントのフィルタリング: 処理軽減のため、送信対象のアプリ内イベントを選択します。
- Push API V1.0 から V2.0 への開発者向け移行ガイド
Push API について
Push API は、アトリビューションイベントメッセージをサーバー側のエンドポイントにリアルタイムで送信します。これにより、複数の環境やタッチポイントを通して、ユーザージャーニーを追跡できます。
以下を制限することで、エンドポイントに送信されるデータの量を削減できます。
- メッセージとアプリ内イベントの種類の選択。
- フィールドの選択。
その他のAppsFlyerデータ配信ソリューション:
- アプリのフローが 5秒未満でリアルタイムアトリビューションデータの可用性に依存する場合は、 コンバージョンデータ が好ましくないかどうかを確認します。
- AppsFlyerのデータ配信ツールの比較
イベントメッセージタイプ
キャンペーンタイプ |
コンバージョンタイプ |
is_retargeting の値 |
retargeting_ conversion_ typeの値 |
非オーガニック | オーガニック | リターゲティング |
---|---|---|---|---|---|---|
ユーザー獲得 | インストール (*) | False | ✓ | ✓ | - | |
ユーザー獲得 | インストール後のアプリ内イベント | False | ✓ | ✓ | - | |
リターゲティング |
リエンゲージメント | True | Re-engagement | - | - | ✓ |
リターゲティング | リエンゲージメントアプリ内イベント | True | Re-engagement | - | - | ✓ |
リターゲティング | リアトリビューション | True | re-attribution | - | - | ✓ |
リターゲティング | リアトリビューションアプリ内イベント | True | re-attribution | - | - | ✓ |
* 一部のインストールは、 制限されたメディアソース に起因するもので、これらのイベントは Push API経由では出力されません。 |
メッセージ構造と固有のフィールド
Push API メッセージは、HTTP メソッドによって異なります。
- GET:データパラメータがURL文字列に追加されます。
- POST:データパラメータは、JSON形式でメッセージ本文に含まれています
- 以下の例では、null/値なしのフィールドが含まれています。将来的には、null/値なしのフィールドの送信を停止する予定です。
使用可能なフィールド
- Push API メッセージには、ここで説明するフィールドが含まれています。
- AppsFlyerプラットフォーム側への追加に伴い、フィールドは随時追加されます。インポート/解析メカニズムでは、これを考慮する必要があります。
タイムスタンプフィールドの形式 :
- UTC(協定世界時)でのタイムスタンプフィールドの場合:
yyyy-mm-dd hh:mm:ss.sss
の形式です。たとえば、「2019-09-17 00:09:25 .123
」と表示されます。あるイベントが日本時間の 14:00 に発生したとします。イベント時刻は UTCの 05:00 に変換されます。記録された時刻は UTC での時間です。 - 選択したタイムゾーンでのタイムスタンプフィールドの場合、
yyyy-mm-dd hh: mm: ss.sss±th:tm
の形式になります。例えば2019-01-20 04:51:16 .000+0000
。日本時間の14:00にイベントが発生したとします。表示されるイベント時間は 14:00 + 09:00 として記録されます。09:00 は日本のタイムゾーンを表しています。
表示名 | V2.0での名称 | 備考 |
---|---|---|
Selected currency | selected_currency | これは、API メッセージの送信時に有効になっているアプリレベルの設定です。 |
Revenue in selected currency | revenue_in_selected_ currency |
|
Cost In Selected Currency | cost_in_selected_ currency |
|
Device Download Time Selected Timezone | device_download_time_selected_ timezone |
|
Attributed Touch Time Selected Timezone | attributed_touch_time_ selected_timezone |
|
Install Time Selected Timezone | install_time_selected_ timezone |
|
Event Time Selected Timezone | event_time_selected_ timezone |
|
Selected Timezone | selected_timezone | これは、API メッセージの送信時に有効になっているアプリレベルの設定です。 |
使用可能なPush API フィールド
Push API V2.0での名称 | Push API 表示名 | Comments |
---|---|---|
advertising_id | Advertising ID | |
af_ad | ad | |
af_ad_id | Ad ID | |
af_ad_type | Ad Type | |
af_adset | Adset | |
af_adset_id | Adset ID | |
af_attribution_lookback | Attribution Lookback Window | |
af_c_id | Campaign ID | |
af_channel | Channel | |
af_cost_currency | Cost Currency | |
af_cost_model | Cost Model | |
af_cost_value | Cost Value | |
af_keywords | Keywords | |
af_prt | Partner | |
af_reengagement_window | Reengagement Window | |
af_siteid | Site ID | |
af_sub_siteid | Sub Site ID | |
af_sub1 | Sub Param 1 | |
af_sub2 | Sub Param 2 | |
af_sub3 | Sub Param 3 | |
af_sub4 | Sub Param 4 | |
af_sub5 | Sub Param 5 | |
amazon_aid | Amazon Fire ID | |
android_id | Android ID | |
api_version | API Version | |
app_id | App ID | |
app_name | App Name | |
app_version | App Version | |
appsflyer_id | AppsFlyer ID | |
attributed_touch_time | Attributed Touch Time | |
attributed_touch_time_selected_timezone | Attributed Touch Time Selected Timezone | Push API 固有 |
attributed_touch_type | Attributed Touch Type | |
bundle_id | Bundle ID | |
campaign | Campaign | |
Carrier | Carrier | |
city | City | |
contributor_1_af_prt | Contributor 1 Partner | |
contributor_1_campaign | Contributor 1 Campaign | |
contributor_1_match_type | Contributor 1 Match Type | |
contributor_1_media_source | Contributor 1 Media Source | |
contributor_1_touch_time | Contributor 1 Touch Time | |
contributor_1_touch_type | Contributor 1 Touch Type | |
contributor_2_af_prt | Contributor 2 Partner | |
contributor_2_campaign | Contributor 2 Campaign | |
contributor_2_match_type | Contributor 2 Match Type | |
contributor_2_media_source | Contributor 2 Media Source | |
contributor_2_touch_time | Contributor 2 Touch Time | |
Contributor_2_touch_type | Contributor 2 Touch Type | |
contributor_3_af_prt | Contributor 3 Partner | |
contributor_3_campaign | Contributor 3 Campaign | |
contributor_3_match_type | Contributor 3 Match Type | |
contributor_3_media_source | Contributor 3 Media Source | |
contributor_3_touch_time | Contributor 3 Touch Time | |
contributor_3_touch_type | Contributor 3 Touch Type | |
cost_in_selected_currency | Cost In Selected Currency | Push API 固有 |
country_code | Country Code | |
custom_data | Custom Data | |
customer_user_id | Customer User ID | |
deeplink_url | Deeplink URL | 2020年の第一四半期から利用可能 |
device_category | Device Category | |
device_download_time |
Device Download Time | 2020年2月3日までは、追加のフィールドであるdownload_timeも利用可能です。 |
device_type | Device Type | |
dma | DMA | |
device_download_time_selected_timezone | Device Download Time Selected Timezone |
Push API 固有 2020年2月3日までは、追加のフィールドであるdownload_time_selected_timezone も利用可能です。 |
event_name | Event Name | |
event_revenue | Event Revenue | |
event_revenue_currency | Event Revenue Currency | |
event_revenue_usd | Event Revenue USD | |
event_source | Event source | |
event_time | Event Time | |
event_time_selected_timezone | Event Time Selected Timezone | Push API 固有 |
event_value | Event Value | |
gp_broadcast_referrer | GP Broadcast Referrer | |
gp_click_time | Google Play Click Time | |
gp_install_begin | Google Play Install Begin Time | |
gp_referrer | Google Play Referrer | |
http_referrer | HTTP Referrer | |
idfa | IDFA | |
idfv | IDFV | |
imei | imei | |
install_app_store | Install App Store | |
install_time | Install Time | |
install_time_selected_timezone | Install Time Selected Timezone | Push API 固有 |
ip | IP | |
is_LAT | Is LAT | 2019年第四四半期より利用可能 |
is_primary_attribution | Is Primary Attribution | |
is_receipt_validated | Is Receipt Validated | |
is_retargeting | Is Retargeting | |
keyword_id | Keyword ID | |
keyword_match_type | Keywords Match Type | |
language | Language | |
match_type | Match Type | |
media_source | Media Source | |
network_account_id | Network Account ID | |
oaid | OAID | |
operator | Operator | |
original_url | Original URL | |
os_version | OS Version | |
platform | Platform | |
postal_code | Postal code | |
region | Region | |
retargeting_conversion_type | Retargeting Conversion Type | |
revenue_in_selected_currency | Revenue In selected currency | Push API 固有 |
sdk_version | SDK Version | |
selected_currency | Selected Currency | Push API 固有 |
selected_timezone | Selected Timezone | Push API 固有 |
State | State | |
store_reinstall (False=ダウンロード, True=再ダウンロード) | Store Reinstall | |
user_agent | User Agent | |
wifi | WIFI |
Push API の設定
警告
第三者にデータを送信するためにPush API を使用しないでください:
Push API を設定するには、アクションリストを完了します。
アクションNo. | 新しいエンドポイントをセットアップするには |
---|---|
1 | |
2 | |
3 |
サーバー要件(お客様のサーバー)
サーバが、ここに記載されている要件に準拠していることを確認します。
エンドポイント URL |
|
エンドポイントのリターンコード | メッセージ受信の際に、エンドポイントは HTTP 200 ステータスコードを返す必要があります。 |
AppsFlyerサーバーをホワイトリスト登録する |
AppsFlyerサーバーの IPアドレス をホワイトリストに登録し、エンドポイントとの疎通を確認します。 |
TLS バージョン |
|
ポート |
ポート: 80, 443 |
Push API 計画チェックリスト
- 次のチェックリストを使用して、エンドポイントの設定を計画します。図の数字は、チェックリストの行番号を表しています。
エンドポイント
No. |
設定 |
詳細 | お客様側の設定 |
---|---|---|---|
1 |
メソッド |
POST または GET | |
2 |
エンドポイント URL |
- | |
3 | イベントメッセージタイプ |
|
|
4 |
フィールド フィールドのリストはすべてのメッセージタイプに共通です |
必要なフィールドを選択します。
|
|
5 |
アプリ内イベントの種類
|
アプリ内イベントでフィルタリングして、エンドポイントに送信されるトラフィックを減らします。 |
|
Facebookにアトリビューションされたユーザーのデータを送信するつもりですか? |
|
|
エンドポイントの設定と管理
- このセクションでは、エンドポイントの追加、テスト、変更、および削除の手順について説明します。
- API 設定を変更できるのは、管理者だけです。チームメンバーは、Push API 設定を見ることができます。

- 「 統合 > API アクセス 」に移動します。「Push API」セクションまでスクロールします。
「Push API」セクションを表示します。 - [エンドポイントを追加] をクリックします。
- HTTP メソッドを選択: POST または GET
- エンドポイント URL を入力します。 このURLは安全ではありません 」というメッセージが表示された場合は、AppsFlyerサポートにお問い合わせください。
- 1 つまたは複数のイベントタイプを選択します。 注意!アプリ内イベントメッセージが無効になっている場合は、アプリ内イベントは記録されていないことを意味します。
- Push API メッセージを設定するフィールドを選択します。注意:
- 常に送信される必須フィールド:App ID, Event name, Event time, IDFA (iOS) または Advertising ID (Android)
- 次の図に示すコントロールを使用して、オプションのフィールドを選択します。
- 最も頻繁に選択されるフィールドがあらかじめ選択されています。選択を解除することができます。
- 必要に応じて、オプションのフィールドを選択ください。
- オプションのフィールドをすべて削除するには、[すべてクリア] を使用します。
- 近い将来、null/値なしのフィールドとそれに関連するキーの送信が停止される予定です。インポート/解析プロセスを検討する際には、このことを考慮してください。
- 1つまたは複数のイベント(最大52イベント)または すべて のアプリ内イベントを選択します。
- リストには、すでに記録されているイベントタイプが表示されます。イベントが見つからない場合は、テストデバイスを使用して、このタイプのイベントを送信します。
- [保存] をクリックします。
Push API がアクティブになりました。
変換データがエンドポイントに送信されます。 - 次の手順を使用して、エンドポイントをテストします。
- Facebookにアトリビューションされたイベントを受け取るには、まず Facebookの利用規約に同意する必要があります。
エンドポイントをテストするには、次の手順を実行します。
- [テスト送信] をクリックします。
テスト結果メッセージが [テスト送信] ボタンの下に表示されます。
テストメッセージがエンドポイントに送信されます。 - エンドポイントがテストメッセージを受信したことを確認します。
送信されたメッセージのコピーは以下の通りです。
POST および GET API メッセージのテスト
次の POST メッセージがテストメッセージとして送信されます。
{
"idfv": "123456789",
"device_category": "phone",
"af_sub1": "sub1-12345",
"customer_user_id": "Customer User ID",
"is_lat": null,
"contributor_2_af_prt": "attributionagency",
"bundle_id": "bundleIdentifier_test",
"gp_broadcastreferrer": "",
"contributor_2_touch_time": "2019-12-31 00:05:42.805",
"contributor_3_touch_type": "click",
"event_source": "SDK",
"af_cost_value": "10",
"contributor_1_match_type": "id_matching",
"app_version": "app_version",
"contributor_3_af_prt": "attributionagency",
"custom_data": null,
"contributor_2_touch_type": "click",
"gp_install_begin": "2019-12-31 00:07:14.000",
"city": "Redmond",
"amazon_aid": "9173fe74-0578-4658-a461-ebb0b4fce6d6",
"gp_referrer": "af_tranid=000712-31122019254604&pid=pdsagency_int&c=pushapi_v2",
"af_cost_model": "CPI",
"af_c_id": "cid12345",
"attributed_touch_time_selected_timezone": "2019-12-31 00:06:32.891+0000",
"selected_currency": "EUR",
"app_name": "com.pds.pushapi2.v2.transparent.com",
"install_time_selected_timezone": "2019-12-31 00:07:14.961+0000",
"postal_code": "98052",
"wifi": false,
"install_time": "2019-12-31 00:07:14.961",
"operator": "ORANGE",
"attributed_touch_type": "click",
"af_attribution_lookback": "25d",
"keyword_match_type": null,
"af_adset_id": "adset12345",
"device_download_time_selected_timezone": "2019-12-31 00:07:14.961+0000",
"contributor_2_media_source": "contrib2",
"contributor_2_match_type": "id_matching",
"api_version": "2.0",
"attributed_touch_time": "2019-12-31 00:06:32.891",
"revenue_in_selected_currency": null,
"is_retargeting": false,
"country_code": "US",
"gp_click_time": "2019-12-31 00:07:12.000",
"contributor_1_af_prt": "attributionagency",
"match_type": "id_matching",
"appsflyer_id": "e126a3b3-3406-4196-a964-563c9ae44ff8",
"dma": "819",
"http_referrer": "https://www.amazon.com/gp/bestsellers/gift-cards/ref=sv_gc_0",
"af_sub5": "sub5-12345",
"af_prt": "attributionagency",
"event_revenue_currency": null,
"store_reinstall": null,
"install_app_store": null,
"media_source": "pdsagency_int",
"deeplink_url": null,
"campaign": "pushapi_v2",
"af_keywords": "keywords12345",
"region": "NA",
"cost_in_selected_currency": "1000",
"event_value": null,
"ip": "20.168.174.166",
"oaid": null,
"event_time": "2019-12-31 00:07:14.961",
"is_receipt_validated": null,
"contributor_1_campaign": "camp1",
"af_sub4": "sub4-12345",
"imei": null,
"contributor_3_campaign": "camp3",
"event_revenue_usd": null,
"af_sub2": "sub2-12345",
"original_url": "https://app.appsflyer.com/com.pds.pushapi2.v2.transparent.com?c=pushapi_v2&pid=pdsagency_int&clickid=click12345&af_ref=000632-31122019&advertiserId=9173fe74-0578-4658-a461-ebb0b4fce6d6&android_id=3e06b4caebc19356&sha1_android_id=sha12345&af_siteid=136396&af_sub_siteid=sub_siteid12345&af_c_id=cid12345&af_adset=adset12345&af_adset_id=adset12345&af_ad=ad12345&af_ad_id=adid12345&af_ad_type=adtype12345&af_channel=channel12345&af_keywords=keywords12345&is_retargeting=False&af_dp=ebay%3A%2F%2Fshoppingcart&af_web_dp=www.dp.com&af_sub1=sub1-12345&af_sub2=sub2-12345&af_sub3=sub3-12345&af_sub4=sub4-12345&af_sub5=sub5-12345&af_cost_model=CPI&af_cost_value=10&af_cost_currency=EUR&sha1_advertising_id=sha12345&sha1_el=sha12345&af_installpostback=false&af_force_dp=true&af_chrome_lp=true&af_ec=1&af_click_lookback=25d&af_viewthrough_lookback=1h&af_reengagement_window=2d&af_prt=attributionagency",
"contributor_2_campaign": "camp2",
"android_id": "3e06b4caebc19356",
"contributor_3_media_source": "contrib3",
"af_adset": "adset12345",
"af_ad": "ad12345",
"state": "WA",
"network_account_id": null,
"device_type": "Samsung::SH-220",
"idfa": null,
"retargeting_conversion_type": null,
"af_channel": "channel12345",
"af_cost_currency": "EUR",
"contributor_1_media_source": "contrib1",
"keyword_id": null,
"device_download_time": "2019-12-31 00:07:14.961",
"contributor_1_touch_type": "click",
"af_reengagement_window": "2d",
"af_siteid": "136396",
"language": "English",
"app_id": "com.pds.pushapi2.v2.transparent.com",
"contributor_1_touch_time": "2019-12-31 00:06:07.847",
"event_revenue": null,
"af_ad_type": "adtype12345",
"carrier": "carrier",
"event_name": "install",
"af_sub_siteid": "sub_siteid12345",
"advertising_id": "9173fe74-0578-4658-a461-ebb0b4fce6d6",
"os_version": "6.0",
"platform": "android",
"af_sub3": "sub3-12345",
"contributor_3_match_type": "id_matching",
"selected_timezone": "UTC",
"af_ad_id": "adid12345",
"contributor_3_touch_time": "2019-12-31 00:05:17.757",
"user_agent": "Dalvik/1.6.0 (Linux; U; Android 6.0; Redmi Note 4 Build/KOT49I.F320S22g",
"is_primary_attribution": null,
"sdk_version": "v4.8.0",
"event_time_selected_timezone": "2019-12-31 00:07:14.961+0000"
}
エンドポイントの変更
エンドポイントの設定を変更するには、次の手順に従います。
- 「 統合 > API アクセス 」に移動します。「Push API」セクションまでスクロールします。
「Push API」セクションを表示します。 - 変更したいエンドポイントを特定します。
- 修正を行います。
- [保存]をクリックします。
エンドポイントの削除
エンドポイントを削除するには、 次の手順に従います。
- 「 統合 > API アクセス 」に移動します。「Push API」セクションまでスクロールします。
- [エンドポイントを削除] をクリックします。
- [保存]をクリックします。エンドポイントが削除されます。
エンドポイントを V1.0 から V2.0 に移行する
エンドポイントを V1.0 から V2.0 に移行するには:
- 「 統合 > API アクセス 」に移動します。「Push API」セクションまでスクロールします。
「Push API」セクションを表示します。 - 移行先のエンドポイントを探します。
- Push API メッセージを設定するフィールドを選択します。
- 常に送信される必須フィールド:App ID, Event name, Event time, IDFA (iOS) または Advertising ID (Android)
- 次の図に示すコントロールを使用して、オプションのフィールドを選択します。
- 最も頻繁に選択されるフィールドがあらかじめ選択されています。選択を解除することができます。
- 必要に応じて、オプションのフィールドを選択ください。
- オプションのフィールドをすべて削除するには、[すべてクリア] を使用します。
- 近い将来、null/値なしのフィールドとそれに関連するキーの送信が停止される予定です。インポート/解析プロセスを検討する際には、このことを考慮してください。
- 1つまたは複数のイベント(最大52イベント)または すべて のアプリ内イベントを選択します。
- リストには、すでに記録されているイベントタイプが表示されます。イベントが見つからない場合は、テストデバイスを使用して、このタイプのイベントを送信します。
- [保存]をクリックします。
- プッシュ API が移行されました。
- コンバージョンデータは引き続きエンドポイントに送信されます。
エンドポイントのエラーメッセージ
症状: エンドポイントURL を設定すると、 この URLは安全ではありません というメッセージが表示されます。
必要なアクション :AppsFlyerサポートに連絡し、アプリID、エンドポイントURL、およびエラーメッセージのスクリーンショットを含めます。
トラブルシューティングと制約事項
リターゲティングアプリ内イベントの重複
ユーザー獲得リエンゲージメント期間中に、リターゲティングキャンペーンの一環として購入イベントが発生すると、アプリ内イベントのリターゲティングが重複します。これは、ユーザー獲得メディアソースとリターゲティングメディアソースの両方に収益を計上するために行われます。
両方を有効にしている場合にのみ、重複するイベントが発生します。
- インストール後のアプリ内イベント
- リターゲティングアプリ内イベント
リターゲティングキャンペーンの一環として、ユーザー獲得のメディアソースにアトリビュートされたアプリ内イベント (install in-app events) のフィールドは is_primary_attribtuion=false となります。
例
- ユーザーが example_app をインストールします。これは ua_network にアトリビュートされます。
- その後、ユーザーは retar_network 上のexample_appのリターゲティングキャンペーンにてリエンゲージメントし、購入に至ります。
アプリ内購入イベントは、次の詳細とともに2回送信されます。
イベントタイプ | Media source | is_retargeting | re_targeting_conversion_type | is_primary_ attribution |
---|---|---|---|---|
インストール後のアプリ内イベント | ua_network | True | re-engagement または reattribution | False |
リターゲティングアプリ内イベント | retar_network | True | re-engagement または reattribution | True |
リターゲティングイベントの重複を特定するには?
is_primary_attributionのブール値は、リターゲティングキャンペーンのプライマリおよびセカンダリのメディアソースを識別します。
- False: オリジナルのユーザ獲得のメディアソースを識別します。注 :これは、値がfalseである唯一のシナリオです。
- True: リエンゲージメントのメディアソースを特定する
この理由は次のとおりです。リターゲティングキャンペーンの結果、ユーザーがキャンペーンに参加すると、リエンゲージメントウィンドウが開きます。リエンゲージメントウィンドウが開いている場合、リエンゲージメントメディアソースはプライマリのメディアソースとみなされ、ユーザー獲得のメディアソースはセカンダリです。ウィンドウが閉じると、元のユーザー獲得のメディアソースがプライマリに戻ります。
アプリ内イベントメッセージの選択が無効になっている
- アプリ内イベントメッセージは、アプリ内イベントが記録された後にのみ選択できます。
- テストデバイスを使用してアプリ内イベントを生成するか、 S2S API を使用して手動で生成します。
Facebookデータの欠落
デフォルトでは、 Facebookの利用規約に同意するまで、 Facebookはユーザーレベルのローデータを連携しません。
利用規約に同意すると、Facebookやその他のデータソースからのユーザーレベルのローデータは、Push APIを介して送信されます。
送信メッセージが見つからない(CloudFront使用の場合)
エンドポイントとして Amazon CloudFront を使用している場合は、CloudFront が拒否コード 421 でメッセージを拒否しているかどうかを確認します。この場合には、「 CloudFront が HTTPS リクエストを処理する方法の選択 」を参照してください 。
制限 & 特性
特性 | 備考 |
---|---|
アドネットワーク | 広告媒体アカウントでは使用できません。 |
代理店 | 代理店アカウントでは使用できません。 |
アプリ固有のタイムゾーン | サポートされています。 |
アプリ固有の通貨 | サポートされています。 |
サイズ制限 | 不適用 |
オーガニック | はい |
非オーガニック | はい |
データの更新頻度 | リアルタイム |
ヒストリカルデータ | サポートされていません。イベントデータはPush APIの構成後に送信されます。過去分のローデータが必要な場合は、Pull APIを使用してください。 |
チームメンバーアクセス | チームメンバーは Push API の設定を表示できますが、変更することはできません。 |
Push API V1.0 からPush API V2.0 への移行
このセクションは、Push API V1.0 から Push API 2.0 への移行を担当するアプリ所有者の BI/IT エンジニアを対象としています。セクション
V1.0 から V2.0 への移行を計画する際には、このセクションで詳しく説明するフィールドの変更を考慮します。
変更内容
フィールドレベルの変更 : 詳細は下記の表の通りです。
- 削除されたフィールド:AppsFlyerローデータフィールドで置き換えられるフィールド
- 名前が変更されたフィールド:フィールド名がAppsFlyeローデータ名と統一されました。
- 追加 (新規) フィールド: V1.0 では使用できないフィールド。メッセージで送信するフィールドを選択できます。
- Push APIの独自フィールド:Push APIでのみで見ることができます。
エンドポイントに変更はありません:
- API V2.0への変更はフィールドのみに関連しており、APIのJSON/クエリのパラメータは変更されません。
- Push API インターフェースの仕組みやエンドポイントに変更はありません。
将来のフィールド追加 :
- Appsflyerにフィールドが追加された際には、Push API 2.0ではすぐに利用可能になります。Push API V1.0は非推奨となり、2020年8月31日に廃止となります。
- このフィールド追加により、API のバージョン番号が変更されることはありません。
- 解析/インポートのメカニズムで追加のフィールドが簡単に入れられるようにします。
Push API V2.0 エンドポイントの設定
- 開発およびテストの目的で、追加の Push API エンドポイントを設定できます。これは、現在の Push API V1.0 の設定に影響を与えることなく実行できます。つまり、Push API V1.0 メッセージは、Push API V2.0 によって送信されるメッセージと並行して送信されます。テストと開発サイクルが完了したら、Push API V1.0 エンドポイントを削除/移行します。
See What's New in AppsFlyer.
Push API フィールドテーブル
プッシュ API V1.0 から削除されたフィールド
V1.0 削除されたフィールド |
V2.0 置換されたフィールド |
説明 |
---|---|---|
fb_adgroup_name | af_ad | |
fb_adgroup_id | af_ad_id | |
fb_adset_name | af_adset | |
fb_adset_id | af_adset_id | |
fb_campaign_id | af_c_id | |
fb_campaign_name | campaign | |
event_type | event_name |
次のいずれかを指定できます。 |
attribution_type | media_source |
V1.0 では、attribution_type フィールドの値は organic または regular でした。 media_source フィールドを使用して、アトリビューションのタイプを次のように導出します。
|
click_time | attributed_touch_time | |
cost_per_install | af_cost_value | |
device_brand (Android のみ) |
device_type |
デバイスタイプには、ブランドとモデルの両方が含まれています |
device_model (Android のみ) | device_type |
デバイスタイプには、ブランドとモデルの両方が含まれています |
名前を変更したフィールド
V1.0での名前 |
V2.0での名前 |
---|---|
agency | af_prt |
af_click_lookback | af_attribution_lookback |
re_targeting_conversion_type | retargeting_conversion_type |
appsflyer_device_id | appsflyer_id |
currency | af_cost_currency |
click_time_selected_timezone | attributed_touch_time_selected_timezone |
click_url | original_url |
download_time | device_download_time |
Push API V2.0 に追加されたフィールド
表示名 | V2.0での名称 | 説明 |
---|---|---|
Amazon Fire ID | amazon_aid | Amazon Fire TVの広告ID |
Contributor 1 Campaign | contributor_1_campaign | Contributorのキャンペーン名 |
Contributor 1 Match Type | contributor_1_match_type | 可能な値には、 gp_referrer、id_matching、SRN、download_time が含まれます。 |
Contributor 1 Media Source | contributor_1_media_source | Contributorのメディアソース |
Contributor 1 Partner | contributor_1_af_prt | 代理店名 / PMD名: 常に小文字に変換。 |
Contributor 1 Touch Time | contributor_1_touch_time | 広告への接触時間 |
Contributor 1 Touch Type | contributor_1_touch_type | タッチの種類 クリック、インプレッション、テレビ |
Contributor 2 Campaign | contributor_2_campaign | Contributorのキャンペーン名 |
Contributor 2 Match Type | contributor_2_match_type | Possible values include: gp_referrer/id_matching/srn |
Contributor 2 Media Source | contributor_2_media_source | Contributorのメディアソース |
Contributor 2 Partner | contributor_2_af_prt | 代理店名 / PMD |
Contributor 2 Touch Time | contributor_2_touch_time | 広告への接触時間 |
Contributor 2 Touch Type | Contributor_2_touch_type | タッチの種類 (クリック/インプレッション/テレビなど) |
Contributor 3 Campaign | contributor_3_campaign | Contributorのキャンペーン名 |
Contributor 3 Match Type | contributor_3_match_type | Possible values include: gp_referrer/id_matching/srn |
Contributor 3 Media Source | contributor_3_media_source | コントリビューター(アシスト)として記録されたメディアソース名 |
Contributor 3 Partner | contributor_3_af_prt | 代理店名 / PMD |
Contributor 3 Touch Time | contributor_3_touch_time | 広告への接触時間 |
Contributor 3 Touch Type | contributor_3_touch_type | タッチの種類 (クリック/インプレッション/テレビなど) |
Custom Data | custom_data | SDK を使用して送信されるデータ,「 Android および iOS SDK ガイド」を参照 |
Device Category | device_category | 可能な値は次のとおりです。携帯電話、タブレット、その他。 Android SDK V4.8.8以降と互換性があります。 |
DMA | dma | Designated Market Area:Nielsen社による、テレビ視聴などの計測に使用されるが米国のエリア区分。 |
Event Revenue USD | event_revenue_usd | USD、もしくは選択した通貨設定での収益金額 / App Settings内で設定可能です。 |
Event Revenue | event_revenue | イベント収益通貨を使用した収益額。 |
Event Revenue Currency | event_revenue_currency | SDKから送信されたイベントの収益通貨単位 |
Event source | event_source | eventの計測元 - SDK or S2Sの値が入ります。 |
Google Play Click Time | gp_click_time | 広告クリック後にGooglePlay内のアプリページが読み込まれた時間タイムソース:Google API Android SDKバージョン4.8.5から利用可能 使用例:install_timeとgp_clickの時間を比較することにより、ユーザーがアプリのダウンロードを開始してからアプリを開くまでにかかる時間についての示唆を得られます。 |
Google Play Install Begin Time | gp_install_begin | インストールの開始時刻 ソース:ユーザーの端末つまり端末に表示されている時間を意味します。注: Android SDKバージョン4.8.5から利用可能 |
Google Play Referrer | gp_referrer | インストールされたアプリのリファラURLAndroid SDK v.4.8.5以降に対応 |
GP Broadcast Referrer | gp_broadcast_referrer | Google PlayのBroadcast Referrer |
Install App Store | install_app_store | アプリのダウンロード元となったAndroidストアの情報 (詳細) |
Is Primary Attribution | is_primary_attribution | リエンゲージメントウィンドウの期間内は、オーバービューに表示されるインストール元のメディアソースとリターゲティングに表示されるリエンゲージメントを生んだメディアソースのどちらにもイベントを紐付けることができます。リエンゲージメントウィンドウ内にイベントが発生した場合、インストール元のメディアソースのこのカラムにはFALSEの値が入ります。リエンゲージメントウィンドウ外の場合、TRUEの値が入ります。 |
Is Receipt Validated | is_receipt_validated | 実装されている場合はtrue / false / null、未実装の場合は空欄です。 |
Keywords Match Type | keyword_match_type | 検索ネットワークAPIもしくは計測リンクによって返されるキーワードのマッチタイプは、ローデータレポート内で確認可能。Google AdsとApple Search Adsのみがこのパラメータの値を返します。 |
Match Type | match_type | アトリビューション手法のタイプ。可能な値は次のとおりです。 gp_referrer(Google Playのリファラー文字列) id_matching fingerprinting srn(Self-Reporting Network) tv(TV atribution) preinstall |
Network Account ID | network_account_id | 広告主のパートナーに関するアカウントID |
Postal code | postal_code | SDKのIPアドレスに基づきます。 |
Reengagement Window | af_reengagement_window | リエンゲージメントアトリビューション期間は、イベントをリターゲティングキャンペーンにアトリビューションすることができる期間のことです。 制限事項:リターゲティングキャンペーンでは、このフィールドは入力されません。 |
Region | region | SDKのIPアドレスに基づきます。 |
State | State | SDKのIPアドレスに基づきます。 |
Sub Site ID | af_sub_siteid | サブパブリッシャーID |
User Agent | user_agent | Original URLにおけるUser Agent |
Push API 固有フィールド
表示名 | V2.0での名称 | 備考 |
---|---|---|
Selected currency | selected_currency | |
Revenue in selected currency | revenue_in_selected_ currency |
|
Cost In Selected Currency | cost_in_selected_ currency |
|
Device Download Time Selected Timezone | device_download_time_selected_ timezone |
|
Attributed Touch Time Selected Timezone | attributed_touch_time_ selected_timezone |
|
Install Time Selected Timezone | install_time_selected_ timezone |
|
Event Time Selected Timezone | event_time_selected_ timezone |
|
Selected Timezone | selected_timezone |