Pembuatan Awal

Instal

Anda dapat menggunakan Pengaturan Bantuan AI untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Kemudian gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-appsflyer` plugin in my project.

Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah:

bun add @capgo/capacitor-appsflyer
bunx cap sync

Import

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';

Bab berjudul “API Overview”

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

Pilih 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 yang digunakan untuk pembelian dalam aplikasi. Berikan kode mata uang ISO 4217 tiga karakter code.

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

await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });

updateServerUninstallToken

Pass 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({ token: 'token-123' });

setAppInviteOneLink

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

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

await AppsFlyer.setAppInviteOneLink({ onelinkID: 'onelink-id-123' });

setOneLinkCustomDomain

Mendaftarkan domain OneLink yang dimiliki untuk mengizinkan AppsFlyer menyelesaikan atribusi parameter yang disembunyikan dalam tautan pendek.

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

await AppsFlyer.setOneLinkCustomDomain({ domains: ['example.com'] });

appendParametersToDeepLinkingURL

Mengaktifkan atribusi untuk tautan App Links yang dalam tanpa OneLink. Panggil metode ini sebelum startSDK()Termasuklah setidaknya pid dan is_retargeting=true di dalam peta parameter.

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

await AppsFlyer.appendParametersToDeepLinkingURL({
  contains: 'contains',
  parameters: {},
});

setResolveDeepLinkURLs

Pakai hal ini ketika sebuah OneLink AppsFlyer dibungkus di dalam sebuah Universal Link lainnya. Hal ini memungkinkan SDK untuk menyelesaikan URL yang dibungkus sehingga deep linking masih berfungsi dengan benar.

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

await AppsFlyer.setResolveDeepLinkURLs({ urls: ['https://example.com'] });

addPushNotificationDeepLinkPath

Mengatur bagaimana SDK mengekstrak nilai deep link dari payload notifikasi push.

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

await AppsFlyer.addPushNotificationDeepLinkPath({ path: ['path/to/file'] });

setSharingFilter

Menghentikan event dari menyebar ke mitra AppsFlyer yang ditentukan.

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

await AppsFlyer.setSharingFilter({ filters: ['filter'] });

setSharingFilterForAllPartners

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

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Menghentikan event dari menyebar ke mitra AppsFlyer yang ditentukan.

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

await AppsFlyer.setSharingFilterForPartners({ filters: ['filter'] });

setAdditionalData

Mengatur data kunci-nilai tambahan untuk dikirim ke AppsFlyer.

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

await AppsFlyer.setAdditionalData({ additionalData: {} });

getAppsFlyerUID

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

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

const result = await AppsFlyer.getAppsFlyerUID();
console.log(result);

anonymizeUser

Opt-Out Akun Pengguna dari Analisis AppsFlyer (Menganonimkan data pengguna).

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

await AppsFlyer.anonymizeUser({ anonymizeUser: true });

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';

const result = await AppsFlyer.stop();
console.log(result);

disableSKAdNetwork

Opt-out dari SKAdNetwork

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

await AppsFlyer.disableSKAdNetwork({ shouldDisable: true });

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).

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

await AppsFlyer.disableAdvertisingIdentifier({ shouldDisable: true });

disableCollectASA

Opt-out dari atribusi iklan pencarian Apple.

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

await AppsFlyer.disableCollectASA({ shouldDisable: true });

setHost

Set host yang disesuaikan.

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

await AppsFlyer.setHost({
  hostPrefixName: 'host-prefix',
  hostName: 'host',
});

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';

const result = await AppsFlyer.generateInviteLink({ brandDomain: 'example.com' });
console.log(result);

validateAndLogInAppPurchaseAndroid

API untuk verifikasi server pembelian dalam aplikasi. Jika validasi berhasil, af_purchase akan terdaftar secara otomatis dengan nilai yang relevan.

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

const result = await AppsFlyer.validateAndLogInAppPurchaseAndroid({
  currency: 'USD',
  publicKey: 'public-key-123',
  signature: 'signature',
  purchaseData: 'purchase-data',
  price: 'price',
});
console.log(result);

validateAndLogInAppPurchaseIos

Lihat definisi sumber untuk kontrak saat ini.

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

const result = await AppsFlyer.validateAndLogInAppPurchaseIos({
  currency: 'USD',
  inAppPurchase: 'in-app-purchase',
  price: 'price',
  transactionId: 'transaction-id-123',
});
console.log(result);

getSdkVersion

Dapatkan versi AppsFlyer SDK yang digunakan di aplikasi.

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

const result = await AppsFlyer.getSdkVersion();
console.log(result);

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';

const result = await AppsFlyer.enableFacebookDeferredApplinks({ enableFacebookDAL: true });
console.log(result);

sendPushNotificationData

Pengukuran dan pengambilan data dari kampanye notifikasi push.

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

await AppsFlyer.sendPushNotificationData({ pushPayload: {} });

setCurrentDeviceLanguage

Setel bahasa perangkat. Data akan ditampilkan di Laporan Data Asli

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

const result = await AppsFlyer.setCurrentDeviceLanguage({ language: 'en-US' });
console.log(result);

logCrossPromoteImpression

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

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

const result = await AppsFlyer.logCrossPromoteImpression({
  appID: 'app-id-123',
  campaign: 'campaign',
  parameters: {},
});
console.log(result);

setUserEmails

Setel alamat email pengguna dan enkripsi mereka

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

const result = await AppsFlyer.setUserEmails({ emails: ['user@example.com'] });
console.log(result);

logLocation

Log lokasi pengguna secara manual

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

const result = await AppsFlyer.logLocation({
  latitude: 48.8566,
  longitude: 2.3522,
});
console.log(result);

setPhoneNumber

Akan dikirim sebagai string SHA-256 yang dienkripsi.

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

const result = await AppsFlyer.setPhoneNumber({ phone: '+15555550123' });
console.log(result);

setPartnerData

Mengizinkan pengiriman data kustom untuk keperluan integrasi mitra.

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

const result = await AppsFlyer.setPartnerData({
  data: {},
  partnerId: 'partner-id-123',
});
console.log(result);

logInvite

Gunakan untuk merekam event undangan dalam aplikasi (af_invite).

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

const result = await AppsFlyer.logInvite({
  eventParameters: {},
  channel: 'channel',
});
console.log(result);

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({ shouldDisable: true });

enableTCFDataCollection

Pilih untuk mengaktifkan/keluar dari pengumpulan data persetujuan otomatis, untuk pengguna yang menggunakan CMP. Nilai flag akan disimpan antara sesi aplikasi.

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

await AppsFlyer.enableTCFDataCollection({ shouldEnableTCFDataCollection: true });

setConsentData

Pilih untuk mengatur 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.

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

await AppsFlyer.setConsentData({ data: { isUserSubjectToGDPR: true } });

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 di aplikasi. Pilih metode ini untuk merekam pendapatan iklan Anda.

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

await AppsFlyer.logAdRevenue({
  monetizationNetwork: 'monetization-network',
  mediationNetwork: MediationNetwork.IRONSOURCE,
  currencyIso4217Code: 'USD',
  revenue: 1,
});

setConsentDataV2

Pilih untuk mengatur 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.

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

await AppsFlyer.setConsentDataV2({
  isUserSubjectToGDPR: true,
  hasConsentForDataUsage: true,
  hasConsentForAdsPersonalization: true,
  hasConsentForAdStorage: true,
});

isSDKStarted

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

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

const result = await AppsFlyer.isSDKStarted();
console.log(result);

isSDKStopped

Pilih metode ini untuk memeriksa apakah SDK AppsFlyer saat ini sudah berhenti.

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

const result = await AppsFlyer.isSDKStopped();
console.log(result);

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 berhasil, af_purchase akan secara otomatis dilogkan dengan nilai yang relevan.

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

const result = await AppsFlyer.validateAndLogInAppPurchaseV2({
  purchaseDetails: {
    purchaseType: AFPurchaseType.oneTimePurchase,
    purchaseToken: 'purchase-token-123',
    productId: 'product-id-123',
  },
});
console.log(result);

Sumber Kebenaran

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

Lanjutkan dari Getting Started

Jika Anda menggunakan Mulai Menggunakan untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-appsflyer untuk kemampuan native di Menggunakan @capgo/capacitor-appsflyer, API Pengenalan untuk detail implementasi di API Pengenalan Pendahuluan untuk detail implementasi di Pendahuluan API Kunci untuk detail implementasi di API Kunci, dan Perangkat Untuk detail implementasi di Perangkat.