Push API streaming data lengkap

Premium
Direkomendasikan untuk
Pemasar Pengembang
Tanggal terakhir diupdate:

Sekilas: Streaming event atribusi data lengkap ke titik akhir sisi server Anda.

6970_Push_API_image.png

Push API

Push API mengalirkan data lengkap yang dihasilkan oleh atribusi AppsFlyer dan atribusi SKAdNetwork (SKAN) sebagai pesan ke server Anda. Anda dapat memilih jenis dan isi pesan serta mengatur titik akhir tujuan.

Jenis pesan yang tersedia, keaktualan data, dan bidang bergantung pada kerangka atribusi (AppsFlyer atau SKAN) seperti yang dijelaskan di bagian berikut. 

Pesan atribusi AppsFlyer

Karakteristik pesan

Karakteristik Detail
Pembagian jenis pesan
  • Pesan dapat dibagi berdasarkan titik akhir (maksimum 6 titik akhir per aplikasi) atau Anda dapat menentukan jenis pesan dengan memeriksa nilai bidang yang tercantum:
    • event_name
    • conversion_type
    • campaign_type 
  • Nilai bidang, per jenis pesan, ditunjukkan pada tabel berikut.

Contoh:

Pesan berisi hal berikut:

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

Gunakan tabel untuk menentukan bahwa event ini adalah event penginstalan dari pengguna organik. 
Kesegaran data

Pesan dikirim segera setelah event dicatat di platform AppsFlyer. Biasanya dalam beberapa menit. 
Isi pesan (bidang)
  • Pesan memiliki struktur key:value.
  • Lihat bidang atribusi AppsFlyer Push API yang tersedia.
  • Setiap kode (key) mewakili bidang data lengkap. Lihat deskripsi bidang data lengkap di AppsFlyer. 
  • Kode kosong atau null tidak dikirim sama sekali.
  • Contoh berisi bidang null dan kosong. Postback real tidak memiliki bidang kosong atau null. Contoh yang diberikan memiliki format JSON.
Format bidang stempel waktu
  • Stempel waktu UTC: yyyy-mm-dd hh:mm:ss.sss. Misalnya, ditampilkan sebagai2019-09-17 00:09:00.123. Sebuah event berlangsung pada pukul 18:00 waktu Tokyo. Waktu event dikonversi ke UTC, yaitu pukul 09:00. Waktu yang dicatat adalah waktu UTC. 
  • Stempel zona waktu yang dipilih (khusus aplikasi): yyyy-mm-dd hh:mm:ss.sss±th:tm. Misalnya 2019-09-17 18:00:16.000+0900. Sebuah event berlangsung pada pukul 18:00 waktu Tokyo. Waktu event yang ditampilkan dicatat sebagai 18:00+09:00. 09:00 adalah zona waktu Tokyo. 

Jenis pesan yang tersedia

Konteks atribusi Jenis pesan Bidang conversion_type bidang campaign_type bidang event_name Bidang event_type
Akuisisi User Penginstalan* Install

Non-organik: UA

Organik: organic

Install

  • Install

  • penginstalan-organik
Akuisisi pengguna  Instal in-app event Install

Non-organik: UA

Organik: organic

Nama event yang ditentukan pengiklan

  • penginstalan-in-app-event

  • penginstalan-organik-in-app-event

Retargeting

 Re-engagement Re-engagement penargetan ulang Re-engagement

Re-engagement
Penargetan ulang  In-App Event Re-engagment Re-engagement penargetan ulang Nama event yang ditentukan pengiklan

interaksi-ulang-in-app-event
Penargetan ulang  Atribusi ulang  instal ulang penargetan ulang Re-attribution

Re-attribution
Akuisisi pengguna  Penginstalan ulang instal ulang

Non-organik: UA

Organik: organic

instal ulang

  • instal ulang

  • penginstalan-organik
Retargeting In-App Event Re-attribution instal ulang penargetan ulang Nama event yang ditentukan pengiklan

atribusi-ulang-in-app-event
* Beberapa penginstalan terkait atribusi lihat-tayang diatribusikan ke sumber media yang dibatasi.

Bidang unik

Nama tampilan Nama Push API
Mata uang yang dipilih* selected_currency
Pendapatan dalam mata uang yang dipilih mata uang income_in_selected_
Biaya dalam mata uang yang dipilih mata uang cost_in_selected_
Zona waktu pengunduhan perangkat yang dipilih device_download_time_selected_timezone
Zona waktu sentuh teratribusi yang dipilih attributed_touch_time_selected_timezone
Zona waktu penginstalan yang dipilih zona waktu install_time_selected_
Zona waktu event yang dipilih Zona waktu event_time_selected_

 zona waktu(*) yang dipilih

 selected_timezone
* Ini adalah pengaturan tingkat aplikasi yang berlaku pada saat pesan API dikirim.

Pesan atribusi SKAN

Bagian ini menjelaskan pesan (jenis laporan) yang tersedia untuk SKAN dan cara mengidentifikasi pesan. Baca bagian ini, lalu Siapkan titik akhir atribusi SKAN.

Bacaan terkait: bidang data lengkap SKAN. Pesan Push API memiliki struktur dan bidang yang setara. 

Karakteristik pesan:

Karakteristik Detail
Pembagian jenis pesan
  • Semua pesan dikirim ke 1 titik akhir yang ditentukan oleh Anda.
  • Untuk menentukan jenis pesan, gunakan bidang berikut:
    • event_name
    • skad_redownload
  • Nilai bidang, per jenis pesan, ditunjukkan pada tabel berikut

Contoh:

Pesan berisi hal berikut:

  • event_name: install
  • skad_redownload: true

Karena skad_redownload: true, Anda menetapkan bahwa ini adalah event pengunduhan ulang. 
Kesegaran data
  • Penginstalan, pengunduhan ulang, dan in-app event:
    • Diproses setiap hari
    • Dikirim ke titik akhir Anda pada hari setelah menerima postback iOS oleh AppsFlyer
    • Perkiraan waktu penerimaan pesan event 05:00–08:00 UTC (waktu tepatnya berfluktuasi)
    • Misalnya: Postback yang diterima pada hari Senin dikirim mulai hari Selasa 05:00 UTC
  • Postback dari iOS dan salinan Postback: Pesan dikirim segera setelah tiba di AppsFlyer
Contoh pesan Lembar kerja berisi contoh pesan. Contoh yang diberikan memiliki format JSON. Pesan contoh SKAN.

Jenis pesan untuk atribusi SKAN

Message type 

bidang event_name

bidang skad_redownload

Bidang event_type
Memasang  Install
  • Kemungkinan nilai: false, blank, null. 
  • Jika bidang tidak ada dalam pesan, anggap nilainya adalah false (salah). 

skad-instal
Pengunduhan ulang  Install True

skad-unduh ulang
In-App Event 

Nama event yang ditentukan oleh pengiklan

 Nama event yang ditentukan oleh pengiklan

skad-in-app-event
Postback dari iOS

Tidak pernah tersedia dalam pesan ini

 Terkadang tersedia

skad-postback
Salinan postback (postingan balik)

Tidak pernah tersedia dalam pesan ini

 Terkadang tersedia

skad-postbacks-salin


Tentukan jenis pesan atribusi SKAN

Catatan: Ini tidak berlaku untuk pesan salinan postback, yang datang langsung dari iOS.

PushAPI-2_en-us.png

Atur titik akhir Push API

 Perhatian

Jangan gunakan Push API untuk mengirim data yang diatribusikan dengan AppsFlyer ke pihak ketiga karena alasan berikut:

  • Anda dapat melanggar peraturan privasi, seperti CCPA, jika pengguna memilih tidak ingin mengirimkan data ke pihak ketiga.
  • Beberapa sumber media membatasi penggunaan data tingkat pengguna yang mereka sediakan, dibagikan dengan pihak ketiga, atau keduanya. Pastikan Anda mematuhi ketentuan penggunaan sumber media.
    Misalnya, Twitter, Snapchat, Pinterest.

Catatan: Peringatan ini tidak berlaku untuk data SKAN. Gunakan Push API untuk mengirim data SKAN ke titik akhir pihak ketiga.

Untuk mengatur Push API, selesaikan daftar tindakan berikut.

Daftar periksa pengaturan API

Langkah Nomor.  Atribusi AppsFlyer Atribusi SKAdNetwork: 
1

Jika Anda telah memiliki titik akhir Push API yang aktif, Anda dapat melewati langkah ini. 

Selesaikan persyaratan sisi server.
2

Untuk atribusi AppsFlyer, rencanakan pengaturan titik ahir menggunakan Daftar periksa perencanaan Push API.

Tak dapat diterapkan
3

Atur titik akhir atribusi AppsFlyer

Atur titik akhir atribusi SKAdNetwork

Persyaratan sisi server (server Anda)

Pastikan server Anda mematuhi persyaratan berikut: 

Persyaratan sisi server

URL Titik Akhir
  • Nama domain yang valid
  • Jumlah maksimum titik akhir unik per aplikasi: 
    • AppsFlyer: 6 titik akhir
    • SKAdNetwork: 3 titik akhir
Kode pengembalian titik akhir Saat menerima pesan, titik akhir Anda harus mengembalikan kode status HTTP 200.
Izinkan server AppsFlyer

Izinkan daftar alamat IP server AppsFlyer di firewall dan sistem keamanan Anda untuk memastikan komunikasi dengan titik akhir.
Versi TLS
Port 

Port: 80, 443

Daftar periksa Push API untuk atribusi AppsFlyer

  • Gunakan daftar periksa untuk memeriksa pengaturan titik akhir atribusi AppsFlyer. Angka-angka pada gambar sesuai dengan jumlah baris pada daftar periksa.
  • Bagian ini tidak relevan dengan atribusi SKAdNetwork. Lihat Mengatur atribusi SKAdNetwork. 

Titik akhir 

PushAPI_us-en.png

Tabel perencanaan titik akhir

No.

Pengaturan

 Detail Gunakan kolom ini untuk mencatat pengaturan yang Anda rencanakan
1

Metode

POST atau GET

  

2

URL Titik Akhir

 -  
3 Tipe pesan event
  • Pilih setidaknya satu tipe pesan event.
  • Untuk memilih pesan in-app event, Anda harus merekam in-app event. Sampai Anda melakukannya, Anda tidak dapat memilih pesan in-app event. 

InappSelectionDisabled_us-en.png

 

4
  • Bidang 
  • Daftar bidang bersifat umum untuk semua tipe pesan

 Peringatan

Jika Anda menandai Pilih semua bidang yang baru ditambahkan juga akan dipilih secara otomatis. Harap pastikan Anda dapat mendukung semua bidang baru yang ditambahkan secara otomatis ke skema untuk menghindari masalah.

Pilih bidang yang wajib diisi.

  • Bidang yang paling umum dipilih sebelumnya secara default.
  • Kami tidak mengirim bidang kosong/null
  
5

Tipe in-app event

 

Menyaring berdasarkan in-app event untuk mengurangi lalu-lintas yang dikirim ke titik akhir Anda.

  • Pilih satu atau lebih atau semua in-app event. Harap diperhatikan! Jika event tidak ditampilkan dalam daftar, carilah. 
  • Jika Anda memilih semua, maka in-app event yang baru ditambahkan secara otomatis. 
  • Anda hanya dapat memilih in-app event setelah direkam setidaknya sekali. Jika perlu, gunakan S2S untuk memulai event tersebut.
  • mceclip1.png
  

Atur titik akhir atribusi AppsFlyer

Catatan: Hanya pemilik akun AppsFlyer yang dapat melakukan perubahan pada pengaturan Push API. Pengguna akun lainnya dapat melihat pengaturan.

Untuk menambahkan titik akhir atribusi AppsFlyer:
  1. Buka Integrasi > Akses API.
    Gulir ke bawah ke sesi Push API.
  2. Klik Tambahkan Titik Akhir. 
  3. Pilih metode HTTP: POSTatau GET
  4. Masukkan URL Titik Akhir. Jika Anda mendapatkan pesan URL ini tidak aman, hubungi tim dukungan AppsFlyer.
  5. Pilih satu tipe event atau lebih. Perhatikan: Jika pesan in-app event dinonaktifkan, artinya tidak ada in-app event yang dicatat hingga saat ini. 
  6. Pilih bidang untuk mengisi pesan Push API. Catatan:
    • Bidang-bidang wajib yang selalu dikirim: ID Aplikasi, Nama event, Waktu event, IDFA (iOS) atau ID Iklan (Android)
    • Gunakan kontrol yang dijabarkan pada gambar berikut untuk memilih bidang opsional. 

      PushAPIFieldSelect1.jpg

      • Bidang yang paling umum dipilih sebelumnya secara default. Anda dapat membatalkan pilihan ini.
      • Pilih bidang opsional sesuai kebutuhan.
      • Gunakan  Hapus semua  untuk menghapus semua bidang pilihan.
      • Kami tidak mengirim bidang null/kosong dan kunci terkait. Pertimbangkan ini saat merencanakan proses impor/parsing Anda.
  7. Pilih satu atau lebih (hingga 52 event) atau  Semua in-app event.
    • Daftar ini diisi oleh tipe event yang telah direkam. Jika acara tidak ada, kirimkan event dengan tipe ini menggunakan perangkat uji. 
  8. Klik Save (Simpan).
    Push API sekarang aktif. Data konversi dikirim ke titik akhir.
  9. Uji titik akhir menggunakan prosedur berikut.

Untuk menguji titik akhir:

  1. Klik Send Test. 
    Pesan hasil pengujian tampil di bawah tombol Send Test . 
    Sebuah pesan pengujian dikirimkan ke titik akhir. Jika pengujian gagal, pastikan Anda memiliki alamat IP AppsFlyer yang diizinkan. 
    Catatan! Mekanisme timeout, memiliki durasi 2 detik, digunakan. Jika AppsFlyer tidak mendapatkan pesan OK selama waktu ini, AppsFlyer menganggap ini sebagai kegagalan pengiriman pesan. 
  2. Verifikasi bahwa titik akhir Anda menerima pesan pengujian.
    Lihat salinan pesan yang dikirim. 

Atur titik akhir atribusi SKAdNetwork

Catatan: Hanya pemilik akun AppsFlyer yang dapat melakukan perubahan pada pengaturan Push API. Pengguna akun lainnya dapat melihat pengaturan.

Untuk menambahkan titik akhir SKAdNetwork Push API:
  1. Buka Integrasi > Akses API.
    Gulir ke bawah ke sesi Push API.
  2. Pilih SKAdNetwork sebagai entitas atribusi. 
  3. Klik Add Endpoint 
    (Tambahkan Titik Akhir). Catatan     : Anda dapat menentukan 1-3 titik akhir SKAdNetwork per aplikasi. 
  4. Pilih metode HTTP: POSTatau GET
  5. Masukkan URL Titik Akhir . Jika Anda mendapatkan pesan URL ini tidak aman, hubungi tim dukungan AppsFlyer.
  6. Kami tidak mengirim bidang null/kosong dan kunci terkait. Pertimbangkan ini saat merencanakan proses impor/parsing Anda.
  7. Klik Save (Simpan).
    Push API sekarang aktif. Data dikirim ke titik akhir. 

Prosedur tambahan—mengelola titik akhir

Mengubah titik akhir

Catatan: Hanya pemilik akun AppsFlyer yang dapat melakukan perubahan pada pengaturan Push API. Pengguna akun lainnya dapat melihat pengaturan.

Untuk mengubah pengaturan titik akhir: 

  1. Buka Integrasi > Akses API.Gulir ke bawah ke sesi Push API.
  2. Temukan titik akhir yang akan diubah.
  3. Lakukan perubahan.
  4. Klik Save.

Menghapus titik akhir

Catatan: Hanya pemilik akun AppsFlyer yang dapat melakukan perubahan pada pengaturan Push API. Pengguna akun lainnya dapat melihat pengaturan.

Untuk menghapus titik akhir:

  1. Buka Integration (Integrasi) > API Access (Akses API).
    Gulir ke bawah ke bagian akses Push API.
  2. Klik Hapus titik akhir.
  3. Klik Save.
    Titik akhir dihapus. 

Penyelesaian masalah, karakteristik, dan batasan

Pesan tes gagal

Jika Anda tidak menerima pesan pengujian dan Anda membatasi akses ke server berdasarkan alamat IP: pastikan Anda memiliki semua alamat IP AppsFlyer yang diizinkan. 

Duplikat penargetan ulang event dalam aplikasi

Penargetan ulang event dalam aplikasi diduplikasi ketika event pembelian terjadi sebagai bagian dari kampanye penargetan ulang selama jendela interaksi ulang UA. Ini dilakukan untuk menghubungkan pendapatan dengan sumber media UA dan sumber media penargetan ulang. 

Anda hanya akan mendapatkan duplikat event jika Anda telah mengaktifkan keduanya:

  • Instal in-app event
  • Menargetkan ulang event dalam aplikasi

Identifikasi dan hapus duplikat in-app event

 

Pilihan pesan in-app event message dinonaktifkan

InappSelectionDisabled_us-en.png

  • Pesan in-app event hanya dapat dipilih setelah salah satu in-app event telah direkam.
  • Gunakan perangkat uji untuk menghasilkan in-app event atau gunakan S2S API untuk melakukannya secara manual. 

Pesan push dan CloudFront tidak ada

Apakah Anda menggunakan Amazon CloudFront sebagai titik akhir Anda? Jika demikian, periksa apakah CloudFront menolak pesan dengan kode tolak 421. Jika demikian, lihat Memilih Cara CloudFront Melayani Permintaan HTTPS

Pesan kesalahan titik akhir

Petunjuk: Pesan URL ini tidak aman tampil saat Anda mengatur URL titik akhir.

Tindakan yang diperlukan: Hubungi tim dukungan AppsFlyer; sertakan ID aplikasi, URL titik akhir, dan screenshot pesan kesalahan.  

Spesifikasi dan batasan

Spesifikasi Catatan 
Jaringan iklan Tidak tersedia 
Agensi Tidak tersedia
Zona waktu khusus aplikasi Didukung
Mata uang khusus aplikasi  Didukung
Keterbatasan ukuran Tak dapat diterapkan
Organik  Ya
Non-organik Ya
Kesegaran data Terus menerus  
Data historis Tidak didukung. Jika Anda kehilangan data, gunakan Pull API untuk mendapatkan data. Dalam hal SKAN, Anda bisa mendapatkan beberapa data historis melalui Data Locker (dibatasi oleh jendela ketersediaan Data Locker). 

Pemilik akun/akses pengguna

Hanya pemilik akunAppsFlyer yang dapat melakukan perubahan pada pengaturan Push API.

  • Setiap akun AppsFlyer hanya memiliki satu pemilik akun. Ini adalah pengguna AppsFlyer pertama (dibuat pada saat akun dibuka) .

Pengguna akun lainnya dapat melihat pengaturan Push API tetapi tidak dapat melakukan perubahan.

Lihat juga