Inizia

Installazione

bun add @capgo/capacitor-appsflyer
bunx cap sync

Importazione

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 Overview

initSDK

Usa 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

Usa questo metodo per avviare AppsFlyer SDK, solo in modalità 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

Impostando il tuo ID cliente, puoi confrontare il tuo ID univoco con quello di AppsFlyer e gli ID degli altri dispositivi. Questo ID è disponibile nei report 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

Imposta la moneta utilizzata per le transazioni in-app. Fornisci 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 APNs su iOS quando un altro plugin li ha raccolti. Utilizza questo per inviare i token di misurazione dell'eliminazione 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 collegamenti App Links senza OneLink. Chiamare questo metodo prima di startSDK(). Includere 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 Collegamento Universale. Lascia che il SDK risolva l'URL avvolto così i collegamenti profondi funzionano 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

Impedisce agli eventi di propagarsi 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 setSharingFilter.

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

Inserisce 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 dell'utente per gli analytics di AppsFlyer (Anonimizza i dati dell'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 dell'utente.

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 Identificatori pubblicitari tramite il SDK. Ciò include l'Identità per gli annunci pubblicitari 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

Opt-out delle attribuzioni degli annunci pubblicitari 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

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

API per la verifica del server delle compravendite in-app. Se la verifica è riuscita, verrà registrato automaticamente un evento af_purchase con i valori pertinenti.

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

Otterra il numero di versione di AppsFlyer SDK utilizzato nell'app.

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

await AppsFlyer.getSdkVersion();

enableFacebookDeferredApplinks

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

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

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Misura e ottieni dati dalle 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 incrociata. 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

Registrare manualmente la posizione dell'utente

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Viene inviato come stringa crittografata SHA-256.

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

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Consente di inviare dati personalizzati per scopi di integrazione 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 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.

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

await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

Attribuendo il reddito pubblicitario, gli owner dell'app ottengono una visione completa del LTV degli utenti e del ROI delle campagne. Il reddito pubblicitario è generato dalla visualizzazione di annunci in video ricompensati, muri offerta, interstizi e banner nell'app. Puoi utilizzare questo metodo per registrare il tuo reddito pubblicitario.

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

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.

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

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Usa questo metodo per verificare se il SDK AppsFlyer è già stato avviato nella sessione corrente.

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

await AppsFlyer.isSDKStarted();

isSDKStopped

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

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

await AppsFlyer.isSDKStopped();

disableAppSetId

Disabilita la raccolta dell'ID dell'app. Se chiamato prima dell'inizializzazione di SDK, l'ID dell'app non verrà raccolto. Se chiamato dopo l'inizializzazione, l'ID dell'app 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 del server delle compravendite 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.tsRiepilogo quando le informazioni pubbliche API cambiano in modo upstream.