Getting Started

Installazione

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

Poi utilizza la seguente richiesta:

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 del tuo platform sotto:

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

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

startSDK

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

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

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

logEvent

Registra un evento in-app.

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

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

setCustomerUserId

La configurazione del 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.

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

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

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({ currencyCode: 'USD' });

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.

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

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

setAppInviteOneLink

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

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

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

setOneLinkCustomDomain

Registra domini OneLink personalizzati affinché AppsFlyer possa risolvere i parametri di attribuzione nascosti nei collegamenti brevi.

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

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

appendParametersToDeepLinkingURL

Abilita l'attribuzione per i collegamenti profondi 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({
  contains: 'contains',
  parameters: {},
});

setResolveDeepLinkURLs

Use this when an AppsFlyer OneLink is wrapped inside another Universal Link. It lets the SDK resolve the wrapped URL so deep linking still works correctly.

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

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

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({ path: ['path/to/file'] });

setSharingFilter

Impedisce agli eventi di propagarsi ai partner AppsFlyer specificati.

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

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

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({ filters: ['filter'] });

setAdditionalData

Imposta ulteriori dati chiave-valore da inviare a AppsFlyer.

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

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

getAppsFlyerUID

Ottieni l'ID dispositivo univoco di AppsFlyer (creato per ogni nuova installazione di un'app).

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

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

anonymizeUser

Disattiva l'analisi di AppsFlyer (Anonimizza i dati dell'utente).

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

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

stop

Una volta invocato questo API, il nostro SDK non comunica più con i nostri server e si ferma di funzionare.

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

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

disableSKAdNetwork

Disattiva SKAdNetwork

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

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

disableAdvertisingIdentifier

Disabilita la raccolta di vari ID pubblicitari tramite il 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({ shouldDisable: true });

disableCollectASA

Disattiva le attribuzioni degli annunci 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

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

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

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

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

validateAndLogInAppPurchaseIos

Vedi le definizioni di riferimento per il contratto corrente.

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 AppsFlyer SDK 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 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';

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

sendPushNotificationData

Misura e ottieni dati dalle campagne di notifica push.

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

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

setCurrentDeviceLanguage

Imposta la lingua del dispositivo. I dati saranno visualizzati nei rapporti di dati Raw

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

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

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

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

setUserEmails

Imposta gli indirizzi email degli utenti e criptali.

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

Viene inviato come stringa crittografata SHA-256.

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

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

setPartnerData

Consente di inviare dati personalizzati per scopi di 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 di invito in-app (af_invite).

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

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

setDisableNetworkData

Usa per escludere la raccolta del nome del fornitore di rete (carrier) e del nome del fornitore del SIM dall'apparecchio.

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

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

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({ shouldEnableTCFDataCollection: true });

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, usa il seguente metodo per fornire manualmente i dati di consenso direttamente al SDK.

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

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

logAdRevenue

By attributing ad revenue, app owners gain the complete view of user LTV and campaign ROI. Ad revenue is generated by displaying ads on rewarded videos, offer walls, interstitials, and banners in an app. You can use this method to log your ad revenue.

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

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

setConsentDataV2

Utilizza 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.setConsentDataV2({
  isUserSubjectToGDPR: true,
  hasConsentForDataUsage: true,
  hasConsentForAdsPersonalization: true,
  hasConsentForAdStorage: true,
});

isSDKStarted

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

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

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

isSDKStopped

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

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

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

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.

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, 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 plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Keep going from Getting Started

Se stai utilizzando Getting Started per pianificare dashboard e API operazioni, connettilo con Utilizzando @capgo/capacitor-appsflyer per la capacità nativa in Utilizzando @capgo/capacitor-appsflyer, API Panoramica 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.