Aller au contenu

@capgo/capacitor-appsflyer

Ajoutez l'attribution AppsFlyer, les analytics, les deferred deep links et le support OneLink à votre application Capacitor

Ajoutez l'attribution AppsFlyer, les analytics, les deferred deep links et le support OneLink à votre application Capacitor

Commencez par initSDK() et les autres méthodes principales listées ci-dessous.

PlateformeSupportNotes
iOSOuiNatif
AndroidOuiNatif
Le WebNonProtéger avec Capacitor.getPlatform()
  • initSDK - Utilisez cette méthode pour initialiser et démarrer SDK AppsFlyer. Ce API doit être appelé dès le lancement de l'application.
  • startSDK - Utilisez cette méthode pour démarrer SDK 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 ID d'autres appareils. Cet ID est disponible dans les rapports de données brutes et dans les API Postback pour le recoupement avec vos ID internes.
MéthodeDescription
addListener('conversion_callback', listener)Écoutez les callbacks de conversion, y compris onConversionDataSuccess et onConversionDataFail, avec OnConversionDataResult les payloads.
addListener('oaoa_callback', listener)Écoutez les callbacks d'attribution d'ouverture d'application, y compris onAppOpenAttribution et onAttributionFailure, avec OnAppOpenAttribution les payloads.
addListener('udl_callback', listener)Écoutez les callbacks de deep link unifiés avec OnDeepLink les payloads.
initSDKUtilisez cette méthode pour initialiser et démarrer AppsFlyer SDK. Ce API doit être appelé dès le lancement de l'application.
startSDKUtilisez cette méthode pour démarrer le SDK d'AppsFlyer, uniquement en mode démarrage manuel.
logEventEnregistrer un événement in-app.
setCustomerUserIdDé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.
setCurrencyCodeDéfinit la devise utilisée pour les achats in-app. Fournissez un code ISO 4217 à trois caractères.
updateServerUninstallTokenTransmettez les tokens GCM/FCM sur Android ou les tokens APNs sur iOS lorsqu'un autre plugin les a collectés. Utilisez ceci pour transmettre les tokens de mesure de désinstallation à AppsFlyer.
setAppInviteOneLinkDéfinit l'ID OneLink utilisé comme lien de base pour l'attribution d'invitation.
setOneLinkCustomDomainEnregistre vos domaines OneLink personnalisés pour qu'AppsFlyer puisse résoudre les paramètres d'attribution cachés dans les liens courts.
appendParametersToDeepLinkingURLActive l'attribution pour les deep links App Links sans OneLink. Appelez cette méthode avant startSDK(). Inclure au moins pid et is_retargeting=true dans la map de paramètres.
setResolveDeepLinkURLsÀ utiliser lorsqu'un AppsFlyer OneLink est encapsulé dans un autre Universal Link. Cela permet à SDK de résoudre l'URL encapsulée pour que le deep linking fonctionne correctement.
addPushNotificationDeepLinkPathConfigure la manière dont SDK extrait les valeurs des deep links depuis les payloads de notifications push.
setSharingFilterEmpêche la propagation des événements vers les partenaires AppsFlyer spécifiés.
setSharingFilterForAllPartnersEmpêche la propagation des événements vers tous les partenaires AppsFlyer. Écrase setSharingFilter.
setSharingFilterForPartnersEmpêche la propagation des événements vers les partenaires AppsFlyer spécifiés.
setAdditionalDataDéfinit des données clés-valeurs supplémentaires à envoyer à AppsFlyer.
getAppsFlyerUIDRécupère l'ID unique de l'appareil AppsFlyer (créé à chaque nouvelle installation de l'app).
anonymizeUserRetrait de l'utilisateur final de l'analyse AppsFlyer (anonymiser les données utilisateur).
stopUne 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.
disableSKAdNetworkOpt-out de SKAdNetwork.
disableAdvertisingIdentifierDé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).
disableCollectASADésactiver les attributions Apple Search Ads.
setHostDéfinir un hôte personnalisé.
generateInviteLinkPermet à vos utilisateurs actuels d'inviter leurs amis et contacts comme nouveaux utilisateurs de votre application.
validateAndLogInAppPurchaseAndroidAPI 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.
validateAndLogInAppPurchaseIosConsultez les définitions source pour le comportement actuel.
getSdkVersionRécupérer la version SDK d'AppsFlyer utilisée dans l'app.
enableFacebookDeferredApplinksActiver 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.
sendPushNotificationDataMesurer et récupérer les données des campagnes de notifications push.
setCurrentDeviceLanguageDéfinir la langue de l'appareil. Les données seront affichées dans les Raw Data Reports.
logCrossPromoteImpressionEnregistre une impression dans le cadre d'une campagne de cross-promotion. Assurez-vous d'utiliser l'ID de l'application promue tel qu'il apparaît dans le dashboard AppsFlyer.
setUserEmailsDéfinir les e-mails des utilisateurs et les chiffrer.
logLocationEnregistrez manuellement la position de l'utilisateur.
setPhoneNumberSera envoyé sous forme de chaîne chiffrée en SHA-256.
setPartnerDataPermet d'envoyer des données personnalisées pour l'intégration de partenaires.
logInviteUse 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 sera conservée entre les sessions de l'app.
setConsentDataUtilisez ceci pour définir manuellement les données de consentement de l'utilisateur. 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.
logAdRevenueEn 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 sur 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.
setConsentDataV2Utilisez ceci pour définir manuellement les données de consentement de l'utilisateur. 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.
isSDKStartedUtilisez cette méthode pour vérifier si le SDK d'AppsFlyer a déjà été démarré dans la session actuelle.
isSDKStoppedUtilisez cette méthode pour vérifier si le SDK d'AppsFlyer est actuellement arrêté.
disableAppSetIdDésactive la collecte de l'AppSet ID. Si appelé avant l'init de SDK, l'AppSet ID ne sera pas collecté. Si appelé après l'init, l'AppSet ID sera collecté mais ne sera pas envoyé dans les payloads de la requête. Android uniquement.
validateAndLogInAppPurchaseV2API pour la vérification serveur des achats in-app V2. Un événement af_purchase avec les valeurs pertinentes sera automatiquement logué si la validation réussit.

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-appsflyer.

Si vous utilisez @capgo/capacitor-appsflyer pour planifier le travail sur les plugins natifs, connectez-l’à Utiliser @capgo/capacitor-appsflyer pour la capacité native dans l'utilisation de @capgo/capacitor-appsflyer, 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 Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.