Iniziare

Installa

bun add @capgo/capacitor-appsflyer
bunx cap sync

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

initSDK

Usa questo metodo per inizializzare e avviare AppsFlyer SDK. Questo API dovrebbe essere chiamato non appena l'app si avvia.

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

await AppsFlyer.initSDK({} as AFInit);

startSDK

Usa questo metodo per avviare AppsFlyer SDK, solo in modalità di avvio manuale.

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

await AppsFlyer.startSDK();

logEvent

Registra un evento in-app.

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

await AppsFlyer.logEvent({} as AFEvent);

setCustomerUserId

Impostare il proprio ID cliente consente di confrontare il proprio ID univoco con l'ID univoco di AppsFlyer e gli ID degli altri dispositivi. Questo ID è disponibile nei rapporti dati raw e nelle API Postback per confrontarlo con i propri ID interni.

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

await AppsFlyer.setCustomerUserId({} as AFCuid);

setCurrencyCode

Imposta la valuta utilizzata per le transazioni in-app. Inserisci un codice ISO 4217 a tre caratteri code.

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

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Passa i token GCM/FCM su Android o i token APNs su iOS quando un altro plugin li ha raccolti. Usa questo per inviare i token di misurazione di disinstallazione a AppsFlyer.

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

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

Imposta l'ID OneLink utilizzato come link base per l'attribuzione degli inviti.

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

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

Abilita l'attribuzione per i link di deep linking di 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

Usa questo quando un OneLink AppsFlyer è avvolto dentro un altro Universal Link. Lascia che il SDK risolva l'URL avvolto in modo che il deep linking funzioni correttamente.

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

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

Configura come il SDK estrae i valori dei collegamenti profondi dai payload delle notifiche push.

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

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Fermare gli eventi da propagare ai partner AppsFlyer specificati.

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Impedisce agli eventi di propagarsi a tutti i partner AppsFlyer. Sovrascrive la impostazione del filtro di condivisione.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Impedisce agli eventi di propagarsi ai partner AppsFlyer specificati.

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

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Imposta dati chiave-valore aggiuntivi da inviare a AppsFlyer.

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

await AppsFlyer.setAdditionalData({} as AFData);

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

Disattivazione utente da parte degli utenti finali per gli analytics AppsFlyer (Anonimizza i dati utente).

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

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

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.

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

await AppsFlyer.stop();

disableSKAdNetwork

Disattivazione di SKAdNetwork

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Disabilita la raccolta di vari ID pubblicitari da parte del SDK. Ciò include l'IDFA di Apple per gli annunci (IDFA), l'ID pubblicitario di Google (GAID), OAID e l'ID pubblicitario di Amazon (AAID).

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

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

Scegli di non riconoscere le attribuzioni di Apple Search Ads.

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

await AppsFlyer.disableCollectASA({} as AFDisable);

setHost

Imposta un host personalizzato.

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

await AppsFlyer.setHost({} as AFHost);

generateInviteLink

Consenti 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

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

Vedi le definizioni di riferimento per il contratto corrente.

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

await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);

getSdkVersion

Ottieni la versione AppsFlyer SDK utilizzata nell'app.

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

await AppsFlyer.getSdkVersion();

enableFacebookDeferredApplinks

Abilita la raccolta dei Deferred AppLinks di Facebook. Richiede Facebook SDK e Facebook app sul dispositivo/client di destinazione. Questa API deve essere invocata prima dell'inizializzazione della AppsFlyer SDK per funzionare correttamente.

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

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Misura e ottieni dati dai campagne di notifiche push.

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

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

Registra un'impressione come parte di una campagna di promozione cross-mediale. 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

Imposta gli indirizzi email degli utenti e criptali.

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

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Registra manualmente la posizione dell'utente

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Verrà inviato come stringa crittografata con SHA-256.

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

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Consente di inviare dati personalizzati per scopi di integrazione con partner.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Usa per registrare un evento di invito in-app (af_invite).

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

await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Usa 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

Usa 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

Usa questo per impostare manualmente i dati di consenso degli utenti. Se la tua app non utilizza un CMP compatibile con TCF v2.2, utilizza il seguente metodo per fornire manualmente i dati di consenso direttamente al SDK.

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

await AppsFlyer.setConsentData({} as AFConsentData);

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 di annunci su video ricompensati, muri offerta, interstizi e banner nell'app. Puoi utilizzare questo metodo per registrare i tuoi ricavi pubblicitari.

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Usa questo per impostare manualmente i dati di consenso degli utenti. Se la tua app non utilizza un CMP compatibile con TCF v2.2, utilizza il seguente metodo per fornire manualmente i dati di consenso direttamente al SDK.

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

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

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

Usa questo metodo per verificare se l'SDK AppsFlyer è attualmente fermato.

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

await AppsFlyer.isSDKStopped();

disableAppSetId

Disabilita la raccolta dell'ID di AppSet. Se chiamato prima dell'SDK inizializzazione, 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. Solo per Android.

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

await AppsFlyer.disableAppSetId();

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à

Questa pagina è generata dal plugin’s src/definitions.tsRiepilogare la sincronizzazione quando le informazioni pubbliche API cambiano in modo upstream.

Continua da Iniziare

Se stai utilizzando Iniziare per pianificare il dashboard e le API operazioni, connettilo con Utilizza @capgo/capacitor-appsflyer per la capacità nativa in Utilizza @capgo/capacitor-appsflyer, API Overview per i dettagli di implementazione in API Panoramica, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.