Getting Started

Installez

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite la commande suivante :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-appsflyer` plugin in my project.

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

bun add @capgo/capacitor-appsflyer
bunx cap sync

Importer

import { AppsFlyer } from '@capgo/capacitor-appsflyer';
import type {
  AFAdRevenueData,
  AFAndroidInAppPurchase,
  AFAnonymizeUser,
  AFAppendToDeepLink,
  AFConsentData,
  AFConsentOptions,
  AFCuid,
  AFCurrency,
  AFData,
  AFDisable,
  AFEmails,
  AFEnableTCFDataCollection,
  AFEvent,
  AFFbDAL,
  AFFilters,
  AFHost,
  AFInit,
  AFIosInAppPurchase,
  AFLanguage,
  AFLatLng,
  AFLinkGenerator,
  AFLogInvite,
  AFOnelinkDomain,
  AFOnelinkID,
  AFPartnerData,
  AFPath,
  AFPhone,
  AFPromotion,
  AFPurchaseDetailsV2,
  AFPushPayload,
  AFUninstall,
  AFUrls,
} from '@capgo/capacitor-appsflyer';

API Vue d'ensemble

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.

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

await AppsFlyer.initSDK({} as AFInit);

startSDK

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

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

await AppsFlyer.startSDK();

logEvent

Enregistrer un événement en application.

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

await AppsFlyer.logEvent({} as AFEvent);

setCustomerUserId

Définir votre propre ID client vous permet de croiser référencer 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.

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

await AppsFlyer.setCustomerUserId({} as AFCuid);

setCurrencyCode

Définit la devise utilisée pour les achats en application. fournit un code ISO 4217 à trois caractères code.

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

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Transmet les jetons GCM/FCM sur Android ou APNs sur iOS lorsque l'autre plugin les a collectés. Utilisez cela pour transmettre les jetons de mesure d'annulation vers AppsFlyer.

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

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

Définit l'ID OneLink utilisé comme lien de base pour l'attribution des invitations.

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Enregistre les domaines OneLink personnalisés afin que AppsFlyer puisse résoudre les paramètres d'attribution cachés dans les liens courts.

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

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Active l'attribution pour les liens App Links sans OneLink. Appelez cette méthode avant startSDK(). Incluez au moins pid et is_retargeting=true dans le dictionnaire de paramètres.

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Utilisez cela lorsque l'OneLink AppsFlyer est enveloppé dans un autre lien universel. Cela permet au SDK de résoudre l'URL enveloppée afin que la mise en page profonde fonctionne correctement.

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

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

Configurez comment le SDK extrait les valeurs de mise en page profonde à partir des payloads de notifications push.

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

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Arrête les événements de se propager aux partenaires AppsFlyer spécifiés.

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Arrête les événements de se propager à tous les partenaires AppsFlyer. Remplace setSharingFilter.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Arrête les événements de se propager aux partenaires AppsFlyer spécifiés.

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

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Fixe des données clés-valeurs supplémentaires à envoyer à AppsFlyer.

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

await AppsFlyer.setAdditionalData({} as AFData);

getAppsFlyerUID

Obtenez l'ID unique de l'appareil d'AppsFlyer (créé pour chaque nouvelle installation d'une application).

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

await AppsFlyer.getAppsFlyerUID();

anonymizeUser

Opt-out de l'utilisateur des analyses d'AppsFlyer (anonymiser les données de l'utilisateur).

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

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Lorsque cette API est invoquée, notre SDK ne communique plus avec nos serveurs et cesse de fonctionner. Utilisable lors de l'implémentation de l'opt-in/opt-out de l'utilisateur.

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

await AppsFlyer.stop();

disableSKAdNetwork

Opt-out du réseau SKAd

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Désactive la collecte de diverses identifiants publicitaires par le SDK. Cela comprend l'Identité pour les annonceurs d'Apple (IDFA), l'ID publicitaire de Google (GAID), OAID et l'ID publicitaire d'Amazon (AAID).

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

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

S'abonner à l'opt-out des attributions des annonces de recherche d'Apple.

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

await AppsFlyer.disableCollectASA({} as AFDisable);

setHost

Définir un hôte personnalisé.

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

await AppsFlyer.setHost({} as AFHost);

generateInviteLink

Permettre à vos utilisateurs existants d'inviter leurs amis et contacts comme nouveaux utilisateurs à votre application.

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

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

validateAndLogInAppPurchaseAndroid

API pour la vérification serveur des achats en application. Un événement af_purchase avec les valeurs pertinentes sera automatiquement enregistré si la validation est réussie.

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

await AppsFlyer.validateAndLogInAppPurchaseAndroid({} as AFAndroidInAppPurchase);

validateAndLogInAppPurchaseIos

Voir les définitions de source pour le contrat actuel.

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

await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);

getSdkVersion

Obtenez la version AppsFlyer SDK utilisée dans l'application.

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

await AppsFlyer.getSdkVersion();

enableFacebookDeferredApplinks

Activer la collecte des liens d'application différés de Facebook. Exige Facebook SDK et application Facebook sur le dispositif cible/client. Cette API doit être invoquée avant l'initialisation de l'instance AppsFlyer SDK pour fonctionner correctement.

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

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Mesurez et obtenez des données de campagnes de notifications push.

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Fixez la langue du dispositif. Les données seront affichées dans les Rapports de données brutes

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Enregistrez 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.

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

await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);

setUserEmails

Fixez les adresses e-mail des utilisateurs et les chiffrer.

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

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Enregistrer manuellement l'emplacement de l'utilisateur

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Sera envoyé sous forme de chaîne chiffrée SHA-256.

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

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Permet d'envoyer des données personnalisées pour des besoins d'intégration de partenaire.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Utilisez pour enregistrer un événement d'invitation utilisateur en application (af_invite).

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

await AppsFlyer.logInvite({} as AFLogInvite);

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.

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

await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Utilisez pour vous inscrire/désinscrire de la collecte automatique des données de consentement, pour les utilisateurs qui utilisent un CMP.

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

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Use this to set user consent data manually. If your app doesn’t use a CMP compatible with TCF v2.2, use the following method to manually provide the consent data directly to the SDK.

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

await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

Copier dans le presse-papier

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Utilisez ce champ 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.

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

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Utilisez cette méthode pour vérifier si l'SDK AppsFlyer a déjà été démarré dans la session actuelle.

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

await AppsFlyer.isSDKStarted();

isSDKStopped

Utilisez cette méthode pour vérifier si l'SDK AppsFlyer est actuellement arrêté.

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

await AppsFlyer.isSDKStopped();

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. Seulement disponible sur Android.

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

await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

API pour la vérification serveur des achats en application V2.

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

await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

Copier dans le presse-papier

Section intitulée « Source De Vérité » src/definitions.ts. Re-run the sync when the public API changes upstream.

Re-faire la synchronisation lorsque les public __CAPGO_KEEP_0__ changent en amont.

Section intitulée « Continuer depuis Getting Started » Si vous utilisez Getting Started pour planifier les opérations de tableau de bord et API , connectez-le avec En utilisant @capgo/capacitor-appsflyer pour la capacité native dans En utilisant @capgo/capacitor-appsflyer, Vue d'ensemble de API pour le détail d'implémentation dans Vue d'ensemble de API, Introduction pour le détail d'implémentation dans Introduction, Clés de API pour le détail d'implémentation dans Clés de API, et Appareils pour le détail d'implémentation dans Appareils.