Démarrage

Installation

bun add @capgo/capacitor-appsflyer
bunx cap sync

Importer

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 Vue d'ensemble

initSDK

Utilisez cette méthode pour initialiser et démarrer AppsFlyer SDK. Cette API doit être appelée dès le lancement de l'application.

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

await AppsFlyer.initSDK({} as AFInit);

startSDK

Utilisez cette méthode pour démarrer AppsFlyer SDK, uniquement en mode de démarrage manuel.

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

await AppsFlyer.startSDK();

logEvent

Enregistrer un événement de l'application.

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

await AppsFlyer.logEvent({} as AFEvent);

setCustomerUserId

La mise en place de votre propre ID client vous permet de croiser votre propre ID unique avec l'ID unique d'AppsFlyer et les autres ID des appareils. Cet ID est disponible dans les rapports de données brutes et dans les API de Postback pour la croisance avec vos propres ID internes.

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

await AppsFlyer.setCustomerUserId({} as AFCuid);

setCurrencyCode

Fixer la devise utilisée pour les achats en application. Fournir un code ISO 4217 à trois caractères code.

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

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Transmettez les jetons GCM/FCM sur Android ou les jetons APNs sur iOS lorsque l'autre plugin les a collectés. Utilisez cela pour transmettre les jetons de mesure d'annulation à AppsFlyer.

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

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

Définit l'ID OneLink utilisé comme lien de base pour l'attribution des invitations.

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Enregistre les domaines OneLink personnalisés pour que AppsFlyer puisse résoudre les paramètres d'attribution cachés dans les liens courts.

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

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Active l'attribution pour les liens profonds App Links sans OneLink. Appelez cette méthode avant startSDK()Incluez au moins pid et dans le tableau des paramètres. is_retargeting=true Copier dans le presse-papiers

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

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({} as AFUrls);

addPushNotificationDeepLinkPath

Configures how the SDK extracts deep link values from push notification payloads.

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

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Copier dans le presse-papiers

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Empêche les événements de se propager à tous les partenaires AppsFlyer. Remplace la configuration de partage.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Empêche les événements de se propager aux partenaires AppsFlyer spécifiés.

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

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Envoie des données clés-valeurs supplémentaires à AppsFlyer.

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

await AppsFlyer.setAdditionalData({} as AFData);

getAppsFlyerUID

Obtenez l'ID unique de l'appareil AppsFlyer (créé pour chaque nouvelle installation d'une application).

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

await AppsFlyer.getAppsFlyerUID();

anonymizeUser

Opt-out de l'utilisateur des analyses AppsFlyer (Anonymiser les données de l'utilisateur).

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

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Lorsque cette API est invoquée, notre SDK ne communique plus avec nos serveurs et cesse de fonctionner. Utilisable lors de l'implémentation de l'opt-in/opt-out de l'utilisateur.

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

await AppsFlyer.stop();

disableSKAdNetwork

Opt-out du réseau SKAd

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Désactive la collecte des diverses identifiants publicitaires par le SDK. Cela inclut l'identifiant Apple pour les annonceurs (IDFA), l'identifiant publicitaire Google (GAID), OAID et l'identifiant publicitaire Amazon (AAID).

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

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

S'abstenir des attributions de publicités Apple Search Ads.

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

await AppsFlyer.disableCollectASA({} as AFDisable);

setHost

Définir un hôte personnalisé.

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

await AppsFlyer.setHost({} as AFHost);

generateInviteLink

Permettre à vos utilisateurs existants d'inviter leurs amis et contacts comme nouveaux utilisateurs à votre application.

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

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

validateAndLogInAppPurchaseAndroid

API pour la vérification serveur des achats en application. Un événement af_purchase avec les valeurs pertinentes sera automatiquement enregistré si la validation est réussie.

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

await AppsFlyer.validateAndLogInAppPurchaseAndroid({} as AFAndroidInAppPurchase);

validateAndLogInAppPurchaseIos

Voir les définitions de source pour le contrat actuel.

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

await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);

getSdkVersion

Obtenez la version AppsFlyer SDK utilisée dans l'application.

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

await AppsFlyer.getSdkVersion();

enableFacebookDeferredApplinks

Activer la collecte des liens d'applications Facebook différés. Exige Facebook SDK et application Facebook sur le dispositif/client cible. Cette API doit être invoquée avant l'initialisation de l'instance AppsFlyer SDK pour fonctionner correctement.

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

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Mesurer et obtenir des données de campagnes de notifications push.

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Fixez la langue de l'appareil. Les données seront affichées dans les Rapports de données brutes

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Enregistrez une impression en tant que partie d'une campagne de cross-promotion. Assurez-vous d'utiliser l'ID de l'application promue tel qu'il apparaît dans l'interface de dashboard d'AppsFlyer.

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

await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);

setUserEmails

Fixez les adresses e-mail des utilisateurs et les chiffrer.

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

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Enregistrez manuellement la localisation de l'utilisateur

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Serait envoyé sous forme de chaîne chiffrée SHA-256.

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

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Permet d'envoyer des données personnalisées pour des besoins d'intégration partenariale.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Utilisez pour enregistrer un événement d'invitation utilisateur (af_invite) en interne.

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

await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Utilisez pour vous désabonner de la collecte du nom de l'opérateur de réseau (carrier) et du nom de l'opérateur SIM du dispositif.

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

await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Utilisez pour vous inscrire/désinscrire de la collecte automatique de données de consentement, pour les utilisateurs qui utilisent un CMP. La valeur de la bannière sera persistante entre les sessions de l'application.

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

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Utilisez cela pour définir les données de consentement de l'utilisateur manuellement. Si votre application ne utilise pas un CMP compatible avec TCF v2.2, utilisez la méthode suivante pour fournir les données de consentement directement au SDK.

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

await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

En attribuant les revenus publicitaires, les propriétaires d'applications obtiennent une vue complète de la valeur à vie de l'utilisateur et du rendement sur investissement des campagnes. Les revenus publicitaires sont générés en affichant des publicités sur des vidéos rémunérées, des murs d'offres, des interstitiels et des bannières dans une application. Vous pouvez utiliser cette méthode pour logger vos revenus publicitaires.

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Utilisez cela pour définir les données de consentement de l'utilisateur manuellement. Si votre application ne utilise pas un CMP compatible avec TCF v2.2, utilisez la méthode suivante pour fournir les données de consentement directement au SDK.

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

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Utilisez cette méthode pour vérifier si l'SDK AppsFlyer a déjà été démarré dans la session actuelle.

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

await AppsFlyer.isSDKStarted();

isSDKStopped

Utilisez cette méthode pour vérifier si l'SDK AppsFlyer est actuellement arrêté.

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

await AppsFlyer.isSDKStopped();

disableAppSetId

Activez la désactivation de la collecte de l'ID d'application. Si appelé avant l'initialisation de l'SDK, l'ID d'application ne sera pas collecté. Si appelé après l'initialisation, l'ID d'application sera collecté mais pas envoyé dans les payloads de requête. Seul Android.

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

await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

API pour la vérification serveur des achats en application V2. Un événement af_purchase avec les valeurs pertinentes sera automatiquement enregistré si la validation est réussie.

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

await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

Source Of Truth

Cette page est générée à partir du plugin’s src/definitions.tsRe-run la synchronisation lorsque les données publiques API changent en amont.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier le tableau de bord et les opérations API, connectez-le avec Utilisez @capgo/capacitor-appsflyer pour la capacité native dans Utilisez @capgo/capacitor-appsflyer, API Overview pour les détails d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.