Avvio

Installa

Puoi utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo competenze al tuo strumento AI utilizzando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Usa poi il seguente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-appsflyer` plugin in my project.

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

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 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

La configurazione del proprio ID cliente consente di correlare il proprio ID univoco con quello univoco di AppsFlyer e con 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({} 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 APNs su iOS quando un altro plugin li ha raccolti. Utilizza questo per inviare i token di misurazione dell'annullamento alle app di postback.

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

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

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

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Registra domini OneLink personalizzati per consentire a AppsFlyer di risolvere i parametri di attribuzione nascosti nei collegamenti brevi.

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

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Abilita l'attribuzione per i collegamenti profondi di App Links senza OneLink. Chiamare questo metodo prima di startSDK()Includere almeno pid e is_retargeting=true nel dizionario dei parametri.

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Usa questo quando un OneLink di AppsFlyer è avvolto da un altro collegamento universale. Lascia che SDK risolva l'URL avvolto affinché il collegamento profondo 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

Ferma gli eventi dall'invio ai partner AppsFlyer specificati.

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Ferma gli eventi dall'invio a tutti i partner AppsFlyer. Sovrascrive setSharingFilter.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Ferma gli eventi dall'invio ai partner AppsFlyer specificati.

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

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Imposta ulteriori dati chiave-valore 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

Disattiva l'utente da 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

Disattiva SKAdNetwork

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Disabilita la raccolta di vari ID pubblicitari del SDK. Ciò include l'Identità per gli annunci 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

Disattiva le attribuzioni degli annunci di ricerca di Apple.

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. 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

Ottieni la versione SDK di AppsFlyer utilizzata nell'app.

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

await AppsFlyer.getSdkVersion();

enableFacebookDeferredApplinks

Abilita la raccolta dei Facebook Deferred AppLinks. Richiede Facebook SDK e Facebook app sul dispositivo/client target. Questo API deve essere invocato prima dell'inizializzazione dell'SDK AppsFlyer per funzionare correttamente.

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

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Misura e ottieni dati dai campioni di notifica 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 cross-promozione. 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

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 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'app.

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

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Usa questo per impostare manualmente i dati di consenso dell'utente. 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 il reddito pubblicitario, gli owner degli app ottengono una visione completa del valore a lungo termine dell'utente e del ROI delle campagne. Il reddito pubblicitario è generato dalla visualizzazione di annunci pubblicitari su video ricompensati, muri offerta, interstizi e banner all'interno di un'app. Puoi utilizzare questo metodo per registrare il tuo reddito pubblicitario.

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Utilizza 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

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

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

await AppsFlyer.isSDKStarted();

isSDKStopped

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

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

await AppsFlyer.isSDKStopped();

disableAppSetId

Disabilita la raccolta dell'ID AppSet. Se chiamata prima dell'inizializzazione di SDK, l'ID AppSet non verrà raccolto. Se chiamata dopo l'inizializzazione, l'ID 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 validazione è riuscita.

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

await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

Punto di Riferimento

Questa pagina è generata dal plugin's src/definitions.ts. Riavvia la sincronizzazione quando le informazioni pubbliche di API cambiano in modo upstream.

Continua da dove si è lasciato il Getting Started

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