Panduan
Cara menggunakan AppsFlyer di Capacitor
Menggunakan @capgo/capacitor-appsflyer
Plugin Capacitor untuk atribusi, analitik, dan deep link AppsFlyer.
Instal
bun add @capgo/capacitor-appsflyer
bunx cap sync
bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.
Impor
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
Sekilas tentang API
| Metode | Deskripsi |
|---|---|
initSDK |
Gunakan metode ini untuk inisialisasi dan menjalankan AppsFlyer SDK. API ini harus dipanggil segera setelah aplikasi diluncurkan. |
startSDK |
Gunakan metode ini untuk menjalankan AppsFlyer SDK, hanya pada mode start manual. |
logEvent |
Log event di dalam aplikasi. |
setCustomerUserId |
Mengatur customer ID sendiri memungkinkan Anda melakukan cross-reference antara ID unik Anda dengan ID unik AppsFlyer dan ID perangkat lainnya. ID ini tersedia di laporan raw-data dan di Postback APIs untuk cross-referencing dengan ID internal Anda. |
setCurrencyCode |
Mengatur mata uang untuk in-app purchases. Mata uang code harus berupa code ISO 4217 dengan 3 karakter. |
updateServerUninstallToken |
(Android) Memungkinkan pengiriman GCM/FCM Tokens yang dikumpulkan oleh plugin pihak ketiga ke server AppsFlyer. Dapat digunakan untuk log Uninstall. (iOS) Memungkinkan pengiriman APN Tokens yang dikumpulkan oleh plugin pihak ketiga ke server AppsFlyer. Dapat digunakan untuk log Uninstall. |
setAppInviteOneLink |
Atur OneLink ID yang akan digunakan untuk atribusi user-invite. Link yang dibuat untuk undangan user akan menggunakan OneLink ini sebagai link dasar. |
setOneLinkCustomDomain |
Agar SDK AppsFlyer berhasil memproses parameter atribusi tersembunyi (yang didekode dalam shortlink ID), semua domain yang dikonfigurasi sebagai branded domain di AppsFlyer Dashboard harus disertakan ke metode ini. |
appendParametersToDeepLinkingURL |
Memungkinkan pemilik aplikasi yang menggunakan App Links untuk deep linking (tanpa OneLink) agar dapat mengatribusi sesi yang dimulai melalui domain yang terkait dengan aplikasi mereka. Panggil metode ini sebelum memanggil start. Anda harus menyertakan parameter berikut dalam parameters Map: pid is_retargeting harus diatur ke true. |
setResolveDeepLinkURLs |
Pengiklan dapat membungkus AppsFlyer OneLink di dalam Universal Link lainnya. Universal Link ini akan membuka aplikasi, tetapi data deep linking tidak akan diteruskan ke AppsFlyer. setResolveDeepLinkURLs memungkinkan Anda mengonfigurasi SDK untuk memproses URL OneLink yang dibungkus, sehingga deep linking dapat berjalan dengan benar. |
addPushNotificationDeepLinkPath |
Mengatur cara SDK mengekstrak nilai deep link dari payload push notification. |
setSharingFilter |
Menghentikan event agar tidak diteruskan ke partner AppsFlyer yang ditentukan. |
setSharingFilterForAllPartners |
Menghentikan event agar tidak diteruskan ke semua partner AppsFlyer. Menimpa setSharingFilter. |
setSharingFilterForPartners |
Menghentikan event agar tidak diteruskan ke partner AppsFlyer yang ditentukan. |
setAdditionalData |
Atur data tambahan untuk dikirim ke AppsFlyer. Lihat. |
getAppsFlyerUID |
Dapatkan ID perangkat unik dari AppsFlyer (dibuat untuk setiap instalasi aplikasi baru). |
anonymizeUser |
Opt-out pengguna akhir dari analitik AppsFlyer (anonimkan data pengguna). |
stop |
Setelah API ini dipanggil, SDK kami tidak lagi berkomunikasi dengan server kami dan berhenti berfungsi. Berguna saat menerapkan opt-in/opt-out pengguna. |
disableSKAdNetwork |
Opt-out dari SKAdNetwork. |
disableAdvertisingIdentifier |
Menonaktifkan pengumpulan berbagai Advertising ID oleh SDK. Ini mencakup Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID, dan Amazon Advertising ID (AAID). |
disableCollectASA |
Opt-out dari atribusi Apple Search Ads. |
setHost |
Atur host kustom. |
generateInviteLink |
Memungkinkan pengguna lama mengundang teman dan kontak mereka sebagai pengguna baru di aplikasi Anda. |
validateAndLogInAppPurchaseAndroid |
API untuk verifikasi server pada pembelian dalam aplikasi. Event af_purchase dengan nilai yang relevan akan otomatis tercatat jika validasi berhasil. |
validateAndLogInAppPurchaseIos |
Lihat definisi di source untuk perilaku saat ini. |
getSdkVersion |
Dapatkan versi SDK AppsFlyer yang digunakan di aplikasi. |
enableFacebookDeferredApplinks |
Aktifkan pengumpulan Facebook Deferred AppLinks. Membutuhkan Facebook SDK dan aplikasi Facebook di perangkat target/client. API ini harus dipanggil sebelum menginisialisasi AppsFlyer SDK agar berfungsi dengan benar. |
sendPushNotificationData |
Ukur dan ambil data dari kampanye push notification. |
setCurrentDeviceLanguage |
Atur bahasa perangkat. Data akan ditampilkan di Raw Data Reports. |
logCrossPromoteImpression |
mencatat impresi sebagai bagian dari kampanye cross-promotion. Pastikan untuk menggunakan App ID yang dipromosikan sesuai dengan yang tertera di dashboard AppsFlyer. |
setUserEmails |
Atur email pengguna dan enkripsikan email tersebut. |
logLocation |
Catat lokasi pengguna secara manual. |
setPhoneNumber |
Akan dikirim sebagai string terenkripsi SHA-256. |
setPartnerData |
Memungkinkan pengiriman data kustom untuk tujuan integrasi partner. |
logInvite |
Gunakan untuk mencatat event in-app user-invite (af_invite). |
setDisableNetworkData |
Gunakan untuk menonaktifkan pengumpulan nama operator jaringan (carrier) dan nama operator SIM dari perangkat. |
enableTCFDataCollection |
Gunakan untuk mengaktifkan/menonaktifkan pengumpulan data consent secara otomatis bagi pengguna yang memakai CMP. Nilai flag akan tetap tersimpan antar sesi aplikasi. |
setConsentData |
Gunakan untuk mengatur data persetujuan user secara manual. Jika aplikasi Anda tidak menggunakan CMP yang kompatibel dengan TCF v2.2, gunakan metode berikut untuk mengirimkan data persetujuan langsung ke SDK. |
logAdRevenue |
Dengan atribusi pendapatan iklan, pemilik aplikasi mendapat gambaran lengkap atas LTV pengguna dan ROI kampanye. Pendapatan iklan dihasilkan dari penayangan iklan di rewarded video, offer wall, interstitial, dan banner dalam aplikasi. Anda dapat menggunakan metode ini untuk mencatat pendapatan iklan Anda. |
setConsentDataV2 |
Gunakan ini untuk mengatur data persetujuan user secara manual. Jika aplikasi Anda tidak menggunakan CMP yang kompatibel dengan TCF v2.2, gunakan metode berikut untuk mengirimkan data persetujuan langsung ke SDK. |
isSDKStarted |
Gunakan metode ini untuk mengecek apakah SDK AppsFlyer sudah dijalankan pada sesi saat ini. |
isSDKStopped |
Gunakan metode ini untuk mengecek apakah SDK AppsFlyer saat ini sudah dihentikan. |
disableAppSetId |
Menonaktifkan pengumpulan AppSet ID. Jika dipanggil sebelum inisialisasi SDK, App Set ID tidak akan dikumpulkan. Jika dipanggil setelah inisialisasi, App Set ID akan dikumpulkan tetapi tidak dikirim dalam request payload. Hanya Android. |
validateAndLogInAppPurchaseV2 |
API untuk verifikasi server pada in-app purchase V2. Event af_purchase dengan nilai terkait akan otomatis tercatat jika validasi berhasil. |
Contoh
initSDK()
Gunakan metode ini untuk inisialisasi dan menjalankan AppsFlyer SDK. API ini 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 menjalankan AppsFlyer SDK, hanya pada mode manual start.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.startSDK();
console.log(result);
logEvent()
Catat event in-app.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);
setCustomerUserId()
Mengatur customer ID sendiri memungkinkan Anda melakukan cross-reference antara ID unik Anda dengan ID unik AppsFlyer dan ID perangkat lainnya. ID ini tersedia di laporan raw-data dan Postback APIs untuk cross-referencing dengan ID internal Anda.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });
setCurrencyCode()
Mengatur mata uang untuk in-app purchase. Mata uang code harus berupa code ISO 4217 dengan 3 karakter.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });
updateServerUninstallToken()
(Android) Memungkinkan pengiriman GCM/FCM Token yang dikumpulkan oleh plugin pihak ketiga ke server AppsFlyer. Dapat digunakan untuk log Uninstall. (iOS) Memungkinkan pengiriman APN Token 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' });
Tabel di atas mencantumkan 44 metode inti. Helper listener, versi, dan kontrak lengkap setiap metode didokumentasikan di repositori GitHub.
Mendengarkan event
addListener mengembalikan sebuah handle. Panggil handle.remove() saat screen di-unmount.
Referensi lengkap
Lanjutkan dari Menggunakan @capgo/capacitor-appsflyer
Jika Anda menggunakan Menggunakan @capgo/capacitor-appsflyer untuk merencanakan pekerjaan plugin native, hubungkan dengan @capgo/capacitor-appsflyer untuk detail implementasi di @capgo/capacitor-appsflyer, Panduan Memulai untuk detail implementasi di Getting Started, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin Capacitor oleh Capgo, dan Menambahkan atau Memperbarui Plugin untuk detail implementasi di bagian Menambahkan atau Memperbarui Plugin.