AppsFlyer Plugin Capacitor

Utiliser @capgo/capacitor-appsflyer

Plugin Capacitor pour l'attribution, l'analytics et les deep links d'AppsFlyer.

Installer

bun add @capgo/capacitor-appsflyer
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

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

Aperçu de API

Méthode	Description
initSDK	Utilisez cette méthode pour initialiser et démarrer AppsFlyer SDK. Ce API doit être appelé dès le lancement de l'application.
startSDK	Utilisez cette méthode pour démarrer le SDK d'AppsFlyer, uniquement en mode démarrage manuel.
logEvent	Enregistrer un événement in-app.
setCustomerUserId	Définir votre propre ID client vous permet de recouper votre 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 Postback pour le recoupement avec vos IDs internes.
setCurrencyCode	Définit la devise pour les achats in-app. La devise code doit être un code ISO 4217 de 3 caractères.
updateServerUninstallToken	(Android) Permet de transmettre au serveur AppsFlyer les tokens GCM/FCM collectés par des plugins tiers. Peut être utilisé pour les logs de désinstallation. (iOS) Permet de transmettre au serveur AppsFlyer les tokens APN collectés par des plugins tiers. Peut être utilisé pour les logs de désinstallation.
setAppInviteOneLink	Définit l'ID OneLink à utiliser pour l'attribution des invitations utilisateur. Le lien généré pour l'invitation utilisera ce OneLink comme lien de base.
setOneLinkCustomDomain	Pour que le SDK d'AppsFlyer puisse résoudre correctement les paramètres d'attribution cachés (décodés dans l'ID du shortlink), tout domaine configuré comme domaine de marque dans le dashboard AppsFlyer doit être fourni à cette méthode.
appendParametersToDeepLinkingURL	Permet aux propriétaires d'applications utilisant les App Links pour le deep linking (sans OneLink) d'attribuer les sessions initiées via un domaine associé à leur application. Appelez cette méthode avant start. Vous devez fournir les paramètres suivants dans la Map de paramètres : pid et is_retargeting doivent être définis sur true.
setResolveDeepLinkURLs	Les annonceurs peuvent encapsuler un OneLink AppsFlyer dans un autre Universal Link. Cet Universal Link lancera l'application, mais aucune donnée de deep linking ne sera transmise à AppsFlyer. setResolveDeepLinkURLs vous permet de configurer le SDK pour résoudre les URL OneLink encapsulées, afin que le deep linking fonctionne correctement.
addPushNotificationDeepLinkPath	Configure la manière dont SDK extrait les valeurs des deep links depuis les payloads de notifications push.
setSharingFilter	Empêche la propagation des événements vers les partenaires AppsFlyer spécifiés.
setSharingFilterForAllPartners	Empêche la propagation des événements vers tous les partenaires AppsFlyer. Écrase setSharingFilter.
setSharingFilterForPartners	Empêche la propagation des événements vers les partenaires AppsFlyer spécifiés.
setAdditionalData	Définit les données supplémentaires à envoyer à AppsFlyer. Voir.
getAppsFlyerUID	Récupère l'ID unique d'appareil AppsFlyer (créé à chaque nouvelle installation d'une application).
anonymizeUser	Retrait de l'utilisateur final de l'analyse AppsFlyer (anonymiser les données utilisateur).
stop	Une fois ce API invoqué, notre SDK ne communique plus avec nos serveurs et cesse de fonctionner. Utile pour implémenter l'opt-in/opt-out utilisateur.
disableSKAdNetwork	Opt-out de SKAdNetwork.
disableAdvertisingIdentifier	Désactive la collecte de divers identifiants publicitaires par le SDK. Cela inclut l'IDFA (Apple Identity for Advertisers), le GAID (Google Advertising ID), l'OAID et l'AAID (Amazon Advertising ID).
disableCollectASA	Désactiver les attributions Apple Search Ads.
setHost	Définir un hôte personnalisé.
generateInviteLink	Permet à vos utilisateurs actuels d'inviter leurs amis et contacts comme nouveaux utilisateurs de votre application.
validateAndLogInAppPurchaseAndroid	API pour la vérification côté serveur des achats in-app. Un événement af_purchase avec les valeurs pertinentes sera automatiquement logué si la validation réussit.
validateAndLogInAppPurchaseIos	Consultez les définitions source pour le comportement actuel.
getSdkVersion	Récupérer la version SDK d'AppsFlyer utilisée dans l'app.
enableFacebookDeferredApplinks	Activer la collecte des Facebook Deferred AppLinks. Nécessite le SDK Facebook et l'app Facebook sur l'appareil cible/client. Ce API doit être appelé avant d'initialiser le SDK d'AppsFlyer pour fonctionner correctement.
sendPushNotificationData	Mesurer et récupérer les données des campagnes de notifications push.
setCurrentDeviceLanguage	Définir la langue de l'appareil. Les données seront affichées dans les Raw Data Reports.
logCrossPromoteImpression	Enregistre une impression dans le cadre d'une campagne de cross-promotion. Veillez à utiliser l'ID de l'app promue tel qu'il apparaît dans le dashboard AppsFlyer.
setUserEmails	Définir les e-mails des utilisateurs et les chiffrer.
logLocation	Enregistrez manuellement la position de l'utilisateur.
setPhoneNumber	Sera envoyé sous forme de chaîne chiffrée SHA-256.
setPartnerData	Permet d'envoyer des données personnalisées pour l'intégration de partenaires.
logInvite	Use to log a user-invite in-app event (af_invite).
setDisableNetworkData	À utiliser pour refuser la collecte du nom de l'opérateur réseau (carrier) et de l'opérateur SIM de l'appareil.
enableTCFDataCollection	À utiliser pour activer/désactiver la collecte automatique des données de consentement pour les utilisateurs utilisant une CMP. La valeur du flag est conservée entre les sessions de l'app.
setConsentData	À utiliser pour définir manuellement les données de consentement. Si votre app n'utilise pas de CMP compatible TCF v2.2, utilisez la méthode suivante pour fournir manuellement les données de consentement directement à SDK.
logAdRevenue	En attribuant les revenus publicitaires, les propriétaires d'apps obtiennent une vue complète de la LTV utilisateur et du ROI des campagnes. Les revenus publicitaires sont générés par l'affichage de publicités via des vidéos récompensées, des offerwalls, des interstitiels et des bannières. Vous pouvez utiliser cette méthode pour enregistrer vos revenus publicitaires.
setConsentDataV2	À utiliser pour définir manuellement les données de consentement. Si votre app n'utilise pas de CMP compatible TCF v2.2, utilisez la méthode suivante pour fournir manuellement les données de consentement directement à SDK.
isSDKStarted	Utilisez cette méthode pour vérifier si le SDK d'AppsFlyer a déjà été démarré dans la session actuelle.
isSDKStopped	Utilisez cette méthode pour vérifier si le SDK d'AppsFlyer est actuellement arrêté.
disableAppSetId	Désactive la collecte de l'AppSet ID. Si appelé avant l'init de SDK, l'App Set ID ne sera pas collecté. Si appelé après l'init, l'App Set ID sera collecté mais non envoyé dans les payloads de requête. Android uniquement.
validateAndLogInAppPurchaseV2	API pour la vérification côté serveur des achats in-app V2. Un événement af_purchase avec les valeurs pertinentes sera automatiquement logué si la validation réussit.

Exemples

initSDK()

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

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

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

startSDK()

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

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

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

logEvent()

Enregistrer un événement in-app.

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

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

setCustomerUserId()

Définir votre propre ID client vous permet de recouper votre 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 Postback pour le recoupement avec vos IDs internes.

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

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

setCurrencyCode()

Définit la devise pour les achats in-app. La devise code doit être un code ISO 4217 de 3 caractères.

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

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

updateServerUninstallToken()

(Android) Permet de transmettre au serveur AppsFlyer les tokens GCM/FCM collectés par des plugins tiers. Peut être utilisé pour les logs de désinstallation. (iOS) Permet de transmettre au serveur AppsFlyer les tokens APN collectés par des plugins tiers. Peut être utilisé pour les logs de désinstallation.

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

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

Le tableau ci-dessus liste les 44 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lorsque l'écran est démonté.

Référence complète

• dépôt GitHub
• Documentation
• Référence API

Continuer depuis Utiliser @capgo/capacitor-appsflyer

Si vous utilisez Utiliser @capgo/capacitor-appsflyer pour planifier le travail sur les plugins natifs, connectez-l’à @capgo/capacitor-appsflyer pour les détails d'implémentation dans @capgo/capacitor-appsflyer, Prise en main pour les détails d'implémentation dans Getting Started Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans les plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins.