Inizia
Copia una riga di impostazione con i passaggi di installazione e la guida markdown completa per questo plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-appsflyer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/appsflyer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Installa
Sezione intitolata “Installa”bun add @capgo/capacitor-appsflyerbunx cap syncImporta
Sezione intitolata “Importa”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 Panoramica
Sezione intitolata “API Panoramica”initSDK
Sezione intitolata “initSDK”Utilizza questo metodo per inizializzare e avviare AppsFlyer SDK. Questo API dovrebbe essere chiamato non appena l'app viene avviata.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.initSDK({} as AFInit);startSDK
Sezione intitolata “startSDK”Usa questo metodo per avviare AppsFlyer SDK, solo in modalità di avvio manuale.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.startSDK();logEvent
Sezione intitolata “logEvent”Registra un evento in-app.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.logEvent({} as AFEvent);setCustomerUserId
Sezione intitolata “setCustomerUserId”Impostando il tuo ID cliente, puoi confrontare il tuo ID univoco con quello di AppsFlyer e con gli ID degli altri dispositivi. Questo ID è disponibile nei rapporti di dati raw e nelle API di postback per confrontarlo con i tuoi ID interni.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({} as AFCuid);setCurrencyCode
Sezione intitolata “setCurrencyCode”Imposta la valuta utilizzata per gli acquisti in-app. Inserisci un codice ISO 4217 a tre caratteri code.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({} as AFCurrency);updateServerUninstallToken
Sezione intitolata “updateServerUninstallToken”Passa i token GCM/FCM su Android o APNs su iOS quando un altro plugin li ha raccolti. Usa questo per inviare i token di misurazione dell'installazione a AppsFlyer.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({} as AFUninstall);setAppInviteOneLink
Sezione intitolata “setAppInviteOneLink”Imposta l'ID OneLink utilizzato come link di base per l'attribuzione degli inviti.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);setOneLinkCustomDomain
Sezione intitolata “setOneLinkCustomDomain”Registra i domini OneLink personalizzati affinché AppsFlyer possa risolvere i parametri di attribuzione nascosti nei link brevi.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);appendParametersToDeepLinkingURL
Sezione intitolata “appendParametersToDeepLinkingURL”Abilita l'attribuzione per i collegamenti profondi App Links senza OneLink. Chiamare questo metodo prima di startSDK()Includi almeno pid e is_retargeting=true nel mappa dei parametri.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);setResolveDeepLinkURLs
Sezione intitolata “setResolveDeepLinkURLs”Usa questo quando un OneLink AppsFlyer è avvolto dentro un altro Universal Link. Lascia che il SDK risolva l'URL avvolto in modo che il collegamento profondo funzioni correttamente.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);addPushNotificationDeepLinkPath
Sezione intitolata “addPushNotificationDeepLinkPath”Configura come il SDK estrae i valori del collegamento profondo dai payload delle notifiche push.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);setSharingFilter
Sezione intitolata “setSharingFilter”Fermi gli eventi dall'essere propagati ai partner AppsFlyer specificati.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setSharingFilter({} as AFFilters);setSharingFilterForAllPartners
Sezione intitolata “setSharingFilterForAllPartners”Impedisce agli eventi di propagarsi a tutti i partner AppsFlyer. Sovrascrive setSharingFilter.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setSharingFilterForAllPartners();setSharingFilterForPartners
Sezione intitolata “setSharingFilterForPartners”Impedisce agli eventi di propagarsi ai partner AppsFlyer specificati.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setSharingFilterForPartners({} as AFFilters);setAdditionalData
Sezione intitolata “setAdditionalData”Imposta dati chiave-valore aggiuntivi da inviare a AppsFlyer.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setAdditionalData({} as AFData);getAppsFlyerUID
Sezione intitolata “getAppsFlyerUID”Ottieni l'ID dispositivo univoco di AppsFlyer (creato per ogni nuova installazione di un'app).
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.getAppsFlyerUID();anonymizeUser
Sezione intitolata “anonymizeUser”Disattivazione utente per gli analytics AppsFlyer (Anonimizza i dati utente).
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);Una volta invocato questo API, il nostro SDK non comunica più con i nostri server e smette di funzionare. Utile quando si implementa l'opt-in/opt-out dell'utente.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.stop();disableSKAdNetwork
Sezione intitolata “disableSKAdNetwork”Disattivazione di SKAdNetwork
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.disableSKAdNetwork({} as AFDisable);disableAdvertisingIdentifier
Sezione intitolata “disableAdvertisingIdentifier”Disabilita la raccolta di vari ID pubblicitari da parte del SDK. Ciò include l'Identità per gli annunci di Apple (IDFA), l'ID pubblicitario di Google (GAID), OAID e l'ID pubblicitario Amazon (AAID).
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);disableCollectASA
Sezione intitolata “disabilita la raccolta di ASA”Opt-out delle attribuzioni di Apple Search Ads.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.disableCollectASA({} as AFDisable);Imposta un host personalizzato.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setHost({} as AFHost);generateInviteLink
Sezione intitolata “genera link di invito”Consentire ai tuoi utenti esistenti di invitare i loro amici e contatti come nuovi utenti per il tuo app
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.generateInviteLink({} as AFLinkGenerator);validateAndLogInAppPurchaseAndroid
Sezione intitolata “valida e accedi all'acquisto in-app Android”API per la verifica del server degli acquisti in-app. Un evento af_purchase con i valori pertinenti verrà registrato automaticamente se la validazione è riuscita.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.validateAndLogInAppPurchaseAndroid({} as AFAndroidInAppPurchase);validateAndLogInAppPurchaseIos
Sezione intitolata “validateAndLogInAppPurchaseIos”Vedi le definizioni di riferimento per il contratto corrente.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);getSdkVersion
Sezione intitolata “getSdkVersion”Ottieni la versione AppsFlyer SDK utilizzata nell'app.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.getSdkVersion();enableFacebookDeferredApplinks
Sezione intitolata “enableFacebookDeferredApplinks”Abilita la raccolta dei collegamenti di AppLink di Facebook. Richiede Facebook SDK e l'app di Facebook sul dispositivo/client di destinazione. Questo API deve essere invocato prima dell'inizializzazione della SDK AppsFlyer per funzionare correttamente.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);sendPushNotificationData
Sezione intitolata “sendPushNotificationData”Misura e ottieni dati dalle campagne di notifiche push.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.sendPushNotificationData({} as AFPushPayload);setCurrentDeviceLanguage
Sezione intitolata “setCurrentDeviceLanguage”Imposta la lingua del dispositivo. I dati saranno visualizzati nei Rapporti di dati raw
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);logCrossPromoteImpression
Sezione intitolata “logCrossPromoteImpression”Registra un'impressione come parte di una campagna di promozione cross. Assicurati di utilizzare l'ID dell'app promossa come appare nel pannello di controllo di AppsFlyer
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);setUserEmails
Sezione intitolata “setUserEmails”Imposta gli indirizzi email degli utenti e criptali
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setUserEmails({} as AFEmails);logLocation
Sezione intitolata “logLocation”Registra manualmente la posizione dell'utente
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.logLocation({} as AFLatLng);setPhoneNumber
Sezione intitolata “impostaNumeroDiTelefono”Verrà inviato come stringa crittografata con SHA-256.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setPhoneNumber({} as AFPhone);setPartnerData
Sezione intitolata “impostaDatiPartner”Consente di inviare dati personalizzati per scopi di integrazione con partner.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setPartnerData({} as AFPartnerData);logInvite
Sezione intitolata “registraInvito”Utilizza per registrare un evento di invito in-app (af_invite).
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.logInvite({} as AFLogInvite);setDisableNetworkData
Sezione intitolata “impostaDisabilitaDatiRete”Utilizza per escludere la raccolta del nome dell'operatore di rete (carrier) e del nome dell'operatore SIM dal dispositivo.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setDisableNetworkData({} as AFDisable);enableTCFDataCollection
Abilita la raccolta dei dati TCFUsa per abilitare/disabilitare la raccolta automatica dei dati di consenso, per gli utenti che utilizzano un CMP. Il valore della flag verrà persistito tra le sessioni dell'applicazione.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);setConsentData
Imposta i dati di consensoUse this to set user consent data manually. If your app doesn’t use a CMP compatible with TCF v2.2, use the following method to manually provide the consent data directly to the SDK.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setConsentData({} as AFConsentData);logAdRevenue
Registra i ricavi pubblicitariAttribuendo i ricavi pubblicitari, gli owner delle app ottengono una visione completa del LTV degli utenti e del ROI delle campagne. I ricavi pubblicitari sono generati dalla visualizzazione di annunci in video ricompensati, muri offerta, interstizi e banner in un'app. Puoi utilizzare questo metodo per registrare i tuoi ricavi pubblicitari.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.logAdRevenue({} as AFAdRevenueData);setConsentDataV2
Imposta i dati di consenso v2Use this to set user consent data manually. If your app doesn’t use a CMP compatible with TCF v2.2, use the following method to manually provide the consent data directly to the SDK.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setConsentDataV2({} as AFConsentOptions);isSDKStarted
Sezione intitolata “isSDKStarted”Usa questo metodo per verificare se l'SDK AppsFlyer è già stato avviato nella sessione corrente.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.isSDKStarted();isSDKStopped
Sezione intitolata “isSDKStopped”Usa questo metodo per verificare se l'SDK AppsFlyer è attualmente fermato.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.isSDKStopped();disableAppSetId
Sezione intitolata “disableAppSetId”Disabilita la raccolta dell'ID di set di applicazioni. Se chiamato prima dell'SDK inizializzazione, l'ID di set di applicazioni non verrà raccolto. Se chiamato dopo l'inizializzazione, l'ID di set di applicazioni verrà raccolto ma non verrà inviato nei payload delle richieste. Solo per Android.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.disableAppSetId();validateAndLogInAppPurchaseV2
Sezione intitolata “validateAndLogInAppPurchaseV2”API per la verifica server di acquisti in-app V2. Un evento af_purchase con i valori pertinenti verrà registrato automaticamente se la verifica è riuscita.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);Fonte di Verità
Sezione intitolata “Fonte di Verità”Questa pagina è generata dal plugin’s src/definitions.tsRiepiloga quando le modifiche pubbliche API sono state apportate in fase di sviluppo.