Dữ liệu thô truyền trực tuyến API Push

Khái quát: Truyền trực tuyến các sự kiện phân bổ dữ liệu thô tới các điểm cuối phía máy chủ của bạn.

6970_Push_API_image.png

Bài đọc liên quan: So sánh các công cụ cung cấp dữ liệu thô | Thiết lập API Push bằng API

API Push

API Push truyền trực tiếp dữ liệu thô được tạo bởi quá trình phân bổ AppsFlyer và phân bổ SKAdNetwork (SKAN) dưới dạng thông báo tới máy chủ của bạn. Bạn có thể chọn loại và nội dung thông báo và đặt các điểm cuối đích.

Các loại thông báo có sẵn, tính cập nhật của dữ liệu và các trường phụ thuộc vào khung phân bổ (AppsFlyer hoặc SKAN) như được mô tả trong các phần tiếp theo. 

Thông báo phân bổ AppsFlyer

Đặc tính thông báo
Đặc điểm Chi tiết
Phân tách loại thông báo
  • Thông báo có thể được phân tách theo điểm cuối (tối đa 6 điểm cuối cho mỗi ứng dụng) hoặc bạn có thể xác định loại thông báo bằng cách kiểm tra giá trị của các trường được liệt kê:
    • event_name
    • conversion_type
    • campaign_type 
  • Giá trị của các trường cho mỗi loại thông báo được cho biết trong bảng sau.

Ví dụ:

Thông báo có nội dung sau:

  • conversion_type=install
  • campaign_type=organic
  • event_name=install

Sử dụng bảng để xác định rằng sự kiện này là sự kiện cài đặt của người dùng tự nhiên. 

Độ mới của dữ liệu

Thông báo được gửi ngay sau khi sự kiện được ghi nhận trên nền tảng AppsFlyer. Hoạt động này thường trong vòng vài phút. 

Nội dung thông báo (trường)
  • Thông báo có cấu trúc key:value.
  • Xem các trường Push API phân bổ có sẵn của AppsFlyer.
  • Mỗi mã khóa đại diện cho một trường dữ liệu thô. Xem mô tả về các trường dữ liệu thô trong AppsFlyer
  • Các mã khóa trống hoặc rỗng hoàn toàn sẽ không được gửi đi.
  • Ví dụ này chứa cả trường rỗng và trường trống. Các đăng lại thực không có trường trống hoặc rỗng. Ví dụ được cung cấp có định dạng JSON.
Định dạng của trường nhãn thời gian
  • Nhãn thời gian UTC: yyyy-mm-dd hh:mm:ss.sss. Ví dụ: hiển thị là2019-09-17 00:09:00.123. Một sự kiện diễn ra lúc 18:00 theo giờ Tokyo. Thời gian sự kiện được chuyển đổi thành UTC, tức là 09:00. Thời gian được ghi nhận là thời gian UTC. 
  • Nhãn thời gian đã chọn của múi giờ (cụ thể cho ứng dụng): yyyy-mm-dd hh:mm:ss.sss±th:tm. Ví dụ: 2019-09-17 18:00:16.000+0900. Một sự kiện diễn ra lúc 18:00 theo giờ Tokyo. Thời gian sự kiện hiển thị được ghi nhận là 18:00+09:00. 09:00 là múi giờ Tokyo. 
Các loại thông báo có sẵn

 

Phân bổ

ngữ cảnh

Loại thông báo

trường conversion_type

Trường campaign_type

Trường event_name

Thu hút người dùng Lượt cài đặt* Cài đặt

Không tự nhiên: UA

Tự nhiên: organic

Cài đặt

Thu hút người dùng  Cài đặt các sự kiện trong ứng dụng Cài đặt

Không tự nhiên: UA

Tự nhiên: organic

Tên sự kiện do nhà quảng cáo xác định

Nhắm mục tiêu lại

Thu hút lại (Re-engagement) Thu hút lại nhắm mục tiêu lại Thu hút 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 nhắm mục tiêu lại Tên sự kiện do nhà quảng cáo xác định
Tái xác định mục tiêu  Tái phân bổ  cài đặt lại nhắm mục tiêu lại Ghi công lại
Thu hút người dùng  Lượt cài đặt lại cài đặt lại

Không tự nhiên: UA

Tự nhiên: organic

cài đặt lại

Nhắm mục tiêu lại Sự kiện trong ứng dụng phân bổ lại cài đặt lại nhắm mục tiêu lại Tên sự kiện do nhà quảng cáo xác định
* 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ác trường duy nhất
Tên hiển thị Tên API Push
Đơn vị 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 tệ đã chọn chi_phí_bằng_loại_tiền_
đã_chọn
Múi giờ thời gian tải xuống thiết bị đã chọn device_download_time_selected_timezone
Múi giờ thời gian tiếp xú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 diễn ra 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.

Thông báo phân bổ SKAN

Phần này mô tả các thông báo (loại báo cáo) có sẵn cho SKAN và cách xác định thông báo. Đọc phần này, sau đó Thiết lập điểm cuối phân bổ SKAN.

Đọc liên quan: Các trường dữ liệu thô SKAN. Thông báo API Push có cấu trúc và trường tương đương. 

Đặc tính thông báo
Đặc điểm Chi tiết
Phân tách loại thông báo
  • Tất cả các thông báo đều được gửi đến 1 điểm cuối do bạn thiết lập.
  • Để xác định loại thông báo, hãy sử dụng các trường sau:
    • event_name
    • skad_redownload
  • Giá trị của các trường cho mỗi loại thông báo được cho biết trong bảng sau

Ví dụ:

Thông báo có nội dung sau:

  • event_name: af_skad_install
  • skad_redownload: true

Vì skad_redownload: true, bạn xác định rằng đây là một sự kiện tải xuống lại. 

Độ mới của dữ liệu
  • Lượt cài đặt, lượt tải xuống lại và sự kiện trong ứng dụng:
    • Xử lý hàng ngày
    • Được gửi tới điểm cuối của bạn vào ngày sau khi AppsFlyer nhận được đăng lại iOS
    • Dự kiến nhận được thông báo sự kiện từ 05:00–08:00 UTC (thời gian chính xác có thể thay đổi)
    • Ví dụ: Các đăng lại nhận được vào Thứ Hai được bắt đầu gửi từ Thứ Ba 05:00 UTC
  • Đăng lại từ iOS và bản sao Đăng lại: Thông báo được gửi ngay sau khi chúng đến AppsFlyer
Ví dụ về thông báo Bảng tính chứa các ví dụ về thông báo. Ví dụ cung cấp có định dạng JSON. Thông báo ví dụ SKAN.

 

Các loại thông báo cho phân bổ SKAN
Loại thông báo 

Trường event_name

Trường skad_redownload

Lượt cài đặt  af_skad_install
  • Các giá trị có thể có: false, trống, rỗng. 
  • Nếu trường không có trong thông báo, hãy coi giá trị đó là false. 
Lượt tải xuống lại  af_skad_install đúng
Sự kiện trong ứng dụng 

Tên sự kiện do nhà quảng cáo đặt

Tên sự kiện do nhà quảng cáo đặt
Đăng lại từ iOS

Không bao giờ có trong thông báo này

Đôi khi có sẵn
Bản sao đăng lại

Không bao giờ có trong thông báo này

Đôi khi có sẵn


Xác định loại thông báo phân bổ SKAN

Lưu ý: Điều này không áp dụng cho các thông báo sao chép đăng lại đến trực tiếp từ iOS.

PushAPI-2_en-us.png

Thiết lập điểm cuối API Push

 Chú ý

Không sử dụng API Push để gửi dữ liệu được phân bổ AppsFlyer đến các bên thứ ba vì các lý do sau:

  • 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 lựa chọn không gửi dữ liệu của họ cho 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ụ: Twitter, Snapchat, Pinterest.

Lưu ý:  Chú ý này không áp dụng cho dữ liệu SKAN. Sử dụng API Push để gửi dữ liệu SKAN tới các điểm cuối của bên thứ ba.

Để thiết lập API Push, hãy hoàn thành danh sách hành động sau.

Danh sách kiểm tra thiết lập API Push
Số bước  Phân bổ AppsFlyer Phân bổ SKAdNetwork 
1

Nếu đã có một điểm cuối API Push đang hoạt động, bạn có thể bỏ qua bước này. 

Hoàn thành các yêu cầu phía máy chủ.

2

Đối với phân bổ AppsFlyer, hãy lập kế hoạch cài đặt điểm cuối bằng cách sử dụng danh sách kiểm tra lập kế hoạch API Push.

Không áp dụng

3

Thiết lập điểm cuối phân bổ AppsFlyer

Thiết lập điểm cuối phân bổ SKAdNetwork

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 sau: 

Yêu cầu phía máy chủ
URL điểm cuối
  • Tên miền hợp lệ
  • Số lượng điểm cuối duy nhất tối đa cho mỗi ứng dụng: 
    • AppsFlyer: 6 điểm cuối
    • SKAdNetwork: 3 điểm cuối
Mã trả về điểm cuối Khi nhận được thông báo, điểm cuối của bạn 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ập kế hoạch API Push để phân bổ AppsFlyer

  • Sử dụng danh sách kiểm tra đó để lập kế hoạch cài đặt điểm cuối phân bổ AppsFlyer của bạn. Các số trong hình khớp với các số hàng trong danh sách kiểm tra.
  • Phần này không liên quan đến phân bổ SKAdNetwork. Xem Thiết lập phân bổ SKAdNetwork. 

Điểm cuối 

PushAPI_us-en.png

Bảng kế hoạch điểm cuối

Số thứ tự

Cài đặt

Chi tiết Sử dụng cột này để ghi nhận các cài đặt bạn đã lên kế hoạch
1

Phương thức

POST hoặc GET

 

2

URL điểm cuối

-  
3 Các loại thông báo sự kiện
  • Chọn ít nhất một loại thông báo sự kiện.
  • Để chọn thông báo sự kiện trong ứng dụng, bạn cần ghi nhận sự kiện trong ứng dụng. Bạn không thể chọn thông báo sự kiện trong ứng dụng cho đến khi thực hiện điều đó. 

InappSelectionDisabled_us-en.png

 

4

  • Các trường 
  • Danh sách các trường là chung cho tất cả các loại thông báo

Chọn các trường cần thiết.

  • Các trường phổ biến nhất được chọn trước theo mặc định.
  • Chúng tôi không gửi các trường trống/rỗng
 
5

Loại Sự kiện trong Ứng dụng

 

Lọc theo các sự kiện trong ứng dụng để giảm lưu lượng truy cập gửi đến điểm cuối của bạn.

  • Chọn một hoặc nhiều hoặc tất cả các sự kiện trong ứng dụng. Lưu ý! Nếu sự kiện không hiển thị trong danh sách, hãy tìm kiếm sự kiện đó. 
  • Nếu bạn chọn tất cả, thì các sự kiện trong ứng dụng mới sẽ tự động được thêm vào. 
  • Bạn chỉ có thể chọn sự kiện trong ứng dụng sau khi sự kiện đó đã được ghi nhận ít nhất một lần. Nếu cần, hãy sử dụng S2S để kích hoạt sự kiện.
  • mceclip1.png
 

Thiết lập điểm cuối phân bổ AppsFlyer

  • Chỉ người dùng quản trị mới có thể thực hiện các thay đổi đối với cài đặt API. Người dùng tài khoản có thể xem cài đặt API Push.
AppsFlyerAdmin_us-en.png Để thêm một điểm cuối phân bổ của AppsFlyer:
  1. Đi đến Integration > API Access(Tích hợp > Truy cập API).Cuộn xuống phần API Push.
  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ự 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à không có sự kiện trong ứng dụng nào được ghi nhận cho đến thời điểm này. 
  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. 

      PushAPIFieldSelect1.jpg

      • Các trường phổ biến nhất được chọn trước theo mặc định. Bạn có thể hủy các lựa 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 Save.
    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.

Để kiểm tra điểm cuối:

  1. Nhấp vào Send Test. 
    Một thông báo kết quả thử nghiệm sẽ hiển thị bên dưới nút Send Test
    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
    Lưu ý! Cơ chế thời gian chờ được sử dụng có thời lượng 3 giây. Nếu AppsFlyer không nhận được thông báo OK trong thời gian này thì AppsFlyer coi đây là gửi thông báo không thành công. 
  2. Xác minh rằng điểm cuối của bạn đã nhận được thông báo thử nghiệm.
    Xem bản sao của thông báo đã gửi. 

Thiết lập điểm cuối phân bổ SKAdNetwork

Lưu ý: Chỉ quản trị viên mới có thể thực hiện các thay đổi đối với cài đặt API. Người dùng tài khoản có thể xem cài đặt API Push.

AppsFlyerAdmin_us-en.png Để thêm điểm cuối API Push SKAdNetwork:
  1. Đi đến Integration > API Access(Tích hợp > Truy cập API).Cuộn xuống phần API Push.
  2. Chọn SKAdNetwork làm thực thể phân bổ. 
  3. Nhấp vào Add Endpoint. 
    Lưu ý
    : Bạn có thể xác định 1-3 điểm cuối SKAdNetwork cho mỗi ứng dụng. 
  4. Chọn một phương thức HTTP: POST hoặc GET
  5. 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.
  6. 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. Nhấp vào Save (Lưu).
    Push API hiện đang hoạt động. Dữ liệu được gửi tới điểm cuối. 

Các quy trình bổ sung—quản lý điểm cuối

Thay đổi điểm cuối

Lưu ý: Chỉ quản trị viên mới có thể thực hiện các thay đổi đối với cài đặt API. Người dùng tài khoản có thể xem cài đặt API Push.

AppsFlyerAdmin_us-en.png Để sửa đổi cài đặt điểm cuối: 

  1. Đi đến Integration > API Access (Tích hợp > Truy cập API).Cuộn xuống phần API Push.
  2. Xác định vị trí điểm cuối cần sửa đổi.
  3. Thực hiện sửa đổi.
  4. Nhấp vào Lưu.

Xóa điểm cuối

Lưu ý: Chỉ quản trị viên mới có thể thực hiện các thay đổi đối với cài đặt API. Người dùng tài khoản có thể xem cài đặt API Push.

AppsFlyerAdmin_us-en.pngĐể xóa điểm cuối:

  1. Đi đến Integration > API Access. 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. 

Khắc phục sự cố, đặc điểm và 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ật cả:

  • Cài đặt các sự kiện trong ứng dụng
  • Nhắm lại mục tiêu Sự kiện trong Ứng dụng

Xác định và loại bỏ các sự kiện trong ứng dụng trùng lặp

 

Chức năng chọn thông báo sự kiện trong ứng dụng bị tắt

InappSelectionDisabled_us-en.png

  • 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 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ân phối Yêu cầu HTTPS của CloudFront.

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; kèm theo 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.

Đặc điểm và hạn chế

Các đặc điểm
Đặc điểm Nhận xét 
Mạng quảng cáo Không có sẵn 
Đại lý Không có sẵn
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 
Không tự nhiên
Độ mới của dữ liệu Liên tục 
Dữ liệu lịch sử Không được hỗ trợ. Nếu bạn đang thiếu dữ liệu, hãy sử dụng API Pull để lấy dữ liệu. Trong trường hợp đối với SKAN, bạn có thể lấy một số dữ liệu lịch sử thông qua Data Locker (bị giới hạn bởi khung thời gian khả dụng của Data Locker). 
Quyền truy cập tài khoản của người dùng Người dùng tài khoản có thể xem cài đặt API Push nhưng không thể thay đổi.
Bài viết này có hữu ích không?