Push API streaming raw-data (V2)

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. 
  
  • Android_Push_API_ V2.0.json
  • iOS_Push_API_V2.json

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. 

• 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

Đả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. 

• 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 

• 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.

Để thêm điểm cuối API Push:

1. Đ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ị.
2. Nhấp vào Thêm Điểm cuối. 
3. Chọn một phương thức HTTP: POST hoặc GET
4. 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.
5. Chọn một hoặc nhiều loại sự.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. 
6. 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.
7. 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. 
8. 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.
9. Kiểm tra điểm cuối bằng cách sử dụng quy trình sau.
10. 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:

1. 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. 
2. 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.

{                  
  "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"
}

Xóa điểm cuối

 Cách xóa điểm cuối:

1. Đi đến Integration > API Access (Tích hợp > Truy cập API).
   Cuộn xuống phần truy cập API Push. 
2. Nhấp vào Delete endpoint (Xóa điểm cuối).
3. 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:

1. Đ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ị.
2. Xác định vị trí điểm cuối để di chuyển.
3. 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.
4. 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. 
5. 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.

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.  

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 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. 

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ó 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. 

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.

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