Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

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

Poi usa 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 questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-appsflyer
npx 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';

Avvio rapido

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

const result = await AppsFlyer.initSDK({
  devKey: 'dev-key-123',
  appID: 'app-id-123',
});
console.log(result);

Esempio: startSDK

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

const result = await AppsFlyer.startSDK();
console.log(result);

Esempio: logEvent

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

const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);

Errori comuni

• Listener: rimuovi gli handle quando gli schermi vengono smontati.
• Sync nativo: esegui npx cap sync dopo gli aggiornamenti dei plugin.
• Fonte di verità: fidati src/definitions.ts nel repo GitHub.

Panoramica API

initSDK

Usa questo metodo per inizializzare e avviare SDK di AppsFlyer. Questo API deve 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

Usa questo metodo per avviare SDK di AppsFlyer, solo in modalità manual start.

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

const result = await AppsFlyer.startSDK();
console.log(result);

logEvent

Logga un evento in-app.

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

const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);

setCustomerUserId

Impostare un customer ID personale ti permette di incrociare il tuo ID univoco con l'ID univoco di AppsFlyer e con gli ID di altri dispositivi. Questo ID è disponibile nei report sui dati grezzi e nelle Postback API per il confronto incrociato con i tuoi ID interni.

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

await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });

setCurrencyCode

Imposta la valuta usata per gli acquisti in-app. Fornisci un code ISO 4217 di tre caratteri.

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

await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });

updateServerUninstallToken

Passa i token GCM/FCM su Android o i token APNs su iOS quando li ha raccolti un altro plugin. Usa questo metodo per inoltrare ad AppsFlyer i token di misurazione delle disinstallazioni.

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

await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });

setAppInviteOneLink

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

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

await AppsFlyer.setAppInviteOneLink({ onelinkID: 'onelink-id-123' });

setOneLinkCustomDomain

Registra i domini OneLink brandizzati per consentire ad AppsFlyer di risolvere i parametri di attribuzione nascosti nei link brevi.

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

await AppsFlyer.setOneLinkCustomDomain({ domains: ['example.com'] });

appendParametersToDeepLinkingURL

Abilita l'attribuzione per i deep link App Links senza OneLink. Chiama questo metodo prima di startSDK(). Includi almeno pid e is_retargeting=true nella mappa dei parametri.

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

await AppsFlyer.appendParametersToDeepLinkingURL({
  contains: 'contains',
  parameters: {},
});

setResolveDeepLinkURLs

Usalo quando un AppsFlyer OneLink è contenuto in un altro Universal Link. Permette a SDK di risolvere l'URL incapsulato, così il deep linking funziona ancora correttamente.

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

await AppsFlyer.setResolveDeepLinkURLs({ urls: ['https://example.com'] });

addPushNotificationDeepLinkPath

Configura come SDK estrae i valori dei deep link dai payload delle notifiche push.

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

await AppsFlyer.addPushNotificationDeepLinkPath({ path: ['path/to/file'] });

setSharingFilter

Impedisce la propagazione degli eventi ai partner AppsFlyer specificati.

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

await AppsFlyer.setSharingFilter({ filters: ['filter'] });

setSharingFilterForAllPartners

Impedisce la propagazione degli eventi a tutti i partner AppsFlyer. Sovrascrive setSharingFilter.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Impedisce la propagazione degli eventi ai partner AppsFlyer specificati.

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

await AppsFlyer.setSharingFilterForPartners({ filters: ['filter'] });

setAdditionalData

Imposta dati aggiuntivi chiave-valore da inviare ad AppsFlyer.

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

await AppsFlyer.setAdditionalData({ additionalData: {} });

getAppsFlyerUID

Recupera l'ID univoco del dispositivo di AppsFlyer (creato per ogni nuova installazione dell'app).

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

const result = await AppsFlyer.getAppsFlyerUID();
console.log(result);

anonymizeUser

Opt-out dell'utente finale dall'analytics di AppsFlyer (anonimizza i dati utente).

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

await AppsFlyer.anonymizeUser({ anonymizeUser: true });

stop

Una volta invocato questo API, il nostro SDK non comunicherà più con i nostri server e smetterà di funzionare. Utile per implementare l'opt-in/opt-out dell'utente.

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

const result = await AppsFlyer.stop();
console.log(result);

disableSKAdNetwork

Opt-out da SKAdNetwork

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

await AppsFlyer.disableSKAdNetwork({ shouldDisable: true });

disableAdvertisingIdentifier

Disabilita la raccolta di vari Advertising ID da parte di SDK. Include Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID e Amazon Advertising ID (AAID).

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

await AppsFlyer.disableAdvertisingIdentifier({ shouldDisable: true });

disableCollectASA

Disabilita le attribuzioni di Apple Search Ads.

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

await AppsFlyer.disableCollectASA({ shouldDisable: true });

setHost

Imposta un host personalizzato.

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

await AppsFlyer.setHost({
  hostPrefixName: 'host-prefix',
  hostName: 'host',
});

generateInviteLink

Permetti ai tuoi utenti attuali di invitare amici e contatti come nuovi utenti della tua app

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

const result = await AppsFlyer.generateInviteLink({ brandDomain: 'example.com' });
console.log(result);

validateAndLogInAppPurchaseAndroid

API per la verifica lato server degli acquisti in-app. Se la validazione ha successo, verrà loggato automaticamente un evento af_purchase con i valori rilevanti.

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

const result = await AppsFlyer.validateAndLogInAppPurchaseAndroid({
  currency: 'USD',
  publicKey: 'public-key-123',
  signature: 'signature',
  purchaseData: 'purchase-data',
  price: 'price',
});
console.log(result);

validateAndLogInAppPurchaseIos

Consulta le definizioni nel sorgente per il contratto attuale.

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

const result = await AppsFlyer.validateAndLogInAppPurchaseIos({
  currency: 'USD',
  inAppPurchase: 'in-app-purchase',
  price: 'price',
  transactionId: 'transaction-id-123',
});
console.log(result);

getSdkVersion

Ottieni la versione SDK di AppsFlyer utilizzata nell'app.

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

const result = await AppsFlyer.getSdkVersion();
console.log(result);

enableFacebookDeferredApplinks

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

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

const result = await AppsFlyer.enableFacebookDeferredApplinks({ enableFacebookDAL: true });
console.log(result);

sendPushNotificationData

Misura e ottieni dati dalle campagne di push notification.

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

await AppsFlyer.sendPushNotificationData({ pushPayload: {} });

setCurrentDeviceLanguage

Imposta la lingua del dispositivo. I dati saranno visualizzati nei Raw Data Reports

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

const result = await AppsFlyer.setCurrentDeviceLanguage({ language: 'en-US' });
console.log(result);

logCrossPromoteImpression

Logga un'impression come parte di una campagna di cross-promotion. Assicurati di usare l'ID dell'app promossa così come appare nella dashboard di AppsFlyer.

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

const result = await AppsFlyer.logCrossPromoteImpression({
  appID: 'app-id-123',
  campaign: 'campaign',
  parameters: {},
});
console.log(result);

setUserEmails

Imposta le email degli utenti e cifrale.

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

const result = await AppsFlyer.setUserEmails({ emails: ['user@example.com'] });
console.log(result);

logLocation

Registra manualmente la posizione dell'utente

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

const result = await AppsFlyer.logLocation({
  latitude: 48.8566,
  longitude: 2.3522,
});
console.log(result);

setPhoneNumber

Verrà inviato come stringa criptata SHA-256.

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

const result = await AppsFlyer.setPhoneNumber({ phone: '+15555550123' });
console.log(result);

setPartnerData

Consente l'invio di dati personalizzati per l'integrazione con partner.

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

const result = await AppsFlyer.setPartnerData({
  data: {},
  partnerId: 'partner-id-123',
});
console.log(result);

logInvite

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

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

const result = await AppsFlyer.logInvite({
  eventParameters: {},
  channel: 'channel',
});
console.log(result);

setDisableNetworkData

Usa per disattivare 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({ shouldDisable: true });

enableTCFDataCollection

Utilizza per attivare o disattivare la raccolta automatica dei dati di consenso per gli utenti che utilizzano una CMP. Il valore del flag verrà salvato tra le sessioni dell'app.

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

await AppsFlyer.enableTCFDataCollection({ shouldEnableTCFDataCollection: true });

setConsentData

Usa questo metodo per impostare manualmente i dati di consenso dell'utente. Se la tua app non utilizza una CMP compatibile con TCF v2.2, usa il seguente metodo per fornire manualmente i dati di consenso direttamente a SDK.

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

await AppsFlyer.setConsentData({ data: { isUserSubjectToGDPR: true } });

logAdRevenue

Attribuendo i ricavi pubblicitari, i proprietari delle app ottengono una visione completa dell'LTV dell'utente e del ROI delle campagne. I ricavi pubblicitari derivano dalla visualizzazione di annunci in rewarded video, offer walls, interstitial e banner all'interno dell'app. Puoi usare questo metodo per loggare i tuoi ricavi pubblicitari.

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

await AppsFlyer.logAdRevenue({
  monetizationNetwork: 'monetization-network',
  mediationNetwork: MediationNetwork.IRONSOURCE,
  currencyIso4217Code: 'USD',
  revenue: 1,
});

setConsentDataV2

Usa questo metodo per impostare manualmente i dati di consenso dell'utente. Se la tua app non utilizza una CMP compatibile con TCF v2.2, usa il seguente metodo per fornire manualmente i dati di consenso direttamente a SDK.

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

await AppsFlyer.setConsentDataV2({
  isUserSubjectToGDPR: true,
  hasConsentForDataUsage: true,
  hasConsentForAdsPersonalization: true,
  hasConsentForAdStorage: true,
});

isSDKStarted

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

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

const result = await AppsFlyer.isSDKStarted();
console.log(result);

isSDKStopped

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

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

const result = await AppsFlyer.isSDKStopped();
console.log(result);

disableAppSetId

Disabilita la raccolta dell'App Set ID. Se chiamato prima dell'init di SDK, l'App Set ID non verrà raccolto. Se chiamato dopo l'init, l'App Set ID verrà raccolto ma non inviato nei payload delle richieste. Solo Android.

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

await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

API per la verifica server degli acquisti in-app V2. Se la validazione ha successo, verrà registrato automaticamente un evento af_purchase con i valori pertinenti.

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

const result = await AppsFlyer.validateAndLogInAppPurchaseV2({
  purchaseDetails: {
    purchaseType: AFPurchaseType.oneTimePurchase,
    purchaseToken: 'purchase-token-123',
    productId: 'product-id-123',
  },
});
console.log(result);

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-appsflyer per la funzionalità nativa in Utilizzo di @capgo/capacitor-appsflyer, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.