@capgo/capacitor-appsflyer

Présentation

Capacitor plugin pour attribution, analytics et liens profonds d'AppsFlyer.

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 démarrage manuel.
• logEvent - Enregistrez un événement en application.
• setCustomerUserId - La définition de votre propre ID client vous permet de cross-referencer votre propre ID unique avec l'ID unique d'AppsFlyer et les IDs des autres appareils. Cet ID est disponible dans les rapports de données brutes et dans les API de postback pour la cross-referencing avec vos IDs internes.

Public API

Méthode	Description
addListener('conversion_callback', listener)	Ecoutez les appels de conversion, y compris onConversionDataSuccess et onConversionDataFail, avec OnConversionDataResult des payloads.
addListener('oaoa_callback', listener)	Écoutez les appels de rappel d'attribution de l'application, y compris onAppOpenAttribution et onAttributionFailure, avec OnAppOpenAttribution paquets.
addListener('udl_callback', listener)	Écoutez les appels de rappel de liens unifiés profonds avec OnDeepLink Les payloads.
initSDK	Utilisez cette méthode pour initialiser et démarrer AppsFlyer SDK. Cette API doit être appelée dès que l'application est lancée.
startSDK	Utilisez cette méthode pour démarrer AppsFlyer SDK, uniquement en mode de démarrage manuel.
logEvent	Enregistrer un événement de l'application.
setCustomerUserId	En mettant en place votre propre ID client, vous pouvez cross-referencer 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 cross-referencer avec vos propres ID internes.
setCurrencyCode	Définit la devise utilisée pour les achats en application. fournit un code ISO 4217 à trois caractères selon l'ISO 4217 code.
updateServerUninstallToken	Passer 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 de désinstallation à AppsFlyer.
setAppInviteOneLink	Définit l'ID OneLink utilisé comme lien de base pour l'attribution des invitations.
setOneLinkCustomDomain	Enregistre les domaines OneLink personnalisés afin que AppsFlyer puisse résoudre les paramètres d'attribution cachés dans les liens courts.
appendParametersToDeepLinkingURL	Active l'attribution pour les liens profonds App Links sans OneLink. Appelez cette méthode avant startSDK()Utilisez au moins pid et is_retargeting=true dans le dictionnaire de paramètres.
setResolveDeepLinkURLs	Utilisez cela lorsque l'OneLink d'AppsFlyer est encapsulé à l'intérieur d'un lien universel. Cela permet au SDK de résoudre l'URL encapsulée afin que la mise en page profonde fonctionne correctement.
addPushNotificationDeepLinkPath	Configure 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	Envoie des données clé-valeur supplémentaires à AppsFlyer.
getAppsFlyerUID	Obtenez l'ID de l'appareil 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 de l'utilisateur).
stop	Lorsque cette API est invoquée, notre SDK ne communique plus avec nos serveurs et cesse de fonctionner. Utile lors de la mise en œuvre de l'opt-in/opt-out de l'utilisateur.
disableSKAdNetwork	Opt-out de SKAdNetwork.
disableAdvertisingIdentifier	Désactivez la collecte de diverses identifiants publicitaires par le SDK. Cela inclut l'identifiant d'Apple pour les annonceurs (IDFA), l'identifiant publicitaire de Google (GAID), OAID et l'identifiant publicitaire d'Amazon (AAID).
disableCollectASA	Opt-out des attributions de recherche d'Apple Ads.
setHost	Configurez 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. Un événement af_purchase avec les valeurs pertinentes sera automatiquement enregistré si la validation est réussie.
validateAndLogInAppPurchaseIos	Voir les définitions de source pour le comportement actuel.
getSdkVersion	Obtenez la version d'AppsFlyer SDK utilisée dans l'application.
enableFacebookDeferredApplinks	Activer la collecte des liens de déférés d'application Facebook. Exige un SDK Facebook et une application Facebook sur le dispositif cible/client. Cette API doit être invoquée avant d'initialiser l'SDK d'AppsFlyer pour fonctionner correctement.
sendPushNotificationData	Mesurer et obtenir des données à partir de campagnes de notifications push.
setCurrentDeviceLanguage	Définir la langue de l'appareil. Les données seront affichées dans les Rapports de données brutes.
logCrossPromoteImpression	Enregistrer 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.
setUserEmails	Définir les adresses e-mail des utilisateurs et les chiffrer.
logLocation	Enregistrer manuellement la localisation de l'utilisateur.
setPhoneNumber	Sera 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 d'invitation de l'utilisateur (af_invite).
setDisableNetworkData	Utilisez pour vous désabiller la collecte du nom de l'opérateur de réseau (fournisseur de services de réseau) et du nom de l'opérateur SIM 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 persistante entre les sessions de l'application.
setConsentData	Utilisez ce paramètre 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.
logAdRevenue	En attribuant des revenus publicitaires, les propriétaires d'applications obtiennent une vue complète de la valeur à long terme de l'utilisateur et du ROI des campagnes. Les revenus publicitaires sont générés par la diffusion d'annonces 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 ceci pour définir les données de consentement 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.
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 d'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 ne sera pas envoyé dans les payloads de requête. (Android uniquement).
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.

Source De Vérité

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