Aller directement au contenu principal

AppsFlyer plugin Capacitor

Ajoutez l'attribution, l'analytique, les liens profonds différés et le support OneLink à votre application Capacitor

Installer

bun add @capgo/capacitor-appsflyer bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-appsflyer
  • pnpm add @capgo/capacitor-appsflyer
  • yarn add @capgo/capacitor-appsflyer

Guide

Comment utiliser AppsFlyer dans Capacitor

Tester sur appareil

Télécharger l'application Capgo, puis scanner le code QR code.

Lien QR de prévisualisation du plugin code AppsFlyer

Utilisation de @capgo/capacitor-appsflyer

Plugin Capacitor pour l'attribution, l'analyse et les liens profonds d'AppsFlyer.

Installer

bun add @capgo/capacitor-appsflyer
bunx cap sync

bunx cap sync copie le plugin code natif dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à niveau du plugin.

Importer

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

API en un coup d'œil

Méthode Description
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 Définir votre propre ID client vous permet de cross-référencer votre propre ID unique avec l'ID unique d'AppsFlyer et d'autres appareils. Cet ID est disponible dans les rapports de données brutes et dans les API de Postback pour la cross-référence avec vos IDs internes.
setCurrencyCode Définit la devise pour les achats en application. La devise code doit être un code ISO 4217 à 3 caractères code.
updateServerUninstallToken (Android) Allows to pass GCM/FCM Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for Uninstall log. (iOS) Allows to pass APN Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for log Uninstall.
setAppInviteOneLink Définissez l'ID OneLink qui doit être utilisé pour attribuer les invitations d'utilisateur. Le lien généré pour l'invitation de l'utilisateur utilisera cet OneLink comme lien de base.
setOneLinkCustomDomain Pour que AppsFlyer SDK résolve avec succès les paramètres d'attribution masqués (décodés dans l'ID de lien court), fournissez à cette méthode tous les domaines configurés en tant que domaine personnalisé dans le tableau de bord d'AppsFlyer.
appendParametersToDeepLinkingURL Activez les propriétaires d'applications utilisant les App Links pour le lien profond (sans OneLink) pour attribuer les sessions initiées via un domaine associé à leur application. Appelez cette méthode avant d'appeler start. Vous devez fournir les paramètres suivants dans le Map de paramètres : pid est_retargeting doit être défini sur true.
setResolveDeepLinkURLs Les annonceurs peuvent envelopper une liaison AppsFlyer OneLink dans une autre liaison Universelle. Cette liaison Universelle invoquera l'application mais les données de liens profonds ne seront pas propagées vers AppsFlyer. setResolveDeepLinkURLs vous permet de configurer le SDK pour résoudre les URL de la liaison OneLink enveloppée, afin que les liens profonds puissent se produire correctement.
addPushNotificationDeepLinkPath Configure comment le SDK extrait les valeurs de liens profonds à partir des payloads de notifications push.
setSharingFilter Arrête les événements de propagation vers les partenaires AppsFlyer spécifiés.
setSharingFilterForAllPartners Arrête les événements de propagation vers tous les partenaires AppsFlyer. Remplace setSharingFilter.
setSharingFilterForPartners Arrête les événements de propagation vers les partenaires AppsFlyer spécifiés.
setAdditionalData Fixe des données supplémentaires à envoyer à AppsFlyer. Voir.
getAppsFlyerUID Obtenez l'ID unique de l'appareil 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 Une fois que ce API est invoqué, 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 de 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 de Google (GAID), OAID et l'identifiant publicitaire d'Amazon (AAID).
disableCollectASA Opt-out des attributions Apple Search Ads.
setHost Définir 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 SDK d'AppsFlyer utilisée dans l'application.
enableFacebookDeferredApplinks Activer la collecte des liens de déferral 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 des 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 d'application promu tel qu'il apparaît dans le tableau de bord d'AppsFlyer.
setUserEmails Set the user emails and encrypt them.
logLocation Manually log the location of the user.
setPhoneNumber sera envoyé sous forme de chaîne chiffrée SHA-256.
setPartnerData Permet d'envoyer des données personnalisées pour des besoins d'intégration partenariale.
logInvite Utilisez pour enregistrer un événement d'invitation en app (af_invite).
setDisableNetworkData Utilisez pour vous désinscrire de la collecte du nom de l'opérateur de réseau (fournisseur) et du nom de l'opérateur SIM à partir du dispositif.
enableTCFDataCollection Use to opt-in/out the automatic collection of consent data, for users who use a CMP. Flag value will be persisted between app sessions.
setConsentData Utilisez 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 au SDK.
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.
setConsentDataV2 Utilisez cette 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 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 Disables AppSet ID collection. If called before SDK init, App Set ID will not be collected. If called after init, App Set ID will be collected but not sent in request payloads. Android only.
validateAndLogInAppPurchaseV2 API pour la vérification de serveur des achats en application V2. Un événement af_purchase avec les valeurs pertinentes sera automatiquement enregistré si la validation est réussie.

Exemples

initSDK()

Utilisez cette méthode pour initialiser et démarrer AppsFlyer SDK. Cette méthode API doit être appelée 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 AppsFlyer SDK, uniquement en mode de démarrage manuel.

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

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

logEvent()

Enregistrez un événement en application.

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

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

setCustomerUserId()

La définition de votre propre ID client vous permet de croiser référencer votre propre ID unique avec l'ID unique d'AppsFlyer et 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.

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

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

setCurrencyCode()

Fixe la devise pour les achats en application. La devise code doit être un code ISO 4217 à 3 caractères code.

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

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

updateServerUninstallToken()

(Android) Permet de transmettre les jetons GCM/FCM collectés par des plugins tiers au serveur d'AppsFlyer. Peut être utilisé pour le journal d'annulation. (iOS) Permet de transmettre les jetons APN collectés par des plugins tiers au serveur d'AppsFlyer. Peut être utilisé pour le journal d'annulation.

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

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

La table ci-dessus liste les 44 méthodes de base. Les aides aux listeners et aux versions, ainsi que la pleine convention de chaque méthode, sont documentées dans le répertoire GitHub.

Écoutez les événements

addListener retourne un gestionnaire. Appelez handle.remove() lorsque la page se démonte.

Toute la référence

Continuez à partir de l'utilisation de @capgo/capacitor-appsflyer

Si vous utilisez L'utilisation de @capgo/capacitor-appsflyer pour planifier le travail du plugin natif, connectez-l’avec @capgo/capacitor-appsflyer pour les détails d'implémentation dans @capgo/capacitor-appsflyer Documentation pour les détails d'implémentation dans Documentation Répertoire du plugin Capgo pour le flux de travail du produit dans le Répertoire de Plugin Capgo Capacitor Plugins par Capgo pour le détail d'implémentation dans Capacitor Plugins par Capgo, et Ajouter ou Mettre à Jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à Jour les Plugins.

FAQ

FAQ du plugin AppsFlyer

Comment installer le plugin AppsFlyer dans une application Capacitor?

Exécutez « bun add @capgo/capacitor-appsflyer » (ou « npm install @capgo/capacitor-appsflyer »), puis exécutez « bunx cap sync » afin que les projets iOS et Android prennent en compte le code natif. Importez-l’à partir de « @capgo/capacitor-appsflyer » dans votre application code.

Le plugin @capgo/capacitor-appsflyer fonctionne-t-il avec React, Vue et Angular?

Oui. AppsFlyer est un paquet Capacitor, donc il fonctionne avec tout framework web qui s'exécute à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript pur.

Quelle version de Capacitor est prise en charge par @capgo/capacitor-appsflyer?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à la version majeure de Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le fichier README du GitHub liste les versions maintenues.

Le plugin @capgo/capacitor-appsflyer est-il gratuit et open source?

Oui. La source code est publique sur GitHub à https://github.com/Cap-go/capacitor-appsflyer/ et le package est gratuit pour l'installation depuis npm. Les rapports de bugs et les demandes de tirage sont les bienvenus.

Puis-je mettre à jour code qui utilise AppsFlyer sans passer par une revue de l'App Store ?

L'installation ou la mise à niveau du plugin modifie le code natif, il faut donc une nouvelle mise en magasin. Une fois cela fait, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être envoyées instantanément avec les mises à jour Capgo en direct.

Envoyez les modifications des AppsFlyer sans attendre la revue de l'application

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Démarrez avec Capgo