@capgo/capacitor-appsflyer

Vue d'ensemble

Capacitor plugin pour AppsFlyer attribution, analytics et liens profonds.

Capacités de base

• 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.
• startSDK - Utilisez cette méthode pour démarrer AppsFlyer SDK, uniquement en mode de démarrage manuel.
• logEvent - Enregistrez un événement en application.
• setCustomerUserId - La définition 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.

Public API

Méthode	Description
addListener('conversion_callback', listener)	Écoutez les appels de conversion, notamment onConversionDataSuccess et onConversionDataFail, avec OnConversionDataResult des payloads.
addListener('oaoa_callback', listener)	Écoutez les appels de attribution d'ouverture d'app, notamment onAppOpenAttribution et onAttributionFailure, avec OnAppOpenAttribution des payloads.
addListener('udl_callback', listener)	Écoutez les appels de liens profonds unifiés avec OnDeepLink des payloads.
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.
startSDK	Utilisez cette méthode pour démarrer AppsFlyer SDK, uniquement en mode de démarrage manuel.
logEvent	Enregistrez un événement en application.
setCustomerUserId	La définition de votre propre ID client vous permet de croiser votre propre ID unique avec l'ID unique d'AppsFlyer et les IDs d'autres appareils. Cet ID est disponible dans les rapports de données brutes et dans les API de Postback pour la croisance avec vos IDs internes.
setCurrencyCode	Fixe la devise utilisée pour les achats en application. fourniez un code ISO 4217 à trois caractères code.
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.
setAppInviteOneLink	Fixe l'ID de OneLink utilisé comme lien de base pour l'attribution des invitations.
setOneLinkCustomDomain	Enregistrez les domaines de OneLink personnalisés pour que AppsFlyer puisse résoudre les paramètres d'attribution cachés dans les liens courts.
appendParametersToDeepLinkingURL	Active l'attribution pour les liens profonds d'App Links sans OneLink. Appelez cette méthode avant startSDK()et pid Utilisez cela lorsque l'OneLink d'AppsFlyer est enveloppé dans un autre lien universel. Cela permet au __CAPGO_KEEP_0__ de résoudre l'URL enveloppée afin que la mise en page profonde fonctionne correctement. is_retargeting=true Include at least
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.
addPushNotificationDeepLinkPath	Configurez comment le SDK extrait les valeurs de lien profond à partir des payloads de notifications push.
setSharingFilter	Arrête les événements de se propager aux partenaires AppsFlyer spécifiés.
setSharingFilterForAllPartners	Arrête les événements de se propager à tous les partenaires AppsFlyer. Remplace la valeur définie par setSharingFilter.
setSharingFilterForPartners	Arrête les événements de se propager aux partenaires AppsFlyer spécifiés.
setAdditionalData	Fixe des données clé-valeur supplémentaires à envoyer à AppsFlyer.
getAppsFlyerUID	Obtenez l'ID de dispositif unique d'AppsFlyer (créé pour chaque nouvelle installation d'une application).
anonymizeUser	Opt-out de l'utilisateur des analyses d'AppsFlyer (Anonymisez les données utilisateur).
stop	Lorsque cette fonction API est invoquée, notre SDK ne communique plus avec nos serveurs et cesse de fonctionner. Utile lors de l'implémentation de l'opt-in/opt-out de l'utilisateur.
disableSKAdNetwork	Opt-out du SKAdNetwork.
disableAdvertisingIdentifier	Désactive la collecte de diverses identités publicitaires par le SDK. Cela inclut l'identité d'Apple pour les annonceurs (IDFA), l'identifiant publicitaire Google (GAID), OAID et l'identifiant publicitaire Amazon (AAID).
disableCollectASA	Opt-out des attributions des annonces de recherche Apple.
setHost	Fixe un hôte personnalisé.
generateInviteLink	Permettre à vos utilisateurs existants d'inviter leurs amis et contacts comme nouveaux utilisateurs à votre application.
validateAndLogInAppPurchaseAndroid	API pour la vérification du serveur des achats en application.
validateAndLogInAppPurchaseIos	Voir les définitions source pour le comportement actuel.
getSdkVersion	Obtenez la version SDK d'AppsFlyer utilisée dans l'application.
enableFacebookDeferredApplinks	Activer la collecte des liens d'applications retardés de Facebook. Exige SDK Facebook et l'application Facebook sur le dispositif cible/client. Cette API doit être invoquée avant l'initialisation de l'SDK AppsFlyer pour fonctionner correctement.
sendPushNotificationData	Mesurer et obtenir des données à partir de campagnes de notifications push.
setCurrentDeviceLanguage	Définir la langue du dispositif. Les données seront affichées dans les rapports de données brutes.
logCrossPromoteImpression	Enregistre une impression en tant que partie d'une campagne de promotion croisée. Assurez-vous d'utiliser l'ID de l'application promue tel qu'il apparaît dans le tableau de bord d'AppsFlyer.
setUserEmails	Définir les adresses e-mail des utilisateurs et les chiffrer.
logLocation	Enregistrer manuellement la localisation de l'utilisateur.
setPhoneNumber	Serait envoyé sous forme de chaîne chiffrée SHA-256.
setPartnerData	Permet d'envoyer des données personnalisées à des fins d'intégration de partenaires.
logInvite	Utilisez pour enregistrer un événement de l'invite de l'utilisateur (af_invite).
setDisableNetworkData	Utilisez pour se désinscrire de la collecte du nom de l'opérateur de réseau (carrier) et du nom de l'opérateur SIM à partir du dispositif.
enableTCFDataCollection	Utilisez pour activer/désactiver la collecte automatique des données de consentement, pour les utilisateurs qui utilisent un CMP. La valeur de la bannière sera persistée entre les sessions de l'application.
setConsentData	Utilisez ce méthode pour définir les données de consentement de l'utilisateur manuellement. Si votre application ne utilise pas un CMP compatible avec la TCF v2.2, utilisez la méthode suivante pour fournir les données de consentement directement à la SDK.
logAdRevenue	En attribuant des revenus publicitaires, les propriétaires d'applications obtiennent une vue complète de la valeur de vie de l'utilisateur (LTV) et du retour sur investissement (ROI) 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 enregistrer vos revenus publicitaires.
setConsentDataV2	Utilisez ce méthode pour définir les données de consentement de l'utilisateur manuellement. Si votre application ne utilise pas un CMP compatible avec la TCF v2.2, utilisez la méthode suivante pour fournir les données de consentement directement à la SDK.
isSDKStarted	Utilisez cette méthode pour vérifier si l'instance AppsFlyer SDK a déjà été démarrée dans la session actuelle.
isSDKStopped	Utilisez cette méthode pour vérifier si l'instance AppsFlyer SDK est actuellement arrêtée.
disableAppSetId	Désactive la collecte de l'ID d'application. Si appelé avant l'initialisation de 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. Disponible uniquement sur Android.
validateAndLogInAppPurchaseV2	API pour la vérification serveur des achats en application V2. Un événement af_purchase avec les valeurs pertinentes sera enregistré automatiquement si la validation est réussie.

Source De Vérité

Cette référence est synchronisée à partir de src/definitions.ts en capacitor-appsflyer.