Getting Started

Instal

bun add @capgo/capacitor-appsflyer
bunx cap sync

Impor

import { AppsFlyer } from '@capgo/capacitor-appsflyer';
import type {
  AFAdRevenueData,
  AFAndroidInAppPurchase,
  AFAnonymizeUser,
  AFAppendToDeepLink,
  AFConsentData,
  AFConsentOptions,
  AFCuid,
  AFCurrency,
  AFData,
  AFDisable,
  AFEmails,
  AFEnableTCFDataCollection,
  AFEvent,
  AFFbDAL,
  AFFilters,
  AFHost,
  AFInit,
  AFIosInAppPurchase,
  AFLanguage,
  AFLatLng,
  AFLinkGenerator,
  AFLogInvite,
  AFOnelinkDomain,
  AFOnelinkID,
  AFPartnerData,
  AFPath,
  AFPhone,
  AFPromotion,
  AFPurchaseDetailsV2,
  AFPushPayload,
  AFUninstall,
  AFUrls,
} from '@capgo/capacitor-appsflyer';

API Ringkasan

initSDK

Gunakan metode ini untuk menginisialisasi dan memulai AppsFlyer SDK. Metode API ini harus dipanggil segera setelah aplikasi diluncurkan.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.initSDK({} as AFInit);

startSDK

Pilih metode ini untuk memulai AppsFlyer SDK, hanya pada mode mulai manual.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.startSDK();

logEvent

Logkan suatu kejadian dalam aplikasi.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.logEvent({} as AFEvent);

setCustomerUserId

Mengatur ID pengguna 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({} as AFCuid);

setCurrencyCode

Mengatur mata uang yang digunakan untuk pembelian dalam aplikasi. Berikan kode mata uang ISO 4217 tiga karakter code.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Kirimkan token GCM/FCM pada Android atau token APNs pada iOS ketika plugin lain mengumpulkannya. Gunakan ini untuk mengirimkan token pengukuran uninstall ke AppsFlyer.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

Atur ID OneLink yang digunakan sebagai basis tautan undangan untuk atribusi.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Daftarkan domain OneLink yang dimiliki untuk mengenali parameter atribusi yang disembunyikan dalam tautan pendek.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Aktifkan atribusi untuk tautan App Links yang dalam tanpa OneLink. Panggil metode ini sebelum startSDK()Termasuk setidaknya pid dan di dalam map parameter. is_retargeting=true Salin ke clipboard

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Use this when an AppsFlyer OneLink is wrapped inside another Universal Link. It lets the SDK resolve the wrapped URL so deep linking still works correctly.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

Configures how the SDK extracts deep link values from push notification payloads.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Salin ke clipboard

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Menghentikan kejadian dari menyebar ke semua mitra AppsFlyer. Menggantikan setSharingFilter.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Menghentikan kejadian dari menyebar ke mitra AppsFlyer yang ditentukan.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Menetapkan data kunci-nilai tambahan untuk dikirim ke AppsFlyer.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setAdditionalData({} as AFData);

getAppsFlyerUID

Dapatkan ID perangkat unik AppsFlyer (dibuat untuk setiap instalasi baru aplikasi).

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.getAppsFlyerUID();

anonymizeUser

Menghilangkan Opt-Out dari pengguna AppsFlyer analytics (Mengamankan data pengguna).

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Setelah API ini diaktifkan, SDK kami tidak lagi berkomunikasi dengan server kami dan berhenti berfungsi. Gunakan ketika menerapkan opt-in/opt-out pengguna.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.stop();

disableSKAdNetwork

Menghilangkan Opt-out dari SKAdNetwork

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Menghilangkan pengumpulan berbagai ID Iklan oleh SDK. Ini termasuk Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID dan Amazon Advertising ID (AAID).

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

Keluar dari atribusi iklan Apple Search Ads.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.disableCollectASA({} as AFDisable);

setHost

Atur host yang kustom.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setHost({} as AFHost);

generateInviteLink

Mengizinkan pengguna Anda yang sudah ada untuk mengundang teman dan kontak mereka sebagai pengguna baru untuk aplikasi Anda.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

validateAndLogInAppPurchaseAndroid

API untuk verifikasi server pembelian dalam aplikasi. Jika validasi berhasil, af_purchase akan ditambahkan ke log dengan nilai yang relevan.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.validateAndLogInAppPurchaseAndroid({} as AFAndroidInAppPurchase);

validateAndLogInAppPurchaseIos

Lihat definisi sumber untuk kontrak saat ini.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);

getSdkVersion

Dapatkan versi AppsFlyer SDK yang digunakan di aplikasi.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.getSdkVersion();

enableFacebookDeferredApplinks

Enable the collection of Facebook Deferred AppLinks. Requires Facebook SDK and Facebook app on target/client device. This API must be invoked before initializing the AppsFlyer SDK in order to function properly.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Ukur dan dapatkan data dari kampanye pemberitahuan push.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Set bahasa perangkat. Data akan ditampilkan dalam Laporan Data Asli

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Log impresi sebagai bagian dari kampanye promosi lintas aplikasi. Pastikan menggunakan ID aplikasi promosi seperti yang muncul di dashboard AppsFlyer.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);

setUserEmails

Set alamat email pengguna dan enkripsi mereka.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Log lokasi pengguna secara manual

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Akan dikirim sebagai string SHA-256 yang dienkripsi.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Mengizinkan pengiriman data kustom untuk keperluan integrasi mitra.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Gunakan untuk merekam acara pengundangan pengguna (af_invite) di aplikasi.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Gunakan untuk mengopt-out dari pengumpulan nama operator jaringan (carrier) dan nama operator SIM dari perangkat.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Gunakan untuk mengaktifkan/menghentikan pengumpulan data persetujuan secara otomatis, untuk pengguna yang menggunakan CMP. Nilai flag akan disimpan antara sesi aplikasi.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

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 manual langsung ke SDK.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setConsentData({} as AFConsentData);

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 penawaran, interstitials, dan banner di aplikasi. Anda dapat menggunakan metode ini untuk merekam pendapatan iklan Anda.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

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 manual langsung ke SDK.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Gunakan metode ini untuk memeriksa apakah aplikasi AppsFlyer SDK sudah dimulai dalam sesi saat ini.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.isSDKStarted();

isSDKStopped

Gunakan metode ini untuk memeriksa apakah aplikasi AppsFlyer SDK sedang berhenti.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.isSDKStopped();

disableAppSetId

Menghentikan pengumpulan ID Aplikasi. Jika dipanggil sebelum SDK diinisialisasi, ID Aplikasi tidak akan dikumpulkan. Jika dipanggil setelah inisialisasi, ID Aplikasi akan dikumpulkan tetapi tidak akan dikirim dalam payload permintaan. Hanya tersedia untuk Android.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

API untuk verifikasi server pembelian dalam aplikasi V2. Jika validasi sukses, af_purchase event dengan nilai relevan akan secara otomatis dilogkan.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.tsRe-run sinkronisasi ketika publik API berubah di atas

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-appsflyer untuk kemampuan asli di Menggunakan @capgo/capacitor-appsflyer, API Ringkasan untuk detail implementasi di API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, dan Perangkat untuk detail implementasi di Perangkat.