@capgo/capacitor-appsflyer
Plugin Capacitor untuk atribusi, analisis, dan tautan dalam AppsFlyer.
Ringkasan
Judul bagian “Ringkasan”Capacitor plugin untuk atribusi, analitis, dan tautan dalam aplikasi AppsFlyer.
Kemampuan Utama
Judul bagian “Kemampuan Utama”initSDK- Use this method to initialize and start AppsFlyer SDK. This API should be called as soon as the app launched.startSDK- Gunakan metode ini untuk memulai AppsFlyer SDK, hanya pada mode mulai manual.logEvent- Log kejadian dalam aplikasi.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.
API Publik
Judul bagian “API Publik”| Metode | Deskripsi |
|---|---|
addListener('conversion_callback', listener) | Dengarkan panggilan balik konversi, termasuk onConversionDataSuccess dan onConversionDataFail, dengan OnConversionDataResult payloads. |
addListener('oaoa_callback', listener) | Dengarkan panggilan balik atribusi aplikasi, termasuk onAppOpenAttribution dan onAttributionFailure, dengan OnAppOpenAttribution payloads. |
addListener('udl_callback', listener) | Dengarkan panggilan balik tautan dalam yang diintegrasikan dengan OnDeepLink payloads. |
initSDK | Gunakan metode ini untuk menginisialisasi dan memulai AppsFlyer SDK. Ini API harus dipanggil segera setelah aplikasi diluncurkan. |
startSDK | Gunakan metode ini untuk memulai AppsFlyer SDK, hanya pada mode mulai manual. |
logEvent | Logkan kejadian dalam aplikasi. |
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. |
setCurrencyCode | Menetapkan mata uang yang digunakan untuk pembelian dalam aplikasi. Berikan kode ISO 4217 tiga karakter code. |
updateServerUninstallToken | Lampirkan token GCM/FCM pada Android atau token APNs pada iOS ketika plugin lain mengumpulkannya. Gunakan ini untuk mengirimkan token pengukuran uninstall ke AppsFlyer. |
setAppInviteOneLink | Menetapkan ID OneLink yang digunakan sebagai basis tautan untuk atribusi undangan. |
setOneLinkCustomDomain | Mendaftarkan domain OneLink yang ditandai sehingga AppsFlyer dapat menyelesaikan parameter atribusi yang disembunyikan dalam tautan pendek. |
appendParametersToDeepLinkingURL | Mengaktifkan atribusi untuk tautan dalam aplikasi tanpa OneLink. Panggil metode ini sebelum startSDK(). Termasuk setidaknya pid dan is_retargeting=true dalam peta parameter. |
setResolveDeepLinkURLs | Gunakan ini ketika tautan OneLink AppsFlyer dibungkus dalam tautan Universal yang lain. Ini memungkinkan SDK menyelesaikan URL yang dibungkus sehingga deep linking masih berfungsi dengan benar. |
addPushNotificationDeepLinkPath | Mengatur cara SDK mengekstrak nilai tautan dalam dari payload notifikasi push. |
setSharingFilter | Menghentikan event dari menyebar ke mitra AppsFlyer yang ditentukan. |
setSharingFilterForAllPartners | Menghentikan event dari menyebar ke semua mitra AppsFlyer. Menggantikan pengaturan filter berbagi. |
setSharingFilterForPartners | Menghentikan event dari menyebar ke mitra AppsFlyer yang ditentukan. |
setAdditionalData | Mengatur data kunci-nilai tambahan untuk dikirim ke AppsFlyer. |
getAppsFlyerUID | Mendapatkan ID perangkat unik AppsFlyer (dibuat untuk setiap instalasi baru aplikasi). |
anonymizeUser | Opt-Out Akhir Pengguna dari analitik AppsFlyer (Mengaburkan data pengguna). |
stop | Setelah API ini diinvok, SDK kami tidak lagi berkomunikasi dengan server kami dan berhenti berfungsi. Berguna ketika menerapkan opt-in/opt-out pengguna. |
disableSKAdNetwork | Opt-out dari SKAdNetwork. |
disableAdvertisingIdentifier | Menghapus pengumpulan berbagai ID iklan oleh SDK. Ini termasuk Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID dan Amazon Advertising ID (AAID). |
disableCollectASA | Opt-out dari atribusi iklan Apple Search Ads. |
setHost | Set __CAPGO_KEEP_0__ host. |
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, maka af_purchase event dengan nilai yang relevan akan terlog otomatis. |
validateAndLogInAppPurchaseIos | Lihat definisi sumber untuk perilaku saat ini. |
getSdkVersion | Dapatkan versi AppsFlyer SDK yang digunakan di aplikasi. |
enableFacebookDeferredApplinks | Mengaktifkan pengumpulan tautan aplikasi yang tertunda Facebook. Memerlukan Facebook SDK dan aplikasi Facebook di perangkat target/klien. Ini API harus diinvok sebelum menginisialisasi AppsFlyer SDK agar berfungsi dengan baik. |
sendPushNotificationData | Ukur dan dapatkan data dari kampanye pemberitahuan push. |
setCurrentDeviceLanguage | Set __CAPGO_KEEP_0__ bahasa perangkat. Data akan ditampilkan di Laporan Data Asli. |
logCrossPromoteImpression | Log impresi sebagai bagian dari kampanye promosi lintas. Pastikan untuk menggunakan ID aplikasi yang dipromosikan seperti yang terlihat di dashboard AppsFlyer. |
setUserEmails | Set email pengguna dan enkripsi mereka. |
logLocation | Log lokasi pengguna secara manual. |
setPhoneNumber | Akan dikirim sebagai string SHA-256 yang dienkripsi. |
setPartnerData | Mengizinkan pengiriman data kustom untuk tujuan integrasi mitra. |
logInvite | Gunakan untuk merekam event undangan pengguna dalam aplikasi (af_invite). |
setDisableNetworkData | Gunakan untuk keluar dari pengumpulan nama operator jaringan (carrier) dan nama operator SIM dari perangkat. |
enableTCFDataCollection | Gunakan untuk mengaktifkan/menghentikan pengumpulan data persetujuan secara otomatis, untuk pengguna yang menggunakan CMP. Nilai flag akan disimpan antara sesi aplikasi. |
setConsentData | Gunakan 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. |
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 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 dimulai dalam sesi saat ini. |
isSDKStopped | Gunakan metode ini untuk memeriksa apakah SDK AppsFlyer sedang berhenti. |
disableAppSetId | Menghapus pengumpulan ID Set Aplikasi. Jika dipanggil sebelum SDK init, ID Set Aplikasi tidak akan dikumpulkan. Jika dipanggil setelah init, ID Set Aplikasi akan dikumpulkan tetapi tidak akan dikirim dalam payload permintaan. Hanya Android. |
validateAndLogInAppPurchaseV2 | API untuk verifikasi server pembelian dalam aplikasi V2. Jika validasi berhasil, event af_purchase dengan nilai relevan akan direkam secara otomatis. |
Sumber Kebenaran
Sumber KebenaranReferensi ini disinkronkan dari src/definitions.ts di capacitor-appsflyer.