@capgo/capacitor-appsflyer

Panoramica

Capacitor plugin per attribuzione, analisi e collegamenti profondi di AppsFlyer.

Capacità di base

• initSDK - Utilizza questo metodo per inizializzare e avviare AppsFlyer SDK. Questo API dovrebbe essere chiamato non appena l'app è stata lanciata.
• startSDK - Utilizza questo metodo per avviare AppsFlyer SDK, solo in modalità avvio manuale.
• logEvent - Registra un evento in-app.
• setCustomerUserId - Impostando il proprio ID cliente, puoi fare riferimento al proprio ID univoco con l'ID univoco di AppsFlyer e agli ID degli altri dispositivi. Questo ID è disponibile nei report di dati crudi e nelle API di postback per fare riferimento con i propri ID interni.

Pubblico API

Metodo	Descrizione
addListener('conversion_callback', listener)	Ascolta per le callback di conversione, comprese onConversionDataSuccess e onConversionDataFail, con OnConversionDataResult payloads.
addListener('oaoa_callback', listener)	Ascolta i callback di attribuzione dell'app aperta, compresi onAppOpenAttribution e onAttributionFailure, con OnAppOpenAttribution payload.
addListener('udl_callback', listener)	Ascolta i callback di collegamento profondo unificati con OnDeepLink payload.
initSDK	Utilizza questo metodo per inizializzare e avviare AppsFlyer SDK. Questo API dovrebbe essere chiamato non appena l'app viene avviata.
startSDK	Utilizza questo metodo per avviare AppsFlyer SDK, solo in modalità di 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 utilizzata per gli acquisti in-app. Fornisci un codice ISO 4217 a tre caratteri code.
updateServerUninstallToken	Passa i token GCM/FCM su Android o APNs su iOS quando un altro plugin li ha raccolti. Utilizza questo per inviare i token di misurazione di disinstallazione a AppsFlyer.
setAppInviteOneLink	Imposta l'ID OneLink utilizzato come link di base per l'attribuzione degli inviti.
setOneLinkCustomDomain	Registra i domini OneLink personalizzati in modo che AppsFlyer possa risolvere i parametri di attribuzione nascosti nei link brevi.
appendParametersToDeepLinkingURL	Abilita l'attribuzione per i collegamenti profondi di App Links senza OneLink. Chiamare questo metodo prima startSDK()Includere almeno pid e is_retargeting=true nel mappa dei parametri.
setResolveDeepLinkURLs	Usa questo quando un OneLink di AppsFlyer è avvolto in un altro collegamento universale. Lascia che il SDK risolva l'URL avvolto in modo che la navigazione profonda funzioni correttamente.
addPushNotificationDeepLinkPath	Configura come il SDK estrae i valori dei collegamenti profondi dai payload delle notifiche push.
setSharingFilter	Sospende gli eventi dalla propagazione ai partner AppsFlyer specificati.
setSharingFilterForAllPartners	Sospende tutti gli eventi dalla propagazione ai partner AppsFlyer. Sovrascrive il filtro di condivisione impostato.
setSharingFilterForPartners	Sospende gli eventi dalla propagazione ai partner AppsFlyer specificati.
setAdditionalData	Imposta dati chiave-valore aggiuntivi da inviare a AppsFlyer.
getAppsFlyerUID	Ottenere l'ID dispositivo univoco di AppsFlyer (creato per ogni nuova installazione di un'app).
anonymizeUser	Disabilita l'analisi degli utenti di AppsFlyer (Anonimizza i dati degli utenti).
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 degli utenti.
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), l'ID pubblicitario di Google (GAID), OAID e l'ID pubblicitario Amazon (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 la tua app.
validateAndLogInAppPurchaseAndroid	API per la verifica del server delle transazioni in-app. Se la validazione è riuscita, verrà registrato automaticamente un evento af_purchase con i valori pertinenti.
validateAndLogInAppPurchaseIos	Vedi le definizioni di origine per il comportamento corrente.
getSdkVersion	Ottenere la versione di AppsFlyer di SDK utilizzata nell'app.
enableFacebookDeferredApplinks	Abilita la raccolta di Facebook Deferred AppLinks. Richiede Facebook SDK e l'app di Facebook sul dispositivo/client di destinazione. Questo API deve essere invocato prima di inizializzare l'SDK di AppsFlyer per funzionare correttamente.
sendPushNotificationData	Misura e ottieni dati dai campagne di notifica push.
setCurrentDeviceLanguage	Imposta la lingua del dispositivo. I dati saranno visualizzati nei rapporti dati Raw.
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.
setUserEmails	Imposta gli indirizzi email degli utenti e criptali.
logLocation	Registra manualmente la posizione dell'utente.
setPhoneNumber	Verrà inviato come stringa crittografata SHA-256.
setPartnerData	Consente di inviare dati personalizzati per scopi di integrazione con partner.
logInvite	Usa per registrare un evento di invito dell'utente (af_invite).
setDisableNetworkData	Usa per disabilitare la raccolta del nome del fornitore di rete (carrier) e del nome del fornitore del sim del dispositivo.
enableTCFDataCollection	Usa per abilitare/disabilitare la raccolta automatica dei dati di consenso, per gli utenti che utilizzano un CMP. Il valore della bandiera sarà persistente tra le sessioni dell'app.
setConsentData	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 i dati di consenso direttamente al SDK.
logAdRevenue	Attribuendo i ricavi pubblicitari, gli owner dell'app ottengono una visione completa del LTV degli utenti e del ROI delle campagne. I ricavi pubblicitari sono generati dalla visualizzazione degli annunci sui video ricompensati, sulle pareti degli offerti, sugli interstizi e sui banner all'interno dell'app. Puoi utilizzare questo metodo per registrare i tuoi ricavi pubblicitari.
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 AppsFlyer è già stato avviato nella sessione corrente.
isSDKStopped	Usa questo metodo per verificare se l'SDK AppsFlyer è attualmente fermato.
disableAppSetId	Disabilita la raccolta di AppSet ID. Se chiamato prima dell'inizializzazione di SDK, App Set ID non verrà raccolto. Se chiamato dopo l'inizializzazione, App Set ID verrà raccolto ma non verrà inviato nei payload delle richieste. Solo per Android.
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.

Fonte di Verità

Questa referenza è sincronizzata da src/definitions.ts in capacitor-appsflyer.