Guida
Come usare AppsFlyer in Capacitor
Utilizzo di @capgo/capacitor-appsflyer
Plugin Capacitor per l'attribuzione, l'analytics e i deep link di AppsFlyer.
Installa
bun add @capgo/capacitor-appsflyer
bunx cap sync
bunx cap sync copia i code nativi del plugin nei tuoi progetti nativi. Eseguilo di nuovo dopo ogni aggiornamento del plugin.
Importa
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
API in breve
| Metodo | Descrizione |
|---|---|
initSDK |
Usa questo metodo per inizializzare e avviare SDK di AppsFlyer. Chiama questo API non appena l'app viene avviata. |
startSDK |
Usa questo metodo per avviare SDK di AppsFlyer, solo in modalità manual start. |
logEvent |
Registra un evento in-app. |
setCustomerUserId |
Impostare il proprio customer ID permette di incrociare il tuo ID univoco con l'ID univoco di AppsFlyer e con gli ID di altri dispositivi. Questo ID è disponibile nei report raw-data e nelle API Postback per il cross-referencing con i tuoi ID interni. |
setCurrencyCode |
Imposta la valuta per gli acquisti in-app. La valuta code deve essere un code ISO 4217 di 3 caratteri. |
updateServerUninstallToken |
(Android) Permette di inviare al server AppsFlyer i token GCM/FCM raccolti da plugin di terze parti. Può essere usato per i log di disinstallazione. (iOS) Permette di inviare al server AppsFlyer i token APN raccolti da plugin di terze parti. Può essere usato per i log di disinstallazione. |
setAppInviteOneLink |
Imposta l'ID OneLink da utilizzare per l'attribuzione degli inviti utente. Il link generato per l'invito utilizzerà questo OneLink come link di base. |
setOneLinkCustomDomain |
Affinché SDK di AppsFlyer risolva correttamente i parametri di attribuzione nascosti (decodificati nell'ID dello shortlink), è necessario fornire a questo metodo qualsiasi dominio configurato come branded domain nella dashboard di AppsFlyer. |
appendParametersToDeepLinkingURL |
Consente ai proprietari di app che usano gli App Links per il deep linking (senza OneLink) di attribuire le sessioni avviate tramite un dominio associato alla propria app. Chiama questo metodo prima di start. Devi includere nel Map dei parametri: pid e is_retargeting deve essere true. |
setResolveDeepLinkURLs |
Gli inserzionisti possono racchiudere un AppsFlyer OneLink all'interno di un altro Universal Link. Questo Universal Link avvierà l'app, ma i dati di deep linking non verranno propagati ad AppsFlyer. setResolveDeepLinkURLs ti permette di configurare SDK per risolvere gli URL OneLink contenuti, garantendo il corretto deep linking. |
addPushNotificationDeepLinkPath |
Configura il modo in cui SDK estrae i valori di deep link dai payload delle notifiche push. |
setSharingFilter |
Interrompe la propagazione degli eventi verso i partner AppsFlyer specificati. |
setSharingFilterForAllPartners |
Interrompe la propagazione degli eventi verso tutti i partner AppsFlyer. Sovrascrive setSharingFilter. |
setSharingFilterForPartners |
Interrompe la propagazione degli eventi verso i partner AppsFlyer specificati. |
setAdditionalData |
Imposta dati aggiuntivi da inviare ad AppsFlyer. Vedi. |
getAppsFlyerUID |
Ottieni l'ID dispositivo univoco di AppsFlyer (creato per ogni nuova installazione dell'app). |
anonymizeUser |
Opt-out dell'utente finale dall'analytics di AppsFlyer (anonimizza i dati utente). |
stop |
Una volta invocato questo API, il nostro SDK non comunicherà più con i nostri server e smetterà di funzionare. Utile per implementare l'opt-in/opt-out dell'utente. |
disableSKAdNetwork |
Opt-out da SKAdNetwork. |
disableAdvertisingIdentifier |
Disabilita la raccolta di vari Advertising ID da parte di SDK. Include Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID e Amazon Advertising ID (AAID). |
disableCollectASA |
Opt-out per le attribuzioni di Apple Search Ads. |
setHost |
Imposta un host personalizzato. |
generateInviteLink |
Permette ai tuoi utenti attuali di invitare amici e contatti come nuovi utenti della tua app. |
validateAndLogInAppPurchaseAndroid |
API per la verifica lato server degli acquisti in-app. Se la validazione ha successo, verrà loggato automaticamente un evento af_purchase con i valori rilevanti. |
validateAndLogInAppPurchaseIos |
Consulta le definizioni sorgente per il comportamento attuale. |
getSdkVersion |
Ottieni la versione SDK di AppsFlyer utilizzata nell'app. |
enableFacebookDeferredApplinks |
Abilita la raccolta dei Facebook Deferred AppLinks. Richiede Facebook SDK e l'app Facebook sul dispositivo target/client. Questo API deve essere invocato prima di inizializzare l'SDK AppsFlyer SDK per funzionare correttamente. |
sendPushNotificationData |
Misura e ottieni dati dalle campagne di push-notification. |
setCurrentDeviceLanguage |
Imposta la lingua del dispositivo. I dati saranno visualizzati nei Raw Data Reports. |
logCrossPromoteImpression |
logga un'impression come parte di una campagna di cross-promotion. Assicurati di usare il promoted App ID così come appare nella dashboard di AppsFlyer. |
setUserEmails |
Imposta le email degli utenti e cifrale. |
logLocation |
Registra manualmente la posizione dell'utente. |
setPhoneNumber |
Verrà inviato come stringa criptata SHA-256. |
setPartnerData |
Consente l'invio di dati personalizzati per l'integrazione con partner. |
logInvite |
Usa per registrare un evento in-app di invito utente (af_invite). |
setDisableNetworkData |
Usa per disattivare la raccolta del nome dell'operatore di rete (carrier) e del nome dell'operatore SIM dal dispositivo. |
enableTCFDataCollection |
Usa per attivare/disattivare la raccolta automatica dei dati di consenso, per gli utenti che usano una CMP. Il valore del flag verrà mantenuto tra le sessioni dell'app. |
setConsentData |
Usa per impostare manualmente i dati di consenso dell'utente. Se la tua app non usa una CMP compatibile con TCF v2.2, usa il seguente metodo per fornire i dati di consenso direttamente a SDK. |
logAdRevenue |
Attribuendo i ricavi pubblicitari, i proprietari delle app ottengono una visione completa del LTV utente e del ROI delle campagne. I ricavi pubblicitari sono generati dalla visualizzazione di annunci in rewarded video, offer wall, interstitial e banner in un'app. Puoi usare questo metodo per registrare i tuoi ricavi pubblicitari. |
setConsentDataV2 |
Usa questo metodo per impostare manualmente i dati di consenso dell'utente. Se la tua app non usa una CMP compatibile con TCF v2.2, usa il seguente metodo per fornire i dati di consenso direttamente a SDK. |
isSDKStarted |
Usa questo metodo per verificare se l'SDK di AppsFlyer è già stato avviato nella sessione corrente. |
isSDKStopped |
Usa questo metodo per verificare se l'SDK di AppsFlyer è attualmente fermo. |
disableAppSetId |
Disabilita la raccolta dell'AppSet ID. Se chiamato prima dell'init di SDK, l'App Set ID non verrà raccolto. Se chiamato dopo l'init, l'App Set ID verrà raccolto ma non inviato nei payload delle richieste. Solo Android. |
validateAndLogInAppPurchaseV2 |
API per la verifica lato server degli acquisti in-app V2. Se la validazione ha successo, verrà loggato automaticamente un evento af_purchase con i valori pertinenti. |
Esempi
initSDK()
Usa questo metodo per inizializzare e avviare SDK di AppsFlyer. Questo API va chiamato non appena l'app viene avviata.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.initSDK({
devKey: 'dev-key-123',
appID: 'app-id-123',
});
console.log(result);
startSDK()
Usa questo metodo per avviare SDK di AppsFlyer, solo in modalità manual start.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.startSDK();
console.log(result);
logEvent()
Logga un evento in-app.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);
setCustomerUserId()
Impostare il proprio customer ID permette di incrociare il proprio ID univoco con l'ID univoco di AppsFlyer e con gli ID di altri dispositivi. Questo ID è disponibile nei report raw-data e nelle Postback API per il cross-referencing con i tuoi ID interni.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });
setCurrencyCode()
Imposta la valuta per gli acquisti in-app. La valuta code deve essere un code ISO 4217 di 3 caratteri.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });
updateServerUninstallToken()
(Android) Permette di inviare al server AppsFlyer i token GCM/FCM raccolti da plugin di terze parti. Può essere usato per il log di disinstallazione. (iOS) Permette di inviare al server AppsFlyer i token APN raccolti da plugin di terze parti. Può essere usato per il log di disinstallazione.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });
La tabella sopra elenca i 44 metodi core. Listener, helper di versione e il contratto completo di ogni metodo sono documentati in repository GitHub.
Ascolta gli eventi
addListener restituisce un handle. Chiama handle.remove() quando la schermata viene smontata.
Riferimento completo
Continua da Usare @capgo/capacitor-appsflyer
Se stai usando Utilizzo di @capgo/capacitor-appsflyer per pianificare il lavoro sui plugin nativi, collegalo a @capgo/capacitor-appsflyer per i dettagli di implementazione in @capgo/capacitor-appsflyer, Per iniziare per i dettagli di implementazione nella guida introduttiva, Directory dei plugin di Capgo per il workflow del prodotto nella Capgo Plugin Directory, Plugin Capacitor di Capgo per i dettagli di implementazione in Plugin Capacitor di Capgo, e Aggiunta o aggiornamento dei plugin per i dettagli di implementazione in Aggiunta o aggiornamento dei plugin.