Guida
Come utilizzare AppsFlyer in Capacitor
Utilizzo di @capgo/capacitor-appsflyer
Plugin Capacitor per l'attribuzione, l'analisi e i collegamenti profondi di AppsFlyer
Installa
bun add @capgo/capacitor-appsflyer
bunx cap sync
bunx cap sync copia il plugin nativo code nei tuoi progetti nativi. Esegui nuovamente dopo ogni aggiornamento del plugin.
Importa
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
API in sintesi
| Metodo | Descrizione |
|---|---|
initSDK |
Usa questo metodo per inizializzare e avviare AppsFlyer SDK. Questo API dovrebbe essere chiamato non appena l'app viene avviata. |
startSDK |
Usa questo metodo per avviare AppsFlyer SDK, solo in modalità avvio manuale. |
logEvent |
Registra un evento in-app. |
setCustomerUserId |
Impostare il proprio ID cliente consente di correlare il proprio ID univoco con l'ID univoco di AppsFlyer e gli ID degli altri dispositivi. Questo ID è disponibile nei report di dati raw e nelle API di postback per la correlazione con gli ID interni. |
setCurrencyCode |
Imposta la valuta per le transazioni in-app. La valuta code dovrebbe essere un codice ISO 4217 a 3 caratteri code. |
updateServerUninstallToken |
(Android) Consente di passare i token GCM/FCM raccolti da plugin terze parti al server di AppsFlyer. Può essere utilizzato per il registro degli uninstall. (iOS) Consente di passare i token APN raccolti da plugin terze parti al server di AppsFlyer. Può essere utilizzato per il registro degli uninstall. |
setAppInviteOneLink |
Imposta l'ID OneLink che dovrebbe essere utilizzato per attribuire l'invito dell'utente. Il link generato per l'invito dell'utente utilizzerà questo OneLink come link di base. |
setOneLinkCustomDomain |
In modo che AppsFlyer SDK possa risolvere con successo i parametri di attribuzione nascosti (decodificati nell'ID del link corto), qualsiasi dominio configurato come dominio personalizzato nella dashboard di AppsFlyer dovrebbe essere fornito a questo metodo. |
appendParametersToDeepLinkingURL |
Abilita gli owner di app che utilizzano App Links per il deep linking (senza OneLink) per attribuire le sessioni iniziate tramite un dominio associato alla loro app. Chiamare questo metodo prima di chiamare start. Deve fornire i seguenti parametri nella mappa dei parametri: pid is_retargeting deve essere impostato su true. |
setResolveDeepLinkURLs |
Gli inserzionisti possono avvolgere un OneLink AppsFlyer all'interno di un altro Universal Link. Questo Universal Link invocherà l'app ma i dati di deep linking non propagheranno a AppsFlyer. setResolveDeepLinkURLs consente di configurare il SDK per risolvere le URL OneLink avvolte, in modo che il deep linking possa avvenire correttamente. |
addPushNotificationDeepLinkPath |
Configura come il SDK estrae i valori di deep link dai payload delle notifiche push. |
setSharingFilter |
Sospende gli eventi dalla propagazione ai partner AppsFlyer specificati. |
setSharingFilterForAllPartners |
Sospende gli eventi dalla propagazione a tutti i partner AppsFlyer. Sovrascrive setSharingFilter. |
setSharingFilterForPartners |
Sospende gli eventi dalla propagazione ai partner AppsFlyer specificati. |
setAdditionalData |
Imposta dati aggiuntivi da inviare a AppsFlyer. Vedi. |
getAppsFlyerUID |
Ottieni l'ID dispositivo univoco di AppsFlyer (creato per ogni nuovo installazione di un'app). |
anonymizeUser |
Fine utente per l'anonimizzazione dei dati utente da AppsFlyer. |
stop |
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. |
disableSKAdNetwork |
Opt-out di SKAdNetwork. |
disableAdvertisingIdentifier |
Disabilita la raccolta di vari ID pubblicitari da parte del SDK. Ciò include l'Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID e Amazon Advertising ID (AAID). |
disableCollectASA |
Opt-out delle attribuzioni di Apple Search Ads. |
setHost |
Imposta un host personalizzato. |
generateInviteLink |
Consenti ai tuoi utenti esistenti di invitare i loro amici e contatti come nuovi utenti per il tuo app. |
validateAndLogInAppPurchaseAndroid |
API per la verifica del server delle transazioni in-app. Se la verifica è riuscita, verrà registrato automaticamente un evento af_purchase con i valori pertinenti. |
validateAndLogInAppPurchaseIos |
Vedi le definizioni di origine per il comportamento attuale. |
getSdkVersion |
Ottieni la versione SDK di AppsFlyer utilizzata nell'app. |
enableFacebookDeferredApplinks |
Abilita la raccolta dei Deferred AppLinks di Facebook. Richiede Facebook SDK e Facebook app sul dispositivo di destinazione/client. Questo API deve essere invocato prima dell'inizializzazione della SDK di AppsFlyer per funzionare correttamente. |
sendPushNotificationData |
Misura e ottieni dati dai campioni di push-notifiche. |
setCurrentDeviceLanguage |
Imposta la lingua del dispositivo. I dati saranno visualizzati nei Report di dati Raw. |
logCrossPromoteImpression |
registra un'impressione come parte di una campagna di promozione cross-mediale. Assicurati di utilizzare l'ID dell'app promossa come appare all'interno del pannello di controllo di AppsFlyer. |
setUserEmails |
Imposta gli indirizzi email degli utenti e criptali. |
logLocation |
Registra manualmente la posizione dell'utente. |
setPhoneNumber |
Viene inviato come stringa crittografata con SHA-256. |
setPartnerData |
Consente di inviare dati personalizzati per scopi di integrazione con partner. |
logInvite |
Usa per registrare un evento di invito in-app (af_invite). |
setDisableNetworkData |
Usa per disabilitare la raccolta del nome dell'operatore di rete (carrier) e del nome dell'operatore SIM dal dispositivo. |
enableTCFDataCollection |
Usa per abilitare/disabilitare la raccolta automatica dei dati di consenso, per gli utenti che utilizzano un CMP. Il valore della bandiera verrà persistito tra le sessioni dell'app. |
setConsentData |
Usa per impostare manualmente i dati di consenso dell'utente. Se il tuo app non utilizza un CMP compatibile con TCF v2.2, utilizza il seguente metodo per fornire manualmente i dati di consenso direttamente al SDK. |
logAdRevenue |
By attributing ad revenue, app owners gain the complete view of user LTV and campaign ROI. Ad revenue is generated by displaying ads on rewarded videos, offer walls, interstitials, and banners in an app. You can use this method to log your ad revenue. |
setConsentDataV2 |
Usa questo per impostare manualmente i dati di consenso dell'utente. Se il tuo app non utilizza un CMP compatibile con TCF v2.2, utilizza il seguente metodo per fornire manualmente i dati di consenso direttamente al 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 fermato. |
disableAppSetId |
Disabilita la raccolta dell'ID di AppSet. Se chiamato prima dell'inizializzazione dell'SDK, l'ID di AppSet non verrà raccolto. Se chiamato dopo l'inizializzazione, l'ID di AppSet verrà raccolto ma non verrà inviato nei payload delle richieste. Disponibile solo per Android. |
validateAndLogInAppPurchaseV2 |
API per la verifica del server delle vendite in-app V2. Un evento af_purchase con i valori pertinenti verrà registrato automaticamente se la validazione è riuscita. |
Esempi
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';
const result = await AppsFlyer.initSDK({
devKey: 'dev-key-123',
appID: 'app-id-123',
});
console.log(result);
startSDK()
Utilizza questo metodo per avviare AppsFlyer SDK, solo in modalità di avvio manuale.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.startSDK();
console.log(result);
logEvent()
Registra un evento in-app.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);
setCustomerUserId()
Impostare il proprio ID cliente consente di correlare il proprio ID univoco con l'ID univoco di AppsFlyer e gli ID degli altri dispositivi. Questo ID è disponibile nei report di dati raw e nelle API di postback per la correlazione con gli ID interni.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });
setCurrencyCode()
Imposta la valuta per le vendite in-app. La valuta code dovrebbe essere un codice ISO 4217 a 3 caratteri code.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });
updateServerUninstallToken()
(Android) Allows to pass GCM/FCM Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for Uninstall log. (iOS) Allows to pass APN Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for log Uninstall.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });
La tabella sopra elenca i 44 metodi di base. Gli ascoltatori e gli aiuti di versione, nonché la piena documentazione di ogni metodo, sono disponibili nel Repository GitHub.
Ascolta gli eventi
addListener restituisce un handle. Chiama handle.remove() quando lo schermo viene smontato.
Riferimento completo
Continua da Utilizzo di @capgo/capacitor-appsflyer
Se stai utilizzando Utilizzo di @capgo/capacitor-appsflyer per pianificare il lavoro del plugin nativo, connettilo con @capgo/capacitor-appsflyer per i dettagli di implementazione in @capgo/capacitor-appsflyer Getting Started per i dettagli di implementazione in Getting Started, Capgo Directory dei Plugin per il workflow del prodotto in Capgo Directory dei Plugin, Capacitor Plugin da Capgo per i dettagli di implementazione in Capacitor Plugin da Capgo, e Aggiungere o Aggiornare i Plugin per i dettagli di implementazione in Aggiungere o Aggiornare i Plugin.