Panduan
Cara menggunakan AppsFlyer di Capacitor
Menggunakan @capgo/capacitor-appsflyer
Capacitor plugin untuk atribusi, analisis, dan tautan dalam aplikasi AppsFlyer.
Install
bun add @capgo/capacitor-appsflyer
bunx cap sync
bunx cap sync Mengcopy plugin code native ke proyek native Anda. Jalankan lagi setelah setiap upgrade plugin.
Import
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
Lihat ringkasan API
| Metode | Deskripsi |
|---|---|
initSDK |
Gunakan metode ini untuk menginisialisasi dan memulai AppsFlyer SDK. Ini API harus dipanggil segera setelah aplikasi diluncurkan. |
startSDK |
Gunakan metode ini untuk memulai SDK AppsFlyer, hanya pada mode mulai manual. |
logEvent |
Logkan event dalam aplikasi. |
setCustomerUserId |
Memasukkan ID pelanggan sendiri memungkinkan Anda untuk menghubungkan ID unik Anda dengan ID unik AppsFlyer dan ID perangkat lainnya. ID ini tersedia dalam laporan data mentah dan dalam API Postback untuk menghubungkan dengan ID internal Anda. |
setCurrencyCode |
Mengatur mata uang untuk pembelian dalam aplikasi. Mata uang code harus berupa kode ISO 4217 3 karakter code. |
updateServerUninstallToken |
(Android) Memungkinkan Anda untuk mengirimkan Token GCM/FCM yang dikumpulkan oleh plugin pihak ketiga ke server AppsFlyer. Dapat digunakan untuk log uninstall. (iOS) Memungkinkan Anda untuk mengirimkan Token APN yang dikumpulkan oleh plugin pihak ketiga ke server AppsFlyer. Dapat digunakan untuk log uninstall. |
setAppInviteOneLink |
Mengatur ID OneLink yang harus digunakan untuk mengatribut pengguna undangan. Tautan yang dihasilkan untuk pengguna undangan akan menggunakan tautan dasar ini sebagai tautan dasar. |
setOneLinkCustomDomain |
Untuk memungkinkan AppsFlyer SDK untuk berhasil menyelesaikan parameter atribusi yang disembunyikan (didekode dalam ID shortlink), Anda harus menyediakan domain yang dikonfigurasi sebagai domain yang di-brand dalam Dashboard AppsFlyer ke metode ini. |
appendParametersToDeepLinkingURL |
Mengaktifkan pemilik aplikasi yang menggunakan App Links untuk deep linking (tanpa OneLink) untuk mengatribuskan sesi yang diinisiasi melalui domain yang terkait dengan aplikasi mereka. Panggil metode ini sebelum memanggil start. Anda harus menyediakan parameter berikut dalam Map parameter: pid harus diatur ke true dan is_retargeting harus diatur ke true. |
setResolveDeepLinkURLs |
Penjual iklan dapat menggabungkan OneLink AppsFlyer dalam tautan Universal lainnya. Tautan Universal ini akan memanggil aplikasi tetapi data deep linking tidak akan menyebar ke AppsFlyer. setResolveDeepLinkURLs memungkinkan Anda untuk mengonfigurasi SDK untuk menyelesaikan URL OneLink yang dibungkus, sehingga deep linking dapat terjadi dengan benar. |
addPushNotificationDeepLinkPath |
Mengatur cara SDK mengekstrak nilai tautan deep dari payload pemberitahuan push. |
setSharingFilter |
Menghentikan event dari menyebar ke mitra AppsFlyer yang ditentukan. |
setSharingFilterForAllPartners |
Menghentikan event dari menyebar ke semua mitra AppsFlyer. Menggantikan setSharingFilter. |
setSharingFilterForPartners |
Menghentikan event dari menyebar ke mitra AppsFlyer yang ditentukan. |
setAdditionalData |
Mengatur data tambahan untuk dikirim ke AppsFlyer. Lihat. |
getAppsFlyerUID |
Dapatkan ID perangkat unik AppsFlyer (dibuat untuk setiap instalasi baru aplikasi). |
anonymizeUser |
Mengaktifkan Opt-Out dari analisis AppsFlyer (Menganonimkan data pengguna). |
stop |
Setelah API ini diaktifkan, SDK kami tidak lagi berkomunikasi dengan server kami dan berhenti berfungsi. Berguna ketika menerapkan opt-in/opt-out pengguna. |
disableSKAdNetwork |
Mengaktifkan Opt-out dari SKAdNetwork. |
disableAdvertisingIdentifier |
Menghentikan pengumpulan ID iklan berbagai oleh SDK. Ini termasuk Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID dan Amazon Advertising ID (AAID). |
disableCollectASA |
Mengaktifkan Opt-out dari atribusi iklan Apple Search Ads. |
setHost |
Atur host yang kustom. |
generateInviteLink |
Mengizinkan pengguna yang sudah ada untuk mengundang teman dan kontak mereka sebagai pengguna baru untuk aplikasi Anda. |
validateAndLogInAppPurchaseAndroid |
API untuk verifikasi server pembelian dalam aplikasi. Jika validasi berhasil, af_purchase akan ditambahkan ke log dengan nilai yang relevan. |
validateAndLogInAppPurchaseIos |
Lihat definisi sumber untuk perilaku saat ini. |
getSdkVersion |
Dapatkan versi AppsFlyer SDK yang digunakan di aplikasi. |
enableFacebookDeferredApplinks |
Aktifkan pengumpulan Facebook Deferred AppLinks. Memerlukan Facebook SDK dan aplikasi Facebook di perangkat target/klien. API ini harus diinvok sebelum menginisialisasi AppsFlyer SDK untuk berfungsi dengan baik. |
sendPushNotificationData |
Tentukan dan dapatkan data dari kampanye pemberitahuan push. |
setCurrentDeviceLanguage |
Atur bahasa perangkat. Data akan ditampilkan dalam Laporan Data Raw. |
logCrossPromoteImpression |
Mengirimkan impresi sebagai bagian dari kampanye promosi lintas. Pastikan untuk menggunakan ID Aplikasi yang dipromosikan seperti yang terlihat di dashboard AppsFlyer. |
setUserEmails |
Atur email pengguna dan enkripsi mereka. |
logLocation |
Mengirimkan lokasi pengguna secara manual. |
setPhoneNumber |
Dikirim sebagai string SHA-256 yang dienkripsi. |
setPartnerData |
Mengizinkan pengiriman data kustom untuk keperluan integrasi mitra. |
logInvite |
Gunakan untuk merekam event undangan pengguna dalam aplikasi (af_invite). |
setDisableNetworkData |
Gunakan untuk keluar dari mengumpulkan nama operator jaringan (carrier) dan nama operator SIM dari perangkat. |
enableTCFDataCollection |
Gunakan untuk mengaktifkan/mengaktifkan pengumpulan data persetujuan secara otomatis, untuk pengguna yang menggunakan CMP. Nilai flag akan disimpan antara sesi aplikasi. |
setConsentData |
Gunakan untuk menetapkan data persetujuan pengguna secara manual. Jika aplikasi Anda tidak menggunakan CMP yang kompatibel dengan TCF v2.2, gunakan metode berikut untuk menyediakan data persetujuan secara langsung ke SDK. |
logAdRevenue |
Dengan mengatributkan pendapatan iklan, pemilik aplikasi mendapatkan pandangan lengkap tentang nilai LTV pengguna dan ROI kampanye. Pendapatan iklan dihasilkan dengan menampilkan iklan pada video berhadiah, dinding tawaran, interstitials, dan banner dalam aplikasi. Anda dapat menggunakan metode ini untuk merekam pendapatan iklan. |
setConsentDataV2 |
Gunakan metode ini untuk menetapkan data persetujuan pengguna secara manual. Jika aplikasi Anda tidak menggunakan CMP yang kompatibel dengan TCF v2.2, gunakan metode berikut untuk menyediakan data persetujuan secara langsung ke SDK. |
isSDKStarted |
Gunakan metode ini untuk memeriksa apakah SDK AppsFlyer sudah dijalankan dalam sesi saat ini. |
isSDKStopped |
Gunakan metode ini untuk memeriksa apakah SDK AppsFlyer sedang berhenti. |
disableAppSetId |
Menghapus pengumpulan ID aplikasi. Jika dipanggil sebelum SDK init, ID aplikasi tidak akan dikumpulkan. Jika dipanggil setelah init, ID aplikasi akan dikumpulkan tetapi tidak akan dikirim dalam payload permintaan. Hanya untuk Android. |
validateAndLogInAppPurchaseV2 |
API untuk verifikasi server pembelian dalam aplikasi V2. Jika validasi berhasil, event af_purchase dengan nilai relevan akan direkam secara otomatis. |
Contoh-Contoh
initSDK()
Gunakan metode ini untuk menginisialisasi dan memulai AppsFlyer SDK. Ini API harus dipanggil segera setelah aplikasi diluncurkan.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.initSDK({
devKey: 'dev-key-123',
appID: 'app-id-123',
});
console.log(result);
startSDK()
Gunakan metode ini untuk memulai AppsFlyer SDK, hanya pada mode mulai manual.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.startSDK();
console.log(result);
logEvent()
Logkan suatu acara dalam aplikasi.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);
setCustomerUserId()
Mengatur ID pelanggan sendiri memungkinkan Anda untuk mencocokkan ID unik Anda dengan ID unik AppsFlyer dan ID perangkat lainnya. ID ini tersedia dalam laporan data mentah dan dalam API Postback untuk mencocokkan dengan ID internal Anda.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });
setCurrencyCode()
Mengatur mata uang untuk pembelian dalam aplikasi. Mata uang code harus berupa kode ISO 4217 3 karakter code.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });
updateServerUninstallToken()
(Android) Memungkinkan Anda untuk melewati Token GCM/FCM yang dikumpulkan oleh plugin pihak ketiga ke server AppsFlyer. Dapat digunakan untuk log uninstall. (iOS) Memungkinkan Anda untuk melewati Token APN yang dikumpulkan oleh plugin pihak ketiga ke server AppsFlyer. Dapat digunakan untuk log uninstall.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });
Daftar metode utama di atas mencakup 44 metode. Bantuan pengguna dan versi, serta kontrak lengkap setiap metode, dapat ditemukan di Repositori GitHub.
Dengarkan acara
addListener kembali sebuah handle. Panggil handle.remove() ketika layar dihancurkan.
Referensi lengkap
Teruskan dari Menggunakan @capgo/capacitor-appsflyer
Jika Anda menggunakan Menggunakan @capgo/capacitor-appsflyer untuk merencanakan pekerjaan plugin native, hubungkannya dengan @capgo/capacitor-appsflyer untuk detail implementasi di @capgo/capacitor-appsflyer, Mulai Menggunakan untuk detail implementasi di Berikut, Daftar Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, dan Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin.