Khái quát: Truyền trực tuyến dữ liệu sự kiện phân bổ tới các điểm cuối phía máy chủ của bạn.
API Push V2.0
Giới thiệu về API Push
API Push truyền trực tuyến thông báo sự kiện phân bổ tới các điểm cuối phía máy chủ của bạn ngay khi có dữ liệu. Việc này cho phép bạn theo dõi hành trình của người dùng thông qua nhiều môi trường và điểm tiếp xúc.
Có thể giảm được khối lượng dữ liệu được gửi đến các điểm cuối bằng cách giới hạn:
- Chủ đề thông báo và các loại sự kiện trong ứng dụng đã chọn.
- Các trường được chọn.
Các giải pháp phân phối dữ liệu AppsFlyer khác có thể bạn quan tâm:
- Nếu luồng ứng dụng của bạn phụ thuộc vào tính khả dụng của dữ liệu phân bổ trong thời gian thực trong chưa đầy năm giây, hãy kiểm tra xem dữ liệu chuyển đổi có thích hợp hơn không.
- So sánh các công cụ phân phối dữ liệu của AppsFlyer
Các loại thông báo sự kiện
Loại ghi công |
Chủ đề |
trường conversion_type |
Không tự nhiên (trường campaign_type) |
Tự nhiên (trường campaign_type) |
---|---|---|---|---|
Thu hút người dùng | Lượt cài đặt(*) | Cài đặt | UA | Tự nhiên |
Thu hút người dùng | Cài đặt các sự kiện trong ứng dụng | Cài đặt | UA | Tự nhiên |
Nhắm mục tiêu lại |
Thu hút lại (Re-engagement) | Thu hút lại (Re-engagement) | Nhắm mục tiêu lại | - |
Tái xác định mục tiêu | Sự kiện trong ứng dụng tương tác lại (Re-engagement in-app events) | Thu hút lại (Re-engagement) | Nhắm mục tiêu lại | - |
Tái xác định mục tiêu | Tái phân bổ | Lượt cài đặt lại | Nhắm mục tiêu lại | - |
Thu hút người dùng | Lượt cài đặt lại | Lượt cài đặt lại | UA | Tự nhiên |
Nhắm mục tiêu lại | Sự kiện trong ứng dụng phân bổ lại | Lượt cài đặt lại | Nhắm mục tiêu lại | - |
* Một số lượt cài đặt liên quan đến phân bổ lượt xem hết được phân bổ cho nguồn truyền thông bị hạn chế. |
Cấu trúc thông báo và các trường duy nhất
Thông báo API Push phụ thuộc vào phương thức HTTP:
- GET: thông số dữ liệu được nối thêm vào chuỗi URL
- POST: tham số dữ liệu được chứa trong phần nội dung thông báo ở định dạng JSON
- Dưới đây là những ví dụ có trường trống/rỗng. Trong tương lai, chúng tôi có kế hoạch ngừng gửi các trường trống/rỗng.
Các trường khả dụng
- Thông báo API Push chứa các trường như được mô tả ở đây.
- Các trường bổ sung sẽ được thêm vào theo thời gian, vì những trường này được thêm vào nền tảng AppsFlyer. Cơ chế nhập/phân tích cú pháp của bạn nên cân nhắc đến điều này.
Định dạng của trường nhãn thời gian:
- Đối với các trường nhãn thời gian trong UTC: định dạng
yyyy-mm-dd hh:mm:ss.sss
. Ví dụ: hiển thị là2019-09-17 00:09:25.123
Một sự kiện đã diễn ra lúc 14:00 theo giờ Tokyo. Thời gian sự kiện được chuyển đổi thành UTC, tức là 05:00. Thời gian được ghi nhận là thời gian UTC. - Đối với các trường nhãn thời gian trong múi giờ đã chọn: định dạng
yyyy-mm-dd hh:mm:ss.±th:tm
. Ví dụ2019-01-20 04:51:16.000+0000
. Một sự kiện diễn ra lúc 14:00 theo giờ Tokyo. Thời gian sự kiện hiển thị được ghi nhận là 14:00+09:00. 09:00 là múi giờ Tokyo.
Tên hiển thị | Tên V2.0 | Nhận xét |
---|---|---|
Tiền tệ đã chọn | selected_currency | Đây là cài đặt cấp ứng dụng có hiệu lực tại thời điểm thông báo API được gửi. |
Doanh thu bằng loại tiền đã chọn | doanh_thu_bằng_loại_tiền_ đã_chọn |
|
Chi phí bằng loại tiền đã chọn | chi_phí_bằng_loại_tiền_ đã_chọn |
|
Múi giờ thời gian tải xuống đã chọn của thiết bị | device_download_time_selected_ timezone |
|
Múi giờ thời gian tương tác được phân bổ đã chọn | attributed_touch_time_ selected_timezone |
|
Múi giờ thời gian cài đặt đã chọn | múi_giờ_thời_gian_cài_đặt_ đã_chọn |
|
Múi giờ thời gian sự kiện đã chọn | múi_giờ_thời_gian_sự_ kiện_đã_chọn |
|
Múi giờ đã chọn | múi_giờ_đã_chọn | Đây là cài đặt cấp ứng dụng có hiệu lực tại thời điểm thông báo API được gửi. |
Các trường API Push khả dụng
- Các trường dữ liệu thô có sẵn qua API Push
- Mô tả chi tiết về tất cả các trường dữ liệu thô trong AppsFlyer bất kể phương thức phân phối
Thiết lập API Push
Chú ý
Không sử dụng API Push để gửi dữ liệu đến bên thứ ba vì:
- Làm như vậy, bạn có thể vi phạm các quy định về quyền riêng tư như CCPA nếu người dùng chọn không cho phép gửi dữ liệu của họ đến bên thứ ba.
- Một số nguồn truyền thông, hạn chế cách sử dụng, chia sẻ với bên thứ ba hoặc cả hai, những dữ liệu cấp người dùng do họ cung cấp. Đảm bảo rằng bạn tuân thủ các điều khoản sử dụng của nguồn truyền thông đó.
Ví dụ: Facebook, Twitter, Snapchat, Pinterest.
Để thiết lập API Push, hãy hoàn thành danh sách hành động.
STT hành động | Để thiết lập một điểm cuối mới |
---|---|
1 | |
2 |
Lập kế hoạch cài đặt điểm cuối bằng danh sách kiểm tra lên kế hoạch |
3 |
Yêu cầu phía máy chủ (máy chủ của bạn)
Đảm bảo rằng máy chủ của bạn tuân thủ các yêu cầu được liệt kê dưới đây.
URL điểm cuối |
|
Mã trả về điểm cuối | Khi nhận được thông báo, điểm cuối phải trả về mã trạng thái HTTP 200. |
Đưa máy chủ AppsFlyer vào danh sách cho phép |
Đưa các địa chỉ IP của máy chủ AppsFlyer vào danh sách cho phép trong tường lửa và hệ thống bảo mật của bạn để đảm bảo giao tiếp với điểm cuối. |
Phiên bản TLS |
|
Cổng |
Cổng: 80, 443 |
Danh sách kiểm tra lên kế hoạch API Push
- Sử dụng danh sách kiểm tra đó để lập kế hoạch cài đặt điểm cuối. Các số trong hình khớp với các số hàng trong danh sách kiểm tra.
Điểm cuối
Thiết lập và quản lý điểm cuối
- Phần này trình bày các quy trình thêm, kiểm tra, sửa đổi và xóa các điểm cuối.
- Chỉ quản trị viên mới có thể thay đổi các cài đặt của API. Thành viên nhóm có thể xem các cài đặt API Push.

- Đi đến Integration > API Access (Tích hợp > Truy cập API).Cuộn xuống phần API Push.
Phần API Push sẽ được hiển thị. - Nhấp vào Thêm Điểm cuối.
- Chọn một phương thức HTTP: POST hoặc GET
- Nhập URL Điểm cuối. Nếu bạn nhận được thông báo "this URL is not safe" (URL này không an toàn), hãy liên hệ với bộ phận hỗ trợ của AppsFlyer.
- Chọn một hoặc nhiều loại sự kiện. Lưu ý! Nếu thông báo sự kiện trong ứng dụng bị tắt, điều đó có nghĩa là, cho đến hiện tại, không có sự kiện trong ứng dụng nào được ghi nhận.
- Chọn các trường để điền vào thông báo API Push. Lưu ý:
- Các trường bắt buộc luôn được gửi đi, đó là: ID ứng dụng, Tên sự kiện, Thời gian sự kiện, IDFA (iOS) hoặc ID quảng cáo (Android)
- Sử dụng các tùy chọn kiểm soát được mô tả trong hình dưới đây để chọn các trường tùy chọn.
- Các trường được chọn thường xuyên nhất sẽ được chọn sẵn trước. Các trường này có thể được bỏ chọn.
- Chọn các trường tùy chọn khi cần.
- Sử dụng nút Clear all (Xóa tất cả) để xóa tất cả các trường không bắt buộc.
- Chúng tôi không gửi các trường rỗng/trống và mã khóa liên kết. Hãy tính đến điều này khi bạn lập kế hoạch cho quy trình nhập/phân tích.
- Chọn một hoặc nhiều (tối đa 52 sự kiện) hoặc Tất cả sự kiện trong ứng dụng.
- Danh sách này được điền bằng các loại sự kiện đã được ghi nhận. Nếu có một sự kiện bị thiếu, hãy gửi một sự kiện có cùng loại này bằng thiết bị thử nghiệm.
- Nhấp vào Lưu
API Push hiện đang hoạt động
Dữ liệu chuyển đổi được gửi đến điểm cuối. - Kiểm tra điểm cuối bằng cách sử dụng quy trình sau.
- Nếu muốn nhận sự kiện được phân bổ cho Facebook, trước tiên bạn phải chấp nhận điều khoản dịch vụ của Facebook.
Để kiểm tra điểm cuối:
- Nhấp vào Send Test
(Gửi Thử nghiệm). Một thông báo kết quả thử nghiệm sẽ hiển thị bên dưới nút Send Test (Gửi Thử nghiệm).
Một thông báo thử nghiệm được gửi đến điểm cuối. Nếu thử nghiệm không thành công, hãy đảm bảo rằng bạn đã đưa các địa chỉ IP AppsFlyer vào danh sách cho phép. - Kiểm tra để đảm bảo rằng điểm cuối đã nhận được thông báo kiểm tra.
Sau đó là một bản sao của thông báo sẽ được gửi.
Kiểm tra thông báo API POST và GET
Thông báo POST sau đây được gửi dưới dạng tin nhắn kiểm tra
{
"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"
}
Thay đổi điểm cuối
Để sửa đổi cài đặt điểm cuối:
- Đi đến Integration > API Access (Tích hợp > Truy cập API).
Cuộn xuống phần API Push.
Phần API Push sẽ được hiển thị. - Xác định vị trí điểm cuối cần sửa đổi.
- Thực hiện sửa đổi.
- Nhấp vào Lưu.
Xóa điểm cuối
Để xóa điểm cuối:
- Đi đến Integration > API Access (Tích hợp > Truy cập API).
Cuộn xuống phần truy cập API Push. - Nhấp vào Delete endpoint (Xóa điểm cuối).
- Nhấp vào Save (Lưu).
Điểm cuối đã bị xóa.
Di chuyển điểm cuối từ V1.0 sang V2.0
Để di chuyển điểm cuối từ V1.0 sang V2.0:
- Đi đến Integration > API Access (Tích hợp > Truy cập API).Cuộn xuống phần API Push.
Phần API Push sẽ được hiển thị. - Xác định vị trí điểm cuối để di chuyển.
- Chọn các trường để điền vào thông báo API Push.
- Các trường bắt buộc luôn được gửi đi, đó là: ID ứng dụng, Tên sự kiện, Thời gian sự kiện, IDFA (iOS) hoặc ID quảng cáo (Android)
- Sử dụng các tùy chọn kiểm soát được mô tả trong hình dưới đây để chọn các trường tùy chọn.
- Các trường được chọn thường xuyên nhất sẽ được chọn sẵn trước. Các trường này có thể được bỏ chọn.
- Chọn các trường tùy chọn khi cần.
- Sử dụng nút Clear all (Xóa tất cả) để xóa tất cả các trường không bắt buộc.
- Trong tương lai gần, chúng tôi sẽ ngừng gửi các trường rỗng/trống và mã khóa được liên kết. Hãy tính đến điều này khi bạn lập kế hoạch cho quy trình nhập/phân tích.
- Chọn một hoặc nhiều (tối đa 52 sự kiện) hoặc Tất cả sự kiện trong ứng dụng.
- Danh sách này được điền bằng các loại sự kiện đã được ghi nhận. Nếu có một sự kiện bị thiếu, hãy gửi một sự kiện có cùng loại này bằng thiết bị thử nghiệm.
- Nhấp vào Save (Lưu)
- API Push đã được di chuyển.
- Dữ liệu chuyển đổi tiếp tục được gửi đến điểm cuối.
Thông báo lỗi điểm cuối
Dấu hiệu: Thông báo this URL is not safe (URL này không an toàn) hiển thị khi bạn đặt URL điểm cuối.
Hành động cần thiết: Liên hệ với bộ phận hỗ trợ của AppsFlyer; bao gồm cả ID ứng dụng, URL điểm cuối và ảnh chụp màn hình của thông báo lỗi.
Khắc phục sự cố, những đặc điểm hạn chế
Gửi thông báo thử nghiệm không thành công
Nếu bạn không nhận được thông báo thử nghiệm và bạn hạn chế quyền truy cập vào máy chủ của mình bằng địa chỉ IP: hãy đảm bảo rằng bạn đã đưa tất cả các địa chỉ IP của AppsFlyer vào danh sách cho phép.
Các sự kiện nhắm lại mục tiêu trùng lặp trong ứng dụng
Các sự kiện nhắm lại mục tiêu trong ứng dụng bị trùng lặp khi một sự kiện mua diễn ra như một phần của chiến dịch nhắm lại mục tiêu trong khung thời gian thu hút lại UA. Điều này được thực hiện để phân bổ doanh thu cho cả nguồn truyền thông UA và nguồn truyền thông nhắm lại mục tiêu.
Bạn sẽ chỉ nhận được sự kiện trùng lặp nếu bạn đã bật cả:
- Cài đặt các sự kiện trong ứng dụng
- Nhắm lại mục tiêu các sự kiện trong ứng dụng
Các sự kiện trong ứng dụng được phân bổ cho nguồn truyền thông UA (sự kiện cài đặt trong ứng dụng) như một phần của chiến dịch nhắm lại mục tiêu có trường is_primary_attribtuion=false.
Ví dụ
- Khi có một người dùng cài đặt example_app thì sự kiện này sẽ được phân bổ cho ua_network
- Sau đó, người dùng tương tác lại với chiến dịch nhắm lại mục tiêu của example_app trên retar_network và thực hiện mua hàng.
Sự kiện mua trong ứng dụng được gửi hai lần với các chi tiết sau:
Loại sự kiện | Nguồn truyền thông | is_retargeting | re_targeting conversion_type | is_primary_ attribution |
---|---|---|---|---|
Cài đặt các sự kiện trong ứng dụng | ua_network | đúng | thu hút lại hoặc phân bổ lại | SAI |
Nhắm lại mục tiêu Sự kiện trong Ứng dụng | retar_network | đúng | thu hút lại hoặc phân bổ lại | đúng |
Làm cách nào để xác định các sự kiện nhắm lại mục tiêu trùng lặp?
Trường is_primary_attribution boolean xác định nguồn truyền thông chính và phụ trong các chiến dịch nhắm lại mục tiêu:
- Sai: xác định nguồn truyền thông UA gốc. Lưu ý: Đây là tình huống duy nhất có giá trị sai.
- Đúng: xác định nguồn truyền thông tái tương tác
Lý do: Nếu người dùng, do kết quả của chiến dịch nhắm lại mục tiêu, tương tác với chiến dịch, khung thời gian thu hút lại sẽ mở ra. Nguồn truyền thông thu hút lại được coi là nguồn truyền thông chính khi khung thời gian thu hút lại mở và nguồn UA là phụ. Sau khi khung thời gian đóng lại, nguồn truyền thông UA ban đầu trở lại thành nguồn truyền thông chính.
Chức năng chọn thông báo sự kiện trong ứng dụng bị tắt
- Chỉ có thể chọn thông báo sự kiện trong ứng dụng sau khi có một sự kiện trong ứng dụng được ghi nhận.
- Sử dụng thiết bị thử nghiệm để tạo sự kiện trong ứng dụng hoặc sử dụng API S2S để thực hiện theo cách thủ công.
Thiếu dữ liệu Facebook
Theo mặc định, Facebook không cung cấp dữ liệu thô ở cấp người dùng, trừ khi bạn chấp nhận Điều khoản dịch vụ của Facebook.
Khi bạn chấp nhận các điều khoản, dữ liệu cấp người dùng từ Facebook và các nguồn dữ liệu thô khác sẽ được gửi qua API Push.
Thiếu tin nhắn đẩy và CloudFront
Bạn có đang sử dụng Amazon CloudFront làm điểm cuối của mình không? Nếu vậy, hãy kiểm tra xem CloudFront có từ chối thông báo với mã từ chối 421 hay không. Nếu đúng như vậy, hãy xem Chọn cách phục vụ yêu cầu HTTPS của CloudFront
Hạn chế & Đặc điểm
Đặc điểm | Nhận xét |
---|---|
Mạng quảng cáo | Không dành cho các mạng quảng cáo sử dụng. |
Đại lý | Không dành cho các đại lý sử dụng |
Múi giờ riêng cho ứng dụng | Được hỗ trợ |
Tiền tệ dành riêng cho ứng dụng | Được hỗ trợ |
Hạn chế về kích thước | Không áp dụng |
Tự nhiên | Có |
Không tự nhiên | Có |
Độ mới của dữ liệu | Liên tục |
Dữ liệu lịch sử | Không được hỗ trợ. Dữ liệu sự kiện được gửi sau khi cấu hình API Push. Nếu bạn cần dữ liệu lịch sử thô, hãy sử dụng API Pull. |
Quyền truy cập của thành viên nhóm | Các thành viên nhóm có thể xem cài đặt API Push nhưng không thể thực hiện thay đổi. |
Di chuyển từ API Push V1.0 sang API Push V2.0
Phần này dành cho chủ sở hữu ứng dụng BI/các kỹ sư CNTT chịu trách nhiệm di chuyển API Push V1.0 sang API Push 2.0.
Khi lập kế hoạch chuyển từ V1.0 sang V2.0, hãy xem xét các thay đổi của trường được nêu chi tiết trong phần này.
Những nội dung thay đổi
Thay đổi về cấp trường, được nêu chi tiết trong các bảng sau:
- Các trường đã xóa: các trường được thay thế bằng các trường dữ liệu thô AppsFlyer
- Các trường được đổi tên: tên trường hiện được điều chỉnh phù hợp với tên dữ liệu thô AppsFlyer
- Các trường bổ sung (mới): các trường không có sẵn trong V1.0 Bạn có thể chọn trường nào sẽ được gửi trong thông báo.
- Các trường duy nhất dành cho API Push: chỉ tìm thấy trong API Push.
Điểm cuối không thay đổi:
- Thay đổi đối với API V2.0 chỉ liên quan đến các trường, có nghĩa là các thông số truy vấn/JSON API không thay đổi
- Không có thay đổi đối với cơ chế hoặc điểm cuối giao diện API Push
Các trường bổ sung trong tương lai:
- Các trường bổ sung trong Appsflyer sẽ sớm được triển khai trong API Push 2.0. API Push V1.0 không còn được sử dụng và sẽ ngừng hỗ trợ vào ngày 31 tháng 8 năm 2020.
- Điều này sẽ không làm thay đổi số phiên bản API
- Đảm bảo rằng bạn phân tích/nhập cơ chế phù hợp với các trường bổ sung một cách dễ dàng
Thiết lập điểm cuối API Push V2.0
- Bạn có thể thiết lập các điểm cuối API Push bổ sung cho mục đích phát triển và thử nghiệm. Có thể thực hiện điều này mà không ảnh hưởng đến cài đặt API Push V1.0 hiện tại. Có nghĩa là các thông báo API Push V1.0 được gửi song song với các thông báo được gửi bởi API Push V2.0. Khi bạn hoàn thành chu trình thử nghiệm và phát triển, hãy xóa/di chuyển các điểm cuối API Push v1.0.
Xem Tính năng mới trong AppsFlyer.
Bảng Trường API Push
Các trường bị xóa khỏi API Push v1.0
V1.0 Trường đã xóa |
V2.0 Trường thay thế |
Mô tả |
---|---|---|
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 | chiến dịch | |
event_type | event_name |
Có thể là một trong những yếu tố sau đây: |
attribution_type | media_source |
Trong phiên bản V1.0, trường attribution_type có giá trị tự nhiên hoặc thông thường. Sử dụng trường media_source để lấy loại phân bổ như sau:
|
click_time | attributed_touch_time | |
cost_per_install | af_cost_value | |
device_brand (Chỉ dành cho Android) |
device_type |
Device_type chứa cả thương hiệu và model |
device_model (Chỉ dành cho Android) | device_type |
Device_type chứa cả thương hiệu và model |
Các trường được đổi tên
Tên V1.0 |
Tên V2.0 |
---|---|
đại lý | af_prt |
af_click_lookback | af_attribution_lookback |
re_targeting_conversion_type | retargeting_conversion_type |
appsflyer_device_id | appsflyer_id |
tiền tệ | af_cost_currency |
click_time_selected_timezone | attributed_touch_time_selected_timezone |
click_url | original_url |
download_time | device_download_time |
Các trường được thêm vào API Push V2.0
Tên hiển thị | Tên V2.0 | Mô tả |
---|---|---|
Amazon Fire ID | amazon_aid | ID quảng cáo Amazon Fire TV |
Chiến dịch Người đóng góp 1 | contributor_1_campaign | Chiến dịch của Người đóng góp |
Loại so khớp Người đóng góp 1 | contributor_1_match_type | Các giá trị có thể bao gồm: gp_referrer, id_matching, SRN, download_time |
Nguồn phương tiện Người đóng góp 1 | contributor_1_media_source | Nguồn phương tiện của người đóng góp |
Đối tác Người đóng góp 1 | contributor_1_af_prt | Đại lý hoặc PMD - luôn được chuyển thành chữ thường |
Thời gian tương tác Người đóng góp 1 | contributor_1_touch_time | Thời gian tương tác |
Loại tương tác Người đóng góp 1 | contributor_1_touch_type | Loại tương tác lượt nhấp, lượt hiển thị, Truyền hình |
Chiến dịch Người đóng góp 2 | contributor_2_campaign | Chiến dịch của Người đóng góp |
Loại so khớp Người đóng góp 2 | contributor_2_match_type | Các giá trị có thể bao gồm: gp_referrer/id_matching/srn |
Nguồn phương tiện Người đóng góp 2 | contributor_2_media_source | Nguồn phương tiện của người đóng góp |
Đối tác Người đóng góp 2 | contributor_2_af_prt | Đại lý hoặc PMD |
Thời gian tương tác Người đóng góp 2 | contributor_2_touch_time | Thời gian tương tác |
Loại tương tác Người đóng góp 2 | contributor_2_touch_type | Loại tương tác (có thể là lượt nhấp/lượt hiển thị/TV) |
Chiến dịch Người đóng góp 3 | contributor_3_campaign | Chiến dịch của Người đóng góp |
Loại so khớp Người đóng góp 3 | contributor_3_match_type | Các giá trị có thể bao gồm: gp_referrer/id_matching/srn |
Nguồn phương tiện Người đóng góp 3 | contributor_3_media_source | Nguồn phương tiện của người đóng góp |
Đối tác Người đóng góp 3 | contributor_3_af_prt | Đại lý hoặc PMD |
Thời gian tương tác Người đóng góp 3 | contributor_3_touch_time | Thời gian tương tác |
Loại tương tác Người đóng góp 3 | contributor_3_touch_type | Loại tương tác (có thể là lượt nhấp / lượt hiển thị / Truyền hình) |
Dữ liệu tùy chỉnh | custom_data | Dữ liệu được gửi bằng sử dụng SDK Xem hướng dẫn SDK của Android và iOS |
Danh mục thiết bị | device_category | Các giá trị có thể bao gồm: điện thoại, máy tính bảng, khác Tương thích với SDK Android phiên bản V4.8.8 trở lên |
DMA | dma | Khu vực thị trường được chỉ định - khu vực địa lý tại Hoa Kỳ nơi hoạt động xem TV tại địa phương được đo lường bởi công ty Nielsen. |
Doanh thu sự kiện USD | event_revenue_usd | Số doanh thu bằng USD hoặc loại tiền tệ tùy chọn, có thể cấu hình trong Cài đặt ứng dụng. |
Doanh thu sự kiện | event_revenue | Lượng tiền doanh thu sử dụng Tiền tệ doanh thu sự kiện |
Tiền tệ doanh thu sự kiện | event_revenue_currency | Tiền tệ doanh thu sự kiện như đã báo cáo với SDK . |
Nguồn sự kiện | event_source | Nguồn sự kiện - hoặc SDK hoặc S2S |
Thời gian nhấp Google Play | gp_click_time | Thời gian tải trang ứng dụng trong Google Play sau khi nhấp vào quảng cáo. Nguồn thời gian: API Google Khả dụng từ SDK Android phiên bản 4.8.5 Ví dụ về trường hợp sử dụng: Bằng cách so sánh install_time với gp_click, bạn có thể nhận được thông tin về thời gian người dùng mất bao lâu kể từ khi họ bắt đầu tải xuống ứng dụng cho đến khi họ mở ứng dụng. |
Thời gian bắt đầu cài đặt Google Play | gp_install_begin | Thời gian cài đặt bắt đầu Nguồn thời gian: Thiết bị người dùng. Có nghĩa là thời gian hiển thị trên thiết bị. Lưu ý: Khả dụng từ SDK Android phiên bản 4.8.5 |
Liên kết giới thiệu Google Play | gp_referrer | URL giới thiệu của gói được cài đặt. Khả dụng từ Android SDK v. 4.8.5. |
Liên kết giới thiệu GP Broadcast | gp_broadcast_referrer | Google Play Broadcast Referrer |
Cài đặt App Store | install_app_store | Xác định cửa hàng Android nơi ứng dụng được tải từ đó về (chi tiết) |
Là phân bổ chính | is_primary_attribution | Trong khung thời gian tương tác lại, chúng tôi có thể phân bổ về nguồn phương tiện gốc (trước lượt tương tác lại) hoặc về nguồn phương tiện tương tác lại. Trong khi sự kiện nằm trong khung thời gian tương tác lại, nguồn phương tiện gốc sẽ không phải là phân bổ chính. Ngoài khung thời gian tương tác lại, đó sẽ là phân bổ chính. |
Biên nhận đã được xác nhận chưa | is_receipt_validated | true/false/null khi được thực hiện trong SDK, nếu không thì để trống |
Loại so khớp từ khóa | keyword_match_type | Các kết quả loại khớp từ khóa bằng cách API mạng tìm kiếm hoặc liên kết phân bổ sẽ được ánh xạ tới báo cáo thô. Lưu ý: Google AdWords và Apple Search Ads là các mạng duy nhất trả về thông số này cho các chiến dịch tìm kiếm. |
Loại so khớp | match_type | Loại phương thức phân bổ. Các giá trị có thể bao gồm: gp_referrer (chuỗi người giới thiệu Google Play) id_matching probabilistic_modeling srn (Mạng tự báo cáo) tv (phân bổ truyền hình) preinstall |
ID tài khoản mạng | network_account_id | ID tài khoản của nhà quảng cáo với đối tác |
Mã bưu chính | postal_code | Dựa trên IP của SDK |
Cửa sổ Tương tác lại | af_reengagement_window | Cửa sổ phân bổ tương tác lại là khoảng thời gian trong đó một sự kiện có thể được phân bổ cho một chiến dịch nhắm lại mục tiêu Hạn chế: Trường không được đưa vào trong các chiến dịch nhắm lại mục tiêu. |
Vùng | vùng | Dựa trên IP từ SDK |
Bang | Bang | Dựa trên IP từ SDK |
ID Trang phụ | af_sub_siteid | ID nhà phát hành phụ |
Tác nhân người dùng | user_agent | Tác nhân người dùng cho URL |
Các trường API Push duy nhất
Tên hiển thị | Tên V2.0 | Nhận xét |
---|---|---|
Tiền tệ đã chọn | selected_currency | |
Doanh thu bằng loại tiền đã chọn | doanh_thu_bằng_loại_tiền_ đã_chọn |
|
Chi phí bằng loại tiền đã chọn | chi_phí_bằng_loại_tiền_ đã_chọn |
|
Múi giờ thời gian tải xuống đã chọn của thiết bị | device_download_time_selected_ timezone |
|
Múi giờ thời gian tương tác được phân bổ đã chọn | attributed_touch_time_ selected_timezone |
|
Múi giờ thời gian cài đặt đã chọn | múi_giờ_thời_gian_cài_đặt_ đã_chọn |
|
Múi giờ thời gian sự kiện đã chọn | múi_giờ_thời_gian_sự_ kiện_đã_chọn |
|
Múi giờ đã chọn | múi_giờ_đã_chọn |